README

这是什么？

本项目旨在使你的包能够相互修改而无需覆盖源代码。

什么是钩子？

它类似于事件。除非钩子监听器捕获它并命令在钩子中运行的函数之外，否则与钩子相关的代码会运行。它们可以按既定顺序设置，这样你就可以在代码中进行多次修改。

它有什么好处？

示例1：你有一个显示编辑器的模块。在这种情况下，编辑器保持不变。如果你在钩子中绑定编辑器的显示，那么你可以编写一个模块，该模块可以重新定义/覆盖此钩子，例如将textarea更改为ckeditor。

示例2：你列出用户。你可以在钩子中包含每一行的打印。这样，你可以编写一个单独的模块，该模块可以在该行中添加电子邮件地址打印。

示例3：你将用户数据保存到数据库中。如果在钩子中这样做，你可以编写一个模块，该模块可以向用户模型添加额外字段，如“名”或“姓”。为此，你不需要修改处理用户的代码，扩展模块不需要了解主模块的功能。

...还有很多其他的事情。如果你正在构建类似CMS的系统，这将使你的生活变得更简单。

如何安装它？

composer require esemve/hook

然后在 app.php 中

...
'providers' => [
    ...
    Esemve\Hook\HookServiceProvider::class,
    ...
 ],
 'aliases' =>[
    ...
    'Hook' => Esemve\Hook\Facades\Hook::class
    ...
 ]

它如何工作？

示例

$user = new User();
$user = Hook::get('fillUser',[$user],function($user){
    return $user;
});

在这种情况下，抛出一个 fillUser 钩子，该钩子接收 $user 对象作为参数。如果没有捕获它，内部函数将返回 $user，因此没有任何操作。但可以由提供者的监听器捕获

Hook::listen('fillUser', function ($callback, $output, $user) {
    if (empty($output))
    {
      $output = $user;
    }
    $output->profilImage = ProfilImage::getForUser($user->id);
    return $output;
}, 10);

$callback 包含钩子的原始内部函数，因此可以在这里调用它。

可以为钩子注册多个监听器，因此监听器在 $output 中接收之前注册的钩子监听器的响应。

然后是钩子传递的参数，在这个例子中是用户。

上面的钩子监听器捕获了 fillUser 的调用，扩展了接收到的对象，并将其返回到原始位置。钩子运行后，$user 对象包含了一个 profilImage 变量。

示例中的编号10是优先级。它们按顺序执行，因此如果为 fillUser 注册了一个编号5，它将在编号10之前运行。

初始输出

你还可以将初始输出传递给监听器。

$initialOutput='test string';

\Hook::get('testing',['other string'],function($otherString){
    return $otherString;
},$initialOutput)

// and later ...

Hook::listen('testing', function ($callback, $output, $otherString) {
    if ($output==='test string') {
        $output="{$output} yeeeaaaayyy!";
    }
    if ($otherString==='other_string') {
        // other string is good too
    }
    return $output; // 'test string yeeeaaaayyy!'
});

如果没有监听器，将返回 'other string'。

在blade模板中的使用

@hook('hookName')

在这种情况下，钩子监听器可以这样捕获

 Hook::listen('template.hookName', function ($callback, $output, $variables) {
   return view('test.button');
 });

在 $variables 变量中，它接收所有可用于blade模板的变量。

❗ 要监听blade模板，你需要监听 template.hookName 而不是只是 hookName！

包装HTML

@hook('hookName', true)
    this content can be modified with dom parsers
    you can inject some html here
@endhook

现在，$output 参数包含由钩子组件包装的HTML。

Hook::listen('template.hookName', function ($callback, $output, $variables) {
  return "<div class=\"alert alert-success\">$output</div>";
});

停止

Hook::stop();

将停止放入钩子监听器将停止注册到此钩子的其他监听器的运行。

用于测试

Hook::mock('hookName','returnValue');

然后，hookName 钩子将返回 returnValue 作为响应。

工匠

php artisan hook::list

列出所有活动的钩子监听器。

许可证：MIT