PHP Класс Cronario\AbstractJob

Наследование: implements Serializable, use trait Cronario\TraitOptions
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$callbacks array
$data array
$result Cronario\Exception\ResultException
$resultClass
$workerClass null | string

Открытые методы

Метод Описание
__clone ( )
__construct ( array $options = [] )
__invoke ( AbstractJob $parentJob = null ) : ResultException | null
addAttempts ( integer $inc = 1 ) : AbstractJob
addData ( $key, $value )
addDebug ( $value )
countAttemptQueueDelay ( ) : integer
getAppId ( ) : array | integer | null | string
getAttemptDelay ( ) : integer
getAttemptStrategy ( ) : integer | null | string
getAttempts ( ) : integer
getAttemptsMax ( ) : integer | null | string
getAuthor ( ) : mixed
getCallbacks ( ) : array
getCallbacksByType ( $type ) : array
getCallbacksDone ( ) : mixed
getCallbacksError ( ) : mixed
getCallbacksFailure ( ) : mixed
getCallbacksSuccess ( ) : mixed
getComment ( ) : integer | null | string
getCreateOn ( ) : integer | null | string
getData ( null $key = null, null $default = null ) : string | integer | null
getDebug ( ) : null | array
getDeleteOn ( ) : integer | null | string
getExpiredOn ( ) : null
getFinishOn ( ) : null
getId ( ) : mixed
getJobClass ( ) : string
getParam ( null $key = null, null $default = null ) : string | integer | null
getPriority ( ) : null
getQueueDelay ( ) : mixed
getResult ( ) : ResultException | null
getSchedule ( ) : integer | null | string
getScheduleDelay ( ) : integer
getStartOn ( ) : mixed
getWorkerClass ( ) : string
hasAttempt ( ) : boolean
hasData ( $key ) : boolean
hasParam ( $key ) : boolean
isDebug ( ) : integer | null | string
isStored ( ) : boolean
isSync ( ) : boolean
putIntoQueue ( )
save ( )
serialize ( ) : string
setAppId ( $appId ) : AbstractJob
setAttemptDelay ( $attemptDelay ) : AbstractJob
setAttemptStrategy ( $attemptStrategy ) : AbstractJob
setAttempts ( $value ) : AbstractJob
setAttemptsMax ( $attemptMax ) : AbstractJob
setAuthor ( $author )
setCallbackDone ( $job ) : AbstractJob
setCallbackError ( $job ) : AbstractJob
setCallbackFailure ( $job ) : AbstractJob
setCallbackSuccess ( $job ) : AbstractJob
setCallbacks ( array $callbacks = [] )
setComment ( $comment ) : AbstractJob
setCreateOn ( $value ) : AbstractJob
setData ( $key, $value )
setDebug ( $debug ) : AbstractJob
setDeleteOn ( $value ) : AbstractJob
setExpiredOn ( $value ) : AbstractJob
setId ( $id ) : AbstractJob
setParam ( $key, $value )
setParams ( array $params = [] )
setPriority ( $priority ) : AbstractJob
setResult ( $result, null $data = null ) : ResultException | mixed
setSchedule ( $schedule ) : AbstractJob
setStartOn ( $value ) : AbstractJob
setSync ( $bool ) : AbstractJob
setWorkerClass ( $class ) : AbstractJob
unserialize ( string $serialized )
unsetData ( $key )

Защищенные методы

Метод Описание
addCallbackJob ( $type, $job )
addDefaultData ( )
getParentId ( ) : integer | null | string
getProducer ( ) region Storage Queue ***********************************************************
getQueue ( ) : Queue
getStorage ( ) : Cronario\Storage\StorageInterface
init ( ) Template Method
setJobClass ( $class ) : AbstractJob
setParentId ( $parentId ) : AbstractJob

Описание методов

__clone() публичный Метод

public __clone ( )

__construct() публичный Метод

public __construct ( array $options = [] )
$options array

__invoke() публичный Метод

public __invoke ( AbstractJob $parentJob = null ) : ResultException | null
$parentJob AbstractJob
Результат Cronario\Exception\ResultException | null

addAttempts() публичный Метод

public addAttempts ( integer $inc = 1 ) : AbstractJob
$inc integer
Результат AbstractJob

addCallbackJob() защищенный Метод

protected addCallbackJob ( $type, $job )
$type
$job

addData() публичный Метод

public addData ( $key, $value )
$key
$value

addDebug() публичный Метод

public addDebug ( $value )
$value

addDefaultData() защищенный Метод

protected addDefaultData ( )

countAttemptQueueDelay() публичный Метод

public countAttemptQueueDelay ( ) : integer
Результат integer

getAppId() публичный Метод

public getAppId ( ) : array | integer | null | string
Результат array | integer | null | string

getAttemptDelay() публичный Метод

public getAttemptDelay ( ) : integer
Результат integer

getAttemptStrategy() публичный Метод

public getAttemptStrategy ( ) : integer | null | string
Результат integer | null | string

getAttempts() публичный Метод

public getAttempts ( ) : integer
Результат integer

getAttemptsMax() публичный Метод

public getAttemptsMax ( ) : integer | null | string
Результат integer | null | string

getAuthor() публичный Метод

public getAuthor ( ) : mixed
Результат mixed

getCallbacks() публичный Метод

public getCallbacks ( ) : array
Результат array

getCallbacksByType() публичный Метод

public getCallbacksByType ( $type ) : array
$type
Результат array

getCallbacksDone() публичный Метод

public getCallbacksDone ( ) : mixed
Результат mixed

getCallbacksError() публичный Метод

public getCallbacksError ( ) : mixed
Результат mixed

getCallbacksFailure() публичный Метод

public getCallbacksFailure ( ) : mixed
Результат mixed

getCallbacksSuccess() публичный Метод

public getCallbacksSuccess ( ) : mixed
Результат mixed

getComment() публичный Метод

public getComment ( ) : integer | null | string
Результат integer | null | string

getCreateOn() публичный Метод

public getCreateOn ( ) : integer | null | string
Результат integer | null | string

getData() публичный Метод

public getData ( null $key = null, null $default = null ) : string | integer | null
$key null
$default null
Результат string | integer | null

getDebug() публичный Метод

public getDebug ( ) : null | array
Результат null | array

getDeleteOn() публичный Метод

public getDeleteOn ( ) : integer | null | string
Результат integer | null | string

getExpiredOn() публичный Метод

public getExpiredOn ( ) : null
Результат null

getFinishOn() публичный Метод

public getFinishOn ( ) : null
Результат null

getId() публичный Метод

public getId ( ) : mixed
Результат mixed

getJobClass() публичный Метод

public getJobClass ( ) : string
Результат string

getParam() публичный Метод

public getParam ( null $key = null, null $default = null ) : string | integer | null
$key null
$default null
Результат string | integer | null

getParentId() защищенный Метод

protected getParentId ( ) : integer | null | string
Результат integer | null | string

getPriority() публичный Метод

public getPriority ( ) : null
Результат null

getProducer() защищенный Метод

region Storage Queue ***********************************************************
protected getProducer ( )

getQueue() защищенный Метод

protected getQueue ( ) : Queue
Результат Queue

getQueueDelay() публичный Метод

public getQueueDelay ( ) : mixed
Результат mixed

getResult() публичный Метод

public getResult ( ) : ResultException | null
Результат Cronario\Exception\ResultException | null

getSchedule() публичный Метод

public getSchedule ( ) : integer | null | string
Результат integer | null | string

getScheduleDelay() публичный Метод

public getScheduleDelay ( ) : integer
Результат integer return -1 : if schedule is not set return x >= 0 : if schedule is set

getStartOn() публичный Метод

public getStartOn ( ) : mixed
Результат mixed

getStorage() защищенный Метод

protected getStorage ( ) : Cronario\Storage\StorageInterface
Результат Cronario\Storage\StorageInterface

getWorkerClass() публичный Метод

public getWorkerClass ( ) : string
Результат string

hasAttempt() публичный Метод

public hasAttempt ( ) : boolean
Результат boolean

hasData() публичный Метод

public hasData ( $key ) : boolean
$key
Результат boolean

hasParam() публичный Метод

public hasParam ( $key ) : boolean
$key
Результат boolean

init() защищенный Метод

Template Method
protected init ( )

isDebug() публичный Метод

public isDebug ( ) : integer | null | string
Результат integer | null | string

isStored() публичный Метод

public isStored ( ) : boolean
Результат boolean

isSync() публичный Метод

public isSync ( ) : boolean
Результат boolean

putIntoQueue() публичный Метод

public putIntoQueue ( )

save() публичный Метод

public save ( )

serialize() публичный Метод

public serialize ( ) : string
Результат string

setAppId() публичный Метод

public setAppId ( $appId ) : AbstractJob
$appId
Результат AbstractJob

setAttemptDelay() публичный Метод

public setAttemptDelay ( $attemptDelay ) : AbstractJob
$attemptDelay
Результат AbstractJob

setAttemptStrategy() публичный Метод

public setAttemptStrategy ( $attemptStrategy ) : AbstractJob
$attemptStrategy
Результат AbstractJob

setAttempts() публичный Метод

public setAttempts ( $value ) : AbstractJob
$value
Результат AbstractJob

setAttemptsMax() публичный Метод

public setAttemptsMax ( $attemptMax ) : AbstractJob
$attemptMax
Результат AbstractJob

setAuthor() публичный Метод

public setAuthor ( $author )
$author

setCallbackDone() публичный Метод

public setCallbackDone ( $job ) : AbstractJob
$job
Результат AbstractJob

setCallbackError() публичный Метод

public setCallbackError ( $job ) : AbstractJob
$job
Результат AbstractJob

setCallbackFailure() публичный Метод

public setCallbackFailure ( $job ) : AbstractJob
$job
Результат AbstractJob

setCallbackSuccess() публичный Метод

public setCallbackSuccess ( $job ) : AbstractJob
$job
Результат AbstractJob

setCallbacks() публичный Метод

public setCallbacks ( array $callbacks = [] )
$callbacks array

setComment() публичный Метод

public setComment ( $comment ) : AbstractJob
$comment
Результат AbstractJob

setCreateOn() публичный Метод

public setCreateOn ( $value ) : AbstractJob
$value
Результат AbstractJob

setData() публичный Метод

public setData ( $key, $value )
$key
$value

setDebug() публичный Метод

public setDebug ( $debug ) : AbstractJob
$debug
Результат AbstractJob

setDeleteOn() публичный Метод

public setDeleteOn ( $value ) : AbstractJob
$value
Результат AbstractJob

setExpiredOn() публичный Метод

public setExpiredOn ( $value ) : AbstractJob
$value
Результат AbstractJob

setId() публичный Метод

public setId ( $id ) : AbstractJob
$id
Результат AbstractJob

setJobClass() защищенный Метод

protected setJobClass ( $class ) : AbstractJob
$class
Результат AbstractJob

setParam() публичный Метод

public setParam ( $key, $value )
$key
$value

setParams() публичный Метод

public setParams ( array $params = [] )
$params array

setParentId() защищенный Метод

protected setParentId ( $parentId ) : AbstractJob
$parentId
Результат AbstractJob

setPriority() публичный Метод

public setPriority ( $priority ) : AbstractJob
$priority
Результат AbstractJob

setResult() публичный Метод

public setResult ( $result, null $data = null ) : ResultException | mixed
$result
$data null
Результат Cronario\Exception\ResultException | mixed

setSchedule() публичный Метод

public setSchedule ( $schedule ) : AbstractJob
$schedule
Результат AbstractJob

setStartOn() публичный Метод

public setStartOn ( $value ) : AbstractJob
$value
Результат AbstractJob

setSync() публичный Метод

public setSync ( $bool ) : AbstractJob
$bool
Результат AbstractJob

setWorkerClass() публичный Метод

public setWorkerClass ( $class ) : AbstractJob
$class
Результат AbstractJob

unserialize() публичный Метод

public unserialize ( string $serialized )
$serialized string

unsetData() публичный Метод

public unsetData ( $key )
$key

Описание свойств

$callbacks защищенное свойство

protected array $callbacks
Результат array

$data защищенное свойство

protected array $data
Результат array

$result защищенное свойство

protected ResultException,Cronario\Exception $result
Результат Cronario\Exception\ResultException

$resultClass защищенное статическое свойство

protected static $resultClass

$workerClass защищенное свойство

protected null|string $workerClass
Результат null | string