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


Files:
SC_Helper_Customer.php
SC_Helper_DB.php
SC_Helper_Mail.php
SC_Helper_Mobile.php
SC_Helper_PageLayout.php
SC_Helper_Plugin.php
SC_Helper_Purchase.php
SC_Helper_Session.php

Classes:
SC_Helper_Customer
SC_Helper_DB
SC_Helper_Mail
SC_Helper_Mobile
SC_Helper_PageLayout
SC_Helper_Plugin
SC_Helper_Purchase
SC_Helper_Session

Class: SC_Helper_DB

Source Location: /helper/SC_Helper_DB.php

Class Overview




DB関連のヘルパークラス.




Author(s):


    
          
  • LOCKON CO.,LTD.
    • 
            





        
    

Version:


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



        




Variables







Methods
























Class Details



[line 31]

DB関連のヘルパークラス.





Tags:





  

    author:  LOCKON CO.,LTD.
  

  

    version:  $Id:SC_Helper_DB.php 15532 2007-08-31 14:39:46Z nanasess $
  










[ Top ]







Class Variables



	
	

	
$g_category_id = 

	
[line 45]

  選択中カテゴリID


  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$g_category_on = 

	
[line 42]

  選択中カテゴリ取得フラグ


  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$g_root_id = 

	
[line 39]

  ルートカテゴリID


  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$g_root_on = 

	
[line 36]

  ルートカテゴリ取得フラグ


  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods




  

	
	
method addProductAfterCategories [line 565]

	

    

    

		void addProductAfterCategories(
integer
$category_id, integer
$product_id)
    

    


	
		商品をカテゴリの末尾に追加する.





	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

          

        integer  
        $product_id  
        プロダクトID
      

        

    


        
[ Top ]

  

  

	
	
method addProductBeforCategories [line 532]

	

    

    

		void addProductBeforCategories(
integer
$category_id, integer
$product_id)
    

    


	
		商品をカテゴリの先頭に追加する.





	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

          

        integer  
        $product_id  
        プロダクトID
      

        

    


        
[ Top ]

  

  

	
	
method findTree [line 283]

	

    

    

		void findTree(
array
&$arrTree, integer
$parent, array
&$result)
    

    


	
		カテゴリツリーを走査し, パンくずリスト用の配列を生成する.





Tags:





  

    see:  SC_Helper_DB::sfGetCatTree()
  









	
        
Parameters:

    

    

          

        integer  
        $parent  
        上位カテゴリID
      

          

        array  
        &$arrTree  
        カテゴリの配列
      

          

        array  
        &$result  
        パンくずリスト用の配列
      

        

    


        
[ Top ]

  

  

	
	
method removeProductByCategories [line 597]

	

    

    

		void removeProductByCategories(
integer
$category_id, integer
$product_id)
    

    


	
		商品をカテゴリから削除する.





	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

          

        integer  
        $product_id  
        プロダクトID
      

        

    


        
[ Top ]

  

  

	
	
method sfCalcIncTax [line 1373]

	

    

    

		integer sfCalcIncTax(
integer
$price, [
$tax = null], [
$tax_rule = null])
    

    


	
		店舗基本情報に基づいて税金付与した金額を返す





Tags:





  

    return:  税金付与した金額
  









	
        
Parameters:

    

    

          

        integer  
        $price  
        計算対象の金額
      

          

          
        $tax  
        
      

          

          
        $tax_rule  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfColumnExists [line 66]

	

    

    

		bool sfColumnExists(
string
$table_name, 
$col_name, [string
$col_type = ""], [string
$dsn = ""], [bool
$add = false], string
$column_name)
    

    


	
		カラムの存在チェックと作成を行う.

チェック対象のテーブルに, 該当のカラムが存在するかチェックする.  引数 $add が true の場合, 該当のカラムが存在しない場合は, カラムの生成を行う.  カラムの生成も行う場合は, $col_type も必須となる.





Tags:





  

    return:  カラムが存在する場合とカラムの生成に成功した場合 true,                テーブルが存在しない場合 false,                引数 $add == false でカラムが存在しない場合 false
  









	
        
Parameters:

    

    

          

        string  
        $table_name  
        テーブル名
      

          

        string  
        $column_name  
        カラム名
      

          

        string  
        $col_type  
        カラムのデータ型
      

          

        string  
        $dsn  
        データソース名
      

          

        bool  
        $add  
        カラムの作成も行う場合 true
      

          

          
        $col_name  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfCountCategory [line 642]

	

    

    

		void sfCountCategory(
[SC_Query
$objQuery = NULL], [boolean
$is_force_all_count = false])
    

    


	
		カテゴリ数の登録を行う.





	
        
Parameters:

    

    

          

        SC_Query  
        $objQuery  
        SC_Query インスタンス
      

          

        boolean  
        $is_force_all_count  
        全カテゴリの集計を強制する場合 true
      

        

    


        
[ Top ]

  

  

	
	
method sfCountMaker [line 1265]

	

    

    

		void sfCountMaker(
SC_Query
$objQuery)
    

    


	
		メーカー商品数数の登録を行う.





	
        
Parameters:

    

    

          

        SC_Query  
        $objQuery  
        SC_Query インスタンス
      

        

    


        
[ Top ]

  

  

	
	
method sfDataExists [line 106]

	

    

    

		bool sfDataExists(
string
$table_name, string
$where, 
$arrval, [string
$dsn = ""], [string
$sql = ""], [bool
$add = false])
    

    


	
		データの存在チェックを行う.





Tags:





  

    return:  データが存在する場合 true, データの追加に成功した場合 true,                $add == false で, データが存在しない場合 false
  









	
        
Parameters:

    

    

          

        string  
        $table_name  
        テーブル名
      

          

        string  
        $where  
        データを検索する WHERE 句
      

          

        string  
        $dsn  
        データソース名
      

          

        string  
        $sql  
        データの追加を行う場合の SQL文
      

          

        bool  
        $add  
        データの追加も行う場合 true
      

          

          
        $arrval  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfDeleteRankRecord [line 1102]

	

    

    

		void sfDeleteRankRecord(
string
$table, string
$colname, string|integer
$id, [string
$andwhere = ""], [bool
$delete = false])
    

    


	
		ランクを含むレコードを削除する.

レコードごと削除する場合は、$deleteをtrueにする





	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $colname  
        カラム名
      

          

        string|integer  
        $id  
        テーブルのキー
      

          

        string  
        $andwhere  
        SQL の AND 条件である WHERE 句
      

          

        bool  
        $delete  
        レコードごと削除する場合 true,                      レコードごと削除しない場合 false
      

        

    


        
[ Top ]

  

  

	
	
method sfExecSqlByFile [line 1402]

	

    

    

		void sfExecSqlByFile(
string
$sqlFilePath)
    

    


	
		指定ファイルが存在する場合 SQL として実行

XXX プラグイン用に追加。将来消すかも。





	
        
Parameters:

    

    

          

        string  
        $sqlFilePath  
        SQL ファイルのパス
      

        

    


        
[ Top ]

  

  

	
	
method sfGetAddPoint [line 1387]

	

    

    

		integer sfGetAddPoint(
integer
$totalpoint, integer
$use_point)
    

    


	
		店舗基本情報に基づいて加算ポイントを返す





Tags:





  

    return:  加算ポイント
  









	
        
Parameters:

    

    

          

        integer  
        $totalpoint  
        
      

          

        integer  
        $use_point  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetBasisCount [line 161]

	

    

    

		int sfGetBasisCount(
)
    

    


	
		基本情報の登録数を取得する





	
        
[ Top ]

  

  

	
	
method sfGetBasisData [line 135]

	

    

    

		array sfGetBasisData(
[boolean
$force = false], [string
$col = ""])
    

    


	
		店舗基本情報を取得する.

引数 $force が false の場合は, 初回のみ DB 接続し,  2回目以降はキャッシュされた結果を使用する.





Tags:





  

    return:  店舗基本情報の配列
  









	
        
Parameters:

    

    

          

        boolean  
        $force  
        強制的にDB取得するか
      

          

        string  
        $col  
        取得カラムを指定する
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCat [line 378]

	

    

    

		array sfGetCat(
integer
$category_id)
    

    


	
		指定したカテゴリーIDのカテゴリーを取得する.





Tags:





  

    return:  指定したカテゴリーIDのカテゴリー
  









	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCatCombName [line 353]

	

    

    

		string sfGetCatCombName(
integer
$category_id)
    

    


	
		親カテゴリーを連結した文字列を取得する.





Tags:





  

    return:  親カテゴリーを連結した文字列
  









	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCategoryId [line 504]

	

    

    

		array sfGetCategoryId(
integer
$product_id, [integer
$category_id = 0], [
$closed = false])
    

    


	
		選択中の商品のカテゴリを取得する.





Tags:





  

    return:  選択中の商品のカテゴリIDの配列
  









	
        
Parameters:

    

    

          

        integer  
        $product_id  
        プロダクトID
      

          

        integer  
        $category_id  
        カテゴリID
      

          

          
        $closed  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCategoryList [line 419]

	

    

    

		array sfGetCategoryList(
[string
$addwhere = ""], [bool
$products_check = false], [string
$head = CATEGORY_HEAD])
    

    


	
		カテゴリツリーの取得を行う.

$products_check:true商品登録済みのものだけ取得する





Tags:





  

    return:  カテゴリツリーの配列
  









	
        
Parameters:

    

    

          

        string  
        $addwhere  
        追加する WHERE 句
      

          

        bool  
        $products_check  
        商品の存在するカテゴリのみ取得する場合 true
      

          

        string  
        $head  
        カテゴリ名のプレフィックス文字列
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCatTree [line 237]

	

    

    

		array sfGetCatTree(
integer
$parent_category_id, [bool
$count_check = false])
    

    


	
		カテゴリツリーの取得を行う.





Tags:





  

    return:  カテゴリツリーの配列
  









	
        
Parameters:

    

    

          

        integer  
        $parent_category_id  
        親カテゴリID
      

          

        bool  
        $count_check  
        登録商品数のチェックを行う場合 true
      

        

    


        
[ Top ]

  

  

	
	
method sfGetCatWhere [line 915]

	

    

    

		array sfGetCatWhere(
integer
$category_id)
    

    


	
		カテゴリから商品を検索する場合のWHERE文と値を返す.





Tags:





  

    return:  商品を検索する場合の配列
  









	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetChildrenArray [line 822]

	

    

    

		array sfGetChildrenArray(
string
$table, string
$pid_name, string
$id_name, integer
$id)
    

    


	
		階層構造のテーブルから子ID配列を取得する.





Tags:





  

    return:  子IDの配列
  









	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $pid_name  
        親ID名
      

          

        string  
        $id_name  
        ID名
      

          

        integer  
        $id  
        ID番号
      

        

    


        
[ Top ]

  

  

	
	
method sfGetChildrenArraySub [line 843]

	

    

    

		array sfGetChildrenArraySub(

$table, string
$pid_name, string
$id_name, array
$arrPID, array
$arrData)
    

    


	
		親ID直下の子IDをすべて取得する.





Tags:





  

    return:  子IDの配列
  









	
        
Parameters:

    

    

          

        array  
        $arrData  
        親カテゴリの配列
      

          

        string  
        $pid_name  
        親ID名
      

          

        string  
        $id_name  
        ID名
      

          

        array  
        $arrPID  
        親IDの配列
      

          

          
        $table  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetChildsID [line 808]

	

    

    

		void sfGetChildsID(
string
$table, string
$pid_name, string
$id_name, integer
$id, array
4)
    

    


	
		子IDの配列を返す.





	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $pid_name  
        親ID名
      

          

        string  
        $id_name  
        ID名
      

          

        integer  
        $id  
        ID
      

          

        array  
        4  
        子ID の配列
      

        

    


        
[ Top ]

  

  

	
	
method sfGetDelivFee [line 1200]

	

    

    

		string sfGetDelivFee(
integer|array
$pref_id, [integer
$deliv_id = 0])
    

    


	
		都道府県から配送料金を取得する.





Tags:





  

    return:  指定の都道府県, 配送業者の配送料金
  









	
        
Parameters:

    

    

          

        integer|array  
        $pref_id  
        都道府県ID 又は都道府県IDの配列
      

          

        integer  
        $deliv_id  
        配送業者ID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetFirstCat [line 394]

	

    

    

		array sfGetFirstCat(
integer
$category_id)
    

    


	
		指定したカテゴリーIDの大カテゴリーを取得する.





Tags:





  

    return:  指定したカテゴリーIDの大カテゴリー
  









	
        
Parameters:

    

    

          

        integer  
        $category_id  
        カテゴリID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetIDValueList [line 934]

	

    

    

		array sfGetIDValueList(
string
$table, string
$keyname, string
$valname, [string
$where = ''], [
$arrVal = array()], array
$arrval)
    

    


	
		SELECTボックス用リストを作成する.





Tags:





  

    return:  SELECT ボックス用リストの配列
  









	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $keyname  
        プライマリーキーのカラム名
      

          

        string  
        $valname  
        データ内容のカラム名
      

          

        string  
        $where  
        WHERE句
      

          

        array  
        $arrval  
        プレースホルダ
      

          

          
        $arrVal  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetLevelCatList [line 457]

	

    

    

		array sfGetLevelCatList(
[bool
$parent_zero = true])
    

    


	
		カテゴリーツリーの取得を行う.

親カテゴリの Value=0 を対象とする





Tags:





  

    return:  カテゴリツリーの配列
  









	
        
Parameters:

    

    

          

        bool  
        $parent_zero  
        親カテゴリの Value=0 の場合 true
      

        

    


        
[ Top ]

  

  

	
	
method sfGetMakerId [line 1289]

	

    

    

		array sfGetMakerId(
integer
$product_id, [integer
$maker_id = 0], [
$closed = false])
    

    


	
		選択中の商品のメーカーを取得する.





Tags:





  

    return:  選択中の商品のメーカーIDの配列
  









	
        
Parameters:

    

    

          

        integer  
        $product_id  
        プロダクトID
      

          

        integer  
        $maker_id  
        メーカーID
      

          

          
        $closed  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetMakerList [line 1324]

	

    

    

		array sfGetMakerList(
[string
$addwhere = ""], [bool
$products_check = false])
    

    


	
		メーカーの取得を行う.

$products_check:true商品登録済みのものだけ取得する





Tags:





  

    return:  カテゴリツリーの配列
  









	
        
Parameters:

    

    

          

        string  
        $addwhere  
        追加する WHERE 句
      

          

        bool  
        $products_check  
        商品の存在するカテゴリのみ取得する場合 true
      

        

    


        
[ Top ]

  

  

	
	
method sfGetMultiCatTree [line 305]

	

    

    

		array sfGetMultiCatTree(
integer
$product_id, [bool
$count_check = false])
    

    


	
		カテゴリツリーの取得を複数カテゴリーで行う.





Tags:





  

    return:  カテゴリツリーの配列
  









	
        
Parameters:

    

    

          

        integer  
        $product_id  
        商品ID
      

          

        bool  
        $count_check  
        登録商品数のチェックを行う場合 true
      

        

    


        
[ Top ]

  

  

	
	
method sfGetParents [line 868]

	

    

    

		array sfGetParents(
string
$table, string
$pid_name, string
$id_name, integer
$id, SC_Query
$objQuery)
    

    


	
		所属するすべての階層の親IDを配列で返す.





Tags:





  

    return:  親IDの配列
  









	
        
Parameters:

    

    

          

        SC_Query  
        $objQuery  
        SC_Query インスタンス
      

          

        string  
        $table  
        テーブル名
      

          

        string  
        $pid_name  
        親ID名
      

          

        string  
        $id_name  
        ID名
      

          

        integer  
        $id  
        ID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetParentsArray [line 882]

	

    

    

		array sfGetParentsArray(
string
$table, string
$pid_name, string
$id_name, integer
$id)
    

    


	
		階層構造のテーブルから親ID配列を取得する.





Tags:





  

    return:  親IDの配列
  









	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $pid_name  
        親ID名
      

          

        string  
        $id_name  
        ID名
      

          

        integer  
        $id  
        ID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetParentsArraySub [line 897]

	

    

    

		void sfGetParentsArraySub(

$table, 
$pid_name, 
$id_name, 
$child)
    

    


	
		



	
        
Parameters:

    

    

          

          
        $table  
        
      

          

          
        $pid_name  
        
      

          

          
        $id_name  
        
      

          

          
        $child  
        
      

        

    


        
[ Top ]

  

  

	
	
method sfGetParentsCol [line 1143]

	

    

    

		array sfGetParentsCol(
SC_Query
$objQuery, string
$table, string
$id_name, string
$col_name, array
$arrId)
    

    


	
		親IDの配列を元に特定のカラムを取得する.





Tags:





  

    return:  特定のカラムの配列
  









	
        
Parameters:

    

    

          

        SC_Query  
        $objQuery  
        SC_Query インスタンス
      

          

        string  
        $table  
        テーブル名
      

          

        string  
        $id_name  
        ID名
      

          

        string  
        $col_name  
        カラム名
      

          

        array  
        $arrId  
        IDの配列
      

        

    


        
[ Top ]

  

  

	
	
method sfGetRollbackPoint [line 205]

	

    

    

		array sfGetRollbackPoint(
integer
$order_id, integer
$use_point, integer
$add_point, integer
$order_status)
    

    


	
		受注番号、最終ポイント、加算ポイント、利用ポイントから「オーダー前ポイント」を取得する





Tags:





  

    return:  オーダー前ポイントの配列
  









	
        
Parameters:

    

    

          

        integer  
        $order_id  
        受注番号
      

          

        integer  
        $use_point  
        利用ポイント
      

          

        integer  
        $add_point  
        加算ポイント
      

          

        integer  
        $order_status  
        対応状況
      

        

    


        
[ Top ]

  

  

	
	
method sfGetRootId [line 168]

	

    

    

		void sfGetRootId(
)
    

    


	
		



	
        
[ Top ]

  

  

	
	
method sfHasProductClass [line 1423]

	

    

    

		bool sfHasProductClass(
integer
$product_id)
    

    


	
		商品規格を設定しているか





Tags:





  

    return:  商品規格が存在する場合:true, それ以外:false
  









	
        
Parameters:

    

    

          

        integer  
        $product_id  
        商品ID
      

        

    


        
[ Top ]

  

  

	
	
method sfIsRecord [line 1232]

	

    

    

		bool sfIsRecord(
string
$table, string
$col, array
$arrval, [array
$addwhere = ""])
    

    


	
		レコードの存在チェックを行う.

TODO SC_Query に移行するべきか？





Tags:





  

    return:  レコードが存在する場合 true
  









	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $col  
        カラム名
      

          

        array  
        $arrval  
        要素の配列
      

          

        array  
        $addwhere  
        SQL の AND 条件である WHERE 句
      

        

    


        
[ Top ]

  

  

	
	
method sfMoveCatRank [line 1173]

	

    

    

		void sfMoveCatRank(
SC_Query
$objQuery, string
$table, string
$id_name, string
$cat_name, integer
$old_catid, integer
$new_catid, integer
$id)
    

    


	
		カテゴリ変更時の移動処理を行う.





	
        
Parameters:

    

    

          

        SC_Query  
        $objQuery  
        SC_Query インスタンス
      

          

        string  
        $table  
        テーブル名
      

          

        string  
        $id_name  
        ID名
      

          

        string  
        $cat_name  
        カテゴリ名
      

          

        integer  
        $old_catid  
        旧カテゴリID
      

          

        integer  
        $new_catid  
        新カテゴリID
      

          

        integer  
        $id  
        ID
      

        

    


        
[ Top ]

  

  

	
	
method sfMoveRank [line 1038]

	

    

    

		void sfMoveRank(
string
$tableName, string
$keyIdColumn, string|integer
$keyId, integer
$pos, [string
$where = ""])
    

    


	
		指定順位へ移動する.





	
        
Parameters:

    

    

          

        string  
        $tableName  
        テーブル名
      

          

        string  
        $keyIdColumn  
        キーを保持するカラム名
      

          

        string|integer  
        $keyId  
        キーの値
      

          

        integer  
        $pos  
        指定順位
      

          

        string  
        $where  
        SQL の AND 条件である WHERE 句
      

        

    


        
[ Top ]

  

  

	
	
method sfRankDown [line 998]

	

    

    

		void sfRankDown(
string
$table, string
$colname, string|integer
$id, [string
$andwhere = ""])
    

    


	
		ランキングを下げる.





	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $colname  
        カラム名
      

          

        string|integer  
        $id  
        テーブルのキー
      

          

        string  
        $andwhere  
        SQL の AND 条件である WHERE 句
      

        

    


        
[ Top ]

  

  

	
	
method sfRankUp [line 958]

	

    

    

		void sfRankUp(
string
$table, string
$colname, string|integer
$id, [string
$andwhere = ""])
    

    


	
		ランキングを上げる.





	
        
Parameters:

    

    

          

        string  
        $table  
        テーブル名
      

          

        string  
        $colname  
        カラム名
      

          

        string|integer  
        $id  
        テーブルのキー
      

          

        string  
        $andwhere  
        SQL の AND 条件である WHERE 句
      

        

    


        
[ Top ]

  

  

	
	
method sfTax [line 1360]

	

    

    

		integer sfTax(
integer
$price)
    

    


	
		店舗基本情報に基づいて税金額を返す





Tags:





  

    return:  税金額
  









	
        
Parameters:

    

    

          

        integer  
        $price  
        計算対象の金額
      

        

    


        
[ Top ]

  

  

	
	
method updateProductCategories [line 610]

	

    

    

		void updateProductCategories(
array
$arrCategory_id, integer
$product_id)
    

    


	
		商品カテゴリを更新する.





	
        
Parameters:

    

    

          

        array  
        $arrCategory_id  
        登録するカテゴリIDの配列
      

          

        integer  
        $product_id  
        プロダクトID
      

        

    


        
[ Top ]

  






        

		    

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