1. class
  2. Hypervel
  3. \
  4. Horizon
  5. \
  6. JobPayload

JobPayload

class JobPayload implements ArrayAccess

Properties

array $decoded

The decoded payload array.

Methods

__construct(string $value)

Create a new raw job payload instance.

string
id()

Get the job ID from the payload.

array
tags()

Get the job tags from the payload.

bool
isRetry()

Determine if the job is a retry of a previous job.

string|null
retryOf()

Get the ID of the job this job is a retry of.

bool
isSilenced()

Determine if the job has been silenced.

JobPayload
prepare(mixed $job)

Prepare the payload for storage on the queue by adding tags, etc.

string
determineType(mixed $job)

Get the "type" of job being queued.

array
determineTags(mixed $job)

Get the appropriate tags for the job.

bool
shouldBeSilenced(mixed $job, array $tags)

Determine if the underlying job class should be silenced.

mixed
underlyingJob(mixed $job)

Get the underlying queued job.

JobPayload
set(array $values)

Set the given key / value pairs on the payload.

string|null
commandName()

Get the "command name" for the job.

string|null
displayName()

Get the "display name" for the job.

bool
offsetExists(mixed $offset)

Determine if the given offset exists.

mixed
offsetGet(mixed $offset)

Get the value at the current offset.

void
offsetSet(mixed $offset, mixed $value)

Set the value at the current offset.

void
offsetUnset(mixed $offset)

Unset the value at the current offset.

Details

at line 29
__construct(string $value)

Create a new raw job payload instance.

Parameters

string $value

the raw payload string

at line 56
string id()

Get the job ID from the payload.

Return Value

string

at line 64
array tags()

Get the job tags from the payload.

Return Value

array

at line 72
bool isRetry()

Determine if the job is a retry of a previous job.

Return Value

bool

at line 80
string|null retryOf()

Get the ID of the job this job is a retry of.

Return Value

string|null

at line 88
bool isSilenced()

Determine if the job has been silenced.

Return Value

bool

at line 96
JobPayload prepare(mixed $job)

Prepare the payload for storage on the queue by adding tags, etc.

Parameters

mixed $job

Return Value

JobPayload

at line 111
protected string determineType(mixed $job)

Get the "type" of job being queued.

Parameters

mixed $job

Return Value

string

at line 125
protected array determineTags(mixed $job)

Get the appropriate tags for the job.

Parameters

mixed $job

Return Value

array

at line 136
protected bool shouldBeSilenced(mixed $job, array $tags)

Determine if the underlying job class should be silenced.

Parameters

mixed $job
array $tags

Return Value

bool

at line 154
protected mixed underlyingJob(mixed $job)

Get the underlying queued job.

Parameters

mixed $job

Return Value

mixed

at line 168
JobPayload set(array $values)

Set the given key / value pairs on the payload.

Parameters

array $values

Return Value

JobPayload

at line 180
string|null commandName()

Get the "command name" for the job.

Return Value

string|null

at line 188
string|null displayName()

Get the "display name" for the job.

Return Value

string|null

at line 196
bool offsetExists(mixed $offset)

Determine if the given offset exists.

Parameters

mixed $offset

Return Value

bool

at line 204
mixed offsetGet(mixed $offset)

Get the value at the current offset.

Parameters

mixed $offset

Return Value

mixed

at line 212
void offsetSet(mixed $offset, mixed $value)

Set the value at the current offset.

Parameters

mixed $offset
mixed $value

Return Value

void

at line 220
void offsetUnset(mixed $offset)

Unset the value at the current offset.

Parameters

mixed $offset

Return Value

void