‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController Class Reference

Public Member Functions

 __construct (IconFactory $iconFactory, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory)
 
ResponseInterface mainAction (ServerRequestInterface $request)
 

Protected Member Functions

 init (ServerRequestInterface $request)
 
 initDatabaseRecord ()
 
 initFileOrFolderRecord ()
 
 main (ServerRequestInterface $request)
 
array getPageTitle ()
 
array getPreview ()
 
array getPropertiesForTable ()
 
array getFieldList (string $table, int $uid)
 
array getExtraFields ()
 
array getReferences (ServerRequestInterface $request)
 
string getLabelForTableColumn ($tableName, $fieldName)
 
array getRecordActions ($table, $uid, ServerRequestInterface $request)
 
array makeRef ($table, $ref, ServerRequestInterface $request)
 
array makeRefFrom ($table, $ref, ServerRequestInterface $request)
 
array transformFileReferenceToRecordReference (array $referenceRecord)
 
bool canAccessPage (string $tableName, array $record)
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 

Protected Attributes

string $table
 
int $uid
 
string $permsClause
 
bool $access = false
 
string $type = ''
 
ModuleTemplate $moduleTemplate
 
array $pageInfo
 
array $row
 
File $fileObject = null
 
Folder $folderObject = null
 
IconFactory $iconFactory
 
UriBuilder $uriBuilder
 
ModuleTemplateFactory $moduleTemplateFactory
 

Detailed Description

Script Class for showing information about an item.

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

Definition at line 53 of file ElementInformationController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::__construct ( IconFactory  $iconFactory,
UriBuilder  $uriBuilder,
ModuleTemplateFactory  $moduleTemplateFactory 
)

Definition at line 107 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$iconFactory, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$moduleTemplateFactory, and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$uriBuilder.

Member Function Documentation

◆ canAccessPage()

bool TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::canAccessPage ( string  $tableName,
array  $record 
)
protected
Parameters
string$tableName‪Name of the table
array$record‪Record to be checked (ensure pid is resolved for workspaces)
Returns
‪bool

Definition at line 847 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isInWebMount().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getBackendUser ( )
protected
Returns
‪BackendUserAuthentication

Definition at line 865 of file ElementInformationController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\canAccessPage(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\init(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\initDatabaseRecord(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ getExtraFields()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getExtraFields ( )
protected

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

Returns
‪array

Definition at line 482 of file ElementInformationController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable().

◆ getFieldList()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getFieldList ( string  $table,
int  $uid 
)
protected

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

Parameters
string$table
int$uid
Returns
‪array

Definition at line 449 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$table, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$uid, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable().

◆ getLabelForTableColumn()

string TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getLabelForTableColumn (   $tableName,
  $fieldName 
)
protected

Get field name for specified table/column name

Parameters
string$tableName‪Table name
string$fieldName‪Column name
Returns
‪string label

Definition at line 570 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getLanguageService ( )
protected
Returns
‪LanguageService

Definition at line 857 of file ElementInformationController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getExtraFields(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLabelForTableColumn(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPageTitle(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ getPageTitle()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getPageTitle ( )
protected

Get page title with icon, table title and record title

Returns
‪array

Definition at line 262 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main().

◆ getPreview()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getPreview ( )
protected

Get preview for current record

Returns
‪array

Definition at line 287 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$fileObject, and $rendererRegistry.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main().

◆ getPropertiesForTable()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getPropertiesForTable ( )
protected

Get property array for html table

Returns
‪array

Definition at line 324 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$folderObject, $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$table, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$uid, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\check(), TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_IMAGE, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getExtraFields(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getFieldList(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main().

◆ getRecordActions()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getRecordActions (   $table,
  $uid,
ServerRequestInterface  $request 
)
protected

Returns the record actions

Parameters
string$table
int$uid
ServerRequestInterface$request
Returns
‪array
Exceptions
RouteNotFoundException

Definition at line 592 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$table, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$uid, and TYPO3\CMS\Backend\Routing\PreviewUriBuilder\create().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ getReferences()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::getReferences ( ServerRequestInterface  $request)
protected

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

Parameters
ServerRequestInterface$request
Returns
‪array

Definition at line 543 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main().

◆ init()

TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::init ( ServerRequestInterface  $request)
protected

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

Parameters
ServerRequestInterface$request

Definition at line 137 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getPagePermsClause(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\initDatabaseRecord(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\initFileOrFolderRecord(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\mainAction().

◆ initDatabaseRecord()

TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::initDatabaseRecord ( )
protected

Init database records (table)

Definition at line 158 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$pageInfo, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\check(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\init().

◆ initFileOrFolderRecord()

TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::initFileOrFolderRecord ( )
protected

Init file/folder parameters

Definition at line 186 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\init().

◆ main()

TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::main ( ServerRequestInterface  $request)
protected

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.

Parameters
ServerRequestInterface$request

Definition at line 214 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPageTitle(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPreview(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getReferences().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\mainAction().

◆ mainAction()

ResponseInterface TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::mainAction ( ServerRequestInterface  $request)

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

Parameters
ServerRequestInterface$request‪the current request
Returns
‪ResponseInterface the response with the content

Definition at line 124 of file ElementInformationController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\init(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\main().

◆ makeRef()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::makeRef (   $table,
  $ref,
ServerRequestInterface  $request 
)
protected

Make reference display

Parameters
string$table‪Table name
int | \TYPO3\CMS\Core\Resource\File$ref‪Filename or uid
ServerRequestInterface$request
Returns
‪array
Exceptions
RouteNotFoundException

Definition at line 639 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$row, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$table, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\canAccessPage(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLabelForTableColumn(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getRecordActions(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Connection\PARAM_STR, TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\transformFileReferenceToRecordReference(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getReferences().

◆ makeRefFrom()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::makeRefFrom (   $table,
  $ref,
ServerRequestInterface  $request 
)
protected

Make reference display (what this elements points to)

Parameters
string$table‪Table name
int$ref‪Filename or uid
ServerRequestInterface$request
Returns
‪array

Definition at line 738 of file ElementInformationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$row, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\$table, TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\canAccessPage(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLabelForTableColumn(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getLanguageService(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getRecordActions(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Connection\PARAM_STR, TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getReferences().

◆ transformFileReferenceToRecordReference()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::transformFileReferenceToRecordReference ( array  $referenceRecord)
protected

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

Parameters
array$referenceRecord
Returns
‪array

Definition at line 815 of file ElementInformationController.php.

References TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef().

Member Data Documentation

◆ $access

bool TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$access = false
protected

Definition at line 73 of file ElementInformationController.php.

◆ $fileObject

File TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$fileObject = null
protected

Definition at line 100 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPreview().

◆ $folderObject

Folder TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$folderObject = null
protected

Definition at line 101 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable().

◆ $iconFactory

IconFactory TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$iconFactory
protected

Definition at line 103 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\__construct().

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$moduleTemplate
protected

Definition at line 85 of file ElementInformationController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$moduleTemplateFactory
protected

Definition at line 105 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\__construct().

◆ $pageInfo

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$pageInfo
protected

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

Definition at line 92 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\initDatabaseRecord().

◆ $permsClause

string TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$permsClause
protected

Definition at line 69 of file ElementInformationController.php.

◆ $row

array TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$row
protected

Database records identified by table/uid

Definition at line 98 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ $table

string TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$table
protected

Record table name

Definition at line 59 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getFieldList(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getRecordActions(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRef(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\makeRefFrom().

◆ $type

string TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$type = ''
protected

Which type of element:

  • ‪"file"
  • ‪"db"

Definition at line 81 of file ElementInformationController.php.

◆ $uid

int TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$uid
protected

Record uid

Definition at line 65 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getFieldList(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getRecordActions().

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController::$uriBuilder
protected

Definition at line 104 of file ElementInformationController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\__construct().