JobApiBeforeRemoveComponent
extends AbstractJobHandlerComponent
in package
uses
SimpleRollbackComponent
Table of Contents
Constants
- SUPPORTED_JOB_ACTION_LIST = [\Vatjar\Jobs\Model\Job::MAIN_ACTION_API => [\Vatjar\Jobs\Model\Job::SUB_ACTION_BEFORE_REMOVE]]
Properties
- $job : Job
- $jobList : array<string|int, Job>
- $helperComponent : mixed
- $lockList : FSLock[string]
- $opt : array<string|int, mixed>
Methods
- __construct() : mixed
- afterHandle() : JobResult
- beforeHandle() : mixed
- canBeReset() : bool
- create() : static
- createAndHandle() : mixed
- doRollbackToJob() : bool
- getHelperComponent() : mixed
- Get the value of helperComponent
- getJob() : Job
- getJobList() : array<string|int, Job>
- getJobParameters() : array<string|int, mixed>
- getLockNameListForHandle() : mixed
- getLockPrefix() : string
- getOpt() : array<string|int, mixed>
- getOptUser() : mixed
- getOptUserId() : mixed
- getOptVal() : mixed
- getOptValOr() : mixed
- handle() : JobResult
- handleJob() : mixed
- handleLock() : mixed
- hasOptKey() : mixed
- loadJobList() : mixed
- lock() : bool
- markJobResetAsFailed() : bool
- setHelperComponent() : self
- Set the value of helperComponent
- setJob() : mixed
- setOpt() : static
- support() : bool
- unlock() : void
- updateMovementCredit() : mixed
- updateMovementProduct() : mixed
- _handle() : JobResult
Constants
SUPPORTED_JOB_ACTION_LIST
public
mixed
SUPPORTED_JOB_ACTION_LIST
= [\Vatjar\Jobs\Model\Job::MAIN_ACTION_API => [\Vatjar\Jobs\Model\Job::SUB_ACTION_BEFORE_REMOVE]]
Properties
$job
protected
Job
$job
$jobList
protected
array<string|int, Job>
$jobList
$helperComponent
private
mixed
$helperComponent
= null
$lockList
private
FSLock[string]
$lockList
= []
$opt
private
array<string|int, mixed>
$opt
Methods
__construct()
public
__construct([Job $job = null ][, array<string|int, mixed> $opt = null ]) : mixed
Parameters
- $job : Job = null
- $opt : array<string|int, mixed> = null
afterHandle()
public
afterHandle(JobResult $jobResult) : JobResult
Parameters
- $jobResult : JobResult
Return values
JobResultbeforeHandle()
public
beforeHandle() : mixed
canBeReset()
public
canBeReset(Job $job) : bool
Parameters
- $job : Job
Return values
boolcreate()
public
static create([Job $job = null ][, array<string|int, mixed> $opt = null ]) : static
Parameters
- $job : Job = null
- $opt : array<string|int, mixed> = null
Return values
staticcreateAndHandle()
public
static createAndHandle([Job $job = null ][, array<string|int, mixed> $opt = null ]) : mixed
Parameters
- $job : Job = null
- $opt : array<string|int, mixed> = null
doRollbackToJob()
public
doRollbackToJob(Job $job) : bool
Parameters
- $job : Job
Return values
boolgetHelperComponent()
Get the value of helperComponent
public
getHelperComponent() : mixed
getJob()
public
getJob() : Job
Return values
JobgetJobList()
public
getJobList() : array<string|int, Job>
Return values
array<string|int, Job>getJobParameters()
public
getJobParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>getLockNameListForHandle()
public
getLockNameListForHandle() : mixed
getLockPrefix()
public
getLockPrefix() : string
Return values
stringgetOpt()
public
getOpt([array<string|int, mixed> $opt = null ]) : array<string|int, mixed>
Parameters
- $opt : array<string|int, mixed> = null
Return values
array<string|int, mixed>getOptUser()
public
getOptUser() : mixed
getOptUserId()
public
getOptUserId() : mixed
getOptVal()
public
getOptVal(string $key) : mixed
Parameters
- $key : string
getOptValOr()
public
getOptValOr(string $key[, mixed $or = null ]) : mixed
Parameters
- $key : string
- $or : mixed = null
handle()
public
handle() : JobResult
Return values
JobResulthandleJob()
public
handleJob(Job $job[, array<string|int, mixed> $opt = null ]) : mixed
Parameters
- $job : Job
- $opt : array<string|int, mixed> = null
handleLock()
public
handleLock() : mixed
hasOptKey()
public
hasOptKey(string $key) : mixed
Parameters
- $key : string
loadJobList()
public
loadJobList() : mixed
Tags
lock()
public
lock([array<string|int, mixed> $lockNameList = [] ]) : bool
Parameters
- $lockNameList : array<string|int, mixed> = []
Tags
Return values
boolmarkJobResetAsFailed()
public
markJobResetAsFailed(Job $job, int $progress) : bool
Parameters
- $job : Job
- $progress : int
Return values
boolsetHelperComponent()
Set the value of helperComponent
public
setHelperComponent(mixed $helperComponent) : self
Parameters
- $helperComponent : mixed
Return values
selfsetJob()
public
setJob(Job $job) : mixed
Parameters
- $job : Job
setOpt()
public
setOpt(array<string|int, mixed> $opt) : static
Parameters
- $opt : array<string|int, mixed>
Return values
staticsupport()
public
static support(Job $job) : bool
Parameters
- $job : Job
Return values
boolunlock()
public
unlock() : void
updateMovementCredit()
public
updateMovementCredit(int $userId) : mixed
Parameters
- $userId : int
updateMovementProduct()
public
updateMovementProduct(int $userId) : mixed
Parameters
- $userId : int
_handle()
protected
_handle() : JobResult