This repository contains some useful helpers for most applications using Laravel.
You can install the package via composer:
composer require maize-tech/laravel-helpers
You can publish the config file with:
php artisan vendor:publish --tag="helpers-config"
This is the content of the published config file:
return [
/*
|--------------------------------------------------------------------------
| Helper macros
|--------------------------------------------------------------------------
|
| Here you may specify the full list of helper macros which will automatically
| be registered on boot.
| The key defines the method name, whereas the value should be the
| fully qualified name of the invokable class.
|
*/
'macros' => Helper::defaultMacros()->merge([
// 'methodName' => App\Example\ExampleClass::class,
])->toArray(),
];
To use the package, you can simply call the hlp()
helper function, followed by one of the Available methods methods listed below.
If needed, you could also call the static method directly.
Here's an example using both the helper function and the static method:
hlp()->sanitizeUrl('mywebsite.com'); // using the helper function
\Maize\Helpers\Helper::sanitizeUrl('mywebsite.com'); // using the static method
anonymizeFilename
classUsesTrait
instanceofTypes
isUrl
modelKeyName
morphClassOf
resolveMorphedModel
paginationLimit
pipe
sanitizeArrayOfStrings
sanitizeString
sanitizeUrl
The anonymizeFilename
function returns a randomized name of the given file followed by its extension.
string $filename = 'my-custom-file.xml';
// returns a UUID string followed by the file extension
// e.g. 'd437fd98-68d1-4874-b0e7-fac06e587083.xml'
hlp()->anonymizeFilename($filename);
The classUsesTrait
function returns whether a class object or name uses the given trait or not.
use App\Models\User;
use Exception;
use Illuminate\Database\Eloquent\Factories\HasFactory;
$model = User::firstOrFail();
hlp()->classUsesTrait(HasFactory::class, $model); // returns true
hlp()->classUsesTrait(HasFactory::class, User::class); // returns true
hlp()->classUsesTrait(Exception::class, $model); // returns false
hlp()->classUsesTrait(Exception::class, User::class); // returns false
The instanceofTypes
function returns whether a class object is an instance of at least one of the given types or not.
use App\Models\User;
use Exception;
use Illuminate\Database\Eloquent\Model;
$model = User::firstOrFail();
hlp()->instanceofTypes($model, Model::class); // returns true
hlp()->instanceofTypes($model, Exception); // returns false
hlp()->instanceofTypes($model, [
Model::class,
Exception::class,
]); // returns true
The isUrl
function returns whether a string is a valid URL or not.
hlp()->isUrl('https://my-application.test'); // returns true
hlp()->isUrl('not-an-url'); // returns false
The modelKeyName
function returns the key name of a given model object or class name.
use App\Models\User;
$model = User::firstOrFail();
hlp()->modelKeyName($model); // returns 'id'
hlp()->modelKeyName(User::class); // returns 'id'
The morphClassOf
function returns the morph class name of a given model object or class name.
use App\Models\User;
use Illuminate\Database\Eloquent\Relations\Relation;
$model = User::firstOrFail();
hlp()->morphClassOf($model); // returns 'App\Models\User'
hlp()->morphClassOf(User::class); // returns 'App\Models\User'
Relation::enforceMorphMap([
'user' => User::class,
]);
hlp()->morphClassOf($model); // returns 'user'
hlp()->morphClassOf(User::class); // returns 'user'
The resolveMorphedModel
function returns the fully qualified model class name of a given morph class name.
You can either pass the singular or plural name of the morph class name.
hlp()->resolveMorphedModel('users'); // returns 'App\Models\User'
hlp()->resolveMorphedModel('user'); // returns 'App\Models\User'
The paginationLimit
function returns the amount of items per page.
It is useful when working with queries who need a pagination, and allows to define a default pagination limit and the max amount of items per page.
It will also check whether the request's query string contains a limit
parameter: if true, the given limit overrides the default limit.
use App\Models\Article;
// use the default pagination limit (16 items)
// GET /api/articles
Article::paginate(
hlp()->paginationLimit() // returns 16 items
);
// use the pagination limit given by the request query string
// GET /api/articles?limit=20
Article::paginate(
hlp()->paginationLimit() // returns 20 items
);
// provide a custom default pagination limit
// GET /api/articles
Article::paginate(
hlp()->paginationLimit(30) // returns 30 items
);
// when defined, the request query string limit overrides the default limit
// GET /api/articles?limit=20
Article::paginate(
hlp()->paginationLimit(30) // returns 20 items
);
// provide a max limit of items for each page
// GET /api/articles?limit=200
Article::paginate(
hlp()->paginationLimit(16, 50) // returns 50 items
);
The pipe
function allows you to integrate Laravel pipelines with ease.
The first parameter is the object to be sent through the pipeline, while the second is the list of pipes.
hlp()->pipe('test', [
\Maize\Helpers\Tests\Support\Actions\Uppercase::class,
]); // returns 'TEST'
hlp()->pipe('test', [
\Maize\Helpers\Tests\Support\Actions\Uppercase::class,
\Maize\Helpers\Tests\Support\Actions\Reverse::class,
]); // returns 'TSET'
hlp()->pipe('', []) // returns an empty string
The sanitizeArrayOfStrings
function sanitizes an array of strings by removing all HTML tags and whitespace from both ends.
When passing an associative array, it also filters all keys with an empty value.
hlp()->sanitizeArrayOfStrings([' test ', ' test ']); // returns '['test', 'test']'
hlp()->sanitizeArrayOfStrings(['a' => ' test </h1> ', 'b' => ' test </h1> ']) // returns ['a' => 'test', 'b' => 'test']
hlp()->sanitizeArrayOfStrings(['a' => '']); // returns an empty array
The sanitizeString
function sanitizes a string by removing all HTML tags and whitespace from both ends.
hlp()->sanitizeString('<h1> test </h1>'); // returns 'test'
hlp()->sanitizeString(' <h1> test '); // returns 'test'
hlp()->sanitizeString('<br />') // returns an empty string
The sanitizeUrl
function prepends the specified url with the https
protocol if none is set.
hlp()->sanitizeUrl('http://innovation.h-farm.com'); // returns 'http://innovation.h-farm.com'
hlp()->sanitizeUrl('innovation.h-farm.com'); // returns 'https://innovation.h-farm.com'
hlp()->sanitizeUrl('') // returns an empty string
If needed, you can easily add your own helper methods.
All you have to do is define your custom helper class and implement the HelperMacro
interface:
<?php
namespace App\Helpers\Macros;
use Maize\Helpers\HelperMacro;
class Ping implements HelperMacro
{
public function __invoke(): \Closure
{
return function (): string {
return 'pong';
};
}
}
After that, you can add your method to the macros
attribute from config/helpers.php
:
return [
/*
|--------------------------------------------------------------------------
| Helper macros
|--------------------------------------------------------------------------
|
| Here you may specify the full list of helper macros which will automatically
| be registered on boot.
| The key defines the method name, whereas the value should be the
| fully qualified name of the invokable class.
|
*/
'macros' => Helper::defaultMacros()->merge([
'ping' => \App\Helpers\Macros\Ping::class,
])->toArray(),
];
Alternatively, if you need to define custom helpers at runtime, you can call the macro
static method of the Helper
class:
use Maize\Helpers\Helper;
Helper::macro('ping', fn (): string => 'pong');
You can now call your custom helper method with the hlp()
helper method:
hlp()->ping(); // returns "pong";
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.