Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmazter/laravel-schedule-list
Laravel package to add command to list all scheduled artisan commands
https://github.com/hmazter/laravel-schedule-list
artisan-command laravel laravel-package laravel-schedule
Last synced: 4 days ago
JSON representation
Laravel package to add command to list all scheduled artisan commands
- Host: GitHub
- URL: https://github.com/hmazter/laravel-schedule-list
- Owner: hmazter
- License: mit
- Created: 2015-08-13T08:51:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T13:49:39.000Z (almost 3 years ago)
- Last Synced: 2024-12-21T00:34:01.183Z (7 days ago)
- Topics: artisan-command, laravel, laravel-package, laravel-schedule
- Language: PHP
- Homepage:
- Size: 85.9 KB
- Stars: 94
- Watchers: 2
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Laravel Schedule List
=====================
[](https://github.com/hmazter/laravel-schedule-list/actions)
[](https://github.styleci.io/repos/40648674)
[](https://packagist.org/packages/hmazter/laravel-schedule-list)
[](https://packagist.org/packages/hmazter/laravel-schedule-list)
[](https://packagist.org/packages/hmazter/laravel-schedule-list)
[](https://packagist.org/packages/hmazter/laravel-schedule-list)
Laravel 5.6+ package to add a artisan command to list all scheduled artisan commands.
With schedule time (cron expression), the command to execute and the command description.
## Install
Require this package with composer using the following command:
```bash
composer require hmazter/laravel-schedule-list
```
**Note!** For Laravel version 5.5 and below use [0.2.0](https://github.com/hmazter/laravel-schedule-list/tree/v0.2.0#Install) tag.
## Usage
Usage from the command line to show all your scheduled artisan commands:
```bash
php artisan schedule:list
```
Outputs:
```
+--------------+---------------------+--------------+-------------------------------+
| expression | next run at | command | description |
+--------------+---------------------+--------------+-------------------------------+
| 0 14 * * 3 * | 2017-08-16 14:00:00 | email:export | Export users to email service |
+--------------+---------------------+--------------+-------------------------------+
```
### Crontab style output
Use `--cron` to show the output in the same style as it would go in a crontab file.
Outputs:
```
0 14 * * 3 * '/usr/local/bin/php' 'artisan' email:export > '/dev/null' 2>&1`
```
### Verbose output
Use `-vv` to show the full command, including php binary path and output path.
Outputs:
```
+--------------+---------------------+----------------------------------------------------------------+-------------------------------+
| expression | next run at | command | description |
+--------------+---------------------+----------------------------------------------------------------+-------------------------------+
| 0 14 * * 3 * | 2017-08-16 14:00:00 | '/usr/local/bin/php' 'artisan' email:export > '/dev/null' 2>&1 | Export users to email service |
+--------------+---------------------+----------------------------------------------------------------+-------------------------------+
```
Using `-vv` together with `--cron` does not change to output from normal `--cron` output.
### Programmatic use
For occasions when you need to access the list of scheduled events programmatically
`\Hmazter\LaravelScheduleList\ScheduleList::all` exists that will return all the scheduled events as an array of `ScheduleEvent`.
Inject the `ScheduleList` or resolve it from the Container and then call `all()` to get all scheduled events.
Usage of it can be seen in [ListScheduler::handle](src/Console/ListScheduler.php)
## Define PHP Binary Path
If you use custom PHP Binary paths or you are using `\Hmazter\LaravelScheduleList\ScheduleList::all` within the context of a web application and not through the console, you can publish the package config file and defining your own binary path:
```
php artisan vendor:publish --provider="Hmazter\LaravelScheduleList\ScheduleListServiceProvider" --tag="config"
```
For example `config/schedule-list.php`:
```
[
"'".PHP_BINARY."'",
"'artisan'",
],
];
```
## Known limitations
Laravel ships with some special scheduling functions ex `between`, `unlessBetween`, `when` and `skip`
these are not handled right now in the schedule listing output.
They are evaluated at each execution of the schedule and does not define any expression that can be included in the table.