README

About Your Package

A collection of observer classes that can be use in your Laravel application.

Installation

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

$ composer require cleaniquecoders/laravel-observers

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

CleaniqueCoders\LaravelObservers\LaravelObserversServiceProvider::class,

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

'LaravelObservers' => CleaniqueCoders\LaravelObservers\LaravelObserversFacade::class,

Usage

Simply publish the config file:

$ php artisan vendor:publish --tag=laravel-observers

Then open up config/observers.php and register your model to which observer do you want.

Please take note, do check for each observer, what's the requirement for each one of it in order to use it.

Hashid Observer

Make sure your model's table has the hashslug column. You may use Blueprint Macro - $table->hashslug(config('hashids.length')) - in your migration or use the following:

$this->string('hashslug')
	->length(config('hashids.length'))
	->nullable()
	->unique()
	->index();

Reference Observer

Make sure your model's table has the hashslug column. You may use Blueprint Macro - $table->reference() - in your migration or use the following:

If you using Blueprint Macro, you can overwrite the label and lenght by pass the first and second argument to the macro:

$table->reference('reference_no', 128);

By default, the length is 64 and label used is reference.

$table->string('reference', config('document.length'))
	->nullable()
	->unique()
	->index();

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-observers!

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-observers 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-observers

Maintainers

Details