Documentation

pm_Hook_SimpleList
in package
implements pm_Hook_Interface

Abstract class for injection into list

Tags
since
17.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

getColumns()  : array<string|int, mixed>
Get additional columns
getColumnsOverride()  : array<string|int, mixed>
Get columns override
getData()  : array<string|int, mixed>
Get list data
getDataProvider()  : array<string|int, mixed>|Zend_Db_Select
Get list data provider
isEnabled()  : bool
Check if hook is enabled or not

Methods

getColumns()

Get additional columns

public getColumns(string $controller, string $action, bool $activeList) : array<string|int, mixed> 
[
    'new-column-id' => [
        'title' => string,
        'noEscape' => bool,
        'searchable' => bool,
        'sortable' => bool,
    ],
    ...
]
Parameters
$controller : string
$action : string
$activeList : bool
Tags
see
pm_View_List_Simple::setColumns()
Return values
array<string|int, mixed> —

getColumnsOverride()

Get columns override

public getColumnsOverride(string $controller, string $action, bool $activeList) : array<string|int, mixed> 
[
    integer => [
        'title' => string,
        'noEscape' => bool,
        'searchable' => bool,
        'sortable' => bool,
    ],
    ...
]
Parameters
$controller : string
$action : string
$activeList : bool
Tags
see
pm_View_List_Simple::setColumns()
Return values
array<string|int, mixed> —

getData()

Get list data

public getData(string $controller, string $action, bool $activeList, array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$controller : string
$action : string
$activeList : bool
$data : array<string|int, mixed>

Original data

Return values
array<string|int, mixed> —

getDataProvider()

Get list data provider

public getDataProvider(string $controller, string $action, bool $activeList, array<string|int, mixed>|Zend_Db_Select $data) : array<string|int, mixed>|Zend_Db_Select
Parameters
$controller : string
$action : string
$activeList : bool
$data : array<string|int, mixed>|Zend_Db_Select

Original data provider

Return values
array<string|int, mixed>|Zend_Db_Select —

isEnabled()

Check if hook is enabled or not

public isEnabled(string $controller, string $action, bool $activeList) : bool
Parameters
$controller : string
$action : string
$activeList : bool
Return values
bool —

Search results