Laravel 如何包含自己的助手函数？

时间：2020-06-24 18:00

很多教程都会说，你在 composer.json 这个文件中通过添加一个自动加载的文件，就可以实现这个需求。但我认为这不是一个好的方式，当你在 helpers.php 文件中添加了更多的函数时，可读性将变得很差。

下面我将介绍一种方式，让你可以定义很多文件，来包含不同的函数。这将让我们的程序更加整洁和更具可读性。

我们开始吧

首先创建一个 HelperServiceProvider.php 服务提供者文件:

php artisan make:provider HelperServiceProvider

使用上面命令，你将在 app\Providers 文件中生成 HelperServiceProvider.php

你可以简单的移除 boot() 方法，我们在这儿不会使用它。

在 register() 方法中我们添加以下代码:

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

这个循环将会遍历 app/Helpers 目录下的所有文件，你可能已经猜到了，现在你可以在这个目录下随便创建文件，它们将会被加载到你的应用程序中，这些帮助函数在你的代码的任何地方都可以被访问（views, models, controllers…）

我们还需要加载这个服务提供者，打开 config/app.php，然后将 HelperServiceProvider 放在你的 AppServiceProvider 上面

...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')}

好的！现在，您可以开始使用自己的PHP文件填充 app / Helpers目录，其中包含您经常使用的帮助程序