JobChangeableReportRegenerateComponent
extends AbstractJobHandlerComponent
in package
Table of Contents
Constants
- SUPPORTED_JOB_ACTION_LIST = [\Vatjar\Jobs\Model\Job::MAIN_ACTION_ENTRY => [\Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_REFRESH_CHANGEABLE_REPORT_LIST, \Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_FORCE_CREATE_CHANGEABLE_REPORT_LIST]]
- JOB_ACTION = [\Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_REFRESH_CHANGEABLE_REPORT_LIST => 'handleRefresh', \Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_FORCE_CREATE_CHANGEABLE_REPORT_LIST => 'handleForceCreate']
Properties
- $job : Job
- $jobList : array<string|int, Job>
- $entityManager : EntityManager|null
- $lockList : FSLock[string]
- $opt : array<string|int, mixed>
- $reportRegenerateService : ReportRegenerateService|null
Methods
- __construct() : mixed
- afterHandle() : JobResult
- beforeHandle() : mixed
- create() : static
- createAndHandle() : mixed
- 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
- setJob() : mixed
- setOpt() : static
- support() : bool
- unlock() : void
- _handle() : JobResult
- deleteProformaPreliminaryZip() : mixed
- deleteProformaPreliminaryZipIfEntryIsEC() : mixed
- getEntityManager() : EntityManager
- getEntries() : mixed
- getEntryIdList() : mixed
- getReportRegenerateService() : mixed
- handleForceCreate() : mixed
- handleRefresh() : mixed
- setReportDefaultValues() : mixed
- skipReportGeneration() : mixed
Constants
SUPPORTED_JOB_ACTION_LIST
public
mixed
SUPPORTED_JOB_ACTION_LIST
= [\Vatjar\Jobs\Model\Job::MAIN_ACTION_ENTRY => [\Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_REFRESH_CHANGEABLE_REPORT_LIST, \Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_FORCE_CREATE_CHANGEABLE_REPORT_LIST]]
JOB_ACTION
private
mixed
JOB_ACTION
= [\Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_REFRESH_CHANGEABLE_REPORT_LIST => 'handleRefresh', \Vatjar\Jobs\Model\Job::SUB_ACTION_ENTRY_FORCE_CREATE_CHANGEABLE_REPORT_LIST => 'handleForceCreate']
Properties
$job
protected
Job
$job
$jobList
protected
array<string|int, Job>
$jobList
$entityManager
private
EntityManager|null
$entityManager
$lockList
private
FSLock[string]
$lockList
= []
$opt
private
array<string|int, mixed>
$opt
$reportRegenerateService
private
ReportRegenerateService|null
$reportRegenerateService
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
Tags
Return values
JobResultbeforeHandle()
public
beforeHandle() : mixed
create()
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
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
boolsetJob()
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
_handle()
protected
_handle() : JobResult
Return values
JobResultdeleteProformaPreliminaryZip()
private
deleteProformaPreliminaryZip(mixed $id) : mixed
Parameters
- $id : mixed
deleteProformaPreliminaryZipIfEntryIsEC()
private
deleteProformaPreliminaryZipIfEntryIsEC(mixed $entry) : mixed
Parameters
- $entry : mixed
getEntityManager()
private
getEntityManager() : EntityManager
Return values
EntityManagergetEntries()
private
getEntries(array<string|int, mixed> $entryIdList) : mixed
Parameters
- $entryIdList : array<string|int, mixed>
getEntryIdList()
private
getEntryIdList(Job $job) : mixed
Parameters
- $job : Job
getReportRegenerateService()
private
getReportRegenerateService() : mixed
handleForceCreate()
private
handleForceCreate() : mixed
handleRefresh()
private
handleRefresh() : mixed
setReportDefaultValues()
private
setReportDefaultValues(Report $report) : mixed
Parameters
- $report : Report
skipReportGeneration()
private
skipReportGeneration(Report $report) : mixed
Parameters
- $report : Report