Module Queue

class Queue extends AbstractModel

Properties summary

Type Property Description
Service $service The related service
Domain $domain The related domain
Addon $addon The related domain

Methods summary

Return Type Method Name Description
createTable(bool|false $drop = false) Create table schema
Builder scopeIncomplete(Builder $query) Where status is unpaid.
static bool add(string $serviceType, int $serviceId, string $module, string $moduleAction, string $lastAttemptError) Add module queue entry.
string getLastAttemptErrorAttribute() Ensure the Last Attempt Error is populated on display when empty.
setLastAttemptErrorAttribute(string $value) Ensure the Last Attempt Error is populated on display when empty.
static bool resolve(string $serviceType, int $serviceId, string $module, string $moduleAction) Resolve a module queue entry.
BelongsTo|Service service() -
BelongsTo|Domain domain() -
BelongsTo|Addon addon() -

Details

createTable (bool|false $drop = false)

Create table schema

Parameters

bool|false $drop Drop pre-existing tables

Builder scopeIncomplete (Builder $query)

Where status is unpaid.

Parameters

Builder $query

Return Value

Builder

static bool add (string $serviceType, int $serviceId, string $module, string $moduleAction, string $lastAttemptError)

Add module queue entry.

Parameters

string $serviceType
int $serviceId
string $module
string $moduleAction
string $lastAttemptError

Return Value

bool

string getLastAttemptErrorAttribute ()

Ensure the Last Attempt Error is populated on display when empty.

Return Value

string

setLastAttemptErrorAttribute (string $value)

Ensure the Last Attempt Error is populated on display when empty.

As we are using a GET mutator, the set mutator appears to be required

Parameters

string $value

static bool resolve (string $serviceType, int $serviceId, string $module, string $moduleAction)

Resolve a module queue entry.

Parameters

string $serviceType
int $serviceId
string $module
string $moduleAction

Return Value

bool

BelongsTo|Service service ()

Return Value

BelongsTo|Service

BelongsTo|Domain domain ()

Return Value

BelongsTo|Domain

BelongsTo|Addon addon ()

Return Value

BelongsTo|Addon