1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Queue
  7. \
  8. Jobs
  9. \
  10. Job

Job

abstract class Job implements JobInterface

Base class for all jobs

Properties

protected string|integer|null $id Unique job id
protected string|null $name Job name
protected integer $priority Priority
protected string|null $extension Extension name
protected int $status Job status
protected array $errors Execution errors
protected int|null $dateExecuted Execution timestamp
protected int|null $dateCreated Date added to queue
protected string|null $queue Queue name
protected array $params Job params

Methods

void
execute()

Job code

__construct(string|null $extension = null, string|null $name = null, array $params = [])

Constructor

void
setParam(string $name, mixed $value)

Set param

mixed
getParam(string $name, mixed $default = null)

Get param value

void
init()

Init job

array
toArray()

Convert to array

array
getErrors()

Get execution errors

void
addError(string $errorMessage)

Add error

bool
hasSuccess()

Return true if job is executed successful

int|null
getDateExecuted()

Get execution timestamp

int|null
getDateCreated()

Get date created

void
setDateExecuted(int|null $time)

Set execution date

void
setDateCreated(int|null $time)

Set date pused to queue

int
getStatus()

Get job status

void
setStatus(int $status)

Set job status

void
__set(string $name, mixed $value)

Set

void
setId(string|null $id)

Set id

string|null
getId()

Get id

string|null
getExtensionName()

Get extension name

string|null
getName()

Get name

int
getPriority()

Get priority

void
setName(string|null $name)

Set name

void
setPriority(int $priority)

Set priority

void
setExtensionName(string|null $name)

Set extension name

void
setQueue(string|null $name)

Set executuion Queue (null for any)

string|null
getQueue()

Get queue

Details

at line 95
abstract void execute()

Job code

Return Value

void

at line 104
__construct(string|null $extension = null, string|null $name = null, array $params = [])

Constructor

Parameters

string|null $extension
string|null $name
array $params

at line 125
void setParam(string $name, mixed $value)

Set param

Parameters

string $name
mixed $value

Return Value

void

at line 137
mixed getParam(string $name, mixed $default = null)

Get param value

Parameters

string $name
mixed $default

Return Value

mixed

at line 147
void init()

Init job

Return Value

void

at line 156
array toArray()

Convert to array

Return Value

array

at line 177
array getErrors()

Get execution errors

Return Value

array

at line 188
void addError(string $errorMessage)

Add error

Parameters

string $errorMessage

Return Value

void

at line 198
bool hasSuccess()

Return true if job is executed successful

Return Value

bool

at line 208
int|null getDateExecuted()

Get execution timestamp

Return Value

int|null

at line 218
int|null getDateCreated()

Get date created

Return Value

int|null

at line 229
void setDateExecuted(int|null $time)

Set execution date

Parameters

int|null $time timestamp

Return Value

void

at line 240
void setDateCreated(int|null $time)

Set date pused to queue

Parameters

int|null $time timestamp

Return Value

void

at line 250
int getStatus()

Get job status

Return Value

int

at line 261
void setStatus(int $status)

Set job status

Parameters

int $status

Return Value

void

at line 275
void __set(string $name, mixed $value)

Set

Parameters

string $name
mixed $value

Return Value

void

at line 286
void setId(string|null $id)

Set id

Parameters

string|null $id

Return Value

void

at line 296
string|null getId()

Get id

Return Value

string|null

at line 306
string|null getExtensionName()

Get extension name

Return Value

string|null

at line 316
string|null getName()

Get name

Return Value

string|null

at line 326
int getPriority()

Get priority

Return Value

int

at line 337
void setName(string|null $name)

Set name

Parameters

string|null $name

Return Value

void

at line 348
void setPriority(int $priority)

Set priority

Parameters

int $priority

Return Value

void

at line 359
void setExtensionName(string|null $name)

Set extension name

Parameters

string|null $name

Return Value

void

at line 370
void setQueue(string|null $name)

Set executuion Queue (null for any)

Parameters

string|null $name

Return Value

void

at line 380
string|null getQueue()

Get queue

Return Value

string|null