WHMCS\Service\Addon | WHMCS\Service\Addon | WHMCS Internal Class Documentation

class Addon extends AbstractModel implements ServiceInterface

Traits

DomainTraits

ProvisioningTraits

Properties summary

Type	Property	Description
protected	$table
protected	$columnMap
protected	$dates
protected	$appends

Methods summary

Return Type	Method Name	Description
Service	getServiceActual()	-
Service	getServiceSurrogate()	-
bool	hasServiceSurrogate()	-
Client	getServiceClient()	-
Properties	getServiceProperties()	-
static	boot()	-
Builder	scopeUserId(Builder $query, int $userId)	-
Builder	scopeOfService(Builder $query, integer $serviceId)	-
Builder	scopeActive(Builder $query)	-
Builder	scopeMarketConnect(Builder $query)	Filter for only MarketConnect addon services.
Builder	scopeIsConsideredActive(Builder $query)	-
Builder	scopeIsNotRecurring(Builder $query)	-
BelongsTo	service()	Each addon belongs to one service.
BelongsTo	productAddon()	Each addon belongs to a single product addon.
BelongsTo	client()	Each addon belongs to one client.
HasMany\|CustomFieldValue	customFieldValues()	-
	getCustomFieldType()	-
	getCustomFieldRelId()	-
static array	getNonTerminalStatuses()	Status values representative of an entry that has further status values it could transition to.
BelongsTo	order()	An addon belongs to a single order.
HasMany	paymentGateway()	Each addon has many payment gateway records.
Properties	getServicePropertiesAttribute()	-
HasMany	ssl()	Each addon could have many ssl records.
BelongsToMany	invoices()	-
bool	canBeUpgraded()	Determine if addon can be upgraded.
bool	isService()	Is this entity a service?
bool	isAddon()	Is this entity an addon?
HasOne	serverModel()	-
HasMany	failedActions()	-
HasMany	moduleConfiguration()	-
string	legacyProvision()	Run provision action in legacy mode.
bool	isRecurring()	-
	getLink()	-
float	recalculateRecurringPrice()	-
string	getProvisioningTypeAttribute()	-
AddonInterface	getServiceProduct()	-
Price	getServiceRecurringAmount()	-
bool	isServiceMetricUsage()	Addon does not support Usage billing at this time

Details

`Service getServiceActual ()`

Return Value

Service

`Service getServiceSurrogate ()`

Return Value

Service

`bool hasServiceSurrogate ()`

Return Value

bool

`Client getServiceClient ()`

Return Value

Client

`Properties getServiceProperties ()`

Return Value

Properties

`static boot ()`

`Builder scopeUserId (Builder $query, int $userId)`

Parameters

Builder	$query
int	$userId

Return Value

Builder

`Builder scopeOfService (Builder $query, integer $serviceId)`

Parameters

Builder	$query
integer	$serviceId

Return Value

Builder

`Builder scopeActive (Builder $query)`

Parameters

Builder

$query

Return Value

Builder

`Builder scopeMarketConnect (Builder $query)`

Filter for only MarketConnect addon services.

Parameters

Builder

$query

Return Value

Builder

`Builder scopeIsConsideredActive (Builder $query)`

Parameters

Builder

$query

Return Value

Builder

`Builder scopeIsNotRecurring (Builder $query)`

Parameters

Builder

$query

Return Value

Builder

`BelongsTo service ()`

Each addon belongs to one service.

Return Value

BelongsTo

`BelongsTo productAddon ()`

Each addon belongs to a single product addon.

Return Value

BelongsTo

`BelongsTo client ()`

Each addon belongs to one client.

Return Value

BelongsTo

`HasMany|CustomFieldValue customFieldValues ()`

Return Value

HasMany|CustomFieldValue

`protected getCustomFieldType ()`

`protected getCustomFieldRelId ()`

`static array getNonTerminalStatuses ()`

Status values representative of an entry that has further status values it could transition to.

Return Value

array

Array of Statuses as strings

`BelongsTo order ()`

An addon belongs to a single order.

Return Value

BelongsTo

`HasMany paymentGateway ()`

Each addon has many payment gateway records.

Return Value

HasMany

`Properties getServicePropertiesAttribute ()`

Return Value

Properties

`HasMany ssl ()`

Each addon could have many ssl records.

Return Value

HasMany

`BelongsToMany invoices ()`

Return Value

BelongsToMany

`bool canBeUpgraded ()`

Determine if addon can be upgraded.

Return Value

bool

`bool isService ()`

Is this entity a service?

Return Value

bool

`bool isAddon ()`

Is this entity an addon?

Return Value

bool

`HasOne serverModel ()`

Return Value

HasOne

`HasMany failedActions ()`

Return Value

HasMany

`HasMany moduleConfiguration ()`

Return Value

HasMany

`string legacyProvision ()`

Run provision action in legacy mode.

Legacy mode returns 'success' on success and an error message string on failure.

Return Value

string

`bool isRecurring ()`

Return Value

bool

`getLink ()`

`float recalculateRecurringPrice ()`

Return Value

float

`string getProvisioningTypeAttribute ()`

Return Value

string

`AddonInterface getServiceProduct ()`

Return Value

AddonInterface

`Price getServiceRecurringAmount ()`

Return Value

Price

`bool isServiceMetricUsage ()`

Addon does not support Usage billing at this time

Return Value

bool