TYPO3\CMS\Core\Resource\Search\FileSearchQuery Class Reference

Public Member Functions
	__construct (QueryBuilder $queryBuilder=null)
	additionalRestriction (QueryRestrictionInterface $additionalRestriction)
Result	execute ()

Static Public Member Functions
static	createForSearchDemand (FileSearchDemand $searchDemand, QueryBuilder $queryBuilder=null)
static	createCountForSearchDemand (FileSearchDemand $searchDemand, QueryBuilder $queryBuilder=null)

Private Member Functions
	initializeQueryBuilder ()
	ensureQueryNotExecuted ()

Private Attributes
const	FILES_TABLE = 'sys_file'
const	FILES_META_TABLE = 'sys_file_metadata'
QueryBuilder	$queryBuilder
array	$additionalRestrictions = []
Result	$result = null

Detailed Description

Represents an SQL query to search for files. Acts as facade to a QueryBuilder and comes with factory methods to preconfigure the query for a search demand.

Definition at line 37 of file FileSearchQuery.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Resource\Search\FileSearchQuery::__construct

(

QueryBuilder

$queryBuilder = null

)

Definition at line 52 of file FileSearchQuery.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchQuery\$queryBuilder.

Member Function Documentation

additionalRestriction()

TYPO3\CMS\Core\Resource\Search\FileSearchQuery::additionalRestriction

(

QueryRestrictionInterface

$additionalRestriction

)

Limit the result set of identifiers, by adding further SQL restrictions. Note that no further restrictions can be added once result is initialized, by starting the iteration over the result. Can be accessed by subclasses to add further restrictions to the query.

Exceptions

Definition at line 156 of file FileSearchQuery.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchQuery\ensureQueryNotExecuted().

createCountForSearchDemand()

static TYPO3\CMS\Core\Resource\Search\FileSearchQuery::createCountForSearchDemand ( FileSearchDemand  $searchDemand, QueryBuilder  $queryBuilder = null  )

static

Prepares a query based on a search demand to be used to count rows.

Parameters

QueryBuilder | null

$queryBuilder

Definition at line 128 of file FileSearchQuery.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchQuery\$queryBuilder, TYPO3\CMS\Core\Resource\Search\FileSearchDemand\getFolder(), and TYPO3\CMS\Core\Resource\Search\FileSearchDemand\isRecursive().

Referenced by TYPO3\CMS\Core\Resource\Search\Result\FileSearchResult\count().

createForSearchDemand()

static TYPO3\CMS\Core\Resource\Search\FileSearchQuery::createForSearchDemand ( FileSearchDemand  $searchDemand, QueryBuilder  $queryBuilder = null  )

static

Prepares a query based on a search demand to be used to fetch rows.

Parameters

QueryBuilder | null

$queryBuilder

Definition at line 62 of file FileSearchQuery.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\Search\FileSearchQuery\$queryBuilder, TYPO3\CMS\Core\Resource\Search\FileSearchDemand\addOrdering(), TYPO3\CMS\Core\Resource\Search\FileSearchQuery\FILES_TABLE, TYPO3\CMS\Core\Resource\Search\FileSearchDemand\getFirstResult(), TYPO3\CMS\Core\Resource\Search\FileSearchDemand\getFolder(), TYPO3\CMS\Core\Resource\Search\FileSearchDemand\getMaxResults(), TYPO3\CMS\Core\Resource\Search\FileSearchDemand\getOrderings(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), TYPO3\CMS\Core\Resource\Search\FileSearchDemand\isRecursive(), and TYPO3\CMS\Core\Database\Query\QueryHelper\parseOrderBy().

Referenced by TYPO3\CMS\Core\Resource\Search\Result\FileSearchResult\initialize().

ensureQueryNotExecuted()

TYPO3\CMS\Core\Resource\Search\FileSearchQuery::ensureQueryNotExecuted ( )

private

Definition at line 196 of file FileSearchQuery.php.

Referenced by TYPO3\CMS\Core\Resource\Search\FileSearchQuery\additionalRestriction().

execute()

Result TYPO3\CMS\Core\Resource\Search\FileSearchQuery::execute

(

)

Returns

‪Result

Definition at line 165 of file FileSearchQuery.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchQuery\$result, and TYPO3\CMS\Core\Resource\Search\FileSearchQuery\initializeQueryBuilder().

initializeQueryBuilder()

TYPO3\CMS\Core\Resource\Search\FileSearchQuery::initializeQueryBuilder ( )

private

Create and initialize QueryBuilder for SQL based file search. Can be accessed by subclasses for example to add further joins to the query.

Definition at line 179 of file FileSearchQuery.php.

Referenced by TYPO3\CMS\Core\Resource\Search\FileSearchQuery\execute().

Member Data Documentation

$additionalRestrictions

array TYPO3\CMS\Core\Resource\Search\FileSearchQuery::$additionalRestrictions = []

private

Definition at line 48 of file FileSearchQuery.php.

$queryBuilder

QueryBuilder TYPO3\CMS\Core\Resource\Search\FileSearchQuery::$queryBuilder

private

Definition at line 43 of file FileSearchQuery.php.

Referenced by TYPO3\CMS\Core\Resource\Search\FileSearchQuery\__construct(), TYPO3\CMS\Core\Resource\Search\FileSearchQuery\createCountForSearchDemand(), and TYPO3\CMS\Core\Resource\Search\FileSearchQuery\createForSearchDemand().

$result

Result TYPO3\CMS\Core\Resource\Search\FileSearchQuery::$result = null

private

Definition at line 50 of file FileSearchQuery.php.

Referenced by TYPO3\CMS\Core\Resource\Search\FileSearchQuery\execute().

FILES_META_TABLE

const TYPO3\CMS\Core\Resource\Search\FileSearchQuery::FILES_META_TABLE = 'sys_file_metadata'

private

Definition at line 41 of file FileSearchQuery.php.

FILES_TABLE

const TYPO3\CMS\Core\Resource\Search\FileSearchQuery::FILES_TABLE = 'sys_file'

private

Definition at line 39 of file FileSearchQuery.php.

Referenced by TYPO3\CMS\Core\Resource\Search\FileSearchQuery\createForSearchDemand().