QueueController
extends AbstractController
in package
Console queue controller class
Tags
Table of Contents
Properties
- $application : Application|null
- Application object
- $bypassMaintenance : bool
- Bypass maintenance false
- $console : Console|null
- Console object
- $defaultAction : string
- Default action
- $maintenanceAction : string
- Maintenance action
Methods
- __construct() : mixed
- Constructor for the controller
- application() : Application
- Get application object
- bypassMaintenance() : bool
- Check the bypass maintenance check
- clear() : void
- Clear command
- config() : void
- Config command
- console() : Console
- Get request object
- dispatch() : void
- Dispatch the controller based on the action
- dispatchMaintenance() : void
- Dispatch the maintenance action
- error() : void
- Default error action method
- getApplication() : Application|null
- Get application object
- getConsole() : Console|null
- Get console object
- getDefaultAction() : string
- Get the default action
- getMaintenanceAction() : string
- Get the maintenance action
- hasApplication() : bool
- Has application object
- hasConsole() : bool
- Has console object
- jobs() : void
- Jobs command
- scheduler() : void
- Scheduler command
- setApplication() : static
- Set application object
- setBypassMaintenance() : static
- Check the bypass maintenance check
- setConsole() : static
- Set console object
- setDefaultAction() : static
- Set the default action
- setMaintenanceAction() : static
- Set the maintenance action
- tasks() : void
- Tasks command
- work() : void
- Work command
- resolveApp() : Application|null
- Resolve the consuming application's own Application instance, printing a friendly error and returning null if nothing is scaffolded
- worker() : Worker|null
- Resolve the app and build a worker for $queue, printing a friendly error and returning null on failure
Properties
$application
Application object
protected
Application|null
$application
= null
$bypassMaintenance
Bypass maintenance false
protected
bool
$bypassMaintenance
= true
$console
Console object
protected
Console|null
$console
= null
$defaultAction
Default action
protected
string
$defaultAction
= 'error'
$maintenanceAction
Maintenance action
protected
string
$maintenanceAction
= 'maintenance'
Methods
__construct()
Constructor for the controller
public
__construct(Application $application[, Console $console = new Console(120) ]) : mixed
Parameters
- $application : Application
- $console : Console = new Console(120)
application()
Get application object
public
application() : Application
Return values
ApplicationbypassMaintenance()
Check the bypass maintenance check
public
bypassMaintenance() : bool
Return values
boolclear()
Clear command
public
clear([string|null $queue = 'default' ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $queue : string|null = 'default'
- $options : array<string|int, mixed> = []
config()
Config command
public
config([string|null $queue = 'default' ]) : void
Parameters
- $queue : string|null = 'default'
console()
Get request object
public
console() : Console
Return values
Consoledispatch()
Dispatch the controller based on the action
public
dispatch([string|null $action = null ][, array<string|int, mixed>|null $params = null ]) : void
Parameters
- $action : string|null = null
- $params : array<string|int, mixed>|null = null
Tags
dispatchMaintenance()
Dispatch the maintenance action
public
dispatchMaintenance() : void
Tags
error()
Default error action method
public
error() : void
Tags
getApplication()
Get application object
public
getApplication() : Application|null
Return values
Application|nullgetConsole()
Get console object
public
getConsole() : Console|null
Return values
Console|nullgetDefaultAction()
Get the default action
public
getDefaultAction() : string
Return values
stringgetMaintenanceAction()
Get the maintenance action
public
getMaintenanceAction() : string
Return values
stringhasApplication()
Has application object
public
hasApplication() : bool
Return values
boolhasConsole()
Has console object
public
hasConsole() : bool
Return values
booljobs()
Jobs command
public
jobs([string|null $queue = 'default' ]) : void
Parameters
- $queue : string|null = 'default'
scheduler()
Scheduler command
public
scheduler([string|null $queue = 'default' ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $queue : string|null = 'default'
- $options : array<string|int, mixed> = []
setApplication()
Set application object
public
setApplication(Application $application) : static
Parameters
- $application : Application
Return values
staticsetBypassMaintenance()
Check the bypass maintenance check
public
setBypassMaintenance([bool $bypass = true ]) : static
Parameters
- $bypass : bool = true
Return values
staticsetConsole()
Set console object
public
setConsole([Console $console = new Console(120) ]) : static
Parameters
- $console : Console = new Console(120)
Return values
staticsetDefaultAction()
Set the default action
public
setDefaultAction(string $default) : static
Parameters
- $default : string
Return values
staticsetMaintenanceAction()
Set the maintenance action
public
setMaintenanceAction(string $maintenance) : static
Parameters
- $maintenance : string
Return values
statictasks()
Tasks command
public
tasks([string|null $queue = 'default' ]) : void
Parameters
- $queue : string|null = 'default'
work()
Work command
public
work([string|null $queue = 'default' ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $queue : string|null = 'default'
- $options : array<string|int, mixed> = []
resolveApp()
Resolve the consuming application's own Application instance, printing a friendly error and returning null if nothing is scaffolded
protected
resolveApp() : Application|null
Return values
Application|nullworker()
Resolve the app and build a worker for $queue, printing a friendly error and returning null on failure
protected
worker(string $queue) : Worker|null
Parameters
- $queue : string