Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cleaniquecoders/laravel-observers
A collection of observer classes that can be use in your Laravel application.
https://github.com/cleaniquecoders/laravel-observers
laravel observer
Last synced: about 2 months ago
JSON representation
A collection of observer classes that can be use in your Laravel application.
- Host: GitHub
- URL: https://github.com/cleaniquecoders/laravel-observers
- Owner: cleaniquecoders
- License: mit
- Created: 2018-08-07T06:01:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-21T03:48:12.000Z (10 months ago)
- Last Synced: 2024-03-21T04:31:16.024Z (10 months ago)
- Topics: laravel, observer
- Language: PHP
- Size: 216 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![Latest Stable Version](https://poser.pugx.org/cleaniquecoders/laravel-observers/v/stable)](https://packagist.org/packages/cleaniquecoders/laravel-observers) [![Total Downloads](https://poser.pugx.org/cleaniquecoders/laravel-observers/downloads)](https://packagist.org/packages/cleaniquecoders/laravel-observers) [![License](https://poser.pugx.org/cleaniquecoders/laravel-observers/license)](https://packagist.org/packages/cleaniquecoders/laravel-observers)
## About Your Package
A collection of observer classes that can be use in your Laravel application.
## Installation
1. 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
```2. Then in your `config/app.php` add the following to the providers array:
```php
CleaniqueCoders\LaravelObservers\LaravelObserversServiceProvider::class,
```3. In the same `config/app.php` add the following to the aliases array:
```php
'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:
```php
$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:
```php
$table->reference('reference_no', 128);
```By default, the length is `64` and label used is `reference`.
```php
$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](http://opensource.org/licenses/MIT).