Documentation

JobReportRegenerateComponent extends AbstractJobHandlerComponent
in package
implements JobHandlerProcedureCallListInterface uses JobHandlerProcedureCallListTrait

Table of Contents

Interfaces

JobHandlerProcedureCallListInterface

Constants

SUPPORTED_JOB_ACTION_LIST  = [\Vatjar\Jobs\Model\Job::MAIN_ACTION_REPORT => \Vatjar\Jobs\Model\Job::SUB_ACTION_REPORT_REGENERATE_ALL]

Properties

$job  : Job
$jobList  : array<string|int, Job>
$procedureCallList  : array<string|int, mixed>
$lockList  : FSLock[string]
$opt  : array<string|int, mixed>

Methods

__construct()  : mixed
afterHandle()  : JobResult
beforeHandle()  : mixed
create()  : static
createAndHandle()  : mixed
doProcedureCallList()  : 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
getProcedureCallList()  : mixed
handle()  : JobResult
handleJob()  : mixed
handleLock()  : mixed
hasOptKey()  : mixed
loadJobList()  : mixed
lock()  : bool
setJob()  : mixed
setOpt()  : static
setProcedureCallList()  : mixed
support()  : bool
unlock()  : void
_handle()  : JobResult

Constants

SUPPORTED_JOB_ACTION_LIST

public mixed SUPPORTED_JOB_ACTION_LIST = [\Vatjar\Jobs\Model\Job::MAIN_ACTION_REPORT => \Vatjar\Jobs\Model\Job::SUB_ACTION_REPORT_REGENERATE_ALL]

Properties

$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

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
static

createAndHandle()

public static createAndHandle([Job $job = null ][, array<string|int, mixed> $opt = null ]) : mixed
Parameters
$job : Job = null
$opt : array<string|int, mixed> = null

getLockPrefix()

public getLockPrefix() : string
Return values
string

getOpt()

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

handleJob()

public handleJob(Job $job[, array<string|int, mixed> $opt = null ]) : mixed
Parameters
$job : Job
$opt : array<string|int, mixed> = null

hasOptKey()

public hasOptKey(string $key) : mixed
Parameters
$key : string

lock()

public lock([array<string|int, mixed> $lockNameList = [] ]) : bool
Parameters
$lockNameList : array<string|int, mixed> = []
Tags
throws
LockException
Return values
bool

setOpt()

public setOpt(array<string|int, mixed> $opt) : static
Parameters
$opt : array<string|int, mixed>
Return values
static

setProcedureCallList()

public setProcedureCallList([multitype $procedureCallList = [] ]) : mixed
Parameters
$procedureCallList : multitype = [] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results