README

This is a helpers package that provides some built in helpers, and also provides an Artisan generator to quickly create your own custom helpers.

Install

Via Composer

$ composer require hooshid/laravel-helpers

Setup

Add the service provider to the providers array in config/app.php.

'providers' => [
    Hooshid\Helpers\HelperServiceProvider::class,
];

If you are using Laravel's automatic package discovery, you can skip this step.

Publishing

You can publish everything at once

php artisan vendor:publish --provider="Hooshid\Helpers\HelperServiceProvider"

or you can publish groups individually.

php artisan vendor:publish --provider="Hooshid\Helpers\HelperServiceProvider" --tag="config"

Usage

This package comes with some built in helpers that you can choose to use or not. By default all of these helpers are active for your application. To adjust which helpers are active and which are inactive, open config/helpers.php and find the package_helpers option. Add or Remove any helpers you wish to activate/inactive to this key. Check the source code to see what functions are included in each helper and what each does.

You can also create your own custom helpers for inclusion in your application. An Artisan generator helps you quickly make new helpers for your application.

php artisan make:helper MyHelper

Your custom helper will be placed in app/Helpers, unless you override the default directory in your configuration.

By default, the service provider uses the glob function to automatically require any PHP files in the 'Helpers' directory. If you prefer a mapper based approach, you may edit the custom_helpers in the configuration file, and include the file name of any helpers in your custom directory you wish to activate. Within the new helper, define your own custom functions that will be available throughout your application.

if (!function_exists('hello')) {

    /**
     * say hello
     *
     * @param string $name
     * @return string
     */
    function hello($name)
    {
        return 'Hello ' . $name . '!';
    }
}

Available functions

New functions are always adding. Feel free to contribute.

Formatter

`get_excerpt()`

get excerpt of text:

get_excerpt($text, $maxChars = null, $suffix = '...', $br = true, $clean_html = true);

`format_bytes()`

Format bytes into kilobytes, megabytes, gigabytes or terabytes:

format_bytes($bytes, $precision = 2);

`clean_string()`

remove html tags from input:

clean_string($value, $functions = null);

`phone()`

phone formatter (iran mobile and home phone numbers):

phone($phone);

Image

`image()`

provides default image if empty:

$image = image('/images/test.jpg');

// /images/test.jpg

`gravatar()`

provides gravatar image (if your app use laravel auth, when run function with null value, function try to catch user email with auth()->user()->email):

$gravatar = gravatar('email@gmail.com');

Strings

`str_lower()`

Convert string to lowercase, assuming it's using the UTF-8 encoding:

$lower = str_lower('TeSt');

// test

`str_upper()`

Convert string to uppercase, assuming it's using the UTF-8 encoding:

$upper = str_upper('TeSt');

// TEST

Change log

Please see CHANGELOG for more information what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

hooshid / laravel-helpers

Maintainers

Details