source: branches/version-2_12-dev/data/class/helper/SC_Helper_Plugin.php @ 21927

Revision 21927, 10.1 KB checked in by pineray, 10 years ago (diff)

#1669 #1859 初期化漏れ、無駄な変数等

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2012 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * プラグインのヘルパークラス.
26 *
27 * @package Helper
28 * @version $Id$
29 */
30class SC_Helper_Plugin {
31    // プラグインのインスタンスの配列.
32    var $arrPluginInstances = array();
33    // プラグインのアクションの配列.
34    var $arrRegistedPluginActions = array();
35    // プラグインのIDの配列.
36    var $arrPluginIds = array();
37    // HeadNaviブロックの配列
38    var $arrHeadNaviBlocsByPlugin = array();
39
40    /**
41     * 有効なプラグインのロード. プラグインエンジンが有効になっていない場合は
42     * プラグインエンジン自身のインストール処理を起動する
43     *
44     * @return void
45     */
46    function load($plugin_activate_flg = true) {
47
48        if (!defined('CONFIG_REALFILE') || !file_exists(CONFIG_REALFILE)) return; // インストール前
49        if (GC_Utils_Ex::isInstallFunction()) return; // インストール中
50        if ($plugin_activate_flg === false) return;
51        // 有効なプラグインを取得
52        $arrPluginDataList = SC_Plugin_Util_Ex::getEnablePlugin();
53        // pluginディレクトリを取得
54        $arrPluginDirectory = SC_Plugin_Util_Ex::getPluginDirectory();
55        foreach ($arrPluginDataList as $arrPluginData) {
56            // プラグイン本体ファイル名が取得したプラグインディレクトリ一覧にある事を確認
57            if (array_search($arrPluginData['plugin_code'], $arrPluginDirectory) !== false) {
58                // プラグイン本体ファイルをrequire.
59                require_once PLUGIN_UPLOAD_REALDIR . $arrPluginData['plugin_code'] . '/' . $arrPluginData['class_name'] . '.php';
60
61                // プラグインのインスタンス生成.
62                $objPlugin = new $arrPluginData['class_name']($arrPluginData);
63                // メンバ変数にプラグインのインスタンスを登録.
64                $this->arrPluginInstances[$arrPluginData['plugin_id']] = $objPlugin;
65                $this->arrPluginIds[] = $arrPluginData['plugin_id'];
66                // ローカルフックポイントの登録.
67                $this->registerLocalHookPoint($objPlugin, $arrPluginData['priority']);
68                // スーパーフックポイントの登録.
69                $this->registerSuperHookPoint($objPlugin, HOOK_POINT_PREPROCESS, 'preProcess', $arrPluginData['priority']);
70                $this->registerSuperHookPoint($objPlugin, HOOK_POINT_PROCESS, 'process', $arrPluginData['priority']);
71            }
72        }
73    }
74
75    /**
76     * SC_Helper_Plugin オブジェクトを返す(Singletonパターン)
77     *
78     * @return object SC_Helper_Pluginオブジェクト
79     */
80    function getSingletonInstance($plugin_activate_flg = true) {
81        if (!isset($GLOBALS['_SC_Helper_Plugin_instance']) || is_null($GLOBALS['_SC_Helper_Plugin_instance'])) {
82            // プラグインのローダーがDB接続を必要とするため、
83            // SC_Queryインスタンス生成後のみオブジェクトを生成する。
84            require_once CLASS_EX_REALDIR . 'SC_Query_Ex.php';
85            if (is_null(SC_Query_Ex::getPoolInstance())) {
86                return false;
87            }
88
89            $GLOBALS['_SC_Helper_Plugin_instance'] = new SC_Helper_Plugin_Ex();
90            $GLOBALS['_SC_Helper_Plugin_instance']->load($plugin_activate_flg);
91        }
92        return $GLOBALS['_SC_Helper_Plugin_instance'];
93    }
94
95    /**
96     * プラグイン実行
97     *
98     * @param string $hook_point フックポイント
99     * @param array  $arrArgs    コールバック関数へ渡す引数
100     * @return void
101     */
102    function doAction($hook_point, $arrArgs = array()) {
103        if (is_array($arrArgs) === false) {
104            array(&$arrArgs);
105        }
106
107        if (array_key_exists($hook_point, $this->arrRegistedPluginActions)
108            && is_array($this->arrRegistedPluginActions[$hook_point])) {
109
110            krsort($this->arrRegistedPluginActions[$hook_point]);
111            foreach ($this->arrRegistedPluginActions[$hook_point] as $arrFuncs) {
112
113                foreach ($arrFuncs as $func) {
114                    if (!is_null($func['function'])) {
115                        call_user_func_array($func['function'], $arrArgs);
116                    }
117                }
118            }
119        }
120    }
121
122    /**
123     * スーパーフックポイントを登録します.
124     *
125     * @param Object $objPlugin プラグインのインスタンス
126     * @param string $hook_point スーパーフックポイント
127     * @param string $function_name 実行する関数名
128     * @param string $priority 実行順
129     */
130    function registerSuperHookPoint($objPlugin, $hook_point, $function_name, $priority) {
131        // スーパープラグイン関数を定義しているかを検証.
132        if (method_exists($objPlugin, $function_name) === true) {
133            // アクションの登録
134            $this->addAction($hook_point, array($objPlugin, $function_name), $priority);
135        }
136    }
137
138    /**
139     * ローカルフックポイントを登録します.
140     *
141     * @param Object $objPlugin プラグインのインスタンス
142     * @param string $priority 実行順
143     */
144    function registerLocalHookPoint($objPlugin, $priority) {
145        // ローカルプラグイン関数を定義しているかを検証.
146        if (method_exists($objPlugin, 'register') === true) {
147            // アクションの登録(プラグイン側に記述)
148            $objPluginHelper =& SC_Helper_Plugin::getSingletonInstance();
149            $objPlugin->register($objPluginHelper, $priority);
150        }
151    }
152
153    /**
154     * プラグイン コールバック関数を追加する
155     *
156     * @param string   $hook_point フックポイント名
157     * @param callback $function   コールバック関数名
158     * @param string   $priority   同一フックポイント内での実行優先度
159     * @return boolean 成功すればtrue
160     */
161    function addAction($hook_point, $function, $priority = 0) {
162        if (!is_callable($function)) {
163            // TODO エラー処理; コール可能な形式ではありません
164        }
165        $idx = $this->makeActionUniqueId($hook_point, $function, $priority);
166        $this->arrRegistedPluginActions[$hook_point][$priority][$idx] = array('function' => $function);
167        return true;
168    }
169
170    /**
171     * コールバック関数を一意に識別するIDの生成
172     *
173     * @param string   $hook_point フックポイント名
174     * @param callback $function   コールバック関数名
175     * @param integer  $priority   同一フックポイント内での実行優先度
176     * @return string コールバック関数を一意に識別するID
177     */
178    function makeActionUniqueId($hook_point, $function, $priority) {
179        static $filter_id_count = 0;
180
181        if (is_string($function)) {
182            return $function;
183        }
184
185        if (is_object($function)) {
186            $function = array($function, '');
187        } else {
188            $function = (array) $function;
189        }
190
191        if (is_object($function[0])) {
192            if (function_exists('spl_object_hash')) {
193                return spl_object_hash($function[0]) . $function[1];
194            } else {
195                $obj_idx = get_class($function[0]).$function[1];
196                if ( false === $priority)
197                    return false;
198                $obj_idx .= isset($this->arrRegistedPluginActions[$hook_point][$priority])
199                         ? count((array)$this->arrRegistedPluginActions[$hook_point][$priority])
200                         : $filter_id_count;
201                $function[0]->wp_filter_id = $filter_id_count;
202                ++$filter_id_count;
203
204                return $obj_idx;
205            }
206        } else if (is_string($function[0])) {
207            return $function[0].$function[1];
208        }
209    }
210
211    /**
212     * ブロックの配列から有効でないpluginのブロックを除外して返します.
213     *
214     * @param array $arrBlocs プラグインのインストールディレクトリ
215     * @return array $arrBlocsサイトルートからメディアディレクトリへの相対パス
216     */
217    function getEnableBlocs($arrBlocs) {
218        foreach ($arrBlocs as $key => $value) {
219            // 有効なpluginのブロック以外.
220            if (!in_array($value['plugin_id'] , $this->arrPluginIds)) {
221                // 通常ブロック以外.
222                if ($value['plugin_id'] != '') {
223                    // ブロック配列から削除する
224                    unset ($arrBlocs[$key]);
225                }
226            }
227        }
228        return $arrBlocs;
229    }
230
231   /**
232     * テンプレートのヘッダに追加するPHPのURLをセットする
233     *
234     * @param string $url PHPファイルのURL
235     * @return void
236     */
237    function setHeadNavi($url) {
238        $this->arrHeadNaviBlocsByPlugin[$url] = TARGET_ID_HEAD;
239    }
240
241    /**
242     * PHPのURLをテンプレートのヘッダに追加する
243     *
244     * @param array|null $arrBlocs  配置情報を含めたブロックの配列
245     * @return void
246     */
247    function setHeadNaviBlocs(&$arrBlocs) {
248        foreach ($this->arrHeadNaviBlocsByPlugin as $key => $value) {
249            $arrBlocs[] = array(
250                'target_id' =>$value,
251                'php_path' => $key
252            );
253        }
254    }
255}
Note: See TracBrowser for help on using the repository browser.