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

Public メソッド

 sfColumnExists ($table_name, $col_name, $col_type="", $dsn="", $add=false)
 sfDataExists ($table_name, $where, $arrval, $dsn="", $sql="", $add=false)
 sfGetBasisData ($force=false, $col="")
 sfGetBasisCount ()
 sfGetRootId ()
 sfGetRollbackPoint ($order_id, $use_point, $add_point, $order_status)
 sfGetCatTree ($parent_category_id, $count_check=false)
 findTree (&$arrTree, $parent, &$result)
 sfGetMultiCatTree ($product_id, $count_check=false)
 sfGetCatCombName ($category_id)
 sfGetCat ($category_id)
 sfGetFirstCat ($category_id)
 sfGetCategoryList ($addwhere="", $products_check=false, $head=CATEGORY_HEAD)
 sfGetLevelCatList ($parent_zero=true)
 sfGetCategoryId ($product_id, $category_id=0, $closed=false)
 addProductBeforCategories ($category_id, $product_id)
 addProductAfterCategories ($category_id, $product_id)
 removeProductByCategories ($category_id, $product_id)
 updateProductCategories ($arrCategory_id, $product_id)
 sfCountCategory ($objQuery=NULL, $is_force_all_count=false)
 sfGetChildsID ($table, $pid_name, $id_name, $id)
 sfGetChildrenArray ($table, $pid_name, $id_name, $id)
 sfGetChildrenArraySub ($table, $pid_name, $id_name, $arrPID)
 sfGetParents ($table, $pid_name, $id_name, $id)
 sfGetParentsArray ($table, $pid_name, $id_name, $id)
 sfGetParentsArraySub ($table, $pid_name, $id_name, $child)
 sfGetCatWhere ($category_id)
 sfGetIDValueList ($table, $keyname, $valname, $where= '', $arrVal=array())
 sfRankUp ($table, $colname, $id, $andwhere="")
 sfRankDown ($table, $colname, $id, $andwhere="")
 sfMoveRank ($tableName, $keyIdColumn, $keyId, $pos, $where="")
 sfDeleteRankRecord ($table, $colname, $id, $andwhere="", $delete=false)
 sfGetParentsCol ($objQuery, $table, $id_name, $col_name, $arrId)
 sfMoveCatRank ($objQuery, $table, $id_name, $cat_name, $old_catid, $new_catid, $id)
 sfGetDelivFee ($pref_id, $deliv_id=0)
 sfIsRecord ($table, $col, $arrval, $addwhere="")
 sfCountMaker ($objQuery)
 sfGetMakerId ($product_id, $maker_id=0, $closed=false)
 sfGetMakerList ($addwhere="", $products_check=false)
 sfTax ($price)
 sfCalcIncTax ($price, $tax=null, $tax_rule=null)
 sfGetAddPoint ($totalpoint, $use_point)
 sfExecSqlByFile ($sqlFilePath)
 sfHasProductClass ($product_id)

変数

 $g_root_on
 $g_root_id
 $g_category_on
 $g_category_id

関数

addProductAfterCategories ( category_id,
product_id 
)

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

引数:
integer$category_idカテゴリID
integer$product_idプロダクトID
戻り値:
void
addProductBeforCategories ( category_id,
product_id 
)

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

引数:
integer$category_idカテゴリID
integer$product_idプロダクトID
戻り値:
void
findTree ( &$  arrTree,
parent,
&$  result 
)

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

引数:
arrayカテゴリの配列
integer$parent上位カテゴリID
arrayパンくずリスト用の配列
戻り値:
void
参照:
sfGetCatTree()
removeProductByCategories ( category_id,
product_id 
)

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

引数:
integer$category_idカテゴリID
integer$product_idプロダクトID
戻り値:
void
sfCalcIncTax ( price,
tax = null,
tax_rule = null 
)

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

引数:
integer$price計算対象の金額
戻り値:
integer 税金付与した金額
sfColumnExists ( table_name,
col_name,
col_type = "",
dsn = "",
add = false 
)

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

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

引数:
string$table_nameテーブル名
string$column_nameカラム名
string$col_typeカラムのデータ型
string$dsnデータソース名
bool$addカラムの作成も行う場合 true
戻り値:
bool カラムが存在する場合とカラムの生成に成功した場合 true, テーブルが存在しない場合 false, 引数 $add == false でカラムが存在しない場合 false
sfCountCategory ( objQuery = NULL,
is_force_all_count = false 
)

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

引数:
SC_Query$objQuerySC_Query インスタンス
boolean$is_force_all_count全カテゴリの集計を強制する場合 true
戻り値:
void
sfCountMaker ( objQuery)

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

引数:
SC_Query$objQuerySC_Query インスタンス
戻り値:
void
sfDataExists ( table_name,
where,
arrval,
dsn = "",
sql = "",
add = false 
)

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

引数:
string$table_nameテーブル名
string$whereデータを検索する WHERE 句
string$dsnデータソース名
string$sqlデータの追加を行う場合の SQL文
bool$addデータの追加も行う場合 true
戻り値:
bool データが存在する場合 true, データの追加に成功した場合 true, $add == false で, データが存在しない場合 false
sfDeleteRankRecord ( table,
colname,
id,
andwhere = "",
delete = false 
)

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

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

引数:
string$tableテーブル名
string$colnameカラム名
string | integer$idテーブルのキー
string$andwhereSQL の AND 条件である WHERE 句
bool$deleteレコードごと削除する場合 true, レコードごと削除しない場合 false
戻り値:
void
sfExecSqlByFile ( sqlFilePath)

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

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

引数:
string$sqlFilePathSQL ファイルのパス
戻り値:
void
sfGetAddPoint ( totalpoint,
use_point 
)

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

引数:
integer$totalpoint
integer$use_point
戻り値:
integer 加算ポイント

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

戻り値:
int
sfGetBasisData ( force = false,
col = "" 
)

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

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

引数:
boolean$force強制的にDB取得するか
string$col取得カラムを指定する
戻り値:
array 店舗基本情報の配列
sfGetCat ( category_id)

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

引数:
integer$category_idカテゴリID
戻り値:
array 指定したカテゴリーIDのカテゴリー
sfGetCatCombName ( category_id)

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

引数:
integer$category_idカテゴリID
戻り値:
string 親カテゴリーを連結した文字列
sfGetCategoryId ( product_id,
category_id = 0,
closed = false 
)

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

引数:
integer$product_idプロダクトID
integer$category_idカテゴリID
戻り値:
array 選択中の商品のカテゴリIDの配列
sfGetCategoryList ( addwhere = "",
products_check = false,
head = CATEGORY_HEAD 
)

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

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

引数:
string$addwhere追加する WHERE 句
bool$products_check商品の存在するカテゴリのみ取得する場合 true
string$headカテゴリ名のプレフィックス文字列
戻り値:
array カテゴリツリーの配列
sfGetCatTree ( parent_category_id,
count_check = false 
)

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

引数:
integer$parent_category_id親カテゴリID
bool$count_check登録商品数のチェックを行う場合 true
戻り値:
array カテゴリツリーの配列
sfGetCatWhere ( category_id)

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

引数:
integer$category_idカテゴリID
戻り値:
array 商品を検索する場合の配列
sfGetChildrenArray ( table,
pid_name,
id_name,
id 
)

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

引数:
string$tableテーブル名
string$pid_name親ID名
string$id_nameID名
integer$idID番号
戻り値:
array 子IDの配列
sfGetChildrenArraySub ( table,
pid_name,
id_name,
arrPID 
)

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

引数:
array$arrData親カテゴリの配列
string$pid_name親ID名
string$id_nameID名
array$arrPID親IDの配列
戻り値:
array 子IDの配列
sfGetChildsID ( table,
pid_name,
id_name,
id 
)

子IDの配列を返す.

引数:
string$tableテーブル名
string$pid_name親ID名
string$id_nameID名
integer$idID
array子ID の配列
sfGetDelivFee ( pref_id,
deliv_id = 0 
)

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

引数:
integer | array$pref_id都道府県ID 又は都道府県IDの配列
integer$deliv_id配送業者ID
戻り値:
string 指定の都道府県, 配送業者の配送料金
sfGetFirstCat ( category_id)

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

引数:
integer$category_idカテゴリID
戻り値:
array 指定したカテゴリーIDの大カテゴリー
sfGetIDValueList ( table,
keyname,
valname,
where = '',
arrVal = array() 
)

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

引数:
string$tableテーブル名
string$keynameプライマリーキーのカラム名
string$valnameデータ内容のカラム名
string$whereWHERE句
array$arrvalプレースホルダ
戻り値:
array SELECT ボックス用リストの配列
sfGetLevelCatList ( parent_zero = true)

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

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

引数:
bool$parent_zero親カテゴリの Value=0 の場合 true
戻り値:
array カテゴリツリーの配列
sfGetMakerId ( product_id,
maker_id = 0,
closed = false 
)

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

引数:
integer$product_idプロダクトID
integer$maker_idメーカーID
戻り値:
array 選択中の商品のメーカーIDの配列
sfGetMakerList ( addwhere = "",
products_check = false 
)

メーカーの取得を行う.

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

引数:
string$addwhere追加する WHERE 句
bool$products_check商品の存在するカテゴリのみ取得する場合 true
戻り値:
array カテゴリツリーの配列
sfGetMultiCatTree ( product_id,
count_check = false 
)

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

引数:
integer$product_id商品ID
bool$count_check登録商品数のチェックを行う場合 true
戻り値:
array カテゴリツリーの配列
sfGetParents ( table,
pid_name,
id_name,
id 
)

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

引数:
SC_Query$objQuerySC_Query インスタンス
string$tableテーブル名
string$pid_name親ID名
string$id_nameID名
integer$idID
戻り値:
array 親IDの配列
sfGetParentsArray ( table,
pid_name,
id_name,
id 
)

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

引数:
string$tableテーブル名
string$pid_name親ID名
string$id_nameID名
integer$idID
戻り値:
array 親IDの配列
sfGetParentsCol ( objQuery,
table,
id_name,
col_name,
arrId 
)

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

引数:
SC_Query$objQuerySC_Query インスタンス
string$tableテーブル名
string$id_nameID名
string$col_nameカラム名
array$arrIdIDの配列
戻り値:
array 特定のカラムの配列
sfGetRollbackPoint ( order_id,
use_point,
add_point,
order_status 
)

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

引数:
integer$order_id受注番号
integer$use_point利用ポイント
integer$add_point加算ポイント
integer$order_status対応状況
戻り値:
array オーダー前ポイントの配列
sfHasProductClass ( product_id)

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

引数:
integer$product_id商品ID
戻り値:
bool 商品規格が存在する場合:true, それ以外:false
sfIsRecord ( table,
col,
arrval,
addwhere = "" 
)

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

TODO SC_Query に移行するべきか?

引数:
string$tableテーブル名
string$colカラム名
array$arrval要素の配列
array$addwhereSQL の AND 条件である WHERE 句
戻り値:
bool レコードが存在する場合 true
sfMoveCatRank ( objQuery,
table,
id_name,
cat_name,
old_catid,
new_catid,
id 
)

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

引数:
SC_Query$objQuerySC_Query インスタンス
string$tableテーブル名
string$id_nameID名
string$cat_nameカテゴリ名
integer$old_catid旧カテゴリID
integer$new_catid新カテゴリID
integer$idID
戻り値:
void
sfMoveRank ( tableName,
keyIdColumn,
keyId,
pos,
where = "" 
)

指定順位へ移動する.

引数:
string$tableNameテーブル名
string$keyIdColumnキーを保持するカラム名
string | integer$keyIdキーの値
integer$pos指定順位
string$whereSQL の AND 条件である WHERE 句
戻り値:
void
sfRankDown ( table,
colname,
id,
andwhere = "" 
)

ランキングを下げる.

引数:
string$tableテーブル名
string$colnameカラム名
string | integer$idテーブルのキー
string$andwhereSQL の AND 条件である WHERE 句
戻り値:
void
sfRankUp ( table,
colname,
id,
andwhere = "" 
)

ランキングを上げる.

引数:
string$tableテーブル名
string$colnameカラム名
string | integer$idテーブルのキー
string$andwhereSQL の AND 条件である WHERE 句
戻り値:
void
sfTax ( price)

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

引数:
integer$price計算対象の金額
戻り値:
integer 税金額
updateProductCategories ( arrCategory_id,
product_id 
)

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

引数:
array$arrCategory_id登録するカテゴリIDの配列
integer$product_idプロダクトID
戻り値:
void

構造体

$g_category_id

選択中カテゴリID

$g_category_on

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

$g_root_id

ルートカテゴリID

$g_root_on

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


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