Skip to content
Last updated

WHMCS\Module\Notification\DescriptionTrait

Trait

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

Methods

isActive

public function isActive()

Is this notification provider active?

Returns bool

getName

public function getName()

Returns bare class name of the specific notification module.

Returns string

getDisplayName

public function getDisplayName()

Get display name for the notification module.

Returns string

setDisplayName

public function setDisplayName($displayName)

Set the display name

Parameters

TypeNameDescription
string$displayName

Returns $this

getLogoFileName

public function getLogoFileName()

Get the logo filename

Returns string

setLogoFileName

public function setLogoFileName($logoFileName)

Set the logo filename

Parameters

TypeNameDescription
string$logoFileName

Returns $this

getLogoPath

public function 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()}'

Returns string