1. class
  2. Eccube
  3. Page
  4. Admin
  5. OwnersStore
  6. Index

Index

class Index 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
initParam(FormParam $objFormParam, string $mode)

パラメーター初期化.

void
initUploadFile(UploadFile $objUpFile, string $key)

ファイルパラメーター初期化.

array
checkUploadFile(string $file_key)

ファイルが指定されている事をチェックします.

boolean
isInstalledPlugin(string $plugin_code)

既にインストールされているプラグインかを判定します.

string
getPluginCode(string $file_name)

ファイル名からプラグインコードを取得する.

string
getPluginDir(string $plugin_code)

プラグイン保存ディレクトリのパスを取得する.

string
getHtmlPluginDir(string $plugin_code)

プラグインHTMLディレクトリのパスを取得する.

string
getPluginFilePath(string $plugin_code, string $plugin_class)

プラグインファイルのパスを取得する.

array
installPlugin(string $archive_file_name, string $key)

プラグインをインストールします.

rollBack(string $temp_dir, string $plugin_id = '', string $plugin_html_dir_path = '')

ロールバック処理 インストール失敗時などに不要な一時ファイルを削除します.

array
getPluginInfo(ReflectionClass $objReflection)

プラグイン情報を取得します.

array
checkPluginConstants(ReflectionClass $objReflection, string $dir_path)

プラグインクラス内の定数をチェックします.

array
updatePlugin(array $target_plugin, string $upload_file_name)

プラグインをアップデートします.

array
unpackPluginFile(string $unpack_file_name, string $unpack_dir_path, string $file_key)

ファイルをアップロードし、解凍先のディレクトリに解凍します.

array
uninstallPlugin(array $plugin)

プラグインをアンインストールします.

array
enablePlugin(array $plugin)

プラグインを有効にします.

array
disablePlugin(array $plugin)

プラグインを無効にします.

integer
updatePriority(int $plugin_id, int $priority)

優先度を更新します.

array
registerData(array $arrPluginInfo, string $mode = 'install')

プラグイン情報をDB登録.

array
requirePluginFile(string $file_path, string $key)

ファイルを読み込む.

array
execPlugin(object $obj, string $class_name, string $exec_func)

インスタンスを生成し、指定のメソッドを実行する.

boolean
unpackPluginArchive(string $path)

プラグインアーカイブを解凍する.

integer
updatePluginEnable(int $plugin_id, int $enable_flg)

pluginidをキーにdtbpluginのstatusを更新します.

array
deletePlugin(int $plugin_id, string $plugin_code)

pluginidをキーにdtbplugin, dtbpluginhookpointから物理削除します.

boolean
isContainsFile(string $plugin_dir, string $file_name)

ファイルがあるかを判定します.

boolean
checkContainsFile(Archive_Tar $tar_obj, string $file_path)

アーカイブ内に指定のファイルが存在するかを判定します.

void
makeDir(string $dir_path)

ディレクトリを作成します.

string
checkConflictPlugin(int $plugin_id)

フックポイントで衝突する可能性のあるプラグインを判定.メッセージを返します.

boolean.
isError($error)

エラー情報が格納されているか判定します.

array
getHookPoint(string $plugin_id)

プラグインIDからフックポイントを取得します,

Details

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

Parameters

$app

at line 52
void init()

Page を初期化する.

Return Value

void

at line 67
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 78
void action()

Page のアクション.

Return Value

void

at line 229
void initParam(FormParam $objFormParam, string $mode)

パラメーター初期化.

Parameters

FormParam $objFormParam
string $mode モード

Return Value

void

at line 245
void initUploadFile(UploadFile $objUpFile, string $key)

ファイルパラメーター初期化.

Parameters

UploadFile $objUpFile UploadFileのインスタンス.
string $key 登録するキー.

Return Value

void

at line 256
array checkUploadFile(string $file_key)

ファイルが指定されている事をチェックします.

Parameters

string $file_key ファイルキー

Return Value

array エラー情報を格納した連想配列.

at line 276
boolean isInstalledPlugin(string $plugin_code)

既にインストールされているプラグインかを判定します.

Parameters

string $plugin_code プラグインコード

Return Value

boolean インストール済の場合true インストールされていない場合false

at line 295
string getPluginCode(string $file_name)

ファイル名からプラグインコードを取得する.

ファイル名を「.」で配列に分解. 配列内から拡張子として格納される可能性のある「tar」「gz」を除外すし、再度結合する.

Parameters

string $file_name ファイル名

Return Value

string $plugin_code プラグインコード.

at line 312
string getPluginDir(string $plugin_code)

プラグイン保存ディレクトリのパスを取得する.

Parameters

string $plugin_code プラグインコード

Return Value

string $plugindirpath プラグイン保存ディレクトリのパス.

at line 325
string getHtmlPluginDir(string $plugin_code)

プラグインHTMLディレクトリのパスを取得する.

Parameters

string $plugin_code プラグインコード

Return Value

string $plugindirpath プラグイン保存ディレクトリのパス.

at line 339
string getPluginFilePath(string $plugin_code, string $plugin_class)

プラグインファイルのパスを取得する.

Parameters

string $plugin_code プラグインコード
string $plugin_class プラグインクラス名

Return Value

string $pluginfilepath クラスファイルのパス.

at line 353
array installPlugin(string $archive_file_name, string $key)

プラグインをインストールします.

Parameters

string $archive_file_name アーカイブファイル名.
string $key キー.

Return Value

array エラー情報を格納した連想配列.

at line 458
rollBack(string $temp_dir, string $plugin_id = '', string $plugin_html_dir_path = '')

ロールバック処理 インストール失敗時などに不要な一時ファイルを削除します.

Parameters

string $temp_dir インストール・アップデート時の一時展開用ディレクトリのパス.
string $plugin_id プラグインID.
string $plugin_html_dir_path プラグイン毎に生成されるhtmlディレクトリのパス.

at line 478
array getPluginInfo(ReflectionClass $objReflection)

プラグイン情報を取得します.

Parameters

ReflectionClass $objReflection

Return Value

array プラグイン情報の配列

at line 518
array checkPluginConstants(ReflectionClass $objReflection, string $dir_path)

プラグインクラス内の定数をチェックします.

Parameters

ReflectionClass $objReflection リフレクションオブジェクト
string $dir_path チェックするプラグインディレクトリ

Return Value

array エラー情報を格納した連想配列.

at line 598
array updatePlugin(array $target_plugin, string $upload_file_name)

プラグインをアップデートします.

Parameters

array $target_plugin アップデートするプラグイン情報の配列.
string $upload_file_name アップロードファイル名.

Return Value

array エラー情報を格納した連想配列.

at line 658
array unpackPluginFile(string $unpack_file_name, string $unpack_dir_path, string $file_key)

ファイルをアップロードし、解凍先のディレクトリに解凍します.

Parameters

string $unpack_file_name 解凍ファイル名
string $unpack_dir_path 解凍先ディレクトリパス
string $file_key ファイルキー

Return Value

array エラー情報を格納した連想配列.

at line 692
array uninstallPlugin(array $plugin)

プラグインをアンインストールします.

Parameters

array $plugin プラグイン情報を確認した連想配列.

Return Value

array エラー情報を格納した連想配列.

at line 727
array enablePlugin(array $plugin)

プラグインを有効にします.

Parameters

array $plugin プラグイン情報を確認した連想配列.

Return Value

array $arrErr エラー情報を格納した連想配列.

at line 753
array disablePlugin(array $plugin)

プラグインを無効にします.

Parameters

array $plugin プラグイン情報を確認した連想配列.

Return Value

array $arrErr エラー情報を格納した連想配列.

at line 781
integer updatePriority(int $plugin_id, int $priority)

優先度を更新します.

Parameters

int $plugin_id プラグインID
int $priority 優先度

Return Value

integer 更新件数

at line 801
array registerData(array $arrPluginInfo, string $mode = 'install')

プラグイン情報をDB登録.

Parameters

array $arrPluginInfo プラグイン情報を格納した連想配列.
string $mode モード

Return Value

array エラー情報を格納した連想配列.

at line 890
array requirePluginFile(string $file_path, string $key)

ファイルを読み込む.

Parameters

string $file_path クラスのpath
string $key エラー情報のキー.

Return Value

array $arrErr エラー情報を格納した連想配列.

at line 911
array execPlugin(object $obj, string $class_name, string $exec_func)

インスタンスを生成し、指定のメソッドを実行する.

Parameters

object $obj インスタンス
string $class_name クラス名
string $exec_func 実行するメソッド名.

Return Value

array $arrErr エラー情報を格納した連想配列.

at line 940
boolean unpackPluginArchive(string $path)

プラグインアーカイブを解凍する.

Parameters

string $path アーカイブパス

Return Value

boolean Archive_Tar::extractModify()のエラー

at line 964
integer updatePluginEnable(int $plugin_id, int $enable_flg)

pluginidをキーにdtbpluginのstatusを更新します.

Parameters

int $plugin_id プラグインID
int $enable_flg 有効フラグ

Return Value

integer 更新件数

at line 984
array deletePlugin(int $plugin_id, string $plugin_code)

pluginidをキーにdtbplugin, dtbpluginhookpointから物理削除します.

Parameters

int $plugin_id プラグインID.
string $plugin_code プラグインコード.

Return Value

array $arrErr エラー情報を格納した連想配列.

at line 1012
boolean isContainsFile(string $plugin_dir, string $file_name)

ファイルがあるかを判定します.

Parameters

string $plugin_dir 対象ディレクトリ.
string $file_name ファイル名.

Return Value

boolean

at line 1033
boolean checkContainsFile(Archive_Tar $tar_obj, string $file_path)

アーカイブ内に指定のファイルが存在するかを判定します.

Parameters

Archive_Tar $tar_obj
string $file_path 判定するファイルパス

Return Value

boolean

at line 1050
void makeDir(string $dir_path)

ディレクトリを作成します.

Parameters

string $dir_path 作成するディレクトリのパス

Return Value

void

at line 1064
string checkConflictPlugin(int $plugin_id)

フックポイントで衝突する可能性のあるプラグインを判定.メッセージを返します.

Parameters

int $plugin_id プラグインID

Return Value

string $conflictalertmessage メッセージ

at line 1100
boolean. isError($error)

エラー情報が格納されているか判定します.

Parameters

$error

Return Value

boolean.

at line 1115
array getHookPoint(string $plugin_id)

プラグインIDからフックポイントを取得します,

Parameters

string $plugin_id プラグインID

Return Value

array フックポイントの連想配列.