1. class
  2. local_middag
  3. \
  4. framework
  5. \
  6. domain
  7. \
  8. job
  9. \
  10. job

job

class job extends abstract_entity implements job_interface

Aggregate root for async command governance.

Methods

mixed
__get(string $name)

Magic getter to allow reading protected properties.

from  abstract_entity
bool
__isset(string $name)

Magic isset to allow checking protected properties.

from  abstract_entity
void
__set(string $name, mixed $value)

Magic setter.

from  abstract_entity
array
jsonSerialize()

Serializes the object to a value that can be natively serialized by json_encode().

from  abstract_entity
__construct(int|null $id = null, string|null $uuid = null, string $extension = 'system', string $jobtype = 'generic', string $transport = 'moodle_adhoc', string $status = 'pending', int $priority = 50, string|null $dedupkey = null, string|null $groupkey = null, string|null $correlationid = null, string|null $subjecttype = null, int|null $subjectid = null, string|null $subjectkey = null, int|null $courseid = null, int|null $userid = null, string|null $payload = null, string|null $runnerref = null, int $attempts = 0, int $maxattempts = 3, int $availableat = 0, int|null $startedat = null, int|null $finishedat = null, int|null $lastattemptat = null, string|null $lastmessage = null, int $timecreated = 0, int $timemodified = 0, array $attempt_log = [])

No description

job
with_status(string $status, string|null $message = null)

No description

job
with_attempt(job_attempt_interface $attempt)

No description

int|null
get_id()

Get the entity unique identifier.

string|null
get_uuid()

No description

string
get_extension()

No description

string
get_jobtype()

No description

string
get_transport()

No description

string
get_status()

No description

int
get_priority()

No description

string|null
get_dedupkey()

No description

string|null
get_groupkey()

No description

string|null
get_correlationid()

No description

string|null
get_subjecttype()

No description

int|null
get_subjectid()

No description

string|null
get_subjectkey()

No description

int|null
get_courseid()

No description

int|null
get_userid()

No description

string|null
get_payload()

No description

string|null
get_runnerref()

No description

int
get_attempts()

No description

int
get_maxattempts()

No description

int
get_availableat()

No description

int|null
get_startedat()

No description

int|null
get_finishedat()

No description

int|null
get_lastattemptat()

No description

string|null
get_lastmessage()

No description

int
get_timecreated()

No description

int
get_timemodified()

No description

array
get_attempt_log()

No description

array
to_array()

No description

Details

in abstract_entity at line 37
mixed __get(string $name)

Magic getter to allow reading protected properties.

Parameters

string $name

Property name

Return Value

mixed

in abstract_entity at line 53
bool __isset(string $name)

Magic isset to allow checking protected properties.

Parameters

string $name

Property name

Return Value

bool

in abstract_entity at line 64
void __set(string $name, mixed $value)

Magic setter.

Parameters

string $name

Property name
mixed $value Value

Return Value

void

in abstract_entity at line 78
array jsonSerialize()

Serializes the object to a value that can be natively serialized by json_encode().

Return Value

array

at line 33
__construct(int|null $id = null, string|null $uuid = null, string $extension = 'system', string $jobtype = 'generic', string $transport = 'moodle_adhoc', string $status = 'pending', int $priority = 50, string|null $dedupkey = null, string|null $groupkey = null, string|null $correlationid = null, string|null $subjecttype = null, int|null $subjectid = null, string|null $subjectkey = null, int|null $courseid = null, int|null $userid = null, string|null $payload = null, string|null $runnerref = null, int $attempts = 0, int $maxattempts = 3, int $availableat = 0, int|null $startedat = null, int|null $finishedat = null, int|null $lastattemptat = null, string|null $lastmessage = null, int $timecreated = 0, int $timemodified = 0, array $attempt_log = [])

No description

Parameters

int|null $id
string|null $uuid
string $extension
string $jobtype
string $transport
string $status
int $priority
string|null $dedupkey
string|null $groupkey
string|null $correlationid
string|null $subjecttype
int|null $subjectid
string|null $subjectkey
int|null $courseid
int|null $userid
string|null $payload
string|null $runnerref
int $attempts
int $maxattempts
int $availableat
int|null $startedat
int|null $finishedat
int|null $lastattemptat
string|null $lastmessage
int $timecreated
int $timemodified
array $attempt_log

at line 68
job with_status(string $status, string|null $message = null)

No description

Parameters

string $status
string|null $message

Return Value

job

at line 78
job with_attempt(job_attempt_interface $attempt)

No description

Parameters

job_attempt_interface $attempt

Return Value

job

at line 89
int|null get_id()

Get the entity unique identifier.

Returns null if the entity has not been persisted yet.

Return Value

int|null

at line 94
string|null get_uuid()

No description

Return Value

string|null

at line 99
string get_extension()

No description

Return Value

string

at line 104
string get_jobtype()

No description

Return Value

string

at line 109
string get_transport()

No description

Return Value

string

at line 114
string get_status()

No description

Return Value

string

at line 119
int get_priority()

No description

Return Value

int

at line 124
string|null get_dedupkey()

No description

Return Value

string|null

at line 129
string|null get_groupkey()

No description

Return Value

string|null

at line 134
string|null get_correlationid()

No description

Return Value

string|null

at line 139
string|null get_subjecttype()

No description

Return Value

string|null

at line 144
int|null get_subjectid()

No description

Return Value

int|null

at line 149
string|null get_subjectkey()

No description

Return Value

string|null

at line 154
int|null get_courseid()

No description

Return Value

int|null

at line 159
int|null get_userid()

No description

Return Value

int|null

at line 164
string|null get_payload()

No description

Return Value

string|null

at line 169
string|null get_runnerref()

No description

Return Value

string|null

at line 174
int get_attempts()

No description

Return Value

int

at line 179
int get_maxattempts()

No description

Return Value

int

at line 184
int get_availableat()

No description

Return Value

int

at line 189
int|null get_startedat()

No description

Return Value

int|null

at line 194
int|null get_finishedat()

No description

Return Value

int|null

at line 199
int|null get_lastattemptat()

No description

Return Value

int|null

at line 204
string|null get_lastmessage()

No description

Return Value

string|null

at line 209
int get_timecreated()

No description

Return Value

int

at line 214
int get_timemodified()

No description

Return Value

int

at line 219
array get_attempt_log()

No description

Return Value

array

at line 227
array to_array()

No description

Return Value

array