Wie man einen Laravel-Helfer erstellt

() translation by (you can also view the original English article)

Zunächst möchte ich die offizielle Website von Laravel über Helfer sprechen lassen.

Laravel enthält eine Vielzahl von globalen "Helfer" PHP-Funktionen. Viele dieser Funktionen werden vom Framework selbst verwendet. Sie können diese jedoch in Ihren eigenen Anwendungen verwenden, wenn Sie sie für praktisch halten.

Im Grunde sind Helfer in Laravel eingebaute Dienstprogrammfunktionen, die Sie von überall in Ihrer Anwendung aufrufen können. Wenn sie nicht vom Kernframework bereitgestellt worden wären, hätten Sie möglicherweise eigene Hilfsklassen entwickelt.

Obwohl der Kern bereits eine Vielzahl von Helfern zur Verfügung stellt, gibt es immer die Möglichkeit, dass Sie Ihre eigenen benötigen und eine entwickeln möchten, so dass Sie nicht den gleichen Code hier und da wiederholen müssen, um eine bessere Wartbarkeit zu erreichen. In diesem Tutorial erfahren Sie, wie Sie einen benutzerdefinierten Laravel-Helfer erstellen.

Helfer in Laravel

Wie bereits erwähnt, gibt es im Kern des Laravel-Frameworks viele Helfer. Sie werden basierend auf der Funktionalität gruppiert, die sie bereitstellen. Hier ist eine Liste von Hilfsgruppen.

Arrays

Helfer in dieser Gruppe bieten Funktionen zum Bearbeiten von Array-Elementen. In den meisten Fällen möchten Sie verschiedene Operationen für Array-Elemente ausführen. Dies ist der Ort, an dem Sie zuerst nachsehen sollten, ob das, wonach Sie suchen, bereits existiert.

Pfade

Ich finde Helfer in dieser Kategorie am nützlichsten. Sie geben den vollständig qualifizierten Pfad verschiedener Verzeichnisse wie App, Storage, Config und dergleichen zurück. Ich wette, Sie verwenden die meisten dieser Helfer bereits in Ihrer Laravel-Anwendung.

Saiten

String-Manipulation ist in Ihrer täglichen Anwendungsentwicklung unvermeidlich. Obwohl es viele String-Manipulationsfunktionen gibt, die von PHP selbst bereitgestellt werden, finden Sie in diesem Abschnitt einige nützliche Funktionen.

URLs

Sie finden nur sehr wenige in dieser Kategorie, aber sie werden in der gesamten Anwendung verwendet. Sie werden zum Generieren von URLs für Route, Asset und Formular verwendet.

Sonstiges

Diese Kategorie enthält Helfer, die eine Vielzahl von Funktionalitäten bieten, von der Protokollierung bis zur Fehlersuche und vielem mehr.

Für eine vollständige Referenz von Laravel-Helfern gibt es keinen besseren Ort als die offizielle Dokumentation.

Erstellen Sie Ihren ersten benutzerdefinierten Helper

Jetzt haben Sie ein grundlegendes Verständnis von Laravel Helfern und wofür sie verwendet werden. In diesem Abschnitt zeige ich Ihnen, wie Sie Ihren eigenen benutzerdefinierten Helper erstellen können, der global in Ihrer Laravel-Anwendung verwendet werden kann.

Um die Dinge einfach und leicht verständlich zu halten, ist es ein ziemlich einfacher Helfer, der eine Benutzer-ID akzeptiert und einen Benutzernamen als Antwort zurückgibt. Das hört sich natürlich nicht schick an, aber ich glaube, es genügt, das Konzept zu demonstrieren, und Sie können es immer erweitern, um Ihre komplexen Anforderungen zu erfüllen.

Ich nehme an, dass Sie eine Benutzertabelle in Ihrer Datenbank haben und es mindestens zwei Felder-userid und username hat.

Das Skelett eines Laravel Helfers

Bevor wir fortfahren und die Dateien tatsächlich erstellen, werfen wir einen kurzen Blick auf die Dateien, die wir im Rest des Artikels erstellen werden.

app/Helpers/Envato/User.php: Es ist unsere Hilfsdatei, die die Logik unseres Helfers enthält.
app/Providers/EnvatoServiceProvider.php: Es ist eine benutzerdefinierte Service-Provider-Datei, die unsere benutzerdefinierte Hilfsdatei lädt.
config / app.php: In dieser Datei deklarieren wir unseren benutzerdefinierten Service-Provider und helfen uns auch, einen Alias für unseren Helfer zu definieren, so dass wir nicht den vollständig qualifizierten Klassennamen unseres Helfers verwenden müssen.
routes / web.php: Eine hübsche Standard-Laravel-Routendatei, in der wir unseren Helfer testen werden.

Erstellen Sie Hilfsdateien

Obwohl Sie Ihre Hilfsdateien überall in Ihrer Anwendung platzieren können, schlägt die intuitivere und standardmäßige Methode vor, dass sie in Ihrem app-Verzeichnis angezeigt wird.

Also mach weiter und erstelle ein Helpers/Envato-Verzeichnis unter app und erstelle eine User.php-Datei mit folgendem Inhalt. Natürlich könntest du es direkt unter dem app oder app/Helper-Verzeichnis platzieren, aber wenn du dieses zusätzliche Level zur Verfügung stellst, können wir unsere Helfer in guter Form organisieren, speziell wenn du viele davon haben willst.

<?php
//app/Helpers/Envato/User.php
namespace App\Helpers\Envato;

use Illuminate\Support\Facades\DB;

class User {
    /**
     * @param int $user_id User-id
     * 
     * @return string
     */
    public static function get_username($user_id) {
        $user = DB::table('users')->where('userid', $user_id)->first();
        
        return (isset($user->username) ? $user->username : '');
    }
}

Die Datei beginnt mit einer hübschen Standard-Namespace-Deklaration:

1	namespace App\Helpers\Envato;

Der Zweck unseres benutzerdefinierten Helpers ist es, einen Benutzernamen basierend auf einer Benutzer-ID abzurufen. Daher müssen wir mit der Datenbank interagieren, und das zwingt uns, DB Facade einzubeziehen.

1	use Illuminate\Support\Facades\DB;

Für diejenigen, die mit Laravel Facades nicht vertraut sind, ist es nur eine weitere bequeme Möglichkeit, auf die Objekte in Service-Containern zuzugreifen. Alternativ hätten Sie die Abhängigkeitsinjektion verwenden können.

Weiter geht es mit der konkreten Umsetzung unseres Helfers. Wie Sie sehen können, gibt es eine statische Methode, die die Logik zum Abrufen eines Benutzernamens basierend auf einer Benutzer-ID definiert.

1	$user = DB::table('users')->where('userid', $user_id)->first();

Das $user-Objekt enthält den Datenbankdatensatz mit der übereinstimmenden Benutzer-ID. Abschließend gibt die Methode den Benutzernamen als Antwort in der folgenden Anweisung zurück.

1	return (isset($user->username) ? $user->username : '');

Soweit unsere Hilfsdatei betroffen ist.

Jetzt haben wir unsere Hilfsdatei erstellt, aber die Frage ist, wie willst du sie benutzen? Zwei schnelle Lösungen kommen mir in den Sinn:

Sie können unseren Helper-Dateinamen in die Datei composer.json aufnehmen, damit er automatisch geladen wird. Dann könnten Sie sofort die statische Methode unserer Helferklasse aufrufen.
Sie können einen Laravel-Dienstanbieter erstellen, mit dem Sie Ihre benutzerdefinierte Hilfsdatei so registrieren können, dass das Laravel-Framework sie zusammen mit anderen Abhängigkeiten lädt. Registrieren Sie diesen Dienstanbieter in der Laravel-Konfiguration und erstellen Sie einen Alias, um Ihren Helper zu verwenden.

Natürlich ist die erste ziemlich schnell und einfach zu implementieren, und Sie könnten versucht sein, dies zu tun, aber ich würde eher die letztere empfehlen, da sie eher handwerklich und wartungsfreundlicher ist.

Wechseln Sie zur Befehlszeile und führen Sie den folgenden Befehl in Ihrem Anwendungsstamm aus, um einen neuen Dienstanbieter zu erstellen.

1	$php artisan make:provider EnvatoServiceProvider
2	Provider created successfully.

Sie sollten die Nachricht sehen, die bestätigt, dass sie erfolgreich im Verzeichnis app/Providers erstellt wurde.

Öffnen Sie diese Datei und Sie sollten bereits zwei Methoden sehen. Der wichtigste im Zusammenhang mit diesem Artikel ist die Methode register. Ja, es ist im Moment leer, also lasst uns ein paar Dinge einspeisen, um es nützlicher zu machen.

1	public function register()
2	{
3	require_once app_path() . '/Helpers/Envato/User.php';
4	}

Die register-Methode wird verwendet, um Ihre Abhängigkeiten zu registrieren, und genau das haben wir getan. Wir haben unsere benutzerdefinierte Hilfsdatei hinzugefügt.

So sollte die Datei app/Providers/EnvatoServiceProvider.php nach Änderungen aussehen.

<?php
// app/Providers/EnvatoServiceProvider.php
namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class EnvatoServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {
        require_once app_path() . '/Helpers/Envato/User.php';
    }
}

Bis jetzt ist alles ziemlich gut. Wir haben unseren kundenspezifischen Helfer und Dienstleister auf dem Tisch.

Als nächstes müssen wir Laravel über unseren Service Provider informieren, damit dieser beim Bootstrapping geladen werden kann. Öffnen wir die Datei config / app.php und fügen Sie am Ende den folgenden Eintrag in das provider-Array ein.

1	App\Providers\EnvatoServiceProvider::class,

Um unseren Helfer auf bequeme Weise zu verwenden, könnten wir auch einen Alias erstellen. Lassen Sie uns das tun, indem Sie den folgenden Eintrag im Array aliases am Ende in derselben Datei hinzufügen.

1	'EnvatoUser' => App\Helpers\Envato\User::class,

Wenn Sie diesen Eintrag definieren, können Sie unseren Helfer mit dem Schlüsselwort EnvatoUser aufrufen. Ziemlich praktisch, nicht wahr? Zu Ihrer Information, hier ist die komplette Datei config / app.php.

<?php
// config/app.php
return [

    /*
    |--------------------------------------------------------------------------
    | Application Name
    |--------------------------------------------------------------------------
    |
    | This value is the name of your application. This value is used when the
    | framework needs to place the application's name in a notification or
    | any other location as required by the application or its packages.
    */

    'name' => 'Laravel',

    /*
    |--------------------------------------------------------------------------
    | Application Environment
    |--------------------------------------------------------------------------
    |
    | This value determines the "environment" your application is currently
    | running in. This may determine how you prefer to configure various
    | services your application utilizes. Set this in your ".env" file.
    |
    */

    'env' => env('APP_ENV', 'production'),

    /*
    |--------------------------------------------------------------------------
    | Application Debug Mode
    |--------------------------------------------------------------------------
    |
    | When your application is in debug mode, detailed error messages with
    | stack traces will be shown on every error that occurs within your
    | application. If disabled, a simple generic error page is shown.
    |
    */

    'debug' => env('APP_DEBUG', false),

    /*
    |--------------------------------------------------------------------------
    | Application URL
    |--------------------------------------------------------------------------
    |
    | This URL is used by the console to properly generate URLs when using
    | the Artisan command line tool. You should set this to the root of
    | your application so that it is used when running Artisan tasks.
    |
    */

    'url' => env('APP_URL', 'https://localhost'),

    /*
    |--------------------------------------------------------------------------
    | Application Timezone
    |--------------------------------------------------------------------------
    |
    | Here you may specify the default timezone for your application, which
    | will be used by the PHP date and date-time functions. We have gone
    | ahead and set this to a sensible default for you out of the box.
    |
    */

    'timezone' => 'UTC',

    /*
    |--------------------------------------------------------------------------
    | Application Locale Configuration
    |--------------------------------------------------------------------------
    |
    | The application locale determines the default locale that will be used
    | by the translation service provider. You are free to set this value
    | to any of the locales which will be supported by the application.
    |
    */

    'locale' => 'en',

    /*
    |--------------------------------------------------------------------------
    | Application Fallback Locale
    |--------------------------------------------------------------------------
    |
    | The fallback locale determines the locale to use when the current one
    | is not available. You may change the value to correspond to any of
    | the language folders that are provided through your application.
    |
    */

    'fallback_locale' => 'en',

    /*
    |--------------------------------------------------------------------------
    | Encryption Key
    |--------------------------------------------------------------------------
    |
    | This key is used by the Illuminate encrypter service and should be set
    | to a random, 32 character string, otherwise these encrypted strings
    | will not be safe. Please do this before deploying an application!
    |
    */

    'key' => env('APP_KEY'),

    'cipher' => 'AES-256-CBC',

    /*
    |--------------------------------------------------------------------------
    | Logging Configuration
    |--------------------------------------------------------------------------
    |
    | Here you may configure the log settings for your application. Out of
    | the box, Laravel uses the Monolog PHP logging library. This gives
    | you a variety of powerful log handlers / formatters to utilize.
    |
    | Available Settings: "single", "daily", "syslog", "errorlog"
    |
    */

    'log' => env('APP_LOG', 'single'),

    'log_level' => env('APP_LOG_LEVEL', 'debug'),

    /*
    |--------------------------------------------------------------------------
    | Autoloaded Service Providers
    |--------------------------------------------------------------------------
    |
    | The service providers listed here will be automatically loaded on the
    | request to your application. Feel free to add your own services to
    | this array to grant expanded functionality to your applications.
    |
    */

    'providers' => [

        /*
         * Laravel Framework Service Providers...
         */
        Illuminate\Auth\AuthServiceProvider::class,
        Illuminate\Broadcasting\BroadcastServiceProvider::class,
        Illuminate\Bus\BusServiceProvider::class,
        Illuminate\Cache\CacheServiceProvider::class,
        Illuminate\Foundation\Providers\ConsoleSupportServiceProvider::class,
        Illuminate\Cookie\CookieServiceProvider::class,
        Illuminate\Database\DatabaseServiceProvider::class,
        Illuminate\Encryption\EncryptionServiceProvider::class,
        Illuminate\Filesystem\FilesystemServiceProvider::class,
        Illuminate\Foundation\Providers\FoundationServiceProvider::class,
        Illuminate\Hashing\HashServiceProvider::class,
        Illuminate\Mail\MailServiceProvider::class,
        Illuminate\Notifications\NotificationServiceProvider::class,
        Illuminate\Pagination\PaginationServiceProvider::class,
        Illuminate\Pipeline\PipelineServiceProvider::class,
        Illuminate\Queue\QueueServiceProvider::class,
        Illuminate\Redis\RedisServiceProvider::class,
        Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,
        Illuminate\Session\SessionServiceProvider::class,
        Illuminate\Translation\TranslationServiceProvider::class,
        Illuminate\Validation\ValidationServiceProvider::class,
        Illuminate\View\ViewServiceProvider::class,

        /*
         * Package Service Providers...
         */
        Laravel\Tinker\TinkerServiceProvider::class,

        /*
         * Application Service Providers...
         */
        App\Providers\AppServiceProvider::class,
        App\Providers\AuthServiceProvider::class,
        // App\Providers\BroadcastServiceProvider::class,
        App\Providers\EventServiceProvider::class,
        App\Providers\RouteServiceProvider::class,
        App\Providers\EnvatoServiceProvider::class,
    ],

    /*
    |--------------------------------------------------------------------------
    | Class Aliases
    |--------------------------------------------------------------------------
    |
    | This array of class aliases will be registered when this application
    | is started. However, feel free to register as many as you wish as
    | the aliases are "lazy" loaded so they don't hinder performance.
    |
    */

    'aliases' => [

        'App' => Illuminate\Support\Facades\App::class,
        'Artisan' => Illuminate\Support\Facades\Artisan::class,
        'Auth' => Illuminate\Support\Facades\Auth::class,
        'Blade' => Illuminate\Support\Facades\Blade::class,
        'Broadcast' => Illuminate\Support\Facades\Broadcast::class,
        'Bus' => Illuminate\Support\Facades\Bus::class,
        'Cache' => Illuminate\Support\Facades\Cache::class,
        'Config' => Illuminate\Support\Facades\Config::class,
        'Cookie' => Illuminate\Support\Facades\Cookie::class,
        'Crypt' => Illuminate\Support\Facades\Crypt::class,
        'DB' => Illuminate\Support\Facades\DB::class,
        'Eloquent' => Illuminate\Database\Eloquent\Model::class,
        'Event' => Illuminate\Support\Facades\Event::class,
        'File' => Illuminate\Support\Facades\File::class,
        'Gate' => Illuminate\Support\Facades\Gate::class,
        'Hash' => Illuminate\Support\Facades\Hash::class,
        'Lang' => Illuminate\Support\Facades\Lang::class,
        'Log' => Illuminate\Support\Facades\Log::class,
        'Mail' => Illuminate\Support\Facades\Mail::class,
        'Notification' => Illuminate\Support\Facades\Notification::class,
        'Password' => Illuminate\Support\Facades\Password::class,
        'Queue' => Illuminate\Support\Facades\Queue::class,
        'Redirect' => Illuminate\Support\Facades\Redirect::class,
        'Redis' => Illuminate\Support\Facades\Redis::class,
        'Request' => Illuminate\Support\Facades\Request::class,
        'Response' => Illuminate\Support\Facades\Response::class,
        'Route' => Illuminate\Support\Facades\Route::class,
        'Schema' => Illuminate\Support\Facades\Schema::class,
        'Session' => Illuminate\Support\Facades\Session::class,
        'Storage' => Illuminate\Support\Facades\Storage::class,
        'URL' => Illuminate\Support\Facades\URL::class,
        'Validator' => Illuminate\Support\Facades\Validator::class,
        'View' => Illuminate\Support\Facades\View::class,
        'EnvatoUser' => App\Helpers\Envato\User::class,
    ],

];

Wir sind fast da! Wir haben die ganze harte Arbeit geleistet, um hierher zu kommen, und jetzt können wir die Vorteile unseres benutzerdefinierten Helfers nutzen.

Ihre erste benutzerdefinierte Helfer in Aktion

Um die Dinge einfach und unkompliziert zu halten, definieren wir eine einfache Laravel-Route und rufen von dort aus unseren Helfer an!

Gehen Sie voran und erstellen Sie eine routes/web.php Datei mit folgendem Inhalt.

<?php
// routes/web.php
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

Route::get('/envato-user-helper-demo', function () {
    return EnvatoUser::get_username(1);
});

Braucht das überhaupt eine Erklärung? Wir haben gerade den benutzerdefinierten Helfer mit der Kurzschrift EnvatoUser::get_username aufgerufen, und er sollte den Benutzernamen zurückgeben.

Natürlich können Sie unseren Helfer von überall in der Anwendung anrufen, sei es ein Controller oder eine Ansicht.

Damit endet unsere Geschichte für heute.

Fazit

Helfer in Laravel sind wirklich ein mächtiges Feature, und ich bin mir sicher, dass Sie als Entwickler das gerne erweitern würden. Und das war das Thema von heute - wir gingen durch die Grundlagen der Laravel-Hilfsdatei-Struktur und erstellten einen nützlichen benutzerdefinierten Helfer.

Ich hoffe, Ihnen hat der Artikel gefallen und er hilft Ihnen bei der Erstellung Ihrer eigenen maßgeschneiderten Helfer in der täglichen Laravel-Anwendungsentwicklung.

Zögern Sie nicht, Ihre Kommentare und Fragen im Feed unten zu hinterlassen. Ich fange auch Kommentare auf meinem Twitter und reagiere auf sie, sobald ich kann!