Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ntimyeboah/laravel-database-trigger
Generate migration file for database trigger
https://github.com/ntimyeboah/laravel-database-trigger
database laravel mysql php trigger
Last synced: 4 days ago
JSON representation
Generate migration file for database trigger
- Host: GitHub
- URL: https://github.com/ntimyeboah/laravel-database-trigger
- Owner: NtimYeboah
- License: mit
- Created: 2018-03-25T18:39:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T16:08:22.000Z (about 1 year ago)
- Last Synced: 2024-09-30T06:04:52.343Z (4 days ago)
- Topics: database, laravel, mysql, php, trigger
- Language: PHP
- Homepage:
- Size: 104 KB
- Stars: 20
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Add database trigger to laravel migrations
==========================================
[](LICENSE.md)
[](https://travis-ci.org/NtimYeboah/laravel-database-trigger)
Laravel Database Trigger provides a way to add database trigger to laravel migrations just like you would with database table.
A trigger is a named database object that is associated with a table, and that activates when a particular event occurs for the table. Read more about triggers [here](https://dev.mysql.com/doc/refman/8.0/en/triggers.html).
## Installation
Laravel Database Trigger requires at least [PHP](https://php.net) 7.3. This particular version supports Laravel v8.*. Check the table below for versions support.
| Package version | Laravel version | PHP version |
|----------|:-------------:|------:|
| 1 | 5.5, 5.6, 5.7 | >= 7.1 |
| 2.* | 5.8 | >= 7.1.3 |
| 3.* | 6.* | >= 7.2.5 or >= 8.0 |
| 4.* | 7.* | >= 7.2.5 or >= 8.0 |
| 5.* | 8.* | >= 7.3 or >= 8.0 |
The package currently supports MySQL only.
To get the latest version, simply require the package using [Composer](https://getcomposer.org):
```bash
$ composer require ntimyeboah/laravel-database-trigger
```
Once installed, if you are not using automatic package discovery, then you need to register the `NtimYeboah\LaravelDatabaseTrigger\TriggerServiceProvider` service provider in your `config/app.php`.
## Usage
Create a trigger migration file using the `make:trigger` artisan command.
The command requires the name of the trigger, name of the event object table, action timing and the event that activates the trigger.
```bash
$ php artisan make:trigger after_users_update
```
### Event object table
The event object table is the name of the table the trigger is associated with.
### Action timing
The activation time for the trigger. Possible values are `after` and `before`.
`after` - Process action after the change is made on the event object table.
`before` - Process action prior to the change is made on the event object table.
### Event
The event to activate trigger. A trigger event can be `insert`, `update` and `delete`.
`insert` - Activate trigger when an insert operation is performed on the event object table.
`update` - Activate trigger when an update operation is performed on the event object table.
`delete` - Activate trigger when a delete operation is performed on the event object table.
The following trigger migration file will be generated for a trigger that uses `after_users_update` as a name, `users` as event object table name, `after` as action timing and `update` as event.
```php
use Illuminate\Database\Migrations\Migration;
use NtimYeboah\LaravelDatabaseTrigger\TriggerFacade as Schema;
class CreateAfterUsersUpdateTrigger extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('after_users_update')
->on('users')
->statement(function() {
return '//...';
})
->after()
->update();
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('users.after_users_update');
}
}
```
Return the trigger statement from the closure of the `statement` method.
The following is an example trigger migration to insert into the `users_audit` table after updating a user row.
```php
...
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('after_users_update')
->on('users')
->statement(function() {
return 'insert into `users_audit` (`name`, `email`) values (old.name, old.email);';
})
->after()
->update();
}
...
```
## Testing
Run the tests with:
```php
$ composer test
```
## Changelog
Please see [CHANGELOG](https://github.com/NtimYeboah/laravel-database-trigger/blob/master/CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/NtimYeboah/laravel-database-trigger/blob/master/CONTRIBUTING.md) for details.
## Security
If you discover a security vulnerability within this package, please send an e-mail to Ntim Yeboah at [email protected]. All security vulnerabilities will be promptly addressed.
## License
Laravel Database Trigger is licensed under [The MIT License (MIT)](LICENSE).