分享每一天-在 Laravel 应用添加类似 WordPress 的钩子机制

在 Laravel 应用添加类似 WordPress 的钩子机制

PHP 2146 0 创建时间：2020-08-08 18:38:43

laravel

#### Laravel 应用添加类似 WordPress 的钩子机制
 
 Laravel中的动作和过滤器。 WordPress样式。

Eventy（由于缺少更好的名称）是一个简单的动作和过滤器（如果需要，也可以使用钩子）系统。
 
动作是要在代码中的某些点执行的代码。 动作永远不会返回任何东西，而只是作为一种选项，可以挂接到您现有的代码上而不必弄乱事情。

进行过滤以修改实体。 他们总是返回某种价值。 默认情况下，它们返回第一个参数，您也应该这样做。
#### 我什么时候使用Eventy？

最好将Eventy用作允许扩展代码的一种方式。无论您是创建程序包还是应用程序，Eventy都能带来您所需的可扩展性。

例如，Eventy可以为基于插件/模块的系统奠定基础。您提供了一个“操作”，允许插件进行自我注册。您可能会提供一个“过滤器”，以便插件可以更改核心中数组的内容。您甚至可以提供“操作”，以便插件可以修改应用程序的菜单。

Eventy绝不是唯一的方法。Laravel提供了Macroable特性，可让您“入侵”一个类和事件，以便您可以立即对代码中的特定点进行操作。

#### 安装

```php
composer require tormjens/eventy
```
如果您使用的是Laravel 5.5或更高版本，则此时可以开始使用该软件包。Laravel框架会自动发现Eventy。

将服务提供者添加到您的中的providers数组中config/app.php。

```php
	'TorMorten \ Eventy \ EventServiceProvider'，
	'TorMorten \ Eventy \ EventBladeServiceProvider'，
```

在中添加外观 config/app.php
```php
'Eventy' => TorMorten \ Eventy \ Facades \ Events :: class，
```

#### 使用:

##### 动作

您可以在代码中的任何位置创建新的操作，如下所示：

```php
use TorMorten\Eventy\Facades\Events as Eventy;

Eventy::action('my.hook', 'awesome');
```
第一个参数是挂钩的名称；您将在以后收听挂机时使用它。所有后续参数都将作为参数发送到操作。这些可以是您想要的任何东西。例如，您可能想告诉听众这是附加到某个模型的。然后，您可以将其作为参数之一传递。

要监听您的钩子，请附加监听器。这些最好添加到您的AppServiceProvider boot()方法中。

例如，如果您想连接到上述钩子，则可以执行以下操作：

```php
Eventy::addAction('my.hook', function($what) {
    echo 'You are '. $what;
}, 20, 1);
```
同样，第一个参数必须是挂钩的名称。第二个是回调。这可以是一个Closure，引用应用程序容器中的类的字符串（MyNamespace\Http\Listener@myHookListener），数组回调（[$object, 'method']）或全局注册的函数function_name。第三个参数是挂钩的优先级。数字越小，执行越早。第四个参数指定您的侦听器接受的参数数量。

##### 筛选器

过滤器的工作方式与动作几乎相同，并且与动作的累积量完全相同。最重要的区别是过滤器始终返回其值。

要添加过滤器：

```php
$value = Eventy::filter('my.hook', 'awesome');
```
如果没有任何侦听器连接到此挂钩，则过滤器将简单地返回'awesome'。

这是向该过滤器添加侦听器的方法（仍在中AppServiceProvider）：
```php
Eventy::addFilter('my.hook', function($what) {
    $what = 'not '. $what;
    return $what;
}, 20, 1);
```

您可以将其与先前的钩子结合使用：
```php
Eventy::addAction('my.hook', function($what) {
    $what = Eventy::filter('my.hook', 'awesome');
    echo 'You are '. $what;
});
```

##### 在Blade中使用
给您添加EventBladeServiceProviderconfig后，有两个指令可用，因此您可以在Blade模板中使用它。

添加与上述操作示例中的操作相同的操作：
```php
@action('my.hook', 'awesome')
```
添加与上述过滤器示例相同的过滤器：

```php
You are @filter('my.hook', 'awesome')
```

##### 使用它来实现可扩展性

这是一个示例，说明如何在具有插件概念的真实应用程序中使用Eventy。

插件A具有一个用于构建查询以获取所有已发布帖子的类。

```php
class PostsQueryBuilder
{
    public function query()
    {
        return Post::where('published_at', '>', now());
    }
}
```

使用Eventy，我可以为其他插件提供一个过滤器，以使其与此挂钩：

```php
use TorMorten\Eventy\Facades\Events as Eventy;

class PostsQueryBuilder
{
    public function query()
    {
        $query = resolve(Post::where('published_at', '>', now());
        return Eventy::filter('posts-query-builder:query', $query);
    }
}
```
然后，插件B随之需要修改其他查询，以仅在标题中包含单词foo的帖子。

在插件B的服务提供程序中（最好是在boot方法中，因为它将始终在Eventy可用后触发），我们将为事件添加一个侦听器。

```php
use TorMorten\Eventy\Facades\Events as Eventy;

class PluginBServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Eventy::addFilter('posts-query-builder:query', function($query) {
            return $query->where('title', 'like', '%foo%');
        });
    }
}
```

地址github:
**https://github.com/tormjens/eventy**

在 Laravel 应用添加类似 WordPress 的钩子机制

商品推荐

广告推荐

推荐文章