Collection of behaviors common to all notification modules that help fulfill \WHMCS\Notification\Notification\NotificationModuleInterface

trait DescriptionTrait

Methods summary

Return Type Method Name Description
bool isActive() Is this notification provider active?
string getName() Returns bare class name of the specific notification module.
string getDisplayName() Get display name for the notification module.
$this setDisplayName(string $displayName) Set the display name
string getLogoFileName() Get the logo filename
$this setLogoFileName(string $logoFileName) Set the logo filename
string getLogoPath() Logo of provider.

Details

bool isActive ()

Is this notification provider active?

Return Value

bool

string getName ()

Returns bare class name of the specific notification module.

Return Value

string

string getDisplayName ()

Get display name for the notification module.

Return Value

string

$this setDisplayName (string $displayName)

Set the display name

Parameters

string $displayName

Return Value

$this

string getLogoFileName ()

Get the logo filename

Return Value

string

$this setLogoFileName (string $logoFileName)

Set the logo filename

Parameters

string $logoFileName

Return Value

$this

string getLogoPath ()

Logo of provider.

Publicly accessible path relative to WHMCS System URL. Expressed as "absolute" path (leading forward slash)

EX. '/modules/notifications/{$this->getName()}/{$this->getLogoFileName()}'

Return Value

string