‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult:
TYPO3\CMS\Core\Resource\Search\Result\FileSearchResultInterface

Public Member Functions

 __construct (FileSearchResultInterface $searchResult, DriverInterface $driver, array $filters)
 
 count ()
 
 current ()
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 

Public Attributes

 $itemName = PathUtility::basename($itemIdentifier)
 
 $parentIdentifier = PathUtility::dirname($itemIdentifier)
 
 $matches = true
 
foreach($this->filters as $filter) if($matches) return $filteredFiles
 

Private Member Functions

 initialize ()
 
array< int, applyFilters(File ... $files):array { $filteredFiles=[];foreach( $files as $file) { $itemIdentifier=$file-> getIdentifier ()
 

Private Attributes

FileSearchResultInterface $searchResult
 
DriverInterface $driver
 
callable[] $filters
 
array $result
 

Detailed Description

Decorator for a search result with files, which filters the result based on given filters.

Definition at line 28 of file DriverFilteredSearchResult.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::__construct ( FileSearchResultInterface  $searchResult,
DriverInterface  $driver,
array  $filters 
)

Member Function Documentation

◆ count()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::count ( )
See also
‪Countable::count()

Definition at line 56 of file DriverFilteredSearchResult.php.

References TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult\initialize().

◆ current()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::current ( )

◆ getIdentifier()

array<int, applyFilters(File ...$files): array { $filteredFiles = []; foreach ($files as $file) { $itemIdentifier = $file-> TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::getIdentifier ( )
private

Filter out identifiers by calling all attached filters

Returns
‪array<int, File>

◆ initialize()

◆ key()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::key ( )

◆ next()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::next ( )

◆ rewind()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::rewind ( )
See also
‪Iterator::rewind()

Definition at line 95 of file DriverFilteredSearchResult.php.

References TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult\initialize().

◆ valid()

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::valid ( )

Member Data Documentation

◆ $driver

DriverInterface TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$driver
private

◆ $filteredFiles

foreach ( $this->filters as $filter) if ( $matches) return TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$filteredFiles

Definition at line 153 of file DriverFilteredSearchResult.php.

◆ $filters

callable [] TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$filters
private

◆ $itemName

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$itemName = PathUtility::basename($itemIdentifier)

Definition at line 128 of file DriverFilteredSearchResult.php.

◆ $matches

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$matches = true

Definition at line 130 of file DriverFilteredSearchResult.php.

◆ $parentIdentifier

TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$parentIdentifier = PathUtility::dirname($itemIdentifier)

Definition at line 129 of file DriverFilteredSearchResult.php.

◆ $result

array TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$result
private

Definition at line 44 of file DriverFilteredSearchResult.php.

◆ $searchResult

FileSearchResultInterface TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult::$searchResult
private