DB
[ class tree: DB ] [ index: DB ] [ all elements ]
Packages:
EC-CUBE 2.4.4
Batch
DB
Graph
Helper
module
Page
SC_Session
SC_SessionFactory
Util


Files:
SC_DB_DBFactory.php
SC_DB_DBFactory_MYSQL.php
SC_DB_DBFactory_PGSQL.php
SC_DB_MasterData.php

Classes:
SC_DB_DBFactory
SC_DB_DBFactory_MYSQL
SC_DB_DBFactory_PGSQL
SC_DB_MasterData

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_DIR/マスタデータ名.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 232]

	

    

    

		bool clearCache(
string
$name)
    

    


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





Tags:





  

    return:  消去した場合 true
  









	
        
Parameters:

    

    

          

        string  
        $name  
        マスタデータ名
      

        

    


        
[ Top ]

  

  

	
	
method createCache [line 255]

	

    

    

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

    


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

引数 $name のマスタデータキャッシュを生成する.  既存のキャッシュが存在する場合は上書きする.
引数 $isDefine が true の場合は, 定数を生成する.  定数コメントを生成する場合は, $commentColumn を指定する.





Tags:





  

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









	
        
Parameters:

    

    

          

        string  
        $name  
        マスタデータ名
      

          

        array  
        $masterData  
        マスタデータ
      

          

        bool  
        $isDefine  
        定数を生成する場合 true
      

          

        array  
        $commentColumn  
        [0] => キー, [1] => コメント文字列,
      

        

    


        
[ Top ]

  

  

	
	
method deleteMasterData [line 210]

	

    

    

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

    


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

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





Tags:





  

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









	
        
Parameters:

    

    

          

        string  
        $name  
        マスタデータ名
      

          

        bool  
        $autoCommit  
        トランザクションを自動的に commit する場合 true
      

        

    


        
[ Top ]

  

  

	
	
method getDbMasterData [line 302]

	

    

    

		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 332]

	

    

    

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

    


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

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





Tags:





  

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









	
        
Parameters:

    

    

          

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

        

    


        
[ Top ]

  

  

	
	
method getMasterData [line 74]

	

    

    

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

    


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

以下の順序でマスタデータを取得する. 
  1. MASTER_DATA_DIR のマスタデータキャッシュを include() で読み込む
  2. 1 で読み込んだ値をチェックし, 値が変数定義されていれば値を返す.
    されていなければ, 次の処理を行う.
  3. 値が未定義の場合は, DBからマスタデータを取得する.
  4. 取得した後, マスタデータのキャッシュを生成し, 値を返す.
  返り値は, key => value 形式の配列である.





Tags:





  

    return:  マスタデータ
  









	
        
Parameters:

    

    

          

        string  
        $name  
        マスタデータ名
      

          

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

        

    


        
[ Top ]

  

  

	
	
method insertMasterData [line 178]

	

    

    

		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 109]

	

    

    

		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 144]

	

    

    

		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:00:05 +0900 by Seasoft