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

Public メソッド

 sfGetPageLayout (&$objPage, $preview=false, $url="", $device_type_id=DEVICE_TYPE_PC)
 getPageProperties ($device_type_id=DEVICE_TYPE_PC, $page_id=null, $where= '', $arrParams=array())
 getBlocs ($device_type_id=DEVICE_TYPE_PC, $where= '', $arrParams=array(), $has_realpath=true)
 getBlocPositions ($device_type_id, $page_id, $has_realpath=true)
 lfDelPageData ($page_id, $device_type_id=DEVICE_TYPE_PC)
 lfDelFile ($filename, $device_type_id)
 isEditablePage ($device_type_id, $page_id)
 getTemplatePath ($device_type_id=DEVICE_TYPE_PC, $isUser=false)
 getUserDir ($device_type_id=DEVICE_TYPE_PC, $hasPackage=false)
 setBlocPathTo ($device_type_id=DEVICE_TYPE_PC, &$arrBlocs)
 getColumnNum ($arrPageLayout)

関数

getBlocPositions ( device_type_id,
page_id,
has_realpath = true 
)

ブロック配置情報を取得する.

public

引数:
integer$device_type_id端末種別ID
integer$page_idページID
boolean$has_realpathphp_path, tpl_path の絶対パスを含める場合 true
戻り値:
array 配置情報を含めたブロックの配列
getBlocs ( device_type_id = DEVICE_TYPE_PC,
where = '',
arrParams = array(),
has_realpath = true 
)

ブロック情報を取得する.

public

引数:
integer$device_type_id端末種別ID
string$where追加の検索条件
array$arrParams追加の検索パラメーター
boolean$has_realpathphp_path, tpl_path の絶対パスを含める場合 true
戻り値:
array ブロック情報の配列
getColumnNum ( arrPageLayout)

カラム数を取得する.

private

引数:
array$arrPageLayoutレイアウト情報の配列
戻り値:
integer $col_num カラム数
getPageProperties ( device_type_id = DEVICE_TYPE_PC,
page_id = null,
where = '',
arrParams = array() 
)

ページの属性を取得する.

この関数は, dtb_pagelayout の情報を検索する. $device_type_id は必須. デフォルト値は DEVICE_TYPE_PC. $page_id が null の場合は, $page_id が 0 以外のものを検索する.

public

引数:
integer$device_type_id端末種別ID
integer$page_idページID; null の場合は, 0 以外を検索する.
string$where追加の検索条件
array$arrParams追加の検索パラメーター
戻り値:
array ページ属性の配列
getTemplatePath ( device_type_id = DEVICE_TYPE_PC,
isUser = false 
)

テンプレートのパスを取得する.

public

引数:
integer$device_type_id端末種別ID
boolean$isUserUSER_REALDIR 以下のパスを返す場合 true
戻り値:
string テンプレートのパス
getUserDir ( device_type_id = DEVICE_TYPE_PC,
hasPackage = false 
)

DocumentRoot から user_data のパスを取得する.

引数 $hasPackage を true にした場合は, user_data/packages/template_name を取得する.

public

引数:
integer$device_type_id端末種別ID
boolean$hasPackageパッケージのパスも含める場合 true
戻り値:
string 端末に応じた DocumentRoot から user_data までのパス
isEditablePage ( device_type_id,
page_id 
)

編集可能ページかどうか.

public

引数:
integer$device_type_id端末種別ID
integer$page_idページID
戻り値:
編集可能ページの場合 true
lfDelFile ( filename,
device_type_id 
)

ページのファイルを削除する.

dtb_pagelayout の削除後に呼び出すこと。

private

引数:
string$filename
integer$device_type_id端末種別ID
戻り値:
void // TODO boolean にするべき?
lfDelPageData ( page_id,
device_type_id = DEVICE_TYPE_PC 
)

ページ情報を削除する.

XXX ファイルを確実に削除したかどうかのチェック

public

引数:
integer$page_idページID
integer$device_type_id端末種別ID
戻り値:
integer 削除数
setBlocPathTo ( device_type_id = DEVICE_TYPE_PC,
&$  arrBlocs 
)

ブロックの php_path, tpl_path を設定する.

private

引数:
integer$device_type_id端末種別ID
array$arrBlocs設定するブロックの配列
戻り値:
void
sfGetPageLayout ( &$  objPage,
preview = false,
url = "",
device_type_id = DEVICE_TYPE_PC 
)

ページのレイアウト情報を取得し, 設定する.

現在の URL に応じたページのレイアウト情報を取得し, LC_Page インスタンスに 設定する.

public

引数:
LC_Page$objPageLC_Page インスタンス
boolean$previewプレビュー表示の場合 true
string$urlページのURL($_SERVER['PHP_SELF'] の情報)
integer$device_type_id端末種別ID
戻り値:
void

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