queue
in package
Table of Contents
Properties
- $_arrayArguments : array<string|int, mixed>
- $_changed : mixed
- $_onSave : bool
- $arguments : string
- $class : mixed
- $createTime : mixed
- $function : mixed
- $id : mixed
- $options : mixed
- $queueId : mixed
- $timeout : mixed
Methods
- all() : mixed
- allQueueId() : mixed
- byId() : mixed
- byQueueId() : mixed
- canRun() : mixed
- cron() : mixed
- firstByQueueId() : mixed
- getArguments() : array<string|int, mixed>|string
- getCache() : mixed
- getClass() : mixed
- getCreateTime() : mixed
- getFunction() : mixed
- getHumanName() : mixed
- getId() : mixed
- getLastRun() : mixed
- getOptions() : mixed
- getPID() : mixed
- getQueueId() : mixed
- getState() : mixed
- getTimeout() : mixed
- halt() : mixed
- initialize() : void
- postSave() : void
- preSave() : mixed
- refresh() : mixed
- remove() : mixed
- run() : mixed
- running() : mixed
- save() : mixed
- setArguments() : self
- setCache() : mixed
- setClass() : mixed
- setCreateTime() : mixed
- setFunction() : mixed
- setId() : mixed
- setLastRun() : mixed
- setOptions() : mixed
- setPID() : mixed
- setQueueId() : mixed
- setState() : mixed
- setTimeout() : mixed
- start() : mixed
- stop() : mixed
- toArray() : mixed
- getSerializedArguments() : string
- getUnserializedArguments() : array<string|int, mixed>
- setSerializedArguments() : void
Properties
$_arrayArguments
private
array<string|int, mixed>
$_arrayArguments
= []
Arguments
$_changed
private
mixed
$_changed
= \false
$_onSave
private
bool
$_onSave
= \false
$arguments
private
string
$arguments
Serialized version of arguments (used only for database fetch)
$class
private
mixed
$class
$createTime
private
mixed
$createTime
$function
private
mixed
$function
$id
private
mixed
$id
$options
private
mixed
$options
$queueId
private
mixed
$queueId
= \null
$timeout
private
mixed
$timeout
= -1
Methods
all()
public
static all() : mixed
allQueueId()
public
static allQueueId() : mixed
byId()
public
static byId(mixed $_id) : mixed
Parameters
- $_id : mixed
byQueueId()
public
static byQueueId(mixed $_queueId) : mixed
Parameters
- $_queueId : mixed
canRun()
public
canRun() : mixed
cron()
public
static cron() : mixed
firstByQueueId()
public
static firstByQueueId(mixed $_queueId) : mixed
Parameters
- $_queueId : mixed
getArguments()
public
getArguments() : array<string|int, mixed>|string
Return values
array<string|int, mixed>|string —Array in normal context, string in onSave
getCache()
public
getCache([mixed $_key = '' ][, mixed $_default = '' ]) : mixed
Parameters
- $_key : mixed = ''
- $_default : mixed = ''
getClass()
public
getClass() : mixed
getCreateTime()
public
getCreateTime() : mixed
getFunction()
public
getFunction() : mixed
getHumanName()
public
getHumanName() : mixed
getId()
public
getId() : mixed
getLastRun()
public
getLastRun() : mixed
getOptions()
public
getOptions([mixed $_key = '' ][, mixed $_default = '' ]) : mixed
Parameters
- $_key : mixed = ''
- $_default : mixed = ''
getPID()
public
getPID([mixed $_default = null ]) : mixed
Parameters
- $_default : mixed = null
getQueueId()
public
getQueueId() : mixed
getState()
public
getState() : mixed
getTimeout()
public
getTimeout() : mixed
halt()
public
halt() : mixed
initialize()
public
initialize() : void
postSave()
public
postSave() : void
preSave()
public
preSave() : mixed
refresh()
public
refresh() : mixed
remove()
public
remove([mixed $halt_before = true ]) : mixed
Parameters
- $halt_before : mixed = true
run()
public
run([mixed $_noErrorReport = false ]) : mixed
Parameters
- $_noErrorReport : mixed = false
running()
public
running() : mixed
save()
public
save([mixed $_direct = false ]) : mixed
Parameters
- $_direct : mixed = false
setArguments()
public
setArguments(array<string|int, mixed> $_arguments) : self
Parameters
- $_arguments : array<string|int, mixed>
-
Arguments as array or serialized arguments
Return values
selfsetCache()
public
setCache(mixed $_key[, mixed $_value = null ]) : mixed
Parameters
- $_key : mixed
- $_value : mixed = null
setClass()
public
setClass(mixed $_class) : mixed
Parameters
- $_class : mixed
setCreateTime()
public
setCreateTime(mixed $_createTime) : mixed
Parameters
- $_createTime : mixed
setFunction()
public
setFunction(mixed $_function) : mixed
Parameters
- $_function : mixed
setId()
public
setId(mixed $_id) : mixed
Parameters
- $_id : mixed
setLastRun()
public
setLastRun(mixed $_lastRun) : mixed
Parameters
- $_lastRun : mixed
setOptions()
public
setOptions(mixed $_options) : mixed
Parameters
- $_options : mixed
setPID()
public
setPID([mixed $pid = null ]) : mixed
Parameters
- $pid : mixed = null
setQueueId()
public
setQueueId(mixed $_queueId) : mixed
Parameters
- $_queueId : mixed
setState()
public
setState(mixed $state) : mixed
Parameters
- $state : mixed
setTimeout()
public
setTimeout(mixed $_timeout) : mixed
Parameters
- $_timeout : mixed
start()
public
start() : mixed
stop()
public
stop() : mixed
toArray()
public
toArray() : mixed
getSerializedArguments()
private
getSerializedArguments() : string
Return values
stringgetUnserializedArguments()
private
getUnserializedArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>setSerializedArguments()
private
setSerializedArguments(string $arguments) : void
Parameters
- $arguments : string