1. class
  2. Eccube
  3. Page
  4. Admin
  5. Design
  6. MainEdit

MainEdit

class MainEdit extends AbstractAdminPage

メイン編集 のページクラス.

Properties

$tpl_mainpage メインテンプレート from AbstractPage
$tpl_column_num テンプレートのカラム数 from AbstractPage
$tpl_mainno メインナンバー from AbstractPage
$tpl_css CSS のパス from AbstractPage
$tpl_javascript JavaScript from AbstractPage
$tpl_title タイトル from AbstractPage
$tpl_login_email ログインメールアドレス from AbstractPage
$tpl_onload HTML ロード後に実行する JavaScript コード from AbstractPage
$transactionid トランザクションID from AbstractPage
$template メインテンプレート名 from AbstractPage
$arrSiteInfo 店舗基本情報 from AbstractPage
$plugin_activate_flg プラグインを実行フラグ from AbstractPage
$arrLimitPostMode POST に限定する mode from AbstractPage
$skip_load_page_layout ページレイアウトを読み込むか from AbstractPage
$load_legacy_js 2.12.x 以前のJavaScript関数を読み込むかどうか from AbstractPage
$tpl_page_class_name from AbstractPage
$arrForm from AbstractPage
$arrErr from AbstractPage
Display $objDisplay from AbstractAdminPage
$tpl_subno from AbstractAdminPage
$tpl_maintitle from AbstractAdminPage
$tpl_subtitle from AbstractAdminPage

Methods

__construct($app = null)

No description

from AbstractPage
void
init()

Page を初期化する.

void
process()

Page のプロセス.

void
sendResponse()

Page のレスポンス送信.

from AbstractAdminPage
void
sendResponseCSV(string $file_name, string $data)

Page のレスポンス送信(ダウンロード).

from AbstractPage
void
__destruct()

デストラクタ

from AbstractPage
void
doLocalHookpointBefore(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

from AbstractPage
void
doLocalHookpointAfter(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

from AbstractPage
getTemplate()

テンプレート取得

from AbstractPage
setTemplate($template)

テンプレート設定(ポップアップなどの場合)

from AbstractPage
string
getLocation(string $path, array $param = array(), mixed $useSSL = 'escape')

$path から URL を取得する.

from AbstractPage
string
getRootPath(string $path)

EC-CUBE のWEBルート(/html/)を / としたパスを返す

from AbstractPage
void
allowClientCache() deprecated

互換性確保用メソッド

from AbstractPage
void
httpCacheControl(string $mode = '')

クライアント・プロキシのキャッシュを制御する.

from AbstractPage
string|null
getMode()

リクエストパラメーター 'mode' を取得する.

from AbstractPage
void
doValidToken(boolean $is_admin = false)

POST アクセスの妥当性を検証する.

from AbstractPage
void
setTokenTo()

トランザクショントークンを取得し, 設定する.

from AbstractPage
log($mess, $log_level = 'Info') deprecated

前方互換用

from AbstractAdminPage
void
p(mixed $val)

デバック出力を行う.

from AbstractPage
void
checkLimitPostMode()

POST に限定された mode か検証する。

from AbstractPage
void
action()

Page のアクション.

void
lfInitParam(FormParam $objFormParam)

パラメーター情報の初期化

array
getTplMainpage(integer $device_type_id, integer $page_id, PageLayoutHelper $objLayout)

ページデータを取得する.

integer|boolean
doRegister(FormParam $objFormParam, PageLayoutHelper $objLayout)

登録を実行する.

integer
registerPage(array $arrParams, PageLayoutHelper $objLayout)

入力内容をデータベースに登録する.

array
lfCheckError($objFormParam, $arrErr)

エラーチェックを行う.

boolean
createPHPFile(string $filename)

PHP ファイルを生成する.

Details

in AbstractPage at line 102
__construct($app = null)

Parameters

$app

at line 52
void init()

Page を初期化する.

Return Value

void

at line 70
void process()

Page のプロセス.

Return Value

void

in AbstractAdminPage at line 110
void sendResponse()

Page のレスポンス送信.

Return Value

void

in AbstractPage at line 190
void sendResponseCSV(string $file_name, string $data)

Page のレスポンス送信(ダウンロード).

Parameters

string $file_name
string $data

Return Value

void

in AbstractPage at line 209
void __destruct()

デストラクタ

・ブロックの基底クラス (Ecube\Page\Bloc) では、継承していない。

Return Value

void

in AbstractPage at line 229
void doLocalHookpointBefore(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

Parameters

PluginHelper $objPlugin

Return Value

void

in AbstractPage at line 250
void doLocalHookpointAfter(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

Parameters

PluginHelper $objPlugin

Return Value

void

in AbstractPage at line 269
getTemplate()

テンプレート取得

in AbstractPage at line 278
setTemplate($template)

テンプレート設定(ポップアップなどの場合)

Parameters

$template

in AbstractPage at line 303
string getLocation(string $path, array $param = array(), mixed $useSSL = 'escape')

$path から URL を取得する.

以下の順序で 引数 $path から URL を取得する. 1. realpath($path) で $path の 絶対パスを取得 2. $SERVER['DOCUMENTROOT'] と一致する文字列を削除 3. $useSSL の値に応じて, HTTPURL 又は, HTTPSURL を付与する.

返り値に, QUERY_STRING を含めたい場合は, key => value 形式 の配列を $param へ渡す.

Parameters

string $path 結果を取得するためのパス
array $param URL に付与するパラメーターの配列
mixed $useSSL 結果に HTTPSURL を使用する場合 true, HTTPURL を使用する場合 false, デフォルト 'escape' 現在のスキーマを使用

Return Value

string $path の存在する http(s):// から始まる絶対パス

See also

\Net_URL

in AbstractPage at line 337
string getRootPath(string $path)

EC-CUBE のWEBルート(/html/)を / としたパスを返す

Parameters

string $path 結果を取得するためのパス

Return Value

string EC-CUBE のWEBルート(/html/)からのパス。

in AbstractPage at line 367
void allowClientCache() deprecated

deprecated 決済モジュール互換のため

互換性確保用メソッド

Return Value

void

in AbstractPage at line 379
void httpCacheControl(string $mode = '')

クライアント・プロキシのキャッシュを制御する.

Parameters

string $mode (nocache/private)

Return Value

void

in AbstractPage at line 414
string|null getMode()

リクエストパラメーター 'mode' を取得する.

  1. $_REQUEST['mode'] の値を取得する.
  2. 存在しない場合は null を返す.

mode に, 半角英数字とアンダーバー(_) 以外の文字列が検出された場合は null を 返す.

Return Value

string|null $_REQUEST['mode'] の文字列

in AbstractPage at line 440
void doValidToken(boolean $is_admin = false)

POST アクセスの妥当性を検証する.

生成されたトランザクショントークンの妥当性を検証し, 不正な場合はエラー画面へ遷移する.

この関数は, 基本的に init() 関数で呼び出され, POST アクセスの場合は自動的に トランザクショントークンを検証する. ページによって検証タイミングなどを制御する必要がある場合は, この関数を オーバーライドし, 個別に設定を行うこと.

Parameters

boolean $is_admin 管理画面でエラー表示をする場合 true

Return Value

void

in AbstractPage at line 460
void setTokenTo()

トランザクショントークンを取得し, 設定する.

Return Value

void

in AbstractAdminPage at line 136
log($mess, $log_level = 'Info') deprecated

deprecated 2.12.0 GcUtils::gfPrintLog を使用すること

前方互換用

Parameters

$mess
$log_level

in AbstractPage at line 491
void p(mixed $val)

デバック出力を行う.

デバック用途のみに使用すること.

Parameters

mixed $val デバックする要素

Return Value

void

in AbstractPage at line 502
void checkLimitPostMode()

POST に限定された mode か検証する。

POST 以外で、POST に限定された mode を実行しようとした場合、落とす。

Return Value

void

at line 81
void action()

Page のアクション.

Return Value

void

at line 158
void lfInitParam(FormParam $objFormParam)

パラメーター情報の初期化

XXX URL のフィールドは, 実際は filename なので注意

Parameters

FormParam $objFormParam FormParamインスタンス

Return Value

void

at line 182
array getTplMainpage(integer $device_type_id, integer $page_id, PageLayoutHelper $objLayout)

ページデータを取得する.

Parameters

integer $device_type_id 端末種別ID
integer $page_id ページID
PageLayoutHelper $objLayout PageLayoutHelper インスタンス

Return Value

array ページデータの配列

at line 208
integer|boolean doRegister(FormParam $objFormParam, PageLayoutHelper $objLayout)

登録を実行する.

ファイルの作成に失敗した場合は, エラーメッセージを出力し, データベースをロールバックする.

Parameters

FormParam $objFormParam FormParam インスタンス
PageLayoutHelper $objLayout PageLayoutHelper インスタンス

Return Value

integer|boolean 登録が成功した場合, 登録したページID; 失敗した場合 false

at line 271
integer registerPage(array $arrParams, PageLayoutHelper $objLayout)

入力内容をデータベースに登録する.

Parameters

array $arrParams フォームパラメーターの配列
PageLayoutHelper $objLayout PageLayoutHelper インスタンス

Return Value

integer ページID

at line 316
array lfCheckError($objFormParam, $arrErr)

エラーチェックを行う.

Parameters

$objFormParam
$arrErr

Return Value

array エラーメッセージの配列

at line 368
boolean createPHPFile(string $filename)

PHP ファイルを生成する.

既に同名の PHP ファイルが存在する場合は何もせず true を返す.(#831)

Parameters

string $filename フォームパラメーターの filename

Return Value

boolean 作成に成功した場合 true