class Bkup 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
$tpl_restore_err リストア中にエラーが発生したか
$arrExcludeSequence 対象外とするシーケンス生成器

Methods

__construct($app = null)

No description

void
init()

Page を初期化する.

void
process()

Page のプロセス.

void
sendResponse()

Page のレスポンス送信.

void
sendResponseCSV(string $file_name, string $data)

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

void
__destruct()

デストラクタ

void
doLocalHookpointBefore(PluginHelper $objPlugin)

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

void
doLocalHookpointAfter(PluginHelper $objPlugin)

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

getTemplate()

テンプレート取得

setTemplate($template)

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

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

$path から URL を取得する.

string
getRootPath(string $path)

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

void
allowClientCache() deprecated

互換性確保用メソッド

void
httpCacheControl(string $mode = '')

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

string|null
getMode()

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

void
doValidToken(boolean $is_admin = false)

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

void
setTokenTo()

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

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

前方互換用

void
p(mixed $val)

デバック出力を行う.

void
checkLimitPostMode()

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

void
action()

Page のアクション.

void
initParam(FormParam $objFormParam, array $arrParams)

パラメーター初期化.

$arrErr
lfCheckError(array $arrForm, string $mode)

データ型以外のエラーチェック.

boolean|int
lfCreateBkupData(string $bkup_name, string $work_dir)

バックアップファイル作成.

boolean
cbOutputCSV(mixed $data)

CSV作成 テンポラリファイル出力 コールバック関数

string
lfGetAutoIncrement()

シーケンス一覧をCSV出力形式に変換する.

lfUpdBkupData($data)

No description

lfGetBkupData($sql_option = '', $filter_bkup_name = '')

バックアップの一覧を取得する

boolean
lfRestore(string $bkup_name, string $bkup_dir, string $bkup_ext, string $mode)

バックアップファイルをリストアする

boolean
lfExeInsertSQL(Query $objQuery, string $dir, string $mode)

CSVファイルからインサート実行.

restoreSequence($objQuery, $csv)

シーケンス生成器を復元する

lfDeleteBackUp($arrForm, $bkup_dir, $bkup_ext)

No description

Details

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

Parameters

$app

at line 49
void init()

Page を初期化する.

Return Value

void

at line 67
void process()

Page のプロセス.

Return Value

void

in AbstractAdminPage at line 98
void sendResponse()

Page のレスポンス送信.

Return Value

void

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

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

Parameters

string $file_name
string $data

Return Value

void

in AbstractPage at line 197
void __destruct()

デストラクタ

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

Return Value

void

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

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

Parameters

PluginHelper $objPlugin

Return Value

void

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

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

Parameters

PluginHelper $objPlugin

Return Value

void

in AbstractPage at line 257
getTemplate()

テンプレート取得

in AbstractPage at line 266
setTemplate($template)

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

Parameters

$template

in AbstractPage at line 291
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 325
string getRootPath(string $path)

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

Parameters

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

Return Value

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

in AbstractPage at line 355
void allowClientCache() deprecated

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

互換性確保用メソッド

Return Value

void

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

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

Parameters

string $mode (nocache/private)

Return Value

void

in AbstractPage at line 402
string|null getMode()

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

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

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

Return Value

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

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

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

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

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

Parameters

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

Return Value

void

in AbstractPage at line 448
void setTokenTo()

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

Return Value

void

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

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

前方互換用

Parameters

$mess
$log_level

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

デバック出力を行う.

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

Parameters

mixed $val デバックする要素

Return Value

void

in AbstractPage at line 490
void checkLimitPostMode()

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

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

Return Value

void

at line 78
void action()

Page のアクション.

Return Value

void

at line 216
void initParam(FormParam $objFormParam, array $arrParams)

パラメーター初期化.

Parameters

FormParam $objFormParam
array $arrParams $_POST値

Return Value

void

at line 232
$arrErr lfCheckError(array $arrForm, string $mode)

データ型以外のエラーチェック.

Parameters

array $arrForm
string $mode

Return Value

$arrErr

at line 269
boolean|int lfCreateBkupData(string $bkup_name, string $work_dir)

バックアップファイル作成.

Parameters

string $bkup_name
string $work_dir

Return Value

boolean|int 結果。true:成功 int:失敗 FIXME 本来は int ではなく、エラーメッセージを戻すべき

at line 349
boolean cbOutputCSV(mixed $data)

CSV作成 テンポラリファイル出力 コールバック関数

Parameters

mixed $data 出力データ

Return Value

boolean true (true:固定 false:中断)

at line 370
string lfGetAutoIncrement()

シーケンス一覧をCSV出力形式に変換する.

シーケンス名,シーケンス値 の形式に出力する.

Return Value

string シーケンス一覧の文字列

at line 393
lfUpdBkupData($data)

Parameters

$data

at line 408
lfGetBkupData($sql_option = '', $filter_bkup_name = '')

バックアップの一覧を取得する

Parameters

$sql_option
$filter_bkup_name

at line 462
boolean lfRestore(string $bkup_name, string $bkup_dir, string $bkup_ext, string $mode)

バックアップファイルをリストアする

Parameters

string $bkup_name
string $bkup_dir
string $bkup_ext
string $mode

Return Value

boolean

at line 515
boolean lfExeInsertSQL(Query $objQuery, string $dir, string $mode)

CSVファイルからインサート実行.

Parameters

Query $objQuery
string $dir
string $mode

Return Value

boolean

at line 587
restoreSequence($objQuery, $csv)

シーケンス生成器を復元する

Parameters

$objQuery
$csv

at line 607
lfDeleteBackUp($arrForm, $bkup_dir, $bkup_ext)

Parameters

$arrForm
$bkup_dir
$bkup_ext