README

这是什么？

该项目的目的是使您的包能够相互修改而无需覆盖源代码。

什么是钩子？

它类似于一个事件。除非钩子监听器捕获它并命令在钩子函数之外运行其他内容，否则被钩子包围的代码将运行。它们可以按既定顺序设置，因此您可以在代码中进行多次修改。

它有什么好处？

示例 1：您有一个显示编辑器的模块。在这种情况下，编辑器始终相同。如果将编辑器的显示绑定到钩子上，则可以编写一个可以重新定义/覆盖此钩子的模块，例如将文本区域更改为 ckeditor。

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

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

...还有很多其他事情。如果您正在构建类似 CMS 的系统，这将使您的生活更加轻松。

我如何安装它？

composer require mevisoft/laravel-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!'
});

如果没有监听器，则返回“其他字符串”。

在 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');

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

Artisan

php artisan hook::list

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

许可：MIT

mevisoft / laravel-hook

维护者

详情