How to Create a Laravel Helper

Here's what the official Laravel site says about helpers.

Laravel includes a variety of global "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.

Basically, helpers in Laravel are built-in utility functions that you can call from anywhere within your application. If the helper you need isn't provided by the core framework, you can code your own helper classes.

You'll learn how to create a custom Laravel helper in this tutorial.

Helpers in Laravel

As we discussed earlier, there are plenty of helpers available in the core of the Laravel framework. They are grouped together based on the functionality they provide. Here’s a list of helper groups.

Arrays

Helpers in this group provide functionality to manipulate array elements. More often than not, you'll want to perform different operations on array elements. So this is the place where you should look first to see if what you're looking for already exists.

Paths

I find the helpers in this category most useful. They return the fully qualified path of different directories like app, storage, config, and the like. I bet you're using most of these helpers already in your Laravel application.

Strings

String manipulation is something inevitable in your day-to-day application development. Although PHP itself provides plenty of string manipulation functions, you'll find a few more useful goodies in this section.

URLs

You'll find very few in this category, but they are used throughout the application. They are used to generate route, asset, and form action URLs.

Miscellaneous

This category contains helpers that provide a variety of functionalities, ranging from logging to debugging and many more.

For a complete reference of Laravel helpers, there's no better place than the official documentation.

How to Call Built-in Laravel Helpers

In this section, I'll demonstrate how you can call built-in Laravel helpers. We'll go through a couple of Laravel helpers to understand what they do and how you can use them.

The Str::ucfirst helper converts the first character of string to uppercase. You can call it as shown in the following snippet from anywhere within your application.

$string = Str::ucfirst('envato helper');<br>// $string should contain "Envato helper"<br>

As you can see, it's pretty straightforward to call a Laravel helper.

Let's look at another helper that's widely used in Laravel.

The url helper helps you to generate a fully qualified URL to the given path.

$url = url('user/profile');<br>// $url should contain full path like "https://localhost/user/profile"<br>

So that's how you can use Laravel helpers. In the next section, we'll discuss how you can create a custom Laravel helper.

Create Your First Custom Helper

Now you have a basic understanding of Laravel helpers and what they are used for. In this section, I’ll demonstrate how you can create your own custom helper that can be used globally in your Laravel application.

To keep things simple and easy to understand, it’ll be a pretty basic helper that takes a user id and returns a user name as a response. Of course, that doesn’t sound fancy, but I believe it’s enough to demonstrate the concept, and you could always extend it to fulfill more complex requirements.

I assume that you have a userid and User Helper Class

Create a Helpers/Envato directory under app and create a User.php file with the following contents. Of course, you could place it directly under the app or app/Helpers directory, but providing that extra level allows us to organize our helpers—especially important when you’re going to have a lot of them.

$string = Str::ucfirst('envato helper');<br>// $string should contain "Envato helper"<br>

The file starts with a pretty standard namespace declaration:

$url = url('user/profile');<br>// $url should contain full path like "https://localhost/user/profile"<br>

The purpose of our custom helper is to retrieve a username based on a user id. Hence, we need to interact with the database, and that forces us to include the register method is used to register your dependencies, and we’ve done exactly that. We’ve included our custom helper file.

Here’s how the app/Providers/EnvatoServiceProvider.php file should look after modifications.

<?php<br>//app/Helpers/Envato/User.php<br>namespace App\Helpers\Envato;<br> <br>use Illuminate\Support\Facades\DB;<br> <br>class User {<br>    /**<br>     * @param int $user_id User-id<br>     * <br>     * @return string<br>     */<br>    public static function get_username($user_id) {<br>        $user = DB::table('users')->where('userid', $user_id)->first();<br>         <br>        return (isset($user->username) ? $user->username : '');<br>    }<br>}<br>

So it’s all pretty good so far. We have our custom helper and service provider on the table.

Custom Service Provider Declaration

Next, we need to inform Laravel about our service provider so that it can load it during bootstrapping. Let’s open config/app.php and add the following entry to the providers<code>providers array.

namespace App\Helpers\Envato;<br>

To use our helper in a convenient way, we can create an alias as well. So let’s do that by adding the following entry in the aliases<code>aliases array at the end of the same file.

<?php<br><br>namespace App\Providers;<br><br>use Illuminate\Support\ServiceProvider;<br><br>class EnvatoServiceProvider extends ServiceProvider<br>{<br>    /**<br>     * Register services.<br>     *<br>     * @return void<br>     */<br>    public function register()<br>    {<br>        require_once app_path() . '/Helpers/Envato/User.php';<br>    }<br><br>    /**<br>     * Bootstrap services.<br>     *<br>     * @return void<br>     */<br>    public function boot()<br>    {<br>        //<br>    }<br>}<br>

By defining this entry, we can call our helper by using the EnvatoUser<code>EnvatoUser keyword. Pretty convenient, huh? We’re almost there! We’ve done all the hard work to get here, and now we can reap the benefits of our custom helper.

Your First Custom Helper in Action

Again, to keep things simple, we’ll define a basic Laravel route and call our helper from there!

Go ahead and add the following code in the routes/web.php file.

App\Providers\EnvatoServiceProvider::class,<br>

Does that need any explanation at all? We’ve just called the custom helper by the shorthand EnvatoUser::get_username<code>EnvatoUser::get_username, and it should return the username.

Of course, you can call this helper from anywhere in the application, be it a controller or view.

Conclusion

Helpers in Laravel are a powerful feature, and I'm sure that as a developer you would love to extend that. So today we went through the basics of the Laravel helper file structure and created a useful custom helper.

I hope you’ve enjoyed the article and it helps you create your own custom helpers in your day-to-day Laravel application development.

The above is the detailed content of How to Create a Laravel Helper. For more information, please follow other related articles on the PHP Chinese website!