laravel 如何利用 macro 方法来扩展基础类的功能

转载地址  https://laravel-china.org/topics/2915/how-to-use-the-macro-method-to-extend-the-function-of-the-base-class-of-laravel

下面转载的文章(多谢挖井人)

在一般编程中，我们要扩展一个基础类，我们需要进行继承才能扩充。然而Laravel利用PHP的特性，编写了一套叫做Macroable的Traits，这样，凡是使用Macroable的类，都是可以使用这个方法扩充的。

基本使用方法

我下面用Collection类来做示范。

要给Collection加一个扩充方法可以这样写：

  <?php
  Collection::macro("macro_name", function ($parameters) {
      // Your macro
  });

这样就很容易的就扩充了Collection的方法，而不需要进行复杂的继承。

我们再举个具体的例子，把所有Collection的字符数组全部变成大写。那么我们就这样写：

<?php
Collection::macro('uppercase', function () {
    return collect($this->items)->map(function ($item) {
        return strtoupper($item);
    });
});

collect(["hello", "world"])->uppercase();

这个结果是: ["HELLO", "WORLD"]

关于macro内部的$this

Collection $this 在macro的作用域必须注意，$this不是指向你文件类的对象，而是指向你marco扩充的类。比如例子中的$this是指向Collection的。

这是因为在Marcoable的源代码中，是可以看到static::$macros[$method]->bindTo($this, static::class)这段代码。而bindTo是改变$this上下文指向的方法。

marco的代码应该放在哪里?

marco的代码应该放在哪里才能让整个项目都能使用。

要让marco扩充的类，保证整个项目都能使用， 需要创建一个ServiceProvider，并把扩充的方法，放入boot()的方法中

  <?php
  namespace App\Providers;

  use Collection;
  use Illuminate\Support\ServiceProvider;

  class CollectionMacroServiceProvider extends ServiceProvider {

      public function boot()
      {
         Collection::macro('uppercase', function () {
            return collect($this->items)->map(function ($item) {
                return strtoupper($item);
            });
        });
      }

  }

然后我们就可以在config/app.php中的providers中下面加App\ProvidersCollectionMacroServiceProvider::class即可

哪些类可以使用marco

• Response
• Request
• Collection
• HTML
• Form
• Filesystem
• Cache
• Str
• Arr
• Translator

等等,使用了Marcoable的Traits，如果是自己编写的类，使用了Marcoable，也可以这样扩充使用（写Laravel开源库的时候）