1. class
  2. Eccube
  3. Page
  4. Shopping
  5. Index

Index

class Index extends AbstractPage

ショッピングログインのページクラス.

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 AbstractPage

Methods

__construct($app = null)

No description

from AbstractPage
void
init()

Page を初期化する.

void
process()

Page のプロセス.

void
sendResponse()

Page のレスポンス送信.

from AbstractPage
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) deprecated

前方互換用

from AbstractPage
void
p(mixed $val)

デバック出力を行う.

from AbstractPage
void
checkLimitPostMode()

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

from AbstractPage
void
action()

Page のプロセス.

void
lfInitParam(FormParam $objFormParam)

お客様情報入力時のパラメーター情報の初期化を行う.

void
lfInitLoginFormParam(FormParam $objFormParam)

ログイン時のパラメーター情報の初期化を行う.

string
getNextLocation($product_type_id, $uniqid, Customer $objCustomer, $objPurchase, SiteSession $objSiteSess, $objCartSess)

ログイン済みの場合の遷移先を取得する.

lfRegistData(integer $uniqid, PurchaseHelper $objPurchase, Customer $objCustomer, FormParam $objFormParam, boolean $isMultiple = false)

データの一時登録を行う.

array
lfCheckError(FormParam $objFormParam)

入力内容のチェックを行う.

void
setFormParams(FormParam $objFormParam, PurchaseHelper $objPurchase, integer $uniqid)

入力済みの購入情報をフォームに設定する.

string
lfGetErrorMessage(integer $error)

エラーメッセージを JSON 形式で返す.

Details

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

Parameters

$app

at line 55
void init()

Page を初期化する.

Return Value

void

at line 80
void process()

Page のプロセス.

Return Value

void

in AbstractPage at line 160
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 AbstractPage at line 470
log($mess, $log_level) 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 92
void action()

Page のプロセス.

Return Value

void

at line 292
void lfInitParam(FormParam $objFormParam)

お客様情報入力時のパラメーター情報の初期化を行う.

Parameters

FormParam $objFormParam FormParam インスタンス

Return Value

void

at line 316
void lfInitLoginFormParam(FormParam $objFormParam)

ログイン時のパラメーター情報の初期化を行う.

Parameters

FormParam $objFormParam FormParam インスタンス

Return Value

void

at line 345
string getNextLocation($product_type_id, $uniqid, Customer $objCustomer, $objPurchase, SiteSession $objSiteSess, $objCartSess)

ログイン済みの場合の遷移先を取得する.

商品種別IDが, ダウンロード商品の場合は, 会員情報を受注一時情報に保存し, 支払方法選択画面のパスを返す. それ以外は, お届け先選択画面のパスを返す.

Parameters

$product_type_id
$uniqid
Customer $objCustomer
$objPurchase
SiteSession $objSiteSess
$objCartSess

Return Value

string 遷移先のパス

at line 371
lfRegistData(integer $uniqid, PurchaseHelper $objPurchase, Customer $objCustomer, FormParam $objFormParam, boolean $isMultiple = false)

データの一時登録を行う.

非会員向けの処理

Parameters

integer $uniqid 受注一時テーブルのユニークID
PurchaseHelper $objPurchase PurchaseHelper インスタンス
Customer $objCustomer Customer インスタンス
FormParam $objFormParam FormParam インスタンス
boolean $isMultiple 複数配送の場合 true

at line 415
array lfCheckError(FormParam $objFormParam)

入力内容のチェックを行う.

追加の必須チェック, 相関チェックを行うため, CheckError を使用する.

Parameters

FormParam $objFormParam FormParam インスタンス

Return Value

array エラー情報の配

at line 452
void setFormParams(FormParam $objFormParam, PurchaseHelper $objPurchase, integer $uniqid)

入力済みの購入情報をフォームに設定する.

受注一時テーブル, セッションの配送情報から入力済みの購入情報を取得し, フォームに設定する.

Parameters

FormParam $objFormParam FormParam インスタンス
PurchaseHelper $objPurchase PurchaseHelper インスタンス
integer $uniqid 購入一時情報のユニークID

Return Value

void

at line 491
string lfGetErrorMessage(integer $error)

エラーメッセージを JSON 形式で返す.

TODO リファクタリング この関数は主にスマートフォンで使用します.

Parameters

integer $error エラーコード

Return Value

string JSON 形式のエラーメッセージ

See also

LC_PageError