Extensions API Documentation - Plesk 17.5
\

\pm_Hook_SimpleList

Abstract class for injection into list

Summary

Methods
Properties
Constants
isEnabled()
getDataProvider()
getData()
getColumnsOverride()
getColumns()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A

Methods

isEnabled()

isEnabled(string  $controller, string  $action, boolean  $activeList) : boolean

Check if hook is enabled or not

Parameters

string $controller
string $action
boolean $activeList

Returns

boolean

getDataProvider()

getDataProvider(string  $controller, string  $action, boolean  $activeList, array|\Zend_Db_Select  $data) : array|\Zend_Db_Select

Get list data provider

Parameters

string $controller
string $action
boolean $activeList
array|\Zend_Db_Select $data

Original data provider

Returns

array|\Zend_Db_Select

getData()

getData(string  $controller, string  $action, boolean  $activeList, array  $data) : array

Get list data

Parameters

string $controller
string $action
boolean $activeList
array $data

Original data

Returns

array

getColumnsOverride()

getColumnsOverride(string  $controller, string  $action, boolean  $activeList) : array

Get columns override

[
    integer => [
        'title' => string,
        'noEscape' => bool,
        'searchable' => bool,
        'sortable' => bool,
    ],
    ...
]

Parameters

string $controller
string $action
boolean $activeList

Returns

array

getColumns()

getColumns(string  $controller, string  $action, boolean  $activeList) : array

Get additional columns

[
    'new-column-id' => [
        'title' => string,
        'noEscape' => bool,
        'searchable' => bool,
        'sortable' => bool,
    ],
    ...
]

Parameters

string $controller
string $action
boolean $activeList

Returns

array