ManagesAttributes
trait ManagesAttributes
Properties
| string | $expression | The cron expression representing the event's frequency. |
|
| int|null | $repeatSeconds | How often to repeat the event during a minute. |
|
| DateTimeZone|string|null | $timezone | The timezone the date should be evaluated on. |
|
| array | $environments | The list of environments the command should run under. |
|
| bool | $evenInMaintenanceMode | Indicates if the command should run in maintenance mode. |
|
| bool | $evenWhenPaused | Indicates if the command should run even when the scheduler is paused. |
|
| bool | $withoutOverlapping | Indicates if the command should not overlap itself. |
|
| bool | $releaseOnTerminationSignals | Indicates if the mutex should be released when the process receives a termination signal. |
|
| bool | $onOneServer | Indicates if the command should only be allowed to run on one server for each cron expression. |
|
| int | $expiresAt | The number of minutes the mutex should be valid. |
|
| bool | $runInBackground | Indicates if the command should run in the background. |
|
| protected array | $filters | The array of filter callbacks. |
|
| protected array | $rejects | The array of reject callbacks. |
|
| string|null | $description | The human-readable description of the event. |
|
| array | $attributes | The arbitrary attributes stored with the event. |
Methods
Limit the environments the command should run in.
State that the command should run even in maintenance mode.
State that the command should run even when the scheduler is paused.
Do not allow the event to overlap each other.
Allow the event to only run on one server for each cron expression.
State that the command should run in the background.
Register a callback to further filter the schedule.
Register a callback to further filter the schedule.
Set the human-friendly description of the event.
Set the human-friendly description of the event.
Set arbitrary attributes to store with the event.
Details
at line 97
ManagesAttributes
environments(UnitEnum|array|string $environments)
Limit the environments the command should run in.
at line 112
ManagesAttributes
evenInMaintenanceMode()
State that the command should run even in maintenance mode.
at line 124
ManagesAttributes
evenWhenPaused()
State that the command should run even when the scheduler is paused.
at line 138
ManagesAttributes
withoutOverlapping(int $expiresAt = 1440, bool $releaseOnTerminationSignals = true)
Do not allow the event to overlap each other.
The expiration time of the underlying cache lock may be specified in minutes.
at line 156
ManagesAttributes
onOneServer()
Allow the event to only run on one server for each cron expression.
at line 168
ManagesAttributes
runInBackground()
State that the command should run in the background.
at line 180
ManagesAttributes
when(bool|callable $callback)
Register a callback to further filter the schedule.
at line 194
ManagesAttributes
skip(bool|callable $callback)
Register a callback to further filter the schedule.
at line 208
ManagesAttributes
name(string $description)
Set the human-friendly description of the event.
at line 218
ManagesAttributes
description(string $description)
Set the human-friendly description of the event.
at line 230
ManagesAttributes
withAttributes(array $attributes)
Set arbitrary attributes to store with the event.