FileSearchDemand

class \TYPO3\CMS\Core\Resource\Search\FileSearchDemand

Immutable value object that represents a search demand for files.

Table of Contents

Methods

addOrdering()  : self
addSearchField()  : self
create()  : self
createForSearchTerm()  : self
getFirstResult()  : int|null
getFolder()  : Folder|null
getMaxResults()  : int|null
getOrderings()  : array|null
getSearchFields()  : array|null
getSearchTerm()  : string|null
isRecursive()  : bool
withFolder()  : self
withMaxResults()  : self
withRecursive()  : self
withSearchTerm()  : self
withStartResult()  : FileSearchDemand
Requests the position of the first result to retrieve (the "offset").

Methods

addOrdering()

public addOrdering(string $tableName, string $fieldName[, string $direction = 'ASC' ]) : self

Parameters

$tableName : string
$fieldName : string
$direction : string = 'ASC'

Return values

self

addSearchField()

public addSearchField(string $tableName, string $field) : self

Parameters

$tableName : string
$field : string

Return values

self

create()

public static create() : self

Return values

self

createForSearchTerm()

public static createForSearchTerm(string $searchTerm) : self

Parameters

$searchTerm : string

Return values

self

getFirstResult()

public getFirstResult() : int|null

Return values

int|null

getMaxResults()

public getMaxResults() : int|null

Return values

int|null

getOrderings()

public getOrderings() : array|null

Return values

array|null

getSearchFields()

public getSearchFields() : array|null

Return values

array|null

getSearchTerm()

public getSearchTerm() : string|null

Return values

string|null

isRecursive()

public isRecursive() : bool

Return values

bool

withMaxResults()

public withMaxResults(int $maxResults) : self

Parameters

$maxResults : int

Return values

self

withRecursive()

public withRecursive() : self

Return values

self

withSearchTerm()

public withSearchTerm(string $searchTerm) : self

Parameters

$searchTerm : string

Return values

self

withStartResult()

Requests the position of the first result to retrieve (the "offset").

public withStartResult(int $firstResult) : FileSearchDemand

Same as in QueryBuilder it is the index of the result set, with 0 being the first result.

Parameters

$firstResult : int

Return values

FileSearchDemand
On this page