Public Member Functions
	__construct (Connection $connection, QueryRestrictionContainerInterface $restrictionContainer=null, \Doctrine\DBAL\Query\QueryBuilder $concreteQueryBuilder=null, array $additionalRestrictions=null)

QueryRestrictionContainerInterface	getRestrictions ()

	setRestrictions (QueryRestrictionContainerInterface $restrictionContainer)

	limitRestrictionsToTables (array $tableAliases)

	resetRestrictions ()

ExpressionBuilder	expr ()

int	getType ()

Connection	getConnection ()

int	getState ()

Doctrine DBAL Query QueryBuilder	getConcreteQueryBuilder ()

Statement Doctrine DBAL ForwardCompatibility Result Doctrine DBAL Driver ResultStatement int	execute ()

string	getSQL ()

QueryBuilder	setParameter ($key, $value, int $type=null)

QueryBuilder	setParameters (array $params, array $types=[])

array	getParameters ()

mixed	getParameter ($key)

array	getParameterTypes ()

mixed	getParameterType ($key)

QueryBuilder	setFirstResult (int $firstResult)

int	getFirstResult ()

QueryBuilder	setMaxResults (int $maxResults)

int	getMaxResults ()

QueryBuilder	add (string $sqlPartName, $sqlPart, bool $append=false)

QueryBuilder	count (string $item)

QueryBuilder	select (string ... $selects)

QueryBuilder	addSelect (string ... $selects)

QueryBuilder	selectLiteral (string ... $selects)

QueryBuilder	addSelectLiteral (string ... $selects)

QueryBuilder	delete (string $delete, string $alias=null)

QueryBuilder	update (string $update, string $alias=null)

QueryBuilder	insert (string $insert)

QueryBuilder	from (string $from, string $alias=null)

QueryBuilder	join (string $fromAlias, string $join, string $alias, string $condition=null)

QueryBuilder	innerJoin (string $fromAlias, string $join, string $alias, string $condition=null)

QueryBuilder	leftJoin (string $fromAlias, string $join, string $alias, string $condition=null)

QueryBuilder	rightJoin (string $fromAlias, string $join, string $alias, string $condition=null)

QueryBuilder	set (string $key, $value, bool $createNamedParameter=true, int $type=\PDO::PARAM_STR)

QueryBuilder	where (... $predicates)

QueryBuilder	andWhere (... $where)

QueryBuilder	orWhere (... $where)

QueryBuilder	groupBy (... $groupBy)

QueryBuilder	addGroupBy (... $groupBy)

QueryBuilder	setValue (string $column, $value, bool $createNamedParameter=true)

QueryBuilder	values (array $values, bool $createNamedParameters=true)

QueryBuilder	having (... $having)

QueryBuilder	andHaving (... $having)

QueryBuilder	orHaving (... $having)

QueryBuilder	orderBy (string $fieldName, string $order=null)

QueryBuilder	addOrderBy (string $fieldName, string $order=null)

mixed	getQueryPart (string $queryPartName)

array	getQueryParts ()

QueryBuilder	resetQueryParts (array $queryPartNames=null)

QueryBuilder	resetQueryPart ($queryPartName)

string	__toString ()

string	createNamedParameter ($value, int $type=\PDO::PARAM_STR, string $placeHolder=null)

string	createPositionalParameter ($value, int $type=\PDO::PARAM_STR)

string	escapeLikeWildcards (string $value)

mixed	quote ($input, int $type=null)

string	quoteIdentifier (string $identifier)

array	quoteIdentifiers (array $input)

array	quoteIdentifiersForSelect (array $input)

array	quoteColumnValuePairs (array $input)

string	castFieldToTextType (string $fieldName)

	__clone ()

Protected Member Functions
string	unquoteSingleIdentifier (string $identifier)

string[]	getQueriedTables ()

Doctrine DBAL Query Expression CompositeExpression mixed	addAdditionalWhereConditions ()

Protected Attributes
Connection	$connection

Doctrine DBAL Query QueryBuilder	$concreteQueryBuilder

QueryRestrictionContainerInterface	$restrictionContainer

array	$additionalRestrictions

Private Attributes
string[]	$restrictionsAppliedInJoinCondition = array( )

Detailed Description

Object oriented approach to building SQL queries.

It's a facade to the Doctrine DBAL QueryBuilder that implements PHP7 type hinting and automatic quoting of table and column names.

$query->select('aField', 'anotherField') ->from('aTable') ->where($query->expr()->eq('aField', 1)) ->andWhere($query->expr()->gte('anotherField',10')) ->execute()

Additional functionality included is support for COUNT() and TRUNCATE() statements.

Definition at line 51 of file QueryBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Database\Query\QueryBuilder::__construct	(	Connection	$connection,
		QueryRestrictionContainerInterface	$restrictionContainer = `null`,
		\Doctrine\DBAL\Query\QueryBuilder	$concreteQueryBuilder = `null`,
		array	$additionalRestrictions = `null`
	)

Initializes a new QueryBuilder.

Parameters

Connection	$connection	‪The DBAL Connection.
QueryRestrictionContainerInterface \| null	$restrictionContainer
\Doctrine\DBAL\Query\QueryBuilder \| null	$concreteQueryBuilder
array \| null	$additionalRestrictions

Definition at line 89 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$additionalRestrictions, TYPO3\CMS\Core\Database\Query\QueryBuilder\$concreteQueryBuilder, TYPO3\CMS\Core\Database\Query\QueryBuilder\$connection, $GLOBALS, and TYPO3\CMS\Core\Database\Query\QueryBuilder\setRestrictions().

Member Function Documentation

◆ __clone()

TYPO3\CMS\Core\Database\Query\QueryBuilder::__clone ( )

Deep clone of the QueryBuilder

See also: ‪\Doctrine\DBAL\Query\QueryBuilder::__clone()

Definition at line 1212 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$concreteQueryBuilder, and TYPO3\CMS\Core\Database\Query\QueryBuilder\$restrictionContainer.

◆ __toString()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::__toString ( )

Gets a string representation of this QueryBuilder which corresponds to the final SQL query being constructed.

Returns: ‪string The string representation of this QueryBuilder.

Definition at line 919 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getSQL().

◆ add()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::add	(	string	$sqlPartName,
			$sqlPart,
		bool	$append = `false`
	)

Either appends to or replaces a single, generic query part.

The available parts are: 'select', 'from', 'set', 'where', 'groupBy', 'having' and 'orderBy'.

Parameters

string	$sqlPartName
string \| array	$sqlPart
bool	$append

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 385 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\add().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\add().

◆ addAdditionalWhereConditions()

Doctrine DBAL Query Expression CompositeExpression mixed TYPO3\CMS\Core\Database\Query\QueryBuilder::addAdditionalWhereConditions ( )

protected

Add the additional query conditions returned by the QueryRestrictionBuilder to the current query and return the original set of conditions so that they can be restored after the query has been built/executed.

Returns: ‪\Doctrine\DBAL\Query\Expression\CompositeExpression|mixed

Definition at line 1188 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getQueriedTables().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\execute(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getSQL().

◆ addGroupBy()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::addGroupBy ( $groupBy )

Adds a grouping expression to the query.

Parameters

string ‪...$groupBy The grouping expression.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 740 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addGroupBy(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifiers().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addGroupBy().

◆ addOrderBy()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::addOrderBy	(	string	$fieldName,
		string	$order = `null`
	)

Adds an ordering to the query results.

Parameters

string	$fieldName	‪The fieldName to order by. Will be quoted according to database platform automatically.
string \| null	$order	‪The ordering direction.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 856 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addOrderBy().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addOrderBy(), TYPO3\CMS\Backend\View\PageLayoutView\prepareQueryBuilder(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder().

◆ addSelect()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::addSelect ( string ... $selects )

Adds an item that is to be returned in the query result.

Parameters

string ‪...$selects

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 429 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addSelect(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifiersForSelect().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addSelect(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\addSelectLiteral().

◆ addSelectLiteral()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::addSelectLiteral ( string ... $selects )

Adds an item that is to be returned in the query result. This should only be used for literal SQL expressions as no quoting/escaping of any kind will be performed on the items.

Parameters

string ‪...$selects Literal SQL expressions to be selected.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 460 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addSelect().

◆ andHaving()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::andHaving ( $having )

Adds a restriction over the groups of the query, forming a logical conjunction with any existing having restrictions.

Parameters

mixed ‪...$having The restriction to append.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 810 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\andHaving().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\andHaving().

◆ andWhere()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::andWhere ( $where )

Adds one or more restrictions to the query results, forming a logical conjunction with any previously specified restrictions.

Parameters

string|CompositeExpression ‪...$where The query restrictions.

Returns: ‪QueryBuilder This QueryBuilder instance.

See also: ‪where()

Definition at line 694 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addPageIdConstraint(), TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getFirstTemplate(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getAllowedLanguageConstraintsForBackendUser(), TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider\getOptimizableTablesForConnection(), TYPO3\CMS\Backend\View\PageLayoutView\prepareQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), and TYPO3\CMS\Core\Database\RelationHandler\remapMM().

◆ castFieldToTextType()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::castFieldToTextType ( string $fieldName )

Creates a cast of the $fieldName to a text datatype depending on the database management system.

Parameters

string $fieldName ‪The fieldname will be quoted and casted according to database platform automatically

Returns: ‪string

Definition at line 1089 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\castFieldToTextType().

◆ count()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::count ( string $item )

Specifies the item that is to be counted in the query result. Replaces any previously specified selections, if any.

Parameters

string $item ‪Will be quoted according to database platform automatically.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 399 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Database\Connection\select().

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreAddedForCountOnExecute().

◆ createNamedParameter()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::createNamedParameter	(		$value,
		int	$type = `\PDO::PARAM_STR`,
		string	$placeHolder = `null`
	)

Creates a new named parameter and bind the value $value to it.

This method provides a shortcut for PDOStatement::bindValue when using prepared statements.

The parameter $value specifies the value that you want to bind. If $placeholder is not provided bindValue() will automatically create a placeholder for you. An automatic placeholder will be of the name ':dcValue1', ':dcValue2' etc.

Parameters

mixed	$value
int	$type
string \| null	$placeHolder	‪The name to bind with. The string must start with a colon ':'.

Returns: ‪string the placeholder name used.

Definition at line 941 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applySlugConstraint(), TYPO3\CMS\Core\Routing\Legacy\PersistedAliasMapperLegacyTrait\createFieldConstraints(), TYPO3\CMS\Core\Routing\Legacy\PersistedPatternMapperLegacyTrait\createFieldConstraints(), TYPO3\CMS\Core\Routing\Aspect\PersistedPatternMapper\createRouteFieldConstraints(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getAllowedLanguageConstraintsForBackendUser(), TYPO3\CMS\Felogin\Updates\MigrateFeloginPlugins\getFlexformConstraints(), TYPO3\CMS\Backend\Search\LiveSearch\LiveSearch\makeQuerySearchByTable(), TYPO3\CMS\Backend\View\PageLayoutView\prepareQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), TYPO3\CMS\Core\Database\Query\QueryBuilder\set(), TYPO3\CMS\Core\Database\Query\QueryBuilder\setValue(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\values().

◆ createPositionalParameter()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::createPositionalParameter	(		$value,
		int	$type = `\PDO::PARAM_STR`
	)

Creates a new positional parameter and bind the given value to it.

Attention: If you are using positional parameters with the query builder you have to be very careful to bind all parameters in the order they appear in the SQL statement , otherwise they get bound in the wrong order which can lead to serious bugs in your code.

Parameters

mixed	$value
int	$type

Returns: ‪string

Definition at line 959 of file QueryBuilder.php.

◆ delete()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::delete	(	string	$delete,
		string	$alias = `null`
	)

Turns the query being built into a bulk delete query that ranges over a certain table.

Parameters

string	$delete	‪The table whose rows are subject to the deletion. Will be quoted according to database platform automatically.
string \| null	$alias	‪The table alias used in the constructed query. Will be quoted according to database platform automatically.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 478 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\delete(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\delete().

◆ escapeLikeWildcards()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::escapeLikeWildcards ( string $value )

Quotes like wildcards for given string value.

Parameters

string $value ‪The value to be quoted.

Returns: ‪string The quoted value.

Definition at line 971 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\LiveSearch\makeQuerySearchByTable().

◆ execute()

Statement Doctrine DBAL ForwardCompatibility Result Doctrine DBAL Driver ResultStatement int TYPO3\CMS\Core\Database\Query\QueryBuilder::execute ( )

Executes this query using the bound parameters and their types.

Returns: ‪Statement|\Doctrine\DBAL\ForwardCompatibility\Result|\Doctrine\DBAL\Driver\ResultStatement|int

Definition at line 204 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addAdditionalWhereConditions(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getType().

Referenced by TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\Platform\MySql\checkDefaultDatabaseCharset(), TYPO3\CMS\Redirects\Repository\RedirectRepository\countRedirectsByByDemand(), TYPO3\CMS\Dashboard\DashboardRepository\create(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getAllTemplates(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getFirstTemplate(), TYPO3\CMS\Workspaces\Service\WorkspaceService\fetchPagesWithVersionsInTable(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findHostsOfRedirects(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findRedirectsByDemand(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findStatusCodesOfRedirects(), TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider\getOptimizableTablesForConnection(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\limitRestrictionsToTablesLimitsRestrictionsInTheContainerToTheGivenTables(), TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\moveDataFromSysLogToSysHistory(), TYPO3\CMS\Backend\History\RecordHistory\prepareEventDataFromQueryBuilder(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreAddedForCountOnExecute(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreAddedForSelectOnExecute(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreReevaluatedOnSettingsChangeForExecute(), TYPO3\CMS\Core\Database\RelationHandler\remapMM(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsAreAppliedInJoinConditionForLeftJoins(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsAreAppliedInJoinConditionForRightJoins(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsCanStillBeRemovedAfterTheyHaveBeenLimitedToTables().

◆ expr()

ExpressionBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::expr ( )

Gets an ExpressionBuilder used for object-oriented construction of query expressions. This producer method is intended for convenient inline usage. Example:

For more complex expression construction, consider storing the expression builder object in a local variable.

Returns: ‪ExpressionBuilder

Definition at line 151 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addAdditionalWhereConditions(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applySlugConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Core\Routing\Legacy\PersistedAliasMapperLegacyTrait\createFieldConstraints(), TYPO3\CMS\Core\Routing\Legacy\PersistedPatternMapperLegacyTrait\createFieldConstraints(), TYPO3\CMS\Core\Routing\Aspect\PersistedPatternMapper\createRouteFieldConstraints(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getAllowedLanguageConstraintsForBackendUser(), TYPO3\CMS\Felogin\Updates\MigrateFeloginPlugins\getFlexformConstraints(), TYPO3\CMS\Core\Database\Query\QueryBuilder\leftJoin(), TYPO3\CMS\Backend\Search\LiveSearch\LiveSearch\makeQuerySearchByTable(), TYPO3\CMS\Backend\View\PageLayoutView\prepareQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\rightJoin().

◆ from()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::from	(	string	$from,
		string	$alias = `null`
	)

Creates and adds a query root corresponding to the table identified by the given alias, forming a cartesian product with any existing query roots.

Parameters

string	$from	‪The table. Will be quoted according to database platform automatically.
string \| null	$alias	‪The alias of the table. Will be quoted according to database platform automatically.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 531 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\from(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

◆ getConcreteQueryBuilder()

Doctrine DBAL Query QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::getConcreteQueryBuilder ( )

Gets the concrete implementation of the query builder

Returns: ‪\Doctrine\DBAL\Query\QueryBuilder

Definition at line 194 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$concreteQueryBuilder.

◆ getConnection()

Connection TYPO3\CMS\Core\Database\Query\QueryBuilder::getConnection ( )

Gets the associated DBAL Connection for this query builder.

Returns: ‪Connection

Definition at line 172 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$connection.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\count(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quote(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteColumnValuePairs(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifiers(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\unquoteSingleIdentifier().

◆ getFirstResult()

int TYPO3\CMS\Core\Database\Query\QueryBuilder::getFirstResult ( )

Gets the position of the first result the query object was set to retrieve (the "offset"). Returns NULL if setFirstResult was not applied to this QueryBuilder.

Returns: ‪int The position of the first result.

Definition at line 343 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArray().

◆ getMaxResults()

int TYPO3\CMS\Core\Database\Query\QueryBuilder::getMaxResults ( )

Gets the maximum number of results the query object was set to retrieve (the "limit"). Returns 0 if setMaxResults was not applied to this query builder.

Returns: ‪int The maximum number of results.

Definition at line 368 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArray().

◆ getParameter()

mixed TYPO3\CMS\Core\Database\Query\QueryBuilder::getParameter ( $key )

Gets a (previously set) query parameter of the query being constructed.

Parameters

string | int $key ‪The key (index or name) of the bound parameter.

Returns: ‪mixed The value of the bound parameter.

Definition at line 296 of file QueryBuilder.php.

◆ getParameters()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::getParameters ( )

Gets all defined query parameters for the query being constructed indexed by parameter index or name.

Returns: ‪array The currently defined query parameters indexed by parameter index or name.

Definition at line 284 of file QueryBuilder.php.

◆ getParameterType()

mixed TYPO3\CMS\Core\Database\Query\QueryBuilder::getParameterType ( $key )

Gets a (previously set) query parameter type of the query being constructed.

Parameters

string | int $key ‪The key (index or name) of the bound parameter type.

Returns: ‪mixed The value of the bound parameter type.

Definition at line 318 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\setWithNamedParameterPassesGivenTypeToCreateNamedParameter().

◆ getParameterTypes()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::getParameterTypes ( )

Gets all defined query parameter types for the query being constructed indexed by parameter index or name.

Returns: ‪array The currently defined query parameter types indexed by parameter index or name.

Definition at line 306 of file QueryBuilder.php.

◆ getQueriedTables()

string [] TYPO3\CMS\Core\Database\Query\QueryBuilder::getQueriedTables ( )

protected

Return all tables/aliases used in FROM or JOIN query parts from the query builder.

The table names are automatically unquoted. This is a helper for to build the list of queried tables for the AbstractRestrictionContainer.

Returns: ‪string[]

Definition at line 1154 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getQueryPart(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\unquoteSingleIdentifier().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addAdditionalWhereConditions().

◆ getQueryPart()

mixed TYPO3\CMS\Core\Database\Query\QueryBuilder::getQueryPart ( string $queryPartName )

Gets a query part by its name.

Parameters

string $queryPartName

Returns: ‪mixed

Definition at line 870 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\getQueriedTables(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArray(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\rightJoin().

◆ getQueryParts()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::getQueryParts ( )

Gets all query parts.

Returns: ‪array

Definition at line 880 of file QueryBuilder.php.

◆ getRestrictions()

QueryRestrictionContainerInterface TYPO3\CMS\Core\Database\Query\QueryBuilder::getRestrictions ( )

Returns: ‪QueryRestrictionContainerInterface

Definition at line 104 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$restrictionContainer.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\applyWorkspaceConstraint(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\changingClonedQueryBuilderDoesNotInfluenceSourceOne(), TYPO3\CMS\Workspaces\Service\WorkspaceService\createQueryBuilderForTable(), TYPO3\CMS\Core\Category\Collection\CategoryCollection\getCollectedRecordsQueryBuilder(), TYPO3\CMS\Backend\Authentication\PasswordReset\getPreparedQueryBuilder(), TYPO3\CMS\Redirects\Repository\RedirectRepository\getQueryBuilder(), TYPO3\CMS\Backend\View\PageLayoutView\getQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getQueryBuilder(), TYPO3\CMS\Redirects\Service\SlugService\getQueryBuilderForPages(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getQueryBuilderWithWorkspaceRestriction(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\getTemplateQueryBuilder(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreReevaluatedOnSettingsChangeForExecute(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreReevaluatedOnSettingsChangeForGetSQL(), TYPO3\CMS\Core\Database\RelationHandler\readForeignField(), TYPO3\CMS\Core\Database\RelationHandler\readMM(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsCanStillBeRemovedAfterTheyHaveBeenLimitedToTables().

◆ getSQL()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::getSQL ( )

Gets the complete SQL string formed by the current specifications of this QueryBuilder.

If the statement is a SELECT TYPE query restrictions based on TCA settings will automatically be applied based on the current QuerySettings.

Returns: ‪string The SQL query string.

Definition at line 230 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\addAdditionalWhereConditions(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getType().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__toString(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\changingClonedQueryBuilderDoesNotInfluenceSourceOne(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreReevaluatedOnSettingsChangeForGetSQL().

◆ getState()

int TYPO3\CMS\Core\Database\Query\QueryBuilder::getState ( )

Gets the state of this query builder instance.

Returns: ‪int Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.

Definition at line 183 of file QueryBuilder.php.

◆ getType()

int TYPO3\CMS\Core\Database\Query\QueryBuilder::getType ( )

Gets the type of the currently built query.

Returns: ‪int

Definition at line 162 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\execute(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getSQL().

◆ groupBy()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::groupBy ( $groupBy )

Specifies a grouping over the results of the query. Replaces any previously specified groupings, if any.

Parameters

string ‪...$groupBy The grouping expression.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 726 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\groupBy(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifiers().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\fetchPagesWithVersionsInTable(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findHostsOfRedirects(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findStatusCodesOfRedirects(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\groupBy().

◆ having()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::having ( $having )

Specifies a restriction over the groups of the query. Replaces any previous having restrictions, if any.

Parameters

mixed ‪...$having The restriction over the groups.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 796 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\having().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\having().

◆ innerJoin()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::innerJoin	(	string	$fromAlias,
		string	$join,
		string	$alias,
		string	$condition = `null`
	)

Creates and adds a join to the query.

Parameters

string	$fromAlias	‪The alias that points to a from clause.
string	$join	‪The table name to join.
string	$alias	‪The alias of the join table.
string \| null	$condition	‪The condition for the join.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 573 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\innerJoin(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\innerJoin(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\join().

◆ insert()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::insert ( string $insert )

Turns the query being built into an insert query that inserts into a certain table

Parameters

string $insert ‪The table into which the rows should be inserted.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 515 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\insert(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\create(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\insert().

◆ join()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::join	(	string	$fromAlias,
		string	$join,
		string	$alias,
		string	$condition = `null`
	)

Creates and adds a join to the query.

Parameters

string	$fromAlias	‪The alias that points to a from clause.
string	$join	‪The table name to join.
string	$alias	‪The alias of the join table.
string \| null	$condition	‪The condition for the join.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 551 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\innerJoin(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

◆ leftJoin()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::leftJoin	(	string	$fromAlias,
		string	$join,
		string	$alias,
		string	$condition = `null`
	)

Creates and adds a left join to the query.

Parameters

string	$fromAlias	‪The alias that points to a from clause.
string	$join	‪The table name to join.
string	$alias	‪The alias of the join table.
string \| null	$condition	‪The condition for the join.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 595 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\andX(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier().

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\limitRestrictionsToTablesLimitsRestrictionsInTheContainerToTheGivenTables(), TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\moveDataFromSysLogToSysHistory(), TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsAreAppliedInJoinConditionForLeftJoins(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsCanStillBeRemovedAfterTheyHaveBeenLimitedToTables().

◆ limitRestrictionsToTables()

TYPO3\CMS\Core\Database\Query\QueryBuilder::limitRestrictionsToTables ( array $tableAliases )

Limits ALL currently active restrictions of the restriction container to the table aliases given

Parameters

array $tableAliases

Definition at line 129 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\limitRestrictionsToTablesLimitsRestrictionsInTheContainerToTheGivenTables(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsCanStillBeRemovedAfterTheyHaveBeenLimitedToTables().

◆ orderBy()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::orderBy	(	string	$fieldName,
		string	$order = `null`
	)

Specifies an ordering for the query results. Replaces any previously specified orderings, if any.

Parameters

string	$fieldName	‪The fieldName to order by. Will be quoted according to database platform automatically.
string \| null	$order	‪The ordering direction. No automatic quoting/escaping.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 841 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\orderBy().

Referenced by TYPO3\CMS\Redirects\Repository\RedirectRepository\findHostsOfRedirects(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findStatusCodesOfRedirects(), TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\moveDataFromSysLogToSysHistory(), TYPO3\CMS\Core\Database\Query\QueryBuilder\orderBy(), TYPO3\CMS\Backend\History\RecordHistory\prepareEventDataFromQueryBuilder(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder().

◆ orHaving()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::orHaving ( $having )

Adds a restriction over the groups of the query, forming a logical disjunction with any existing having restrictions.

Parameters

mixed ‪...$having The restriction to add.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 825 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\orHaving().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\orHaving().

◆ orWhere()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::orWhere ( $where )

Adds one or more restrictions to the query results, forming a logical disjunction with any previously specified restrictions.

Parameters

string|CompositeExpression ‪...$where The WHERE statement.

Returns: ‪QueryBuilder This QueryBuilder instance.

See also: ‪where()

Definition at line 711 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\orWhere().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\fetchPagesWithVersionsInTable(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\orWhere().

◆ quote()

mixed TYPO3\CMS\Core\Database\Query\QueryBuilder::quote	(		$input,
		int	$type = `null`
	)

Quotes a given input parameter.

Parameters

mixed	$input	‪The parameter to be quoted.
int \| null	$type	‪The type of the parameter.

Returns: ‪mixed Often string, but also int or float or similar depending on $input and platform

Definition at line 984 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection().

◆ quoteColumnValuePairs()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::quoteColumnValuePairs ( array $input )

Quotes an associative array of column-value so the column names can be safely used, even if the name is a reserved name.

Delimiting style depends on the underlying database platform that is being used.

Parameters

array $input

Returns: ‪array

Definition at line 1078 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection(), and TYPO3\CMS\Core\Database\Connection\quoteColumnValuePairs().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\values().

◆ quoteIdentifier()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::quoteIdentifier ( string $identifier )

Quotes a string so it can be safely used as a table or column name, even if it is a reserved name.

Delimiting style depends on the underlying database platform that is being used.

Parameters

string $identifier ‪The name to be quoted.

Returns: ‪string The quoted name.

Definition at line 999 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection(), and TYPO3\CMS\Core\Database\Connection\quoteIdentifier().

◆ quoteIdentifiers()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::quoteIdentifiers ( array $input )

Quotes an array of column names so it can be safely used, even if the name is a reserved name.

Delimiting style depends on the underlying database platform that is being used.

Parameters

array $input

Returns: ‪array

Definition at line 1013 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection(), and TYPO3\CMS\Core\Database\Connection\quoteIdentifiers().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addGroupBy(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\groupBy().

◆ quoteIdentifiersForSelect()

array TYPO3\CMS\Core\Database\Query\QueryBuilder::quoteIdentifiersForSelect ( array $input )

Quotes an array of column names so it can be safely used, even if the name is a reserved name. Takes into account the special case of the * placeholder that can only be used in SELECT type statements.

Delimiting style depends on the underlying database platform that is being used.

Parameters

array $input

Returns: ‪array

Exceptions

Definition at line 1030 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\addSelect(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\select().

◆ resetQueryPart()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::resetQueryPart ( $queryPartName )

Resets a single SQL part.

Parameters

string $queryPartName

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 906 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\resetQueryPart().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\resetQueryPart().

◆ resetQueryParts()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::resetQueryParts ( array $queryPartNames = null )

Resets SQL parts.

Parameters

array | null $queryPartNames

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 892 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\resetQueryParts().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\resetQueryParts().

◆ resetRestrictions()

TYPO3\CMS\Core\Database\Query\QueryBuilder::resetRestrictions ( )

Re-apply default restrictions

Definition at line 137 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\setRestrictions().

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\queryRestrictionsAreReevaluatedOnSettingsChangeForExecute().

◆ rightJoin()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::rightJoin	(	string	$fromAlias,
		string	$join,
		string	$alias,
		string	$condition = `null`
	)

Creates and adds a right join to the query.

Parameters

string	$fromAlias	‪The alias that points to a from clause.
string	$join	‪The table name to join.
string	$alias	‪The alias of the join table.
string \| null	$condition	‪The condition for the join.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 623 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\andX(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), TYPO3\CMS\Core\Database\Query\QueryBuilder\getQueryPart(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\unquoteSingleIdentifier().

Referenced by TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\restrictionsAreAppliedInJoinConditionForRightJoins().

◆ select()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::select ( string ... $selects )

Specifies items that are to be returned in the query result. Replaces any previously specified selections, if any.

Parameters

string ‪...$selects

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 416 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifiersForSelect(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\select().

◆ selectLiteral()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::selectLiteral ( string ... $selects )

Specifies items that are to be returned in the query result. Replaces any previously specified selections, if any. This should only be used for literal SQL expressions as no quoting/escaping of any kind will be performed on the items.

Parameters

string ‪...$selects Literal SQL expressions to be selected. Warning: No quoting will be done!

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 445 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\select().

◆ set()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::set	(	string	$key,
			$value,
		bool	$createNamedParameter = `true`,
		int	$type = `\PDO::PARAM_STR`
	)

Sets a new value for a column in a bulk update query.

Parameters

string	$key	‪The column to set.
string	$value	‪The value, expression, placeholder, etc.
bool	$createNamedParameter	‪Automatically create a named parameter for the value
int	$type

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 660 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\set().

Referenced by TYPO3\CMS\Core\Database\RelationHandler\remapMM(), TYPO3\CMS\Core\Database\Query\QueryBuilder\set(), and TYPO3\CMS\Core\Tests\Unit\Database\Query\QueryBuilderTest\setWithNamedParameterPassesGivenTypeToCreateNamedParameter().

◆ setFirstResult()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::setFirstResult ( int $firstResult )

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

Parameters

int $firstResult ‪The first result to return.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 330 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\setFirstResult().

Referenced by TYPO3\CMS\Redirects\Repository\RedirectRepository\findRedirectsByDemand(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\setFirstResult().

◆ setMaxResults()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::setMaxResults ( int $maxResults )

Sets the maximum number of results to retrieve (the "limit").

Parameters

int $maxResults ‪The maximum number of results to retrieve.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 355 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\setMaxResults().

Referenced by TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getFirstTemplate(), TYPO3\CMS\Redirects\Repository\RedirectRepository\findRedirectsByDemand(), TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\moveDataFromSysLogToSysHistory(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\setMaxResults().

◆ setParameter()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::setParameter	(		$key,
			$value,
		int	$type = `null`
	)

Sets a query parameter for the query being constructed.

Parameters

string \| int	$key	‪The parameter position or name.
mixed	$value	‪The parameter value.
int \| null	$type	‪One of the Connection::PARAM_* constants.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 257 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\setParameter().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\setParameter().

◆ setParameters()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::setParameters	(	array	$params,
		array	$types = `[]`
	)

Sets a collection of query parameters for the query being constructed.

Parameters

array	$params	‪The query parameters to set.
array	$types	‪The query parameters types to set.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 272 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\setParameters().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\setParameters().

◆ setRestrictions()

TYPO3\CMS\Core\Database\Query\QueryBuilder::setRestrictions ( QueryRestrictionContainerInterface $restrictionContainer )

Parameters

QueryRestrictionContainerInterface $restrictionContainer

Definition at line 112 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\$restrictionContainer, and TYPO3\CMS\Core\Database\Query\Restriction\QueryRestrictionContainerInterface\add().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__construct(), TYPO3\CMS\Core\Routing\Aspect\PersistedPatternMapper\createQueryBuilder(), TYPO3\CMS\Core\Routing\Aspect\PersistedAliasMapper\createQueryBuilder(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\resetRestrictions().

◆ setValue()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::setValue	(	string	$column,
			$value,
		bool	$createNamedParameter = `true`
	)

Sets a value for a column in an insert query.

Parameters

string	$column	‪The column into which the value should be inserted.
string	$value	‪The value that should be inserted into the column.
bool	$createNamedParameter	‪Automatically create a named parameter for the value

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 756 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\setValue().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\setValue().

◆ unquoteSingleIdentifier()

string TYPO3\CMS\Core\Database\Query\QueryBuilder::unquoteSingleIdentifier ( string $identifier )

protected

Unquote a single identifier (no dot expansion). Used to unquote the table names from the expressionBuilder so that the table can be found in the TCA definition.

Parameters

string $identifier ‪The identifier / table name

Returns: ‪string The unquoted table name / identifier

Definition at line 1130 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection().

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\getQueriedTables(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\rightJoin().

◆ update()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::update	(	string	$update,
		string	$alias = `null`
	)

Turns the query being built into a bulk update query that ranges over a certain table

Parameters

string	$update	‪The table whose rows are subject to the update.
string \| null	$alias	‪The table alias used in the constructed query.

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 497 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteIdentifier(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\update().

Referenced by TYPO3\CMS\Core\Database\RelationHandler\remapMM(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\update().

◆ values()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::values	(	array	$values,
		bool	$createNamedParameters = `true`
	)

Specifies values for an insert query indexed by column names. Replaces any previous values, if any.

Parameters

array	$values	‪The values to specify for the insert query indexed by column names.
bool	$createNamedParameters	‪Automatically create named parameters for all values

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 775 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\quoteColumnValuePairs().

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\create().

◆ where()

QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::where ( $predicates )

Specifies one or more restrictions to the query result. Replaces any previously specified restrictions, if any.

Parameters

string|CompositeExpression ‪...$predicates

Returns: ‪QueryBuilder This QueryBuilder instance.

Definition at line 677 of file QueryBuilder.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\where().

Member Data Documentation

◆ $additionalRestrictions

array TYPO3\CMS\Core\Database\Query\QueryBuilder::$additionalRestrictions

protected

Definition at line 69 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__construct().

◆ $concreteQueryBuilder

Doctrine DBAL Query QueryBuilder TYPO3\CMS\Core\Database\Query\QueryBuilder::$concreteQueryBuilder

protected

Definition at line 61 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__clone(), TYPO3\CMS\Core\Database\Query\QueryBuilder\__construct(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getConcreteQueryBuilder().

◆ $connection

Connection TYPO3\CMS\Core\Database\Query\QueryBuilder::$connection

protected

The DBAL Connection.

Definition at line 57 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__construct(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\getConnection().

◆ $restrictionContainer

QueryRestrictionContainerInterface TYPO3\CMS\Core\Database\Query\QueryBuilder::$restrictionContainer

protected

Definition at line 65 of file QueryBuilder.php.

Referenced by TYPO3\CMS\Core\Database\Query\QueryBuilder\__clone(), TYPO3\CMS\Core\Database\Query\QueryBuilder\getRestrictions(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\setRestrictions().

◆ $restrictionsAppliedInJoinCondition

string [] TYPO3\CMS\Core\Database\Query\QueryBuilder::$restrictionsAppliedInJoinCondition = array( )

private

List of table aliases which are completely ignored when generating the table restrictions in the where-clause.

Aliases added here are part of a LEFT/RIGHT JOIN, having their restrictions applied in the JOIN's ON condition already.

Definition at line 79 of file QueryBuilder.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ __toString()

◆ add()

◆ addAdditionalWhereConditions()

◆ addGroupBy()

◆ addOrderBy()

◆ addSelect()

◆ addSelectLiteral()

◆ andHaving()

◆ andWhere()

◆ castFieldToTextType()

◆ count()

◆ createNamedParameter()

◆ createPositionalParameter()

◆ delete()

◆ escapeLikeWildcards()

◆ execute()

◆ expr()

◆ from()

◆ getConcreteQueryBuilder()

◆ getConnection()

◆ getFirstResult()

◆ getMaxResults()

◆ getParameter()

◆ getParameters()

◆ getParameterType()

◆ getParameterTypes()

◆ getQueriedTables()

◆ getQueryPart()

◆ getQueryParts()

◆ getRestrictions()

◆ getSQL()

◆ getState()

◆ getType()

◆ groupBy()

◆ having()

◆ innerJoin()

◆ insert()

◆ join()

◆ leftJoin()

◆ limitRestrictionsToTables()

◆ orderBy()

◆ orHaving()

◆ orWhere()

◆ quote()

◆ quoteColumnValuePairs()

◆ quoteIdentifier()

◆ quoteIdentifiers()

◆ quoteIdentifiersForSelect()

◆ resetQueryPart()

◆ resetQueryParts()

◆ resetRestrictions()

◆ rightJoin()

◆ select()

◆ selectLiteral()

◆ set()

◆ setFirstResult()

◆ setMaxResults()

◆ setParameter()

◆ setParameters()

◆ setRestrictions()

◆ setValue()

◆ unquoteSingleIdentifier()

◆ update()

◆ values()

◆ where()

Member Data Documentation

◆ $additionalRestrictions

◆ $concreteQueryBuilder

◆ $connection

◆ $restrictionContainer

◆ $restrictionsAppliedInJoinCondition