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

PluginHelper

class PluginHelper

プラグインのヘルパークラス.

Properties

$arrPluginInstances
$arrRegistedPluginActions
$arrPluginIds
$arrHeadNaviBlocsByPlugin

Methods

void
load($plugin_activate_flg = true)

有効なプラグインのロード. プラグインエンジンが有効になっていない場合は プラグインエンジン自身のインストール処理を起動する

static PluginHelper
getSingletonInstance($plugin_activate_flg = true)

PluginHelper オブジェクトを返す（Singletonパターン）

void
doAction(string $hook_point, array $arrArgs = array())

プラグイン実行

registerSuperHookPoint(Object $objPlugin, string $hook_point, string $function_name, string $priority)

スーパーフックポイントを登録します.

registerLocalHookPoint(Object $objPlugin, string $priority)

ローカルフックポイントを登録します.

boolean
addAction(string $hook_point, callback $function, integer $priority)

プラグイン コールバック関数を追加する

string
makeActionUniqueId(string $hook_point, callback $function, integer $priority)

コールバック関数を一意に識別するIDの生成

array
getEnableBlocs(array $arrBlocs)

ブロックの配列から有効でないpluginのブロックを除外して返します.

void
setHeadNavi(string $url)

テンプレートのヘッダに追加するPHPのURLをセットする

void
setHeadNaviBlocs(array|null $arrBlocs)

PHPのURLをテンプレートのヘッダに追加する

static void
hook(string $hook_point, SiteView[] $arrArgs = array(), boolean $plugin_activate_flg = PLUGIN_ACTIVATE_FLAG)

Utility function to set a hook point.

Details

at line 55
void load($plugin_activate_flg = true)

有効なプラグインのロード. プラグインエンジンが有効になっていない場合は プラグインエンジン自身のインストール処理を起動する

Parameters

$plugin_activate_flg

Return Value

void

at line 99
static PluginHelper getSingletonInstance($plugin_activate_flg = true)

PluginHelper オブジェクトを返す（Singletonパターン）

Parameters

$plugin_activate_flg

Return Value

PluginHelper PluginHelperオブジェクト

at line 122
void doAction(string $hook_point, array $arrArgs = array())

プラグイン実行

Parameters

string $hook_point フックポイント
array $arrArgs コールバック関数へ渡す引数

Return Value

void

at line 175
registerSuperHookPoint(Object $objPlugin, string $hook_point, string $function_name, string $priority)

スーパーフックポイントを登録します.

Parameters

Object $objPlugin プラグインのインスタンス
string $hook_point スーパーフックポイント
string $function_name 実行する関数名
string $priority 実行順

at line 190
registerLocalHookPoint(Object $objPlugin, string $priority)

ローカルフックポイントを登録します.

Parameters

Object $objPlugin プラグインのインスタンス
string $priority 実行順

at line 208
boolean addAction(string $hook_point, callback $function, integer $priority)

プラグイン コールバック関数を追加する

Parameters

string $hook_point フックポイント名
callback $function コールバック関数名
integer $priority 同一フックポイント内での実行優先度

Return Value

boolean 成功すればtrue

at line 227
string makeActionUniqueId(string $hook_point, callback $function, integer $priority)

コールバック関数を一意に識別するIDの生成

Parameters

string $hook_point フックポイント名
callback $function コールバック関数名
integer $priority 同一フックポイント内での実行優先度

Return Value

string コールバック関数を一意に識別するID

at line 267
array getEnableBlocs(array $arrBlocs)

ブロックの配列から有効でないpluginのブロックを除外して返します.

Parameters

array $arrBlocs プラグインのインストールディレクトリ

Return Value

array $arrBlocsサイトルートからメディアディレクトリへの相対パス

at line 289
void setHeadNavi(string $url)

テンプレートのヘッダに追加するPHPのURLをセットする

Parameters

string $url PHPファイルのURL

Return Value

void

at line 300
void setHeadNaviBlocs(array|null $arrBlocs)

PHPのURLをテンプレートのヘッダに追加する

Parameters

array|null $arrBlocs 配置情報を含めたブロックの配列

Return Value

void

at line 318
static void hook(string $hook_point, SiteView[] $arrArgs = array(), boolean $plugin_activate_flg = PLUGIN_ACTIVATE_FLAG)

Utility function to set a hook point.

Parameters

string $hook_point hook point
SiteView[] $arrArgs argument passing to callback function
boolean $plugin_activate_flg

Return Value

void