1. class
  2. Eccube
  3. Framework
  4. Helper
  5. PageLayoutHelper

PageLayoutHelper

class PageLayoutHelper

Webページのレイアウト情報を制御するヘルパークラス.

Properties

$classes

Methods

void
sfGetPageLayout(LC_Page $objPage, boolean $preview = false, string $url = '', integer $device_type_id = DEVICE_TYPE_PC)

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

array
getPageProperties(integer $device_type_id = DEVICE_TYPE_PC, integer $page_id = null, string $where = '', string[] $arrParams = array())

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

array
getBlocs(integer $device_type_id = DEVICE_TYPE_PC, string $where = '', array $arrParams = array(), boolean $has_realpath = true)

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

array
getBlocPositions(integer $device_type_id, integer $page_id, boolean $has_realpath = true)

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

integer
lfDelPageData(integer $page_id, integer $device_type_id = DEVICE_TYPE_PC)

ページ情報を削除する.

void
lfDelFile(string $filename, integer $device_type_id)

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

boolean
isEditablePage(integer $device_type_id, integer $page_id)

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

string
getTemplatePath(integer $device_type_id = DEVICE_TYPE_PC, boolean $isUser = false)

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

string
getUserDir(integer $device_type_id = DEVICE_TYPE_PC, boolean $hasPackage = false)

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

void
setBlocPathTo(integer $device_type_id = DEVICE_TYPE_PC, array $arrBlocs = array())

ブロックの phppath, tplpath を設定する.

integer
getColumnNum(array $arrPageLayout)

カラム数を取得する.

Details

at line 71
void sfGetPageLayout(LC_Page $objPage, boolean $preview = false, string $url = '', integer $device_type_id = DEVICE_TYPE_PC)

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

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

Parameters

LC_Page $objPage LC_Page インスタンス
boolean $preview プレビュー表示の場合 true
string $url ページのURL($SERVER['SCRIPTNAME'] の情報)
integer $device_type_id 端末種別ID

Return Value

void

at line 148
array getPageProperties(integer $device_type_id = DEVICE_TYPE_PC, integer $page_id = null, string $where = '', string[] $arrParams = array())

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

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

Parameters

integer $device_type_id 端末種別ID
integer $page_id ページID; null の場合は, 0 以外を検索する.
string $where 追加の検索条件
string[] $arrParams 追加の検索パラメーター

Return Value

array ページ属性の配列

at line 174
array getBlocs(integer $device_type_id = DEVICE_TYPE_PC, string $where = '', array $arrParams = array(), boolean $has_realpath = true)

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

Parameters

integer $device_type_id 端末種別ID
string $where 追加の検索条件
array $arrParams 追加の検索パラメーター
boolean $has_realpath phppath, tplpath の絶対パスを含める場合 true

Return Value

array ブロック情報の配列

at line 195
array getBlocPositions(integer $device_type_id, integer $page_id, boolean $has_realpath = true)

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

Parameters

integer $device_type_id 端末種別ID
integer $page_id ページID
boolean $has_realpath phppath, tplpath の絶対パスを含める場合 true

Return Value

array 配置情報を含めたブロックの配列

at line 238
integer lfDelPageData(integer $page_id, integer $device_type_id = DEVICE_TYPE_PC)

ページ情報を削除する.

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

Parameters

integer $page_id ページID
integer $device_type_id 端末種別ID

Return Value

integer 削除数

at line 262
void lfDelFile(string $filename, integer $device_type_id)

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

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

Parameters

string $filename
integer $device_type_id 端末種別ID

Return Value

void // TODO boolean にするべき?

at line 295
boolean isEditablePage(integer $device_type_id, integer $page_id)

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

Parameters

integer $device_type_id 端末種別ID
integer $page_id ページID

Return Value

boolean �合 true

at line 316
string getTemplatePath(integer $device_type_id = DEVICE_TYPE_PC, boolean $isUser = false)

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

Parameters

integer $device_type_id 端末種別ID
boolean $isUser USER_REALDIR 以下のパスを返す場合 true

Return Value

string テンプレートのパス

at line 355
string getUserDir(integer $device_type_id = DEVICE_TYPE_PC, boolean $hasPackage = false)

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

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

Parameters

integer $device_type_id 端末種別ID
boolean $hasPackage パッケージのパスも含める場合 true

Return Value

string 端末に応じた DocumentRoot から user_data までのパス

at line 386
void setBlocPathTo(integer $device_type_id = DEVICE_TYPE_PC, array $arrBlocs = array())

ブロックの phppath, tplpath を設定する.

Parameters

integer $device_type_id 端末種別ID
array $arrBlocs 設定するブロックの配列

Return Value

void

at line 406
integer getColumnNum(array $arrPageLayout)

カラム数を取得する.

Parameters

array $arrPageLayout レイアウト情報の配列

Return Value

integer $col_num カラム数