Download the PHP package bmitch/consoleevents without Composer
On this page you can find all versions of the php package bmitch/consoleevents. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bmitch/consoleevents
More information about bmitch/consoleevents
Files in bmitch/consoleevents
Package consoleevents
Short Description Events for Laravel Console Commands
License MIT
Informations about the package consoleevents
Console Events for Laravel Commands
What is it?
This package allows you to have events triggered by your Artisan Commands. The events available are:
Bmitch\ConsoleEvents\Events\CommandStarting
Triggered when an Artisan Command is starting.
Bmitch\ConsoleEvents\Events\CommandTerminating
Triggered when an Artisan Command is terminating.
Why use it?
The main reason I created this package was for a use case where multiple commands were executed nightly and I wanted an easy way to log when they started and stopped. By hooking into these events it makes it easy.
How to Install
Add to composer
Modify commands to extend custom class
In any command that you wish to trigger these events simply replace the:
with
Create and Register Listeners
Create two listeners within the app/Listeners
folder like this:
Then register it within the app\Providers\EventServiceProvider.php
class:
Seeing the results
Run your command and check laravel.log
. You should see an entry that was triggered by the CommandStartingListener
.
Something like:
Additional Methods
The Bmitch\ConsoleEvents\Command
class automatically tracks how long it takes to execute and provides a getExecutionTime()
method to make it easy to add this data when Logging data.
Contributing
Please see CONTRIBUTING.md
License
The MIT License (MIT). Please see License File for more information.