Skip to content
Last updated

WHMCS\Module\Addon\Setting

Class · extends AbstractModel

Class Setting

Traits

  • EncryptedModelTrait

Constants

NameDescription
MODULE_LICENSINGTODO: Move constants to related licensing add-on classes, when possible, in current WHMCS state module add-ons do not have classes, only php files available
SETTING_OPTIMISE_TABLE

Properties

TypeNameDescription
``$timestamps

Methods

getSettingValueForModule

public static function getSettingValueForModule(string $module, string $setting): ?string

Retrieve value for addon module's setting

Parameters

TypeNameDescription
string$module
string$setting

Returns string\|null — - string if entry is found, null if setting is not defined.

scopeModule

public function scopeModule($query, $module)

setModuleValue

public static function setModuleValue(string $module, string $setting, $value): self

deleteAllAccessEntries

public static function deleteAllAccessEntries(): void

deleteModule

public static function deleteModule(string $module): void

getForAddon

public static function getForAddon(string $module): Collection

setValueAttribute

public function setValueAttribute($value): void

getValueAttribute

public function getValueAttribute(): ?string

isEncryptedSetting

public function isEncryptedSetting(): bool

encryptAndSaveValue

public function encryptAndSaveValue(): bool

getHashKey

public function getHashKey(): string