マスタデータのキャッシュを消去する.
bool
clearCache
(string $name)
マスタデータのキャッシュを生成する.
引数 $name のマスタデータキャッシュを生成する. 既存のキャッシュが存在する場合は上書きする.
引数 $isDefine が true の場合は, 定数を生成する. 定数コメントを生成する場合は, $commentColumn を指定する.
bool
createCache
(string $name, array $masterData, [bool $isDefine = false], [array $commentColumn = array()])
-
string
$name: マスタデータ名
-
array
$masterData: マスタデータ
-
bool
$isDefine: 定数を生成する場合 true
-
array
$commentColumn: [0] => キー, [1] => コメント文字列,
マスタデータを削除する.
引数 $name のマスタデータを削除し, キャッシュも削除する.
integer
deleteMasterData
(string $name, [bool $autoCommit = true])
-
string
$name: マスタデータ名
-
bool
$autoCommit: トランザクションを自動的に commit する場合 true
DBからマスタデータを取得する.
キャッシュの有無に関係なく, DBからマスタデータを検索し, 取得する.
返り値は, key => value 形式の配列である.
array
getDbMasterData
(string $name, [array $columns = array()])
-
string
$name: マスタデータ名
-
array
$columns: [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
デフォルトのカラム名の配列を返す.
引数 $columns が空の場合, デフォルトのカラム名の配列を返す. 空でない場合は, 引数の値をそのまま返す.
array
getDefaultColumnName
([array $columns = array()])
-
array
$columns: [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
マスタデータを取得する.
以下の順序でマスタデータを取得する.
- MASTER_DATA_DIR のマスタデータキャッシュを include_once() で読み込む
- 1 で読み込んだ値をチェックし, 値が変数定義されていれば値を返す.
されていなければ, 次の処理を行う.
- 値が未定義の場合は, DBからマスタデータを取得する.
- 取得した後, マスタデータのキャッシュを生成し, 値を返す.
返り値は, key => value 形式の配列である.
array
getMasterData
(string $name, [array $columns = array()])
-
string
$name: マスタデータ名
-
array
$columns: [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
マスタデータを追加する.
引数 $masterData の値でマスタデータを更新する. $masterData は key => value 形式の配列である必要がある.
integer
insertMasterData
(string $name, string $key, $value, string $comment, [bool $autoCommit = true])
-
string
$name: マスタデータ名
-
string
$key: キー名
-
string
$comment: コメント
-
bool
$autoCommit: トランザクションを自動的に commit する場合 true
-
$value
マスタデータをDBに追加する.
引数 $masterData をマスタデータとしてDBに追加し, キャッシュを生成する. 既存のキャッシュが存在する場合は上書きする. $masterData は key => value 形式の配列である必要がある.
integer
registMasterData
(string $name, array $columns, array $masterData, [bool $autoCommit = true])
-
string
$name: マスタデータ名
-
array
$columns: [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
-
array
$masterData: マスタデータ
-
bool
$autoCommit: トランザクションを自動的に commit する場合 true
マスタデータを更新する.
引数 $masterData の値でマスタデータを更新する. $masterData は key => value 形式の配列である必要がある.
integer
updateMasterData
(string $name, array $columns, array $masterData, [bool $autoCommit = true])
-
string
$name: マスタデータ名
-
array
$columns: [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
-
array
$masterData: マスタデータ
-
bool
$autoCommit: トランザクションを自動的に commit する場合 true