コミュニティ 学ぶ ツールライブラリ レジャー
検索
日本語
ホームページ > バックエンド開発 > PHPチュートリアル > PHPフックメカニズムの原理と詳細な説明

PHPフックメカニズムの原理と詳細な説明

藏色散人
リリース： 2023-04-08 09:44:01
転載
2863 人が閲覧しました

PHPフックメカニズムの原理と詳細な説明

#フックとは何ですか?

プラグインについては聞いたことがあると思いますが、WordPress には多くのプラグインがあり、フック機構を使用して実装されています。

コードの実行中、操作のいくつかの特別なポイントで事前にいくつかの特別なメソッドを実行します。たとえば、メソッド (Blog::add の add メソッドなど) を実行する前に、入力パラメーターと実行メソッドを記録します。 ) その後、処理結果を記録します 実行メソッドの前後に簡易フック(マウントポイント)があり、このフックにフック関数(入力パラメータの記録と処理結果の記録)を配置して、いくつかのタスクを実行しますプログラムの実行に関係のないもの。 

<?php
class Blog extends Controller{
    
    public function add(){
        
        //some code
        $res = $data;
        
        return $res;
    }
}
$obj = new Blog();
Log::write($_REQUEST);
$res =  $obj->add();
Log::write(json_encode($res));
ログイン後にコピー

メソッドを実行する前に OnBeforeRunActionCallback() メソッドが配置されている場合、このメソッドは最初は空である可能性がありますが、将来的には元のコードを変更せずに OnBeforeRunActionCallback() を直接使用できます。コード ロジックを追加するだけです。ロギング、パラメータフィルタリングなどの内部。 

<?php
class Blog extends Controller{
    
    public function add(){
        
        //some code
        $res = $data;
        
        return $res;
    }
}
$obj = new Blog();
OnBeforeRunActionCallback($_REQUEST);
$obj->add();
OnAfterRunActionCallback($res);
function OnBeforeRunActionCallback($param){
    Log::write($param);
        FilterParams($param);
}
function OnAfterRunActionCallback($res){
    Log::write(json_encode($res));
}
ログイン後にコピー

プロジェクトコード内で拡張が必要と思われる箇所(まだ拡張されていない)にフック関数を配置し、拡張が必要な​​場合はこのフックに実装する必要のあるクラスや関数をマウントします。 . 実装が拡張されました。

原則

実際のフックは通常、クラス フックとして設計されており、フックに登録プラグインを提供し (add_hook)、フック メソッド (trigger_hook) をトリガーします。 。プラグインを登録する場合、フックに対応する配列にプラグインで実行する実行メソッドを格納します。 

$_listeners = array(
    &#39;OnBeforeRunAction&#39; => array(
        &#39;callback1&#39;,
        &#39;callback2&#39;,
        &#39;callback3&#39;,
    ),
);
//提前注册插件到钩子
add_hook(&#39;OnBeforeRunAction&#39;, &#39;callback4&#39;);
//特定地方执行钩子
trigger_hook(&#39;OnBeforeRunAction&#39;);
ログイン後にコピー

フックがトリガーされると、OnBeforeRunAction に登録されたコールバック メソッドが走査され、対応するコールバック メソッドが実行されて動的拡張関数が実装されます。登録されたフック メソッドは通常、匿名関数です: 

function trigger_hook($hook, $data=&#39;&#39;){
    //查看要实现的钩子，是否在监听数组之中
    if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
    {
        // 循环调用开始
        foreach ($this->_listeners[$hook] as $listener)
        {
            if(is_callable()){
                call_user_func($listener, $data);
            }elseif(is_array($listener)){
                // 取出插件对象的引用和方法
                $class =& $listener[0];
                $method = $listener[1];
                if(method_exists($class,$method))
                {
                    // 动态调用插件的方法
                    $class->$method($data);
                }
            }
        }
    }
}
ログイン後にコピー

実装方法は?

シンプル

1. プラグイン クラス Hook: プラグインを登録し、プラグインを実行するためのメソッドを提供します。実際には、対応するマウント ポイントを格納します。配列内の実行可能メソッド。

2. プラグインを特定の設定ファイルや関数に統一して登録します。 

class Hook
{
    //action hooks array  
    private static $actions = array();
    /**
     * ads a function to an action hook
     * @param $hook
     * @param $function
     */
    public static function add_action($hook,$function)
    {   
        $hook=mb_strtolower($hook,CHARSET);
        // create an array of function handlers if it doesn&#39;t already exist
        if(!self::exists_action($hook))
        {
            self::$actions[$hook] = array();
        }
        // append the current function to the list of function handlers
        if (is_callable($function))
        {
            self::$actions[$hook][] = $function;
            return TRUE;
        }
        return FALSE ;
    }
    /**
     * executes the functions for the given hook
     * @param string $hook
     * @param array $params
     * @return boolean true if a hook was setted
     */
    public static function do_action($hook,$params=NULL)
    {
        $hook=mb_strtolower($hook,CHARSET);
        if(isset(self::$actions[$hook]))
        {
            // call each function handler associated with this hook
            foreach(self::$actions[$hook] as $function)
            {
                if (is_array($params))
                {
                    call_user_func_array($function,$params);
                }
                else
                {
                    call_user_func($function);
                }
                //cant return anything since we are in a loop! dude!
            }
            return TRUE;
        }
        return FALSE;
    }
    /**
     * gets the functions for the given hook
     * @param string $hook
     * @return mixed
     */
    public static function get_action($hook)
    {
        $hook=mb_strtolower($hook,CHARSET);
        return (isset(self::$actions[$hook]))? self::$actions[$hook]:FALSE;
    }
    /**
     * check exists the functions for the given hook
     * @param string $hook
     * @return boolean
     */
    public static function exists_action($hook)
    {
        $hook=mb_strtolower($hook,CHARSET);
        return (isset(self::$actions[$hook]))? TRUE:FALSE;
    }
}
 
    /**
     * Hooks Shortcuts not in class
     */
    function add_action($hook,$function)
    {
        return Hook::add_action($hook,$function);
    }
 
    function do_action($hook)
    {
        return Hook::do_action($hook);
    }
ログイン後にコピー

使用例: 

//添加钩子
Hook::add_action(&#39;unique_name_hook&#39;,&#39;some_class::hook_test&#39;);
//或使用快捷函数添加钩子:
add_action(&#39;unique_name_hook&#39;,&#39;other_class::hello&#39;);
add_action(&#39;unique_name_hook&#39;,&#39;some_public_function&#39;);
//执行钩子
do_action(&#39;unique_name_hook&#39;);//也可以使用 Hook::do_action();
ログイン後にコピー

インストール・アンインストールあり

フッククラスの初期化時に、開いているプラ​​グインを登録(データベース レコードなど) ;グローバル状況が適切な場合にマウント ポイントを設定し、操作が適切な場合にマウント ポイント登録イベントをトリガーします。

1. プラグイン クラス Hook: プラグインの登録と実行のためのメソッドを提供し、実際にはマウント ポイントに対応する実行メソッドを配列に格納します。

2. プラグイン クラスに初期化メソッドを追加して、インストールされているプラ​​グインを検索し、プラグインで実行する必要がある登録メソッド (reg) を実行し、プラグイン メソッドを登録します。フックをマウントポイントに登録します。

3. プラグインは常に特定のディレクトリに配置し、特定の仕様に従って設定ファイルを記述します。バックグラウンドにはプラグイン リスト ページがあり、指定したディレクトリ内のプラグインを参照します。インストール時にプラグイン情報がデータベースに記録され、アンインストール時にデータベースの記録情報が削除されます。 

<?php
/**
 * @file plugin.php
 * @brief 插件核心类
 * @note 观察者模式，注册事件，触发事件
 */
class plugin extends IInterceptorBase
{
    //默认开启的插件列表
    private static $defaultList = array("_verification","_goodsCategoryWidget","_authorization","_userInfo","_initData");
    //已经注册监听
    private static $_listen = array();
    //加载插件
    public static function init()
    {
        $pluginDB    = new IModel(&#39;plugin&#39;);
        $pluginList  = $pluginDB->query("is_open = 1","class_name","sort asc");
        //加载默认插件
        foreach(self::$defaultList as $val)
        {
            $pluginList[]= array(&#39;class_name&#39; => $val);
        }
        foreach($pluginList as $key => $val)
        {
            $className = $val[&#39;class_name&#39;];
            $classFile = self::path().$className."/".$className.".php";
            if(is_file($classFile))
            {
                include_once($classFile);
                $pluginObj = new $className();
                $pluginObj->reg();
            }
        }
    }
    /**
     * @brief 注册事件
     * @param string $event 事件
     * @param object ro function $classObj 类实例 或者 匿名函数
     * @param string $method 方法名字
     */
    public static function reg($event,$classObj,$method = "")
    {
        if(!isset(self::$_listen[$event]))
        {
            self::$_listen[$event] = array();
        }
        self::$_listen[$event][] = array($classObj,$method);
    }
    /**
     * @brief 显示已注册事件
     * @param string $event 事件名称
     * @return array
     */
    public static function get($event = &#39;&#39;)
    {
        if($event)
        {
            if( isset(self::$_listen[$event]) )
            {
                return self::$_listen[$event];
            }
            return null;
        }
        return self::$_listen;
    }
    /**
     * @brief 触发事件
     * @param string $event 事件
     * @param mixed  $data  数据
     * @notice 可以调用匿名函数和方法
     */
    public static function trigger($event,$data = null)
    {
        $result = array();
        if(isset(self::$_listen[$event]))
        {
            foreach(self::$_listen[$event] as $key => $val)
            {
                list($pluginObj,$pluginMethod) = $val;
                $result[$key] = is_callable($pluginObj) ? call_user_func($pluginObj,$data):call_user_func(array($pluginObj,$pluginMethod),$data);
            }
        }
        return isset($result[1]) ? $result : current($result);
    }
    /**
     * @brief 插件物理路径
     * @return string 路径字符串
     */
    public static function path()
    {
        return IWeb::$app->getBasePath()."plugins/";
    }
    /**
     * @brief 插件WEB路径
     * @return string 路径字符串
     */
    public static function webPath()
    {
        return IUrl::creatUrl(&#39;&#39;)."plugins/";
    }
    /**
     * @brief 获取全部插件
     * @param string $name 插件名字，如果为空则获取全部插件信息
     * @return array 插件信息 array(
        "name"        => 插件名字,
        "description" => 插件描述,
        "explain"     => 使用说明,
        "class_name"  => 插件ID,
        "is_open"     => 是否开启,
        "is_install"  => 是否安装,
        "config_name" => 默认插件参数结构,
        "config_param"=> 已经保存的插件参数,
        "sort"        => 排序,
     )
     */
    public static function getItems($name = &#39;&#39;)
    {
        $result = array();
        $dirRes = opendir(self::path());
        //遍历目录读取配置文件
        $pluginDB = new IModel(&#39;plugin&#39;);
        while($dir = readdir($dirRes))
        {
            if($dir[0] == "." || $dir[0] == "_")
            {
                continue;
            }
            if($name && $result)
            {
                break;
            }
            if($name && $dir != $name)
            {
                continue;
            }
            $pluginIndex = self::path().$dir."/".$dir.".php";
            if(is_file($pluginIndex))
            {
                include_once($pluginIndex);
                if(get_parent_class($dir) == "pluginBase")
                {
                    $class_name   = $dir;
                    $pluginRow    = $pluginDB->getObj(&#39;class_name = "&#39;.$class_name.&#39;"&#39;);
                    $is_open      = $pluginRow ? $pluginRow[&#39;is_open&#39;] : 0;
                    $is_install   = $pluginRow ? 1                     : 0;
                    $sort         = $pluginRow ? $pluginRow[&#39;sort&#39;]    : 99;
                    $config_param = array();
                    if($pluginRow && $pluginRow[&#39;config_param&#39;])
                    {
                        $config_param = JSON::decode($pluginRow[&#39;config_param&#39;]);
                    }
                    $result[$dir] = array(
                        "name"        => $class_name::name(),
                        "description" => $class_name::description(),
                        "explain"     => $class_name::explain(),
                        "class_name"  => $class_name,
                        "is_open"     => $is_open,
                        "is_install"  => $is_install,
                        "config_name" => $class_name::configName(),
                        "config_param"=> $config_param,
                        "sort"        => $sort,
                    );
                }
            }
        }
        if(!$name)
        {
            return $result;
        }
        return isset($result[$name]) ? $result[$name] : array();
    }
    /**
     * @brief 系统内置的所有事件触发
     */
    public static function onCreateApp(){plugin::init();plugin::trigger("onCreateApp");}
    public static function onFinishApp(){plugin::trigger("onFinishApp");}
    public static function onBeforeCreateController($ctrlId){plugin::trigger("onBeforeCreateController",$ctrlId);plugin::trigger("onBeforeCreateController@".$ctrlId);}
    public static function onCreateController($ctrlObj){plugin::trigger("onCreateController");plugin::trigger("onCreateController@".$ctrlObj->getId());}
    public static function onFinishController($ctrlObj){plugin::trigger("onFinishController");plugin::trigger("onFinishController@".$ctrlObj->getId());}
    public static function onBeforeCreateAction($ctrlObj,$actionId){plugin::trigger("onBeforeCreateAction",$actionId);plugin::trigger("onBeforeCreateAction@".$ctrlObj->getId());plugin::trigger("onBeforeCreateAction@".$ctrlObj->getId()."@".$actionId);}
    public static function onCreateAction($ctrlObj,$actionObj){plugin::trigger("onCreateAction");plugin::trigger("onCreateAction@".$ctrlObj->getId());plugin::trigger("onCreateAction@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onFinishAction($ctrlObj,$actionObj){plugin::trigger("onFinishAction");plugin::trigger("onFinishAction@".$ctrlObj->getId());plugin::trigger("onFinishAction@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onCreateView($ctrlObj,$actionObj){plugin::trigger("onCreateView");plugin::trigger("onCreateView@".$ctrlObj->getId());plugin::trigger("onCreateView@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onFinishView($ctrlObj,$actionObj){plugin::trigger("onFinishView");plugin::trigger("onFinishView@".$ctrlObj->getId());plugin::trigger("onFinishView@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onPhpShutDown(){plugin::trigger("onPhpShutDown");}
}
/**
 * @brief 插件基类，所有插件必须继承此类
 * @notice 必须实现3个抽象方法： reg(),name(),description()
 */
abstract class pluginBase extends IInterceptorBase
{
    //错误信息
    protected $error = array();
    //注册事件接口，内部通过调用payment::reg(事件,对象实例,方法);
    public function reg(){}
    /**
     * @brief 默认插件参数信息，写入到plugin表config_param字段
     * @return array("字段名" => array(
         "name"    => "文字显示",
         "type"    => "数据类型【text,radio,checkbox,select】",
         "pattern" => "数据校验【int,float,date,datetime,require,正则表达式】",
         "value"   => "1,数组：枚举数据【radio,checkbox,select】的预设值,array(名字=>数据); 2,字符串：【text】默认数据",
        ))
     */
    public static function configName()
    {
        return array();
    }
    /**
     * @brief 插件安装
     * @return boolean
     */
    public static function install()
    {
        return true;
    }
    /**
     * @brief 插件卸载
     * @return boolean
     */
    public static function uninstall()
    {
        return true;
    }
    /**
     * @brief 插件名字
     * @return string
     */
    public static function name()
    {
        return "插件名称";
    }
    /**
     * @brief 插件功能描述
     * @return string
     */
    public static function description()
    {
        return "插件描述";
    }
    /**
     * @brief 插件使用说明
     * @return string
     */
    public static function explain()
    {
        return "";
    }
    /**
     * @brief 获取DB中录入的配置参数
     * @return array
     */
    public function config()
    {
        $className= get_class($this);
        $pluginDB = new IModel(&#39;plugin&#39;);
        $dataRow  = $pluginDB->getObj(&#39;class_name = "&#39;.$className.&#39;"&#39;);
        if($dataRow && $dataRow[&#39;config_param&#39;])
        {
            return JSON::decode($dataRow[&#39;config_param&#39;]);
        }
        return array();
    }
    /**
     * @brief 返回错误信息
     * @return array
     */
    public function getError()
    {
        return $this->error ? join("\r\n",$this->error) : "";
    }
    /**
     * @brief 写入错误信息
     * @return array
     */
    public function setError($error)
    {
        $this->error[] = $error;
    }
    /**
     * @brief 插件视图渲染有布局
     * @param string $view 视图名字
     * @param array  $data 视图里面的数据
     */
    public function redirect($view,$data = array())
    {
        if($data === true)
        {
            $this->controller()->redirect($view);
        }
        else
        {
            $__className      = get_class($this);
            $__pluginViewPath = plugin::path().$__className."/".$view;
            $result = self::controller()->render($__pluginViewPath,$data);
            if($result === false)
            {
                IError::show($__className."/".$view."插件视图不存在");
            }
        }
    }
    /**
     * @brief 插件视图渲染去掉布局
     * @param string $view 视图名字
     * @param array  $data 视图里面的数据
     */
    public function view($view,$data = array())
    {
        self::controller()->layout = "";
        $this->redirect($view,$data);
    }
    /**
     * @brief 插件物理目录
     * @param string 插件路径地址
     */
    public function path()
    {
        return plugin::path().get_class($this)."/";
    }
    /**
     * @brief 插件WEB目录
     * @param string 插件路径地址
     */
    public function webPath()
    {
        return plugin::webPath().get_class($this)."/";
    }
}
ログイン後にコピー

関連する php の知識については、

php チュートリアル をご覧ください。

以上がPHPフックメカニズムの原理と詳細な説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

関連ラベル：
php
ソース：cnblogs.com
前の記事：Pimple 実行プロセス (PHP コンテナー) の簡単な分析 次の記事：PHP によるクライアントへのシステム メッセージのリアルタイム プッシュの原理と詳細な説明
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
最新の問題
URL パラメータから取得した PHP 配列が期待どおりに動作しない カテゴリ ID を含む URL パラメータがあり、それを次のような配列として扱いたいと考えています: http://example.com?cat[]=3,9,13 PHP では、...
から 2024-04-06 22:09:02
0
1
1428
ApacheのどこにCustomLogディレクティブを配置すればよいですか 私はphp:7.2-apachedockerを使用しています。ヘルスチェック URL ログイン アクセス ログを無効にする必要があります。このリンクに基づいて、Customlog ...
から 2024-04-06 22:03:59
0
1
990
戻り値の変数の形式は何ですか? 私はphpの初心者です。コードを見つけました: if($x<time()){return[false,'error'];} ロジックや変数は重要ではありませんが、[false...
から 2024-04-06 21:55:20
0
1
778
opentbs を使用して odt ファイルを生成するときに発生する問題: 同じキーの値が別の列ではなく同じ行に表示されます。 PHPでodtを作成するためにOpenTbsというライブラリを使っていますが、列と行が動的に生成されるので利用しています。行と列の作成方法は知っていますが、それらを整理する方法がわ...
から 2024-04-06 20:18:18
0
1
483
ループするために MySQL の結果を ID ごとにグループ化する mysqlにフライトデータを含むテーブルがあります。 codeigniter3Journey_idair_idFlightDurationout_or_inflightdurati...
から 2024-04-06 17:27:56
0
1
406
関連トピック
詳細>
人気のおすすめ
人気のチュートリアル
詳細>
関連するチュートリアル
人気のおすすめ
最新のコース
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート