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

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

Static Public Member Functions
static FileSearchQuery	createForSearchDemand (FileSearchDemand $searchDemand, QueryBuilder $queryBuilder=null)
static FileSearchQuery	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
QueryRestrictionInterface[]	$additionalRestrictions = array( )
Doctrine DBAL Driver Statement int	$result

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 36 of file FileSearchQuery.php.

Constructor & Destructor Documentation

__construct()

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

(

QueryBuilder

$queryBuilder = null

)

Definition at line 54 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.

Parameters

QueryRestrictionInterface

$additionalRestriction

Exceptions

Definition at line 166 of file FileSearchQuery.php.

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

createCountForSearchDemand()

static FileSearchQuery 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

FileSearchDemand	$searchDemand
QueryBuilder | null	$queryBuilder

Returns

‪FileSearchQuery

Definition at line 136 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 FileSearchQuery 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

FileSearchDemand	$searchDemand
QueryBuilder | null	$queryBuilder

Returns

‪FileSearchQuery

Definition at line 66 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\Index\FileIndexRepository\findBySearchWordInMetaData(), and TYPO3\CMS\Core\Resource\Search\Result\FileSearchResult\initialize().

ensureQueryNotExecuted()

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

private

Definition at line 203 of file FileSearchQuery.php.

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

execute()

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

(

)

Definition at line 172 of file FileSearchQuery.php.

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

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

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 186 of file FileSearchQuery.php.

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

Member Data Documentation

$additionalRestrictions

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

private

Definition at line 48 of file FileSearchQuery.php.

$queryBuilder

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

private

Definition at line 44 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

Doctrine DBAL Driver Statement int TYPO3\CMS\Core\Resource\Search\FileSearchQuery::$result

private

Definition at line 52 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 40 of file FileSearchQuery.php.

FILES_TABLE

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

private

Definition at line 38 of file FileSearchQuery.php.

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