README

About Your Package

A collection of helpers for your application.

Installation

In order to install cleaniquecoders/laravel-helper in your Laravel project, just run the composer require command from your terminal:

composer require cleaniquecoders/laravel-helper

Then in your config/app.php add the following to the providers array:

CleaniqueCoders\LaravelHelper\LaravelHelperServiceProvider::class,

In the same config/app.php add the following to the aliases array:

'LaravelHelper' => CleaniqueCoders\LaravelHelper\LaravelHelperFacade::class,

Publish Laravel Helper config file:

php artisan vendor:publish --tag=laravel-helper

Usage

Generate Sequence

generate_sequence(313) will generate 000313. This is quiet useful if you want to standardised the generate sequence number.

Abbreviation

abbrv('your words') will generate YRWDS.

You may configure abbrv() helper via helper config file.

Fully Qualified Class Name, FQCN

fqcn($user) - will return App\User. This will be useful if you dealing with Polymorph relationship.

Slugged Name of FQCN

str_slug_fqcn($user) - will generate app-user, kebab case of the FQCN. This will be useful if you want to have sluggable name of an object and use it as identifier in the database, instead of the FQCN.

Notification

You can simply send notification to user by calling notify() helper.

// send by id
notify(1)
    ->subject('Laravel Helper')
    ->message('Sending notification via notify helper is awesome.')->send();

// you can send by email, but require to specify column name on second argument
notify('nasrulhazim.m@gmail.com', 'email')
    ->subject('Laravel Helper')
    ->message('Sending notification via notify helper is awesome.')
    ->send();

// Send with Subject and Message, CC and BCC
$cc = \App\Models\User::whereIn('id', [2,3,4])->get()->pluck('email')->toArray();
$bcc = \App\Models\User::whereIn('id', [5,6,7])->get()->pluck('email')->toArray();

notify(1)
   ->subject('Laravel Helper')
   ->message('Send notification via notify() helper is awesome and easy.')
   ->cc($cc)
   ->bcc($bcc)
   ->send();

// Send Notification with Subject, Message, Link.
notify(1)
   ->subject('Laravel Helper')
   ->message('Send notification via notify() helper is awesome and easy.')
   ->link('https://google.com')
   ->send();

// Send Notification with Subject, Message, Link and Custom Link Label.
notify(1)
   ->subject('Laravel Helper')
   ->message('Send notification via notify() helper is awesome and easy.')
   ->link('https://google.com')
   ->link_label('Google')
   ->send();

// Send Notification with Subject, Message, Link, Custom Link Label and Custom Template.
notify(1)
   ->subject('Laravel Helper')
   ->message('Send notification via notify() helper is awesome and easy.')
   ->link('https://google.com')
   ->link_label('Google')
   ->template('mail.custom')
   ->send();

// Send Notification with Subject, Message, Link, Custom Link Label, Custom Template and Mixed Data.
notify(1)
   ->subject('Laravel Helper')
   ->message('Send notification via notify() helper is awesome and easy.')
   ->link('https://google.com')
   ->link_label('Google')
   ->template('mail.custom')
   ->data($anything)
   ->send();

You can set anything to data - array, object, string, etc.

Test

To run the test, type vendor/bin/phpunit in your terminal.

To have codes coverage, please ensure to install PHP XDebug then run the following command:

$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr

Contributing

Thank you for considering contributing to the cleaniquecoders/laravel-helper!

Bug Reports

To encourage active collaboration, it is strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.

Coding Style

cleaniquecoders/laravel-helper follows the PSR-2 coding standard and the PSR-4 autoloading standard.

You may use PHP CS Fixer in order to keep things standardised. PHP CS Fixer configuration can be found in .php_cs.

License

This package is open-sourced software licensed under the MIT license.

cleaniquecoders / laravel-helper

Maintainers

Details