RecordsContentObject extends AbstractContentObject
Contains RECORDS class object.
Table of Contents
Properties
- $cObj : ContentObjectRenderer|null
- $data : array<string|int, mixed>
- List of all selected records with full data, arranged per table
- $itemArray : array<string|int, mixed>
- List of all items with table and uid information
- $pageRenderer : PageRenderer|null
- $request : ServerRequestInterface
- Always set via setRequest() by ContentObjectFactory after instantiation
- $timeTracker : TimeTracker
Methods
- __construct() : mixed
- getContentObjectRenderer() : ContentObjectRenderer
- render() : string
- Rendering the cObject, RECORDS
- setContentObjectRenderer() : void
- setRequest() : void
- collectRecordsFromCategories() : mixed
- Collects records for all selected tables and categories.
- collectRecordsFromSource() : mixed
- Collects records according to the configured source
- getPageRenderer() : PageRenderer
- getPageRepository() : PageRepository
- getTypoScriptFrontendController() : TypoScriptFrontendController
- hasTypoScriptFrontendController() : bool
- isRecordsPageAccessible() : bool
- Checks if the records page is accessible
Properties
$cObj
protected
ContentObjectRenderer|null
$cObj
= null
$data
List of all selected records with full data, arranged per table
protected
array<string|int, mixed>
$data
= []
$itemArray
List of all items with table and uid information
protected
array<string|int, mixed>
$itemArray
= []
$pageRenderer
protected
PageRenderer|null
$pageRenderer
= null
$request
Always set via setRequest() by ContentObjectFactory after instantiation
protected
ServerRequestInterface
$request
$timeTracker read-only
protected
TimeTracker
$timeTracker
Methods
__construct()
public
__construct(TimeTracker $timeTracker) : mixed
Parameters
- $timeTracker : TimeTracker
getContentObjectRenderer()
public
getContentObjectRenderer() : ContentObjectRenderer
Return values
ContentObjectRendererrender()
Rendering the cObject, RECORDS
public
render([array<string|int, mixed> $conf = [] ]) : string
Parameters
- $conf : array<string|int, mixed> = []
-
Array of TypoScript properties
Return values
string —Output
setContentObjectRenderer()
public
setContentObjectRenderer(ContentObjectRenderer $cObj) : void
Parameters
- $cObj : ContentObjectRenderer
setRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface
collectRecordsFromCategories()
Collects records for all selected tables and categories.
protected
collectRecordsFromCategories(string $selectedCategories, array<string|int, mixed> $tables, string $relationField) : mixed
Parameters
- $selectedCategories : string
-
Comma-separated list of categories
- $tables : array<string|int, mixed>
-
List of tables
- $relationField : string
-
Name of the field containing the categories relation
collectRecordsFromSource()
Collects records according to the configured source
protected
collectRecordsFromSource(string $source, array<string|int, mixed> $tables) : mixed
Parameters
- $source : string
-
Source of records
- $tables : array<string|int, mixed>
-
List of tables
getPageRenderer()
protected
getPageRenderer() : PageRenderer
Return values
PageRenderergetPageRepository()
protected
getPageRepository() : PageRepository
Return values
PageRepositorygetTypoScriptFrontendController()
protected
getTypoScriptFrontendController() : TypoScriptFrontendController
Tags
Return values
TypoScriptFrontendControllerhasTypoScriptFrontendController()
protected
hasTypoScriptFrontendController() : bool
Return values
boolisRecordsPageAccessible()
Checks if the records page is accessible
protected
isRecordsPageAccessible(string $table, array<string|int, mixed> $row, array<string|int, mixed> $conf) : bool
Parameters
- $table : string
- $row : array<string|int, mixed>
- $conf : array<string|int, mixed>