ElementInformationController

Script Class for showing information about an item.

Internal

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Properties

$access  : bool
$fileObject  : File|null
$folderObject  : Folder|null
$iconFactory  : IconFactory
$moduleTemplate  : ModuleTemplate
$moduleTemplateFactory  : ModuleTemplateFactory
$pageInfo  : array<string|int, mixed>
For type "db": Set to page record of the parent page of the item set (if type="db")
$permsClause  : string
$row  : array<string|int, mixed>
Database records identified by table/uid
$table  : string
Record table name
$type  : string
Which type of element: - "file" - "db"
$uid  : int
Record uid
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
mainAction()  : ResponseInterface
Injects the request object for the current request or subrequest As this controller goes only through the main() method, it is rather simple for now
canAccessPage()  : bool
getBackendUser()  : BackendUserAuthentication
getExtraFields()  : array<string|int, mixed>
Get the extra fields (uid, timestamps, creator) for the table
getFieldList()  : array<string|int, mixed>
Get the list of fields that should be shown for the given table
getLabelForTableColumn()  : string
Get field name for specified table/column name
getLanguageService()  : LanguageService
getPageTitle()  : array<string|int, mixed>
Get page title with icon, table title and record title
getPreview()  : array<string|int, mixed>
Get preview for current record
getPropertiesForTable()  : array<string|int, mixed>
Get property array for html table
getRecordActions()  : array<string|int, mixed>
Returns the record actions
getReferences()  : array<string|int, mixed>
Get references section (references from and references to current record)
init()  : void
Determines if table/uid point to database record or file and if user has access to view information
initDatabaseRecord()  : void
Init database records (table)
initFileOrFolderRecord()  : void
Init file/folder parameters
main()  : void
Compiles the whole content to be outputted, which is then set as content to the moduleTemplate There is a hook to do a custom rendering of a record.
makeRef()  : array<string|int, mixed>
Make reference display
makeRefFrom()  : array<string|int, mixed>
Make reference display (what this elements points to)
transformFileReferenceToRecordReference()  : array<string|int, mixed>
Convert FAL file reference (sys_file_reference) to reference index (sys_refindex) table format

Properties

$pageInfo

For type "db": Set to page record of the parent page of the item set (if type="db")

protected array<string|int, mixed> $pageInfo

$row

Database records identified by table/uid

protected array<string|int, mixed> $row

$table

Record table name

protected string $table

$type

Which type of element: - "file" - "db"

protected string $type = ''

Methods

mainAction()

Injects the request object for the current request or subrequest As this controller goes only through the main() method, it is rather simple for now

public mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface

the current request

Return values
ResponseInterface —

the response with the content

canAccessPage()

protected canAccessPage(string $tableName, array<string|int, mixed> $record) : bool
Parameters
$tableName : string

Name of the table

$record : array<string|int, mixed>

Record to be checked (ensure pid is resolved for workspaces)

Return values
bool

getExtraFields()

Get the extra fields (uid, timestamps, creator) for the table

protected getExtraFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFieldList()

Get the list of fields that should be shown for the given table

protected getFieldList(string $table, int $uid) : array<string|int, mixed>
Parameters
$table : string
$uid : int
Return values
array<string|int, mixed>

getLabelForTableColumn()

Get field name for specified table/column name

protected getLabelForTableColumn(string $tableName, string $fieldName) : string
Parameters
$tableName : string

Table name

$fieldName : string

Column name

Return values
string —

label

getPageTitle()

Get page title with icon, table title and record title

protected getPageTitle() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPreview()

Get preview for current record

protected getPreview() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPropertiesForTable()

Get property array for html table

protected getPropertiesForTable() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRecordActions()

Returns the record actions

protected getRecordActions(string $table, int $uid, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
$table : string
$uid : int
$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
array<string|int, mixed>

getReferences()

Get references section (references from and references to current record)

protected getReferences(ServerRequestInterface $request) : array<string|int, mixed>
Parameters
$request : ServerRequestInterface
Return values
array<string|int, mixed>

init()

Determines if table/uid point to database record or file and if user has access to view information

protected init(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

initDatabaseRecord()

Init database records (table)

protected initDatabaseRecord() : void

initFileOrFolderRecord()

Init file/folder parameters

protected initFileOrFolderRecord() : void

main()

Compiles the whole content to be outputted, which is then set as content to the moduleTemplate There is a hook to do a custom rendering of a record.

protected main(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

makeRef()

Make reference display

protected makeRef(string $table, int|File $ref, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
$table : string

Table name

$ref : int|File

Filename or uid

$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
array<string|int, mixed>

makeRefFrom()

Make reference display (what this elements points to)

protected makeRefFrom(string $table, int $ref, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
$table : string

Table name

$ref : int

Filename or uid

$request : ServerRequestInterface
Return values
array<string|int, mixed>

transformFileReferenceToRecordReference()

Convert FAL file reference (sys_file_reference) to reference index (sys_refindex) table format

protected transformFileReferenceToRecordReference(array<string|int, mixed> $referenceRecord) : array<string|int, mixed>
Parameters
$referenceRecord : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results