Documentation

pm_Promo_AdminHome
in package
implements pm_Hook_Interface

Promo block for admin home page

Tags
since
11.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

$_moduleId  : string
Module identity
__construct()  : mixed
Create promo block
getButtonText()  : string
Retrieve text for promo button
getButtonUrl()  : string
Retrieve URL for promo button
getHideText()  : string
Retrieve text for Hide link
getIconUrl()  : string
Retrieve icon URL (for 32x32 icon)
getText()  : string
Retrieve promo text
getTitle()  : string
Retrieve text for promo title
isActive()  : bool
Check if block is active
lmsg()  : string
Retrieve translated message from locale file
onHide()  : mixed
On hide event hook

Properties

$_moduleId

Module identity

protected string $_moduleId

Methods

__construct()

Create promo block

public __construct() : mixed
Return values
mixed

getButtonText()

Retrieve text for promo button

public getButtonText() : string
Return values
string

getButtonUrl()

Retrieve URL for promo button

public getButtonUrl() : string
Return values
string

getHideText()

Retrieve text for Hide link

public getHideText() : string
Return values
string

getIconUrl()

Retrieve icon URL (for 32x32 icon)

public getIconUrl() : string
Return values
string

getText()

Retrieve promo text

public getText() : string
Return values
string

getTitle()

Retrieve text for promo title

public getTitle() : string
Return values
string

isActive()

Check if block is active

public isActive() : bool
Return values
bool

lmsg()

Retrieve translated message from locale file

public lmsg(string $key[, array<string|int, mixed> $params = [] ]) : string
Parameters
$key : string
$params : array<string|int, mixed> = []
Tags
since
12.0

added argument $params

Return values
string

onHide()

On hide event hook

public onHide() : mixed
Return values
mixed

Search results