class
Illuminate
/
Console
/
Scheduling
/
ScheduleListCommand
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.
ScheduleListCommand
Extends
Properties
protected
$signature string
The console command name.
Default: 'schedule:list
{--timezone= : The timezone that times should be displayed in}
{--next : Sort the listed tasks by their next due date}
'
protected
$description string
The console command description.
Default: 'List all scheduled tasks'
protected
static
$terminalWidthResolver Closure |null
The terminal width resolver callback.
Default: null
Methods
public
handle ( Schedule $schedule ) : void
Execute the console command.
Parameters
- $schedule Schedule
private
getCronExpressionSpacing
(
$events
)
:
array
Get the spacing to be used on each event row.
Parameters
- $events Illuminate\...\Collection
private
getRepeatExpressionSpacing ( $events ) : int
Get the spacing to be used on each event row.
Parameters
- $events Illuminate\...\Collection
private
listEvent ( $event , $terminalWidth , $expressionSpacing , $repeatExpressionSpacing , $timezone ) : Illuminate\...\DateTimeZone
List the given even in the console.
Parameters
- $ Event
- $terminalWidth int
- $expressionSpacing array
- $repeatExpressionSpacing array
- $timezone DateTimeZone
private
getRepeatExpression ( $event ) : string
Get the repeat expression for an event.
Parameters
- $event Event
private
sortEvents ( Illuminate\...\Collection $events , DateTimeZone $timezone ) : Illuminate\...\Collection
Sort the events by due date if option set.
Parameters
- $events Illuminate\...\Collection
- $timezone DateTimeZone
private
getNextDueDateForEvent ( $event , DateTimeZone $timezone ) : Carbon
Get the next due date for an event.
Parameters
- $event Event
- $timezone DateTimeZone
private
formatCronExpression ( $expression , $spacing ) : string
Format the cron expression based on the spacing provided.
Parameters
- $expression string
-
$spacing
array
private
getClosureLocation ( CallbackEvent $event ) : string
Get the file and line number for the event closure.
Parameters
- $event CallbackEvent
public
static
getTerminalWidth ( ) : int
Get the terminal width.
public
static
resolveTerminalWidthUsing ( $resolver ) : void
Set a callback that should be used when resolving the terminal width.
Parameters
- $resolver Closure |null