TYPO3 11.5 API: PageInformationController

PageInformationController

Class for displaying page information (records, page record properties) in Web -> Info

Internal

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Properties

$addElement_tdCssClass : array<string|int, mixed>: Keys are fieldnames and values are td-css-classes to add in addElement();
$backendLayoutView : BackendLayoutView|null
$fieldArray : array<string|int, mixed>
$fieldConfiguration : array<string|int, mixed>
$iconFactory : IconFactory
$id : int
$pObj : InfoModuleController
$uriBuilder : UriBuilder

Methods

__construct() : mixed
init() : mixed: Init, called from parent object
main() : string: Main, called from parent object
addElement() : string: Returns a table-row with the content from the fields in the input data array.
cleanTableNames() : string: Function, which returns all tables to which the user has access. Also a set of standard tables (pages, sys_filemounts, etc...) are filtered out. So what is left is basically all tables which makes sense to list content from.
fillFieldConfiguration() : mixed: Generate configuration for field selection
getBackendLayouts() : array<string|int, mixed>
getBackendUser() : BackendUserAuthentication
getIcon() : string: Creates the icon image tag for the page and wraps it in a link which will trigger the click menu.
getLanguageService() : LanguageService|null
getPageRecordsRecursive() : array<string|int, mixed>: Adds pages-rows to an array, selecting recursively in the page tree.
getPagesTableFieldValue() : string: Returns the HTML code for rendering a field in the pages table.
getTable_pages() : string: Renders records from the pages table from page id
modMenu() : array<string|int, mixed>: Returns the menu array
numberOfRecords() : int: Counts and returns the number of records on the page with $pid
pages_drawItem() : string: Adds a list item for the pages-rendering
resolveBackendLayoutValue() : string

$addElement_tdCssClass

Keys are fieldnames and values are td-css-classes to add in addElement();


    protected
        array<string|int, mixed>
    $addElement_tdCssClass
     = []

$backendLayoutView


    protected
        BackendLayoutView|null
    $backendLayoutView
     = null

$fieldArray


    protected
        array<string|int, mixed>
    $fieldArray

$fieldConfiguration


    protected
        array<string|int, mixed>
    $fieldConfiguration
     = []

$iconFactory


    protected
        IconFactory
    $iconFactory

$id


    protected
        int
    $id

Value of the GET/POST var 'id'

$pObj


    protected
        InfoModuleController
    $pObj

Contains a reference to the parent calling object

$uriBuilder


    protected
        UriBuilder
    $uriBuilder

__construct()


    public
                    __construct(IconFactory $iconFactory, UriBuilder $uriBuilder) : mixed

Parameters

$iconFactory : IconFactory
$uriBuilder : UriBuilder

init()

Init, called from parent object


    public
                    init(InfoModuleController $pObj, ServerRequestInterface $request) : mixed

Parameters

$pObj : InfoModuleController: A reference to the parent (calling) object
$request : ServerRequestInterface

main()

Main, called from parent object


    public
                    main(ServerRequestInterface $request) : string

Parameters

$request : ServerRequestInterface

Return values

string —

Output HTML for the module.

addElement()

Returns a table-row with the content from the fields in the input data array.


    protected
                    addElement(array<string|int, mixed> $data) : string

OBS: $this->fieldArray MUST be set! (represents the list of fields to display)

Parameters

$data : array<string|int, mixed>: Is the data array, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in -tags

Return values

string —

HTML content for the table row

cleanTableNames()

Function, which returns all tables to which the user has access. Also a set of standard tables (pages, sys_filemounts, etc...) are filtered out. So what is left is basically all tables which makes sense to list content from.


    protected
                    cleanTableNames() : string

Return values

string

fillFieldConfiguration()

Generate configuration for field selection


    protected
                    fillFieldConfiguration(int $pageId) : mixed

Parameters

$pageId : int: current page id

getBackendLayouts()


    protected
                    getBackendLayouts(array<string|int, mixed> $row, string $field) : array<string|int, mixed>

Parameters

$row : array<string|int, mixed>
$field : string

Return values

array<string|int, mixed>

getBackendUser()


    protected
                    getBackendUser() : BackendUserAuthentication

Return values

BackendUserAuthentication

getIcon()

Creates the icon image tag for the page and wraps it in a link which will trigger the click menu.


    protected
                    getIcon(array<string|int, mixed> $row) : string

Parameters

$row : array<string|int, mixed>: Record array

Return values

string —

HTML for the icon

getLanguageService()


    protected
                    getLanguageService() : LanguageService|null

Return values

LanguageService|null

getPageRecordsRecursive()

Adds pages-rows to an array, selecting recursively in the page tree.


    protected
                    getPageRecordsRecursive(int $pid, int $depth[, string $iconPrefix = '' ][, array<string|int, mixed> $rows = [] ]) : array<string|int, mixed>

Parameters

$pid : int: Starting page id to select from
$depth : int: Depth (decreasing)
$iconPrefix : string = '': Prefix for icon code.
$rows : array<string|int, mixed> = []: Array which will accumulate page rows

Return values

array<string|int, mixed> —

$rows with added rows.

getPagesTableFieldValue()

Returns the HTML code for rendering a field in the pages table.


    protected
                    getPagesTableFieldValue(string $field, array<string|int, mixed> $row) : string

The row value is processed to a human readable form and the result is parsed through htmlspecialchars().

Parameters

$field : string: The name of the field of which the value should be rendered.
$row : array<string|int, mixed>: The pages table row as an associative array.

Return values

string —

The rendered table field value.

getTable_pages()

Renders records from the pages table from page id


    protected
                    getTable_pages(int $id, int $depth, ServerRequestInterface $request) : string

Parameters

$id : int: Page id
$depth : int
$request : ServerRequestInterface

Return values

string —

HTML for the listing

modMenu()

Returns the menu array


    protected
                    modMenu() : array<string|int, mixed>

Return values

array<string|int, mixed>

numberOfRecords()

Counts and returns the number of records on the page with $pid


    protected
                    numberOfRecords(string $table, int $pid) : int

Parameters

$table : string: Table name
$pid : int: Page id

Return values

int —

Number of records.

pages_drawItem()

Adds a list item for the pages-rendering


    protected
                    pages_drawItem(array<string|int, mixed> $row, array<string|int, mixed> $fieldArr, ServerRequestInterface $request) : string

Parameters

$row : array<string|int, mixed>: Record array
$fieldArr : array<string|int, mixed>: Field list
$request : ServerRequestInterface

Return values

string —

HTML for the item

resolveBackendLayoutValue()


    protected
                    resolveBackendLayoutValue(string|null $layoutValue, string $field, array<string|int, mixed> $row) : string

Parameters

$layoutValue : string|null
$field : string
$row : array<string|int, mixed>

Return values

string

PageInformationController

Table of Contents

Properties

Methods

Properties

$addElement_tdCssClass

$backendLayoutView

$fieldArray

$fieldConfiguration

$iconFactory

$id

$pObj

$uriBuilder

Methods

__construct()

Parameters

init()

Parameters

main()

Parameters

Return values

addElement()

Parameters

Return values

cleanTableNames()

Return values

fillFieldConfiguration()

Parameters

getBackendLayouts()

Parameters

Return values

getBackendUser()

Return values

getIcon()

Parameters

Return values

getLanguageService()

Return values

getPageRecordsRecursive()

Parameters

Return values

getPagesTableFieldValue()

Parameters

Return values

getTable_pages()

Parameters

Tags

Return values

modMenu()

Return values

numberOfRecords()

Parameters

Return values

pages_drawItem()

Parameters

Tags

Return values

resolveBackendLayoutValue()

Parameters

Return values