‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Resource\Search\FileSearchDemand Class Reference

Public Member Functions

 getSearchTerm ()
 
 getFolder ()
 
 getFirstResult ()
 
 getMaxResults ()
 
 getSearchFields ()
 
 getOrderings ()
 
 isRecursive ()
 
 withSearchTerm (string $searchTerm)
 
 withFolder (Folder $folder)
 
 withStartResult (int $firstResult)
 
 withMaxResults (int $maxResults)
 
 addSearchField (string $tableName, string $field)
 
 addOrdering (string $tableName, string $fieldName, string $direction='ASC')
 
 withRecursive ()
 

Static Public Member Functions

static create ()
 
static createForSearchTerm (string $searchTerm)
 

Private Member Functions

 __construct (?string $searchTerm=null)
 

Private Attributes

string null $searchTerm
 
Folder null $folder
 
int null $firstResult
 
int null $maxResults
 
array null $searchFields
 
array null $orderings
 
bool $recursive = false
 

Detailed Description

Immutable value object that represents a search demand for files.

Definition at line 25 of file FileSearchDemand.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::__construct ( ?string  $searchTerm = null)
private

Only factory methods are allowed to be used to create this object

Parameters
string | null$searchTerm

Definition at line 60 of file FileSearchDemand.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchDemand\$searchTerm.

Member Function Documentation

◆ addOrdering()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::addOrdering ( string  $tableName,
string  $fieldName,
string  $direction = 'ASC' 
)

◆ addSearchField()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::addSearchField ( string  $tableName,
string  $field 
)

Definition at line 146 of file FileSearchDemand.php.

◆ create()

static TYPO3\CMS\Core\Resource\Search\FileSearchDemand::create ( )
static

Definition at line 65 of file FileSearchDemand.php.

◆ createForSearchTerm()

◆ getFirstResult()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::getFirstResult ( )

◆ getFolder()

◆ getMaxResults()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::getMaxResults ( )

◆ getOrderings()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::getOrderings ( )

◆ getSearchFields()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::getSearchFields ( )

◆ getSearchTerm()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::getSearchTerm ( )

◆ isRecursive()

◆ withFolder()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::withFolder ( Folder  $folder)

◆ withMaxResults()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::withMaxResults ( int  $maxResults)

◆ withRecursive()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::withRecursive ( )

Definition at line 162 of file FileSearchDemand.php.

◆ withSearchTerm()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::withSearchTerm ( string  $searchTerm)

◆ withStartResult()

TYPO3\CMS\Core\Resource\Search\FileSearchDemand::withStartResult ( int  $firstResult)

Requests the position of the first result to retrieve (the "offset"). Same as in QueryBuilder it is the index of the result set, with 0 being the first result.

Definition at line 130 of file FileSearchDemand.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchDemand\$firstResult.

Member Data Documentation

◆ $firstResult

int null TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$firstResult
private

◆ $folder

Folder null TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$folder
private

◆ $maxResults

int null TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$maxResults
private

◆ $orderings

array null TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$orderings
private

◆ $recursive

bool TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$recursive = false
private

◆ $searchFields

array null TYPO3\CMS\Core\Resource\Search\FileSearchDemand::$searchFields
private

◆ $searchTerm