Documentation

pm_Hook_DynamicList
in package
implements pm_Hook_Interface

Abstract class for adding custom content to domain card in dynamic view

Tags
since
18.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

getAdditionalTitleContent()  : string|null
getColumns()  : array<string|int, mixed>
Retrieve the list of columns
getData()  : array<string|int, mixed>
Retrieve data of visible list items
getDataProvider()  : array<string|int, mixed>
Retrieve all list data
getInitContent()  : string|null
getSidebar()  : string|null
Retrieve the left sidebar of domain card
getTabs()  : array<string|int, mixed>
Retrieve the list of domain card tabs

Methods

getAdditionalTitleContent()

public getAdditionalTitleContent() : string|null
Return values
string|null —

getColumns()

Retrieve the list of columns

public getColumns() : array<string|int, mixed> 
[
     'column-key' => [
         'title' => 'My Column',
         'order' => 'before:status',
     ]
]
Tags
since
18.0.56
Return values
array<string|int, mixed> —

getData()

Retrieve data of visible list items

public getData(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Tags
since
18.0.56
Return values
array<string|int, mixed> —

getDataProvider()

Retrieve all list data

public getDataProvider(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Tags
since
18.0.56
Return values
array<string|int, mixed> —

getInitContent()

public getInitContent() : string|null
Return values
string|null —

getSidebar()

Retrieve the left sidebar of domain card

public getSidebar(string $itemId) : string|null 
'<span>My awesome card sidebar</span>'
Parameters
$itemId : string
Tags
since
18.0.56
Return values
string|null —

getTabs()

Retrieve the list of domain card tabs

public getTabs(string $itemId) : array<string|int, mixed> 
[
     'uniqueTabId' => [
         'title' => 'My Awesome Tab',
         'content' => '<span>My awesome tab content</span>',
         'order' => 3,
         'default' => false,
     ]
]
Parameters
$itemId : string

identifier of domain or alias object in format {a|d}:{objectId}

Return values
array<string|int, mixed> —

Search results