Skip to content
Last updated

WHMCS\Module\Queue

Class · extends AbstractModel

Module Queue

Methods

createTable

public function createTable($drop = false)

Create table schema

Parameters

TypeNameDescription
bool|false$dropDrop pre-existing tables

scopeIncomplete

public function scopeIncomplete(QueryBuilder $query)

Where status is unpaid.

Parameters

TypeNameDescription
QueryBuilder$query

Returns QueryBuilder

add

public static function add($serviceType, $serviceId, $module, $moduleAction, $lastAttemptError)

Add module queue entry.

Parameters

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

Returns bool

getLastAttemptErrorAttribute

public function getLastAttemptErrorAttribute()

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

Returns string

setLastAttemptErrorAttribute

public function setLastAttemptErrorAttribute($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

TypeNameDescription
string$value

resolve

public static function resolve($serviceType, $serviceId, $module, $moduleAction)

Resolve a module queue entry.

Parameters

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

Returns bool

service

public function service()

Returns BelongsTo\|Service

domain

public function domain()

Returns BelongsTo\|Domain

addon

public function addon()

Returns BelongsTo\|ServiceAddon