Laravel 如何添加自定义助手函数

有时候我们会创建一个函数，在任何地方都可以调用，这个和laravel自带的助手函数类似。目前很多教程的方法是创建一个helpers.php文件，然后通过 composer.json 中添加自动加载这个文件，但是随着文件的增长，这个文件会变得很难管理。

我们的解决方法是将作用类似的函数放在同一个文件中，这样更加清楚和可读。

首先我们需要创建一个 HelperServiceProvider.php：

php artisan make:provider HelperServiceProvider

运行上面的命令之后，我们就在 app\Providers 文件夹中创建好了 HelperServiceProvider.php 文件。

打开刚才创建好的 Provider 文件，我们可以移除 boot() 方法，在这里我们不会用到这个方法。

在 register() 函数中输入如下代码：

public function register()
{
    foreach(glob(app_path('Helpers') . '/*.php') as $file) {
        require_once $file;
    }
}

这段代码的作用是引入 app/Helpers 下的所有文件，我们会把助手函数文件放到这个文件夹下。

下面我们来加载这个 provider，打开config/app.php文件，在AppServiceProvider上面添加 HelperServiceProvider：

...
App\Providers\HelperServiceProvider::class,
App\Providers\AppServiceProvider::class,
App\Providers\AuthServiceProvider::class,
App\Providers\BroadcastServiceProvider::class,
...

现在让我们尝试创建一个简单的函数，在app/Helpers下创建一个文件Carbon.php：

<?php /**
 * Carbon helper
 *
 * @param $time
 * @param $tz
 *
 * @return Carbon\Carbon
 */
function carbon($time = null, $tz = null)
{
    return new \Carbon\Carbon($time, $tz);
}

在这里你不需要添加命名空间。如果你想检查函数是否已经存在，可以使用 function_exists() 函数。

现在你可以在任何地方使用助手函数 carbon()。如果想添加一个返回指定时间格式的函数，可以和之前一样，在 Carbon.php 文件中添加一个新函数：

<?php

/**
 * Carbon helper
 *
 * @param $time
 * @param $tz
 *
 * @return Carbon\Carbon
 */
function carbon($time = null, $tz = null)
{
    return new \Carbon\Carbon($time, $tz);
}

function carbonFormatted($time = null, $tz = null)
{
    return carbon($time, $tz)->format('Y-m-d')
}

现在你可以在app/Helpers下创建自己的助手函数文件了！

参考

Laravel - Include your own helper functions