EC-CUBE
Public メソッド | 変数
クラス SC_DB_MasterData
SC_DB_MasterDataに対する継承グラフ
Inheritance graph
[凡例]

Public メソッド

 getMasterData ($name, $columns=array())
 registMasterData ($name, $columns, $masterData, $autoCommit=true)
 updateMasterData ($name, $columns, $masterData, $autoCommit=true)
 insertMasterData ($name, $key, $value, $comment, $autoCommit=true)
 deleteMasterData ($name, $autoCommit=true)
 clearCache ($name)
 createCache ($name, $columns=array(), $isDefine=false, $commentColumn=array())
 getDbMasterData ($name, $columns=array())
 getDefaultColumnName ($columns=array())
 getMasterDataAsDefine ($masterData, $comments=array())

変数

 $objQuery
 $columns = array('id', 'name', 'rank', 'remarks')

関数

clearCache ( name)

マスターデータのキャッシュを消去する.

引数:
string$nameマスターデータ名
戻り値:
bool 消去した場合 true
createCache ( name,
columns = array(),
isDefine = false,
commentColumn = array() 
)

マスターデータのキャッシュを生成する.

引数 $name のマスターデータキャッシュを生成する. 既存のキャッシュが存在する場合は上書きする.

引数 $isDefine が true の場合は, 定数を生成する. 定数コメントを生成する場合は, $commentColumn を指定する.

引数:
string$nameマスターデータ名
array$masterDataマスターデータ
bool$isDefine定数を生成する場合 true
array$commentColumn[0] => キー, [1] => コメント文字列, [2] => 表示順 を表すカラム名を格納した配列
戻り値:
bool キャッシュの生成に成功した場合 true
deleteMasterData ( name,
autoCommit = true 
)

マスターデータを削除する.

引数 $name のマスターデータを削除し, キャッシュも削除する.

引数:
string$nameマスターデータ名
bool$autoCommitトランザクションを自動的に commit する場合 true
戻り値:
integer マスターデータの削除数
getDbMasterData ( name,
columns = array() 
)

DBからマスターデータを取得する.

キャッシュの有無に関係なく, DBからマスターデータを検索し, 取得する.

返り値は, key => value 形式の配列である.

引数:
string$nameマスターデータ名
array$columns[0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
戻り値:
array マスターデータ
getDefaultColumnName ( columns = array())

デフォルトのカラム名の配列を返す.

引数 $columns が空の場合, デフォルトのカラム名の配列を返す. 空でない場合は, 引数の値をそのまま返す.

引数:
array$columns[0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
戻り値:
array カラム名を格納した配列
getMasterData ( name,
columns = array() 
)

マスターデータを取得する.

以下の順序でマスターデータを取得する. 1. MASTER_DATA_REALDIR にマスターデータキャッシュが存在しない場合、 DBからマスターデータを取得して、マスターデータキャッシュを生成する。 2. マスターデータキャッシュを読み込み、変数に格納し返す。

返り値は, key => value 形式の配列である.

引数:
string$nameマスターデータ名
array$columns[0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
戻り値:
array マスターデータ
getMasterDataAsDefine ( masterData,
comments = array() 
)

マスターデータの配列を定数定義の文字列として出力する.

private

引数:
array$masterDataマスターデータの配列
array$commentsコメントの配列
戻り値:
string 定数定義の文字列
insertMasterData ( name,
key,
value,
comment,
autoCommit = true 
)

マスターデータを追加する.

引数 $masterData の値でマスターデータを更新する. $masterData は key => value 形式の配列である必要がある.

引数:
string$nameマスターデータ名
string$keyキー名
string$commentコメント
bool$autoCommitトランザクションを自動的に commit する場合 true
戻り値:
integer マスターデータの更新数
registMasterData ( name,
columns,
masterData,
autoCommit = true 
)

マスターデータをDBに追加する.

引数 $masterData をマスターデータとしてDBに追加し, キャッシュを生成する. 既存のキャッシュが存在する場合は上書きする. $masterData は key => value 形式の配列である必要がある.

引数:
string$nameマスターデータ名
array$columns[0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
array$masterDataマスターデータ
bool$autoCommitトランザクションを自動的に commit する場合 true
戻り値:
integer マスターデータの登録数
updateMasterData ( name,
columns,
masterData,
autoCommit = true 
)

マスターデータを更新する.

引数 $masterData の値でマスターデータを更新する. $masterData は key => value 形式の配列である必要がある.

引数:
string$nameマスターデータ名
array$columns[0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列
array$masterDataマスターデータ
bool$autoCommitトランザクションを自動的に commit する場合 true
戻り値:
integer マスターデータの更新数

構造体

$columns = array('id', 'name', 'rank', 'remarks')

デフォルトのテーブルカラム名

$objQuery

SC_Query インスタンス


このクラスの説明は次のファイルから生成されました:
 全て データ構造 ネームスペース 関数 変数