Arikaim CMS

RecurringJob extends Job
in package
implements JobInterface, RecurringJobInterface Uses Recurring

AbstractYes

Base class for all Recurring jobs

Table of Contents

Interfaces

JobInterface
Job interface
RecurringJobInterface
Job recurring interface

Properties

$dateCreated  : int|null
Date added to queue
$dateExecuted  : int|null
Execution timestamp
$descriptor  : object|null
Descriptor instance
$descriptorClass  : null|string
Descriptor class
$extension  : string|null
Extension name
$id  : string|int|null
Unique job id
$interval  : string|null
Recuring interval
$name  : string|null
Job name
$params  : array<string|int, mixed>
Job params
$priority  : int
Priority
$queue  : string|null
Queue name
$result  : object
Job result
$scheduleTime  : int|null
Scheduled date time (timestamp)
$status  : int
Job status

Methods

__construct()  : mixed
Constructor
__set()  : void
Set
addError()  : void
Add error
descriptor()  : object|null
Get descriptor
execute()  : mixed
Job code
getDateCreated()  : int|null
Get date created
getDateExecuted()  : int|null
Get execution timestamp
getDueDate()  : int
Get next run date time timestamp
getErrors()  : array<string|int, mixed>
Get execution errors
getExtensionName()  : string|null
Get extension name
getId()  : string|null
Get id
getName()  : string|null
Get name
getNextRunDate()  : int|false
Get next run date
getParam()  : mixed
Get param value
getParams()  : array<string|int, mixed>
Get hjob params
getPriority()  : int
Get priority
getQueue()  : string|null
Get queue
getRecurringInterval()  : string|null
RecurringJobInterface implementation function
getScheduleTime()  : int|null
ScheduledJobInterface implementation
getStatus()  : int
Get job status
hasSuccess()  : bool
Return true if job is executed successful
init()  : void
Init job
isDue()  : bool
Return true if job is due
isRecurring()  : bool
Return true if job is recurring
result()  : object
Get job result object
runAt()  : ScheduledJob
Set scheduled time
setDateCreated()  : void
Set date pused to queue
setDateExecuted()  : void
Set execution date
setDescriptorClass()  : void
Set descriptor class
setExtensionName()  : void
Set extension name
setId()  : void
Set id
setName()  : void
Set name
setParam()  : void
Set param
setParams()  : void
Set job params
setPriority()  : void
Set priority
setQueue()  : void
Set executuion Queue (null for any)
setRecurringInterval()  : void
Set recurring interval
setScheduleTime()  : object
Set scheduled time (timestamp)
setStatus()  : void
Set job status
toArray()  : array<string|int, mixed>
Convert to array
initDescriptor()  : void
Init descriptor properties

Properties

$dateCreated

Date added to queue

protected int|null $dateCreated = null

$dateExecuted

Execution timestamp

protected int|null $dateExecuted = null

$descriptor

Descriptor instance

protected object|null $descriptor = null

$descriptorClass

Descriptor class

protected null|string $descriptorClass = null

$extension

Extension name

protected string|null $extension = null

$id

Unique job id

protected string|int|null $id = null

$interval

Recuring interval

protected string|null $interval = null

$name

Job name

protected string|null $name = null

$params

Job params

protected array<string|int, mixed> $params = []

$priority

Priority

protected int $priority = 0

$queue

Queue name

protected string|null $queue = null

$result

Job result

protected object $result

$scheduleTime

Scheduled date time (timestamp)

protected int|null $scheduleTime = null

$status

Job status

protected int $status = \Arikaim\Core\Interfaces\Job\JobInterface::STATUS_CREATED

Methods

__construct()

Constructor

public __construct([string|null $extension = null ][, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$extension : string|null = null
$params : array<string|int, mixed> = []

__set()

Set

public __set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

addError()

Add error

public addError(string $errorMessage) : void
Parameters
$errorMessage : string

descriptor()

Get descriptor

public descriptor() : object|null
Return values
object|null

execute()

Job code

public abstract execute() : mixed

getDateCreated()

Get date created

public getDateCreated() : int|null
Return values
int|null

getDateExecuted()

Get execution timestamp

public getDateExecuted() : int|null
Return values
int|null

getDueDate()

Get next run date time timestamp

public getDueDate() : int
Return values
int

getErrors()

Get execution errors

public getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExtensionName()

Get extension name

public getExtensionName() : string|null
Return values
string|null

getId()

Get id

public getId() : string|null
Return values
string|null

getName()

Get name

public getName() : string|null
Return values
string|null

getNextRunDate()

Get next run date

public static getNextRunDate(string $interval[, int|null $dateLastExecution = null ]) : int|false
Parameters
$interval : string
$dateLastExecution : int|null = null
Return values
int|false

getParam()

Get param value

public getParam(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getParams()

Get hjob params

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPriority()

Get priority

public getPriority() : int
Return values
int

getQueue()

Get queue

public getQueue() : string|null
Return values
string|null

getRecurringInterval()

RecurringJobInterface implementation function

public getRecurringInterval() : string|null
Return values
string|null

getScheduleTime()

ScheduledJobInterface implementation

public getScheduleTime() : int|null
Return values
int|null

getStatus()

Get job status

public getStatus() : int
Return values
int

hasSuccess()

Return true if job is executed successful

public hasSuccess() : bool
Return values
bool

init()

Init job

public init() : void

isDue()

Return true if job is due

public isDue() : bool
Return values
bool

isRecurring()

Return true if job is recurring

public isRecurring() : bool
Return values
bool

result()

Get job result object

public result() : object
Return values
object

runAt()

Set scheduled time

public runAt(string $date) : ScheduledJob
Parameters
$date : string
Return values
ScheduledJob

setDateCreated()

Set date pused to queue

public setDateCreated(int|null $time) : void
Parameters
$time : int|null

timestamp

setDateExecuted()

Set execution date

public setDateExecuted(int|null $time) : void
Parameters
$time : int|null

timestamp

setDescriptorClass()

Set descriptor class

public setDescriptorClass(string $class) : void
Parameters
$class : string

setExtensionName()

Set extension name

public setExtensionName(string|null $name) : void
Parameters
$name : string|null

setId()

Set id

public setId(string|null $id) : void
Parameters
$id : string|null

setName()

Set name

public setName(string|null $name) : void
Parameters
$name : string|null

setParam()

Set param

public setParam(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

setParams()

Set job params

public setParams(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>

setPriority()

Set priority

public setPriority(int $priority) : void
Parameters
$priority : int

setQueue()

Set executuion Queue (null for any)

public setQueue(string|null $name) : void
Parameters
$name : string|null

setRecurringInterval()

Set recurring interval

public setRecurringInterval(string $interval) : void
Parameters
$interval : string

setScheduleTime()

Set scheduled time (timestamp)

public setScheduleTime(int $timestamp) : object
Parameters
$timestamp : int
Return values
object

setStatus()

Set job status

public setStatus(int $status) : void
Parameters
$status : int

toArray()

Convert to array

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

initDescriptor()

Init descriptor properties

protected initDescriptor() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results