Documentation

Block
in package

Custom block to be embedded into administrator's Home page in SPV

Tags
since
18.0.60

Table of Contents

SECTION_PLESK  = 'plesk'
SECTION_SECURITY  = 'security'
SECTION_SERVER  = 'server'
getColumn()  : int
Define column the block should be placed to
getContent()  : string
Define block content
getFooter()  : string
Define block footer
getIcon()  : string
Define block icon
getId()  : string
Define block unique ID
getName()  : string
Define block name
getOrder()  : int
Define order within the column the block should be placed to
getSection()  : string
Define section the block belongs to
getSectionOrder()  : int
Define order within the section the block should be placed to
getSkeletonSize()  : int
Define size of the skeleton (content placeholder) to be shown while content is loaded
getTitle()  : string
Define block title
isAsyncLoaded()  : bool
Define if the block content should be loaded asynchronously
isEnabled()  : bool
Define if the block is enabled by default

Constants

SECTION_PLESK

public mixed SECTION_PLESK = 'plesk'

SECTION_SECURITY

public mixed SECTION_SECURITY = 'security'

SECTION_SERVER

public mixed SECTION_SERVER = 'server'

Methods

getColumn()

Define column the block should be placed to

public getColumn() : int

Possible values: 0, 1, 2. Last column by default.

Return values
int

getContent()

Define block content

public getContent() : string

Attention: unescaped HTML. Extension description by default.

Return values
string

getFooter()

Define block footer

public getFooter() : string

Attention: unescaped HTML. Empty by default.

Return values
string

getIcon()

Define block icon

public getIcon() : string

To be shown when customizing Home page.

Return values
string

getId()

Define block unique ID

public getId() : string

Classname by default.

Return values
string

getName()

Define block name

public getName() : string

To be shown when customizing Home page. Extension title by default.

Return values
string

getOrder()

Define order within the column the block should be placed to

public getOrder() : int

Last block in column by default.

Return values
int

getSection()

Define section the block belongs to

public getSection() : string

To be shown when customizing Home page. SECTION_PLESK by default.

Return values
string

getSectionOrder()

Define order within the section the block should be placed to

public getSectionOrder() : int

To be shown when customizing Home page. Last block in section by default.

Return values
int

getSkeletonSize()

Define size of the skeleton (content placeholder) to be shown while content is loaded

public getSkeletonSize() : int

Applied only to asynchronously loaded blocks. 2 by default.

Return values
int

getTitle()

Define block title

public getTitle() : string

Attention: unescaped HTML. Extension title by default.

Return values
string

isAsyncLoaded()

Define if the block content should be loaded asynchronously

public isAsyncLoaded() : bool

True by default.

Return values
bool

isEnabled()

Define if the block is enabled by default

public isEnabled() : bool

true by default.

Return values
bool

Search results