DB
[ class tree: DB ] [ index: DB ] [ all elements ]

Class: SC_DB_MasterData

Source Location: /db/SC_DB_MasterData.php

Class Overview


マスターデータを扱うクラス.


Author(s):

  • LOCKON CO.,LTD.

Version:

  • $Id:SC_DB_MasterData.php 15532 2007-08-31 14:39:46Z nanasess $

Variables

Methods



Class Details

[line 44]
マスターデータを扱うクラス.

プルダウン等で使用するマスターデータを扱う. マスターデータは, DB に格納されているが, パフォーマンスを得るため, 初回のみ DBへアクセスし, データを定義したキャッシュファイルを生成する.

マスターデータのテーブルは, 下記のようなカラムが必要がある.

  1. キーとなる文字列
  2. 表示文字列
  3. 表示順
上記カラムのデータ型は特に指定しないが, 1 と 2 は常に string 型となる.

マスターデータがキャッシュされると, key => value 形式の配列として使用できる. マスターデータのキャッシュは, MASTER_DATA_REALDIR/マスターデータ名.php というファイルが生成される.




Tags:

author:  LOCKON CO.,LTD.
version:  $Id:SC_DB_MasterData.php 15532 2007-08-31 14:39:46Z nanasess $


[ Top ]


Class Variables

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

[line 52]

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


Type:   mixed


[ Top ]

$objQuery =

[line 49]

SC_Query インスタンス


Type:   mixed


[ Top ]



Class Methods


method clearCache [line 227]

bool clearCache( string $name)

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



Tags:

return:  消去した場合 true


Parameters:

string   $name   マスターデータ名

[ Top ]

method createCache [line 254]

bool createCache( string $name, [ $columns = array()], [bool $isDefine = false], [array $commentColumn = array()], array $masterData)

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

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

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




Tags:

return:  キャッシュの生成に成功した場合 true


Parameters:

string   $name   マスターデータ名
array   $masterData   マスターデータ
bool   $isDefine   定数を生成する場合 true
array   $commentColumn   [0] => キー, [1] => コメント文字列,
   $columns  

[ Top ]

method deleteMasterData [line 205]

integer deleteMasterData( string $name, [bool $autoCommit = true])

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

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




Tags:

return:  マスターデータの削除数


Parameters:

string   $name   マスターデータ名
bool   $autoCommit   トランザクションを自動的に commit する場合 true

[ Top ]

method getDbMasterData [line 305]

array getDbMasterData( string $name, [array $columns = array()])

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

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

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




Tags:

return:  マスターデータ


Parameters:

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

[ Top ]

method getDefaultColumnName [line 337]

array getDefaultColumnName( [array $columns = array()])

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

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




Tags:

return:  カラム名を格納した配列


Parameters:

array   $columns   [0] => キー, [1] => 表示文字列, [2] => 表示順 を表すカラム名を格納した配列

[ Top ]

method getMasterData [line 72]

array getMasterData( string $name, [array $columns = array()])

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

以下の順序でマスターデータを取得する.

  1. MASTER_DATA_REALDIR にマスターデータキャッシュが存在しない場合、 DBからマスターデータを取得して、マスターデータキャッシュを生成する。
  2. マスターデータキャッシュを読み込み、変数に格納し返す。
返り値は, key => value 形式の配列である.




Tags:

return:  マスターデータ


Parameters:

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

[ Top ]

method insertMasterData [line 173]

integer insertMasterData( string $name, string $key, $value, string $comment, [bool $autoCommit = true])

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

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




Tags:

return:  マスターデータの更新数


Parameters:

string   $name   マスターデータ名
string   $key   キー名
string   $comment   コメント
bool   $autoCommit   トランザクションを自動的に commit する場合 true
   $value  

[ Top ]

method registMasterData [line 104]

integer registMasterData( string $name, array $columns, array $masterData, [bool $autoCommit = true])

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

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




Tags:

return:  マスターデータの登録数


Parameters:

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

[ Top ]

method updateMasterData [line 139]

integer updateMasterData( string $name, array $columns, array $masterData, [bool $autoCommit = true])

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

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




Tags:

return:  マスターデータの更新数


Parameters:

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

[ Top ]


Documentation generated on Fri, 24 Feb 2012 14:02:32 +0900 by Seasoft