RecordIndexer
Read onlyYes
FinalYes
Indexes database records, as configured by indexing configurations of type "Database records" (index_config.type = 1).
This class is not part of TYPO3's Core API.
Table of Contents
Methods
- __construct() : mixed
- findIndexOnChangeConfigurations() : array<int, RecordInterface>
- Find all indexing configurations of type "Database records" that ask for a record to be indexed as soon as it is changed. A configuration applies when it is placed on the same page as the record, or points to the record's page as alternative source page.
- indexRecord() : void
- Index a single record according to the given indexing configuration. The record is indexed as if it was a page, located on the page of the indexing configuration.
- removePage() : void
- Remove everything that has been indexed for a page.
- removeRecord() : void
- Remove everything that has been indexed for a record by the given indexing configuration.
Methods
__construct()
public
__construct(ConnectionPool $connectionPool, RecordFactory $recordFactory, AdministrationRepository $administrationRepository, ServiceLocator $indexers) : mixed
Parameters
- $connectionPool : ConnectionPool
- $recordFactory : RecordFactory
- $administrationRepository : AdministrationRepository
- $indexers : ServiceLocator
findIndexOnChangeConfigurations()
Find all indexing configurations of type "Database records" that ask for a record to be indexed as soon as it is changed. A configuration applies when it is placed on the same page as the record, or points to the record's page as alternative source page.
public
findIndexOnChangeConfigurations(RecordInterface $record) : array<int, RecordInterface>
Parameters
- $record : RecordInterface
Return values
array<int, RecordInterface>indexRecord()
Index a single record according to the given indexing configuration. The record is indexed as if it was a page, located on the page of the indexing configuration.
public
indexRecord(Record $record, RecordInterface $configuration) : void
Parameters
- $record : Record
- $configuration : RecordInterface
removePage()
Remove everything that has been indexed for a page.
public
removePage(int $pageId) : void
Parameters
- $pageId : int
removeRecord()
Remove everything that has been indexed for a record by the given indexing configuration.
public
removeRecord(RecordInterface $record, RecordInterface $configuration) : void
Parameters
- $record : RecordInterface
- $configuration : RecordInterface