Extensions API Documentation - Plesk 17.5
\

\pm_Promo_CustomerHome

Promo block for customer (on Websites&Domains page)

Summary

Methods
Properties
Constants
__construct()
lmsg()
isActive()
onHide()
getTitle()
getText()
getIconUrl()
getHideText()
getButtonUrl()
getButtonText()
No public properties found
No constants found
No protected methods found
$_moduleId
$_clientId
N/A

Properties

$_moduleId

$_moduleId : string

Module identity

Type

string

$_clientId

$_clientId : integer

Client identity

Type

integer

Methods

__construct()

__construct()

Create promo block

lmsg()

lmsg(string  $key, array  $params = array()) : string

Retrieve translated message from locale file

Parameters

string $key
array $params

Returns

string

isActive()

isActive() : boolean

Check if block is active

Returns

boolean

onHide()

onHide()

On hide event hook

getTitle()

getTitle() : string

Retrieve text for promo title

Returns

string

getText()

getText() : string

Retrieve promo text

Returns

string

getIconUrl()

getIconUrl() : string

Retrieve icon URL (for 32x32 icon)

Returns

string

getHideText()

getHideText() : string

Retrieve text for Hide link

Returns

string

getButtonUrl()

getButtonUrl() : string

Retrieve URL for promo button

Returns

string

getButtonText()

getButtonText() : string

Retrieve text for promo button

Returns

string