PHP Class Cronario\AbstractJob

Inheritance: implements Serializable, use trait Cronario\TraitOptions
Afficher le fichier Open project: cronario/cronario Class Usage Examples

Protected Properties

Свойство Type Description
$callbacks array
$data array
$result Cronario\Exception\ResultException
$resultClass
$workerClass null | string

Méthodes publiques

Méthode Description
__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 )

Méthodes protégées

Méthode Description
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

Method Details

__clone() public méthode

public __clone ( )

__construct() public méthode

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

__invoke() public méthode

public __invoke ( AbstractJob $parentJob = null ) : ResultException | null
$parentJob AbstractJob
Résultat Cronario\Exception\ResultException | null

addAttempts() public méthode

public addAttempts ( integer $inc = 1 ) : AbstractJob
$inc integer
Résultat AbstractJob

addCallbackJob() protected méthode

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

addData() public méthode

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

addDebug() public méthode

public addDebug ( $value )
$value

addDefaultData() protected méthode

protected addDefaultData ( )

countAttemptQueueDelay() public méthode

public countAttemptQueueDelay ( ) : integer
Résultat integer

getAppId() public méthode

public getAppId ( ) : array | integer | null | string
Résultat array | integer | null | string

getAttemptDelay() public méthode

public getAttemptDelay ( ) : integer
Résultat integer

getAttemptStrategy() public méthode

public getAttemptStrategy ( ) : integer | null | string
Résultat integer | null | string

getAttempts() public méthode

public getAttempts ( ) : integer
Résultat integer

getAttemptsMax() public méthode

public getAttemptsMax ( ) : integer | null | string
Résultat integer | null | string

getAuthor() public méthode

public getAuthor ( ) : mixed
Résultat mixed

getCallbacks() public méthode

public getCallbacks ( ) : array
Résultat array

getCallbacksByType() public méthode

public getCallbacksByType ( $type ) : array
$type
Résultat array

getCallbacksDone() public méthode

public getCallbacksDone ( ) : mixed
Résultat mixed

getCallbacksError() public méthode

public getCallbacksError ( ) : mixed
Résultat mixed

getCallbacksFailure() public méthode

public getCallbacksFailure ( ) : mixed
Résultat mixed

getCallbacksSuccess() public méthode

public getCallbacksSuccess ( ) : mixed
Résultat mixed

getComment() public méthode

public getComment ( ) : integer | null | string
Résultat integer | null | string

getCreateOn() public méthode

public getCreateOn ( ) : integer | null | string
Résultat integer | null | string

getData() public méthode

public getData ( null $key = null, null $default = null ) : string | integer | null
$key null
$default null
Résultat string | integer | null

getDebug() public méthode

public getDebug ( ) : null | array
Résultat null | array

getDeleteOn() public méthode

public getDeleteOn ( ) : integer | null | string
Résultat integer | null | string

getExpiredOn() public méthode

public getExpiredOn ( ) : null
Résultat null

getFinishOn() public méthode

public getFinishOn ( ) : null
Résultat null

getId() public méthode

public getId ( ) : mixed
Résultat mixed

getJobClass() public méthode

public getJobClass ( ) : string
Résultat string

getParam() public méthode

public getParam ( null $key = null, null $default = null ) : string | integer | null
$key null
$default null
Résultat string | integer | null

getParentId() protected méthode

protected getParentId ( ) : integer | null | string
Résultat integer | null | string

getPriority() public méthode

public getPriority ( ) : null
Résultat null

getProducer() protected méthode

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

getQueue() protected méthode

protected getQueue ( ) : Queue
Résultat Queue

getQueueDelay() public méthode

public getQueueDelay ( ) : mixed
Résultat mixed

getResult() public méthode

public getResult ( ) : ResultException | null
Résultat Cronario\Exception\ResultException | null

getSchedule() public méthode

public getSchedule ( ) : integer | null | string
Résultat integer | null | string

getScheduleDelay() public méthode

public getScheduleDelay ( ) : integer
Résultat integer return -1 : if schedule is not set return x >= 0 : if schedule is set

getStartOn() public méthode

public getStartOn ( ) : mixed
Résultat mixed

getStorage() protected méthode

protected getStorage ( ) : Cronario\Storage\StorageInterface
Résultat Cronario\Storage\StorageInterface

getWorkerClass() public méthode

public getWorkerClass ( ) : string
Résultat string

hasAttempt() public méthode

public hasAttempt ( ) : boolean
Résultat boolean

hasData() public méthode

public hasData ( $key ) : boolean
$key
Résultat boolean

hasParam() public méthode

public hasParam ( $key ) : boolean
$key
Résultat boolean

init() protected méthode

Template Method
protected init ( )

isDebug() public méthode

public isDebug ( ) : integer | null | string
Résultat integer | null | string

isStored() public méthode

public isStored ( ) : boolean
Résultat boolean

isSync() public méthode

public isSync ( ) : boolean
Résultat boolean

putIntoQueue() public méthode

public putIntoQueue ( )

save() public méthode

public save ( )

serialize() public méthode

public serialize ( ) : string
Résultat string

setAppId() public méthode

public setAppId ( $appId ) : AbstractJob
$appId
Résultat AbstractJob

setAttemptDelay() public méthode

public setAttemptDelay ( $attemptDelay ) : AbstractJob
$attemptDelay
Résultat AbstractJob

setAttemptStrategy() public méthode

public setAttemptStrategy ( $attemptStrategy ) : AbstractJob
$attemptStrategy
Résultat AbstractJob

setAttempts() public méthode

public setAttempts ( $value ) : AbstractJob
$value
Résultat AbstractJob

setAttemptsMax() public méthode

public setAttemptsMax ( $attemptMax ) : AbstractJob
$attemptMax
Résultat AbstractJob

setAuthor() public méthode

public setAuthor ( $author )
$author

setCallbackDone() public méthode

public setCallbackDone ( $job ) : AbstractJob
$job
Résultat AbstractJob

setCallbackError() public méthode

public setCallbackError ( $job ) : AbstractJob
$job
Résultat AbstractJob

setCallbackFailure() public méthode

public setCallbackFailure ( $job ) : AbstractJob
$job
Résultat AbstractJob

setCallbackSuccess() public méthode

public setCallbackSuccess ( $job ) : AbstractJob
$job
Résultat AbstractJob

setCallbacks() public méthode

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

setComment() public méthode

public setComment ( $comment ) : AbstractJob
$comment
Résultat AbstractJob

setCreateOn() public méthode

public setCreateOn ( $value ) : AbstractJob
$value
Résultat AbstractJob

setData() public méthode

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

setDebug() public méthode

public setDebug ( $debug ) : AbstractJob
$debug
Résultat AbstractJob

setDeleteOn() public méthode

public setDeleteOn ( $value ) : AbstractJob
$value
Résultat AbstractJob

setExpiredOn() public méthode

public setExpiredOn ( $value ) : AbstractJob
$value
Résultat AbstractJob

setId() public méthode

public setId ( $id ) : AbstractJob
$id
Résultat AbstractJob

setJobClass() protected méthode

protected setJobClass ( $class ) : AbstractJob
$class
Résultat AbstractJob

setParam() public méthode

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

setParams() public méthode

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

setParentId() protected méthode

protected setParentId ( $parentId ) : AbstractJob
$parentId
Résultat AbstractJob

setPriority() public méthode

public setPriority ( $priority ) : AbstractJob
$priority
Résultat AbstractJob

setResult() public méthode

public setResult ( $result, null $data = null ) : ResultException | mixed
$result
$data null
Résultat Cronario\Exception\ResultException | mixed

setSchedule() public méthode

public setSchedule ( $schedule ) : AbstractJob
$schedule
Résultat AbstractJob

setStartOn() public méthode

public setStartOn ( $value ) : AbstractJob
$value
Résultat AbstractJob

setSync() public méthode

public setSync ( $bool ) : AbstractJob
$bool
Résultat AbstractJob

setWorkerClass() public méthode

public setWorkerClass ( $class ) : AbstractJob
$class
Résultat AbstractJob

unserialize() public méthode

public unserialize ( string $serialized )
$serialized string

unsetData() public méthode

public unsetData ( $key )
$key

Property Details

$callbacks protected_oe property

protected array $callbacks
Résultat array

$data protected_oe property

protected array $data
Résultat array

$result protected_oe property

protected ResultException,Cronario\Exception $result
Résultat Cronario\Exception\ResultException

$resultClass protected_oe static_oe property

protected static $resultClass

$workerClass protected_oe property

protected null|string $workerClass
Résultat null | string