Documentation

pm_Hook_LoginContentInclude extends pm_Hook_ContentInclude
in package
implements pm_Hook_Interface

Abstract class for content injection into login page

Tags
since
12.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

getBodyContent()  : string
Retrieve additional HTML content which will be added to HTML body tag
getHeadContent()  : string
Retrieve additional HTML content which will be added to HTML head tag
getJsConfig()  : array<string|int, mixed>
Retrieve key-value array which will be encoded into JSON and added to HTML head tag as JavaScript block
getJsContent()  : string
Retrieve JavaScript code which will be added to HTML head tag
getJsOnReadyContent()  : string
Retrieve JavaScript code which will be added to HTML head tag and fired after DOMReady event
getSidebarContent()  : string
Retrieve additional HTML content which will be added to sidebar area
init()  : mixed
Init routines generating content using other APIs (e.g. pm_View_Status)

Methods

getBodyContent()

Retrieve additional HTML content which will be added to HTML body tag

public getBodyContent() : string
Return values
string

getHeadContent()

Retrieve additional HTML content which will be added to HTML head tag

public getHeadContent() : string
Return values
string

getJsConfig()

Retrieve key-value array which will be encoded into JSON and added to HTML head tag as JavaScript block

public getJsConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getJsContent()

Retrieve JavaScript code which will be added to HTML head tag

public getJsContent() : string
Return values
string

getJsOnReadyContent()

Retrieve JavaScript code which will be added to HTML head tag and fired after DOMReady event

public getJsOnReadyContent() : string
Return values
string

getSidebarContent()

Retrieve additional HTML content which will be added to sidebar area

public getSidebarContent() : string
Tags
since
17.8
Return values
string

init()

Init routines generating content using other APIs (e.g. pm_View_Status)

public init() : mixed
Return values
mixed

Search results