ContentFetcher
Read onlyYes
Class responsible for fetching the content data related to a BackendLayout
- Reads content records
- Performs workspace overlay on records
- Capable of returning all records in active language as flat array
- Capable of returning records for a given column in a given (optional) language
- Capable of returning translation data (brief info about translation consistency)
this is experimental and subject to change in TYPO3 v10 / v11
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Methods
- __construct() : mixed
- getBackendUser() : BackendUserAuthentication
- getContentRecordsPerColumn() : array<string|int, mixed>
- Gets content records per column.
- getFlatContentRecords() : iterable<string|int, mixed>
- getTranslationData() : array<string|int, mixed>
- getUnusedRecords() : iterable<string|int, mixed>
- Allows to decide via an Event whether a custom type has children which were rendered or should not be rendered.
- getLanguageService() : LanguageService
- getQueryBuilder() : QueryBuilder
- getResult() : array<string|int, mixed>
- removeWorkspaceDeletedPlaceholdersUidsFromUntranslatedRecordUids() : array<string|int, mixed>
Methods
__construct()
public
__construct(EventDispatcherInterface $eventDispatcher, FrontendInterface $runtimeCache, ConnectionPool $connectionPool, TcaSchemaFactory $tcaSchemaFactory, FlashMessageService $flashMessageService) : mixed
Parameters
- $eventDispatcher : EventDispatcherInterface
- $runtimeCache : FrontendInterface
- $connectionPool : ConnectionPool
- $tcaSchemaFactory : TcaSchemaFactory
- $flashMessageService : FlashMessageService
getBackendUser()
public
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetContentRecordsPerColumn()
Gets content records per column.
public
getContentRecordsPerColumn(PageLayoutContext $pageLayoutContext[, int|null $columnNumber = null ][, int|null $languageId = null ]) : array<string|int, mixed>
This is required for correct workspace overlays.
Parameters
- $pageLayoutContext : PageLayoutContext
- $columnNumber : int|null = null
- $languageId : int|null = null
Return values
array<string|int, mixed> —Associative array for each column (colPos) or for all columns if $columnNumber is null
getFlatContentRecords()
public
getFlatContentRecords(PageLayoutContext $pageLayoutContext, int $languageId) : iterable<string|int, mixed>
Parameters
- $pageLayoutContext : PageLayoutContext
- $languageId : int
Return values
iterable<string|int, mixed>getTranslationData()
public
getTranslationData(PageLayoutContext $pageLayoutContext, iterable<string|int, mixed> $contentElements, int $language) : array<string|int, mixed>
Parameters
- $pageLayoutContext : PageLayoutContext
- $contentElements : iterable<string|int, mixed>
- $language : int
Return values
array<string|int, mixed>getUnusedRecords()
Allows to decide via an Event whether a custom type has children which were rendered or should not be rendered.
public
getUnusedRecords(PageLayoutContext $pageLayoutContext) : iterable<string|int, mixed>
Parameters
- $pageLayoutContext : PageLayoutContext
Return values
iterable<string|int, mixed>getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetQueryBuilder()
protected
getQueryBuilder(PageLayoutContext $pageLayoutContext) : QueryBuilder
Parameters
- $pageLayoutContext : PageLayoutContext
Return values
QueryBuildergetResult()
protected
getResult(mixed $result) : array<string|int, mixed>
Parameters
- $result : mixed
Return values
array<string|int, mixed>removeWorkspaceDeletedPlaceholdersUidsFromUntranslatedRecordUids()
protected
removeWorkspaceDeletedPlaceholdersUidsFromUntranslatedRecordUids(PageLayoutContext $pageLayoutContext, array<string|int, mixed> $untranslatedRecordUids, int $language) : array<string|int, mixed>
Parameters
- $pageLayoutContext : PageLayoutContext
- $untranslatedRecordUids : array<string|int, mixed>
- $language : int