Scheduler
extends AbstractProcessor
in package
Scheduler class
Tags
Table of Contents
- $completed : array<string|int, AbstractJob>
- Completed jobs
- $failed : array<string|int, AbstractJob>
- Failed jobs
- $failedExceptions : array<string|int, Exception>
- Failed jobs exceptions
- $results : array<string|int, mixed>
- Job results
- $schedules : array<string|int, Schedule>
- Job schedules
- addJob() : Schedule
- Add job
- addSchedule() : Scheduler
- Add schedule
- addSchedules() : Scheduler
- Add schedules
- getCompletedJob() : AbstractJob
- Get completed job
- getCompletedJobs() : array<string|int, mixed>
- Get completed jobs
- getFailedException() : Exception
- Get failed exception
- getFailedExceptions() : array<string|int, mixed>
- Get failed exceptions
- getFailedJob() : AbstractJob
- Get failed job
- getFailedJobs() : array<string|int, mixed>
- Get failed jobs
- getJobResult() : mixed
- Get job result
- getJobResults() : array<string|int, mixed>
- Get job results
- getSchedule() : Schedule
- Get schedule
- getSchedules() : array<string|int, mixed>
- Get schedules
- hasCompletedJobs() : bool
- Has completed jobs
- hasFailedExceptions() : bool
- Has failed exceptions
- hasFailedJobs() : bool
- Has failed jobs
- hasJobResults() : bool
- Has job results
- hasSchedule() : bool
- Has schedule
- hasSchedules() : bool
- Has schedules
- processNext() : void
- Process next job
Properties
$completed
Completed jobs
protected
array<string|int, AbstractJob>
$completed
= []
$failed
Failed jobs
protected
array<string|int, AbstractJob>
$failed
= []
$failedExceptions
Failed jobs exceptions
protected
array<string|int, Exception>
$failedExceptions
= []
$results
Job results
protected
array<string|int, mixed>
$results
= []
$schedules
Job schedules
protected
array<string|int, Schedule>
$schedules
= []
Methods
addJob()
Add job
public
addJob(AbstractJob $job) : Schedule
Parameters
- $job : AbstractJob
Return values
Schedule —addSchedule()
Add schedule
public
addSchedule(Schedule $schedule) : Scheduler
Parameters
- $schedule : Schedule
Return values
Scheduler —addSchedules()
Add schedules
public
addSchedules(array<string|int, mixed> $schedules) : Scheduler
Parameters
- $schedules : array<string|int, mixed>
Return values
Scheduler —getCompletedJob()
Get completed job
public
getCompletedJob(mixed $index) : AbstractJob
Parameters
- $index : mixed
Return values
AbstractJob —getCompletedJobs()
Get completed jobs
public
getCompletedJobs() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFailedException()
Get failed exception
public
getFailedException(mixed $index) : Exception
Parameters
- $index : mixed
Return values
Exception —getFailedExceptions()
Get failed exceptions
public
getFailedExceptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFailedJob()
Get failed job
public
getFailedJob(mixed $index) : AbstractJob
Parameters
- $index : mixed
Return values
AbstractJob —getFailedJobs()
Get failed jobs
public
getFailedJobs() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobResult()
Get job result
public
getJobResult(mixed $index) : mixed
Parameters
- $index : mixed
Return values
mixed —getJobResults()
Get job results
public
getJobResults() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSchedule()
Get schedule
public
getSchedule(int $index) : Schedule
Parameters
- $index : int
Return values
Schedule —getSchedules()
Get schedules
public
getSchedules() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasCompletedJobs()
Has completed jobs
public
hasCompletedJobs() : bool
Return values
bool —hasFailedExceptions()
Has failed exceptions
public
hasFailedExceptions() : bool
Return values
bool —hasFailedJobs()
Has failed jobs
public
hasFailedJobs() : bool
Return values
bool —hasJobResults()
Has job results
public
hasJobResults() : bool
Return values
bool —hasSchedule()
Has schedule
public
hasSchedule(int $index) : bool
Parameters
- $index : int
Return values
bool —hasSchedules()
Has schedules
public
hasSchedules() : bool
Return values
bool —processNext()
Process next job
public
processNext([Queue $queue = null ]) : void
Parameters
- $queue : Queue = null