123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347 |
- <?php
- namespace Doctrine\DBAL\Query;
- use Doctrine\DBAL\Connection;
- use Doctrine\DBAL\Driver\Statement;
- use Doctrine\DBAL\ParameterType;
- use Doctrine\DBAL\Query\Expression\CompositeExpression;
- use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
- use function array_key_exists;
- use function array_keys;
- use function array_unshift;
- use function func_get_args;
- use function func_num_args;
- use function implode;
- use function is_array;
- use function is_object;
- use function key;
- use function strtoupper;
- use function substr;
- /**
- * QueryBuilder class is responsible to dynamically create SQL queries.
- *
- * Important: Verify that every feature you use will work with your database vendor.
- * SQL Query Builder does not attempt to validate the generated SQL at all.
- *
- * The query builder does no validation whatsoever if certain features even work with the
- * underlying database vendor. Limit queries and joins are NOT applied to UPDATE and DELETE statements
- * even if some vendors such as MySQL support it.
- */
- class QueryBuilder
- {
- /*
- * The query types.
- */
- public const SELECT = 0;
- public const DELETE = 1;
- public const UPDATE = 2;
- public const INSERT = 3;
- /*
- * The builder states.
- */
- public const STATE_DIRTY = 0;
- public const STATE_CLEAN = 1;
- /**
- * The DBAL Connection.
- *
- * @var Connection
- */
- private $connection;
- /**
- * The array of SQL parts collected.
- *
- * @var mixed[]
- */
- private $sqlParts = [
- 'select' => [],
- 'from' => [],
- 'join' => [],
- 'set' => [],
- 'where' => null,
- 'groupBy' => [],
- 'having' => null,
- 'orderBy' => [],
- 'values' => [],
- ];
- /**
- * The complete SQL string for this query.
- *
- * @var string
- */
- private $sql;
- /**
- * The query parameters.
- *
- * @var mixed[]
- */
- private $params = [];
- /**
- * The parameter type map of this query.
- *
- * @var int[]|string[]
- */
- private $paramTypes = [];
- /**
- * The type of query this is. Can be select, update or delete.
- *
- * @var int
- */
- private $type = self::SELECT;
- /**
- * The state of the query object. Can be dirty or clean.
- *
- * @var int
- */
- private $state = self::STATE_CLEAN;
- /**
- * The index of the first result to retrieve.
- *
- * @var int
- */
- private $firstResult = null;
- /**
- * The maximum number of results to retrieve.
- *
- * @var int
- */
- private $maxResults = null;
- /**
- * The counter of bound parameters used with {@see bindValue).
- *
- * @var int
- */
- private $boundCounter = 0;
- /**
- * Initializes a new <tt>QueryBuilder</tt>.
- *
- * @param Connection $connection The DBAL Connection.
- */
- public function __construct(Connection $connection)
- {
- $this->connection = $connection;
- }
- /**
- * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
- * This producer method is intended for convenient inline usage. Example:
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where($qb->expr()->eq('u.id', 1));
- * </code>
- *
- * For more complex expression construction, consider storing the expression
- * builder object in a local variable.
- *
- * @return ExpressionBuilder
- */
- public function expr()
- {
- return $this->connection->getExpressionBuilder();
- }
- /**
- * Gets the type of the currently built query.
- *
- * @return int
- */
- public function getType()
- {
- return $this->type;
- }
- /**
- * Gets the associated DBAL Connection for this query builder.
- *
- * @return Connection
- */
- public function getConnection()
- {
- return $this->connection;
- }
- /**
- * Gets the state of this query builder instance.
- *
- * @return int Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
- */
- public function getState()
- {
- return $this->state;
- }
- /**
- * Executes this query using the bound parameters and their types.
- *
- * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
- * for insert, update and delete statements.
- *
- * @return Statement|int
- */
- public function execute()
- {
- if ($this->type === self::SELECT) {
- return $this->connection->executeQuery($this->getSQL(), $this->params, $this->paramTypes);
- }
- return $this->connection->executeUpdate($this->getSQL(), $this->params, $this->paramTypes);
- }
- /**
- * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
- *
- * <code>
- * $qb = $em->createQueryBuilder()
- * ->select('u')
- * ->from('User', 'u')
- * echo $qb->getSQL(); // SELECT u FROM User u
- * </code>
- *
- * @return string The SQL query string.
- */
- public function getSQL()
- {
- if ($this->sql !== null && $this->state === self::STATE_CLEAN) {
- return $this->sql;
- }
- switch ($this->type) {
- case self::INSERT:
- $sql = $this->getSQLForInsert();
- break;
- case self::DELETE:
- $sql = $this->getSQLForDelete();
- break;
- case self::UPDATE:
- $sql = $this->getSQLForUpdate();
- break;
- case self::SELECT:
- default:
- $sql = $this->getSQLForSelect();
- break;
- }
- $this->state = self::STATE_CLEAN;
- $this->sql = $sql;
- return $sql;
- }
- /**
- * Sets a query parameter for the query being constructed.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.id = :user_id')
- * ->setParameter(':user_id', 1);
- * </code>
- *
- * @param string|int $key The parameter position or name.
- * @param mixed $value The parameter value.
- * @param string|int|null $type One of the {@link \Doctrine\DBAL\ParameterType} constants.
- *
- * @return $this This QueryBuilder instance.
- */
- public function setParameter($key, $value, $type = null)
- {
- if ($type !== null) {
- $this->paramTypes[$key] = $type;
- }
- $this->params[$key] = $value;
- return $this;
- }
- /**
- * Sets a collection of query parameters for the query being constructed.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.id = :user_id1 OR u.id = :user_id2')
- * ->setParameters(array(
- * ':user_id1' => 1,
- * ':user_id2' => 2
- * ));
- * </code>
- *
- * @param mixed[] $params The query parameters to set.
- * @param int[]|string[] $types The query parameters types to set.
- *
- * @return $this This QueryBuilder instance.
- */
- public function setParameters(array $params, array $types = [])
- {
- $this->paramTypes = $types;
- $this->params = $params;
- return $this;
- }
- /**
- * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
- *
- * @return mixed[] The currently defined query parameters indexed by parameter index or name.
- */
- public function getParameters()
- {
- return $this->params;
- }
- /**
- * Gets a (previously set) query parameter of the query being constructed.
- *
- * @param mixed $key The key (index or name) of the bound parameter.
- *
- * @return mixed The value of the bound parameter.
- */
- public function getParameter($key)
- {
- return $this->params[$key] ?? null;
- }
- /**
- * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
- *
- * @return int[]|string[] The currently defined query parameter types indexed by parameter index or name.
- */
- public function getParameterTypes()
- {
- return $this->paramTypes;
- }
- /**
- * Gets a (previously set) query parameter type of the query being constructed.
- *
- * @param mixed $key The key (index or name) of the bound parameter type.
- *
- * @return mixed The value of the bound parameter type.
- */
- public function getParameterType($key)
- {
- return $this->paramTypes[$key] ?? null;
- }
- /**
- * Sets the position of the first result to retrieve (the "offset").
- *
- * @param int $firstResult The first result to return.
- *
- * @return $this This QueryBuilder instance.
- */
- public function setFirstResult($firstResult)
- {
- $this->state = self::STATE_DIRTY;
- $this->firstResult = $firstResult;
- return $this;
- }
- /**
- * Gets the position of the first result the query object was set to retrieve (the "offset").
- * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
- *
- * @return int The position of the first result.
- */
- public function getFirstResult()
- {
- return $this->firstResult;
- }
- /**
- * Sets the maximum number of results to retrieve (the "limit").
- *
- * @param int $maxResults The maximum number of results to retrieve.
- *
- * @return $this This QueryBuilder instance.
- */
- public function setMaxResults($maxResults)
- {
- $this->state = self::STATE_DIRTY;
- $this->maxResults = $maxResults;
- return $this;
- }
- /**
- * Gets the maximum number of results the query object was set to retrieve (the "limit").
- * Returns NULL if {@link setMaxResults} was not applied to this query builder.
- *
- * @return int The maximum number of results.
- */
- public function getMaxResults()
- {
- return $this->maxResults;
- }
- /**
- * Either appends to or replaces a single, generic query part.
- *
- * The available parts are: 'select', 'from', 'set', 'where',
- * 'groupBy', 'having' and 'orderBy'.
- *
- * @param string $sqlPartName
- * @param string $sqlPart
- * @param bool $append
- *
- * @return $this This QueryBuilder instance.
- */
- public function add($sqlPartName, $sqlPart, $append = false)
- {
- $isArray = is_array($sqlPart);
- $isMultiple = is_array($this->sqlParts[$sqlPartName]);
- if ($isMultiple && ! $isArray) {
- $sqlPart = [$sqlPart];
- }
- $this->state = self::STATE_DIRTY;
- if ($append) {
- if ($sqlPartName === 'orderBy' || $sqlPartName === 'groupBy' || $sqlPartName === 'select' || $sqlPartName === 'set') {
- foreach ($sqlPart as $part) {
- $this->sqlParts[$sqlPartName][] = $part;
- }
- } elseif ($isArray && is_array($sqlPart[key($sqlPart)])) {
- $key = key($sqlPart);
- $this->sqlParts[$sqlPartName][$key][] = $sqlPart[$key];
- } elseif ($isMultiple) {
- $this->sqlParts[$sqlPartName][] = $sqlPart;
- } else {
- $this->sqlParts[$sqlPartName] = $sqlPart;
- }
- return $this;
- }
- $this->sqlParts[$sqlPartName] = $sqlPart;
- return $this;
- }
- /**
- * Specifies an item that is to be returned in the query result.
- * Replaces any previously specified selections, if any.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.id', 'p.id')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
- * </code>
- *
- * @param mixed $select The selection expressions.
- *
- * @return $this This QueryBuilder instance.
- */
- public function select($select = null)
- {
- $this->type = self::SELECT;
- if (empty($select)) {
- return $this;
- }
- $selects = is_array($select) ? $select : func_get_args();
- return $this->add('select', $selects);
- }
- /**
- * Adds an item that is to be returned in the query result.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.id')
- * ->addSelect('p.id')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
- * </code>
- *
- * @param mixed $select The selection expression.
- *
- * @return $this This QueryBuilder instance.
- */
- public function addSelect($select = null)
- {
- $this->type = self::SELECT;
- if (empty($select)) {
- return $this;
- }
- $selects = is_array($select) ? $select : func_get_args();
- return $this->add('select', $selects, true);
- }
- /**
- * Turns the query being built into a bulk delete query that ranges over
- * a certain table.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->delete('users', 'u')
- * ->where('u.id = :user_id');
- * ->setParameter(':user_id', 1);
- * </code>
- *
- * @param string $delete The table whose rows are subject to the deletion.
- * @param string $alias The table alias used in the constructed query.
- *
- * @return $this This QueryBuilder instance.
- */
- public function delete($delete = null, $alias = null)
- {
- $this->type = self::DELETE;
- if (! $delete) {
- return $this;
- }
- return $this->add('from', [
- 'table' => $delete,
- 'alias' => $alias,
- ]);
- }
- /**
- * Turns the query being built into a bulk update query that ranges over
- * a certain table
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->update('counters', 'c')
- * ->set('c.value', 'c.value + 1')
- * ->where('c.id = ?');
- * </code>
- *
- * @param string $update The table whose rows are subject to the update.
- * @param string $alias The table alias used in the constructed query.
- *
- * @return $this This QueryBuilder instance.
- */
- public function update($update = null, $alias = null)
- {
- $this->type = self::UPDATE;
- if (! $update) {
- return $this;
- }
- return $this->add('from', [
- 'table' => $update,
- 'alias' => $alias,
- ]);
- }
- /**
- * Turns the query being built into an insert query that inserts into
- * a certain table
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?',
- * 'password' => '?'
- * )
- * );
- * </code>
- *
- * @param string $insert The table into which the rows should be inserted.
- *
- * @return $this This QueryBuilder instance.
- */
- public function insert($insert = null)
- {
- $this->type = self::INSERT;
- if (! $insert) {
- return $this;
- }
- return $this->add('from', ['table' => $insert]);
- }
- /**
- * Creates and adds a query root corresponding to the table identified by the
- * given alias, forming a cartesian product with any existing query roots.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.id')
- * ->from('users', 'u')
- * </code>
- *
- * @param string $from The table.
- * @param string|null $alias The alias of the table.
- *
- * @return $this This QueryBuilder instance.
- */
- public function from($from, $alias = null)
- {
- return $this->add('from', [
- 'table' => $from,
- 'alias' => $alias,
- ], true);
- }
- /**
- * Creates and adds a join to the query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
- public function join($fromAlias, $join, $alias, $condition = null)
- {
- return $this->innerJoin($fromAlias, $join, $alias, $condition);
- }
- /**
- * Creates and adds a join to the query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
- public function innerJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', [
- $fromAlias => [
- 'joinType' => 'inner',
- 'joinTable' => $join,
- 'joinAlias' => $alias,
- 'joinCondition' => $condition,
- ],
- ], true);
- }
- /**
- * Creates and adds a left join to the query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
- public function leftJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', [
- $fromAlias => [
- 'joinType' => 'left',
- 'joinTable' => $join,
- 'joinAlias' => $alias,
- 'joinCondition' => $condition,
- ],
- ], true);
- }
- /**
- * Creates and adds a right join to the query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
- public function rightJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', [
- $fromAlias => [
- 'joinType' => 'right',
- 'joinTable' => $join,
- 'joinAlias' => $alias,
- 'joinCondition' => $condition,
- ],
- ], true);
- }
- /**
- * Sets a new value for a column in a bulk update query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->update('counters', 'c')
- * ->set('c.value', 'c.value + 1')
- * ->where('c.id = ?');
- * </code>
- *
- * @param string $key The column to set.
- * @param string $value The value, expression, placeholder, etc.
- *
- * @return $this This QueryBuilder instance.
- */
- public function set($key, $value)
- {
- return $this->add('set', $key . ' = ' . $value, true);
- }
- /**
- * Specifies one or more restrictions to the query result.
- * Replaces any previously specified restrictions, if any.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('c.value')
- * ->from('counters', 'c')
- * ->where('c.id = ?');
- *
- * // You can optionally programatically build and/or expressions
- * $qb = $conn->createQueryBuilder();
- *
- * $or = $qb->expr()->orx();
- * $or->add($qb->expr()->eq('c.id', 1));
- * $or->add($qb->expr()->eq('c.id', 2));
- *
- * $qb->update('counters', 'c')
- * ->set('c.value', 'c.value + 1')
- * ->where($or);
- * </code>
- *
- * @param mixed $predicates The restriction predicates.
- *
- * @return $this This QueryBuilder instance.
- */
- public function where($predicates)
- {
- if (! (func_num_args() === 1 && $predicates instanceof CompositeExpression)) {
- $predicates = new CompositeExpression(CompositeExpression::TYPE_AND, func_get_args());
- }
- return $this->add('where', $predicates);
- }
- /**
- * Adds one or more restrictions to the query results, forming a logical
- * conjunction with any previously specified restrictions.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.username LIKE ?')
- * ->andWhere('u.is_active = 1');
- * </code>
- *
- * @see where()
- *
- * @param mixed $where The query restrictions.
- *
- * @return $this This QueryBuilder instance.
- */
- public function andWhere($where)
- {
- $args = func_get_args();
- $where = $this->getQueryPart('where');
- if ($where instanceof CompositeExpression && $where->getType() === CompositeExpression::TYPE_AND) {
- $where->addMultiple($args);
- } else {
- array_unshift($args, $where);
- $where = new CompositeExpression(CompositeExpression::TYPE_AND, $args);
- }
- return $this->add('where', $where, true);
- }
- /**
- * Adds one or more restrictions to the query results, forming a logical
- * disjunction with any previously specified restrictions.
- *
- * <code>
- * $qb = $em->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->where('u.id = 1')
- * ->orWhere('u.id = 2');
- * </code>
- *
- * @see where()
- *
- * @param mixed $where The WHERE statement.
- *
- * @return $this This QueryBuilder instance.
- */
- public function orWhere($where)
- {
- $args = func_get_args();
- $where = $this->getQueryPart('where');
- if ($where instanceof CompositeExpression && $where->getType() === CompositeExpression::TYPE_OR) {
- $where->addMultiple($args);
- } else {
- array_unshift($args, $where);
- $where = new CompositeExpression(CompositeExpression::TYPE_OR, $args);
- }
- return $this->add('where', $where, true);
- }
- /**
- * Specifies a grouping over the results of the query.
- * Replaces any previously specified groupings, if any.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->groupBy('u.id');
- * </code>
- *
- * @param mixed $groupBy The grouping expression.
- *
- * @return $this This QueryBuilder instance.
- */
- public function groupBy($groupBy)
- {
- if (empty($groupBy)) {
- return $this;
- }
- $groupBy = is_array($groupBy) ? $groupBy : func_get_args();
- return $this->add('groupBy', $groupBy, false);
- }
- /**
- * Adds a grouping expression to the query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->groupBy('u.lastLogin');
- * ->addGroupBy('u.createdAt')
- * </code>
- *
- * @param mixed $groupBy The grouping expression.
- *
- * @return $this This QueryBuilder instance.
- */
- public function addGroupBy($groupBy)
- {
- if (empty($groupBy)) {
- return $this;
- }
- $groupBy = is_array($groupBy) ? $groupBy : func_get_args();
- return $this->add('groupBy', $groupBy, true);
- }
- /**
- * Sets a value for a column in an insert query.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?'
- * )
- * )
- * ->setValue('password', '?');
- * </code>
- *
- * @param string $column The column into which the value should be inserted.
- * @param string $value The value that should be inserted into the column.
- *
- * @return $this This QueryBuilder instance.
- */
- public function setValue($column, $value)
- {
- $this->sqlParts['values'][$column] = $value;
- return $this;
- }
- /**
- * Specifies values for an insert query indexed by column names.
- * Replaces any previous values, if any.
- *
- * <code>
- * $qb = $conn->createQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?',
- * 'password' => '?'
- * )
- * );
- * </code>
- *
- * @param mixed[] $values The values to specify for the insert query indexed by column names.
- *
- * @return $this This QueryBuilder instance.
- */
- public function values(array $values)
- {
- return $this->add('values', $values);
- }
- /**
- * Specifies a restriction over the groups of the query.
- * Replaces any previous having restrictions, if any.
- *
- * @param mixed $having The restriction over the groups.
- *
- * @return $this This QueryBuilder instance.
- */
- public function having($having)
- {
- if (! (func_num_args() === 1 && $having instanceof CompositeExpression)) {
- $having = new CompositeExpression(CompositeExpression::TYPE_AND, func_get_args());
- }
- return $this->add('having', $having);
- }
- /**
- * Adds a restriction over the groups of the query, forming a logical
- * conjunction with any existing having restrictions.
- *
- * @param mixed $having The restriction to append.
- *
- * @return $this This QueryBuilder instance.
- */
- public function andHaving($having)
- {
- $args = func_get_args();
- $having = $this->getQueryPart('having');
- if ($having instanceof CompositeExpression && $having->getType() === CompositeExpression::TYPE_AND) {
- $having->addMultiple($args);
- } else {
- array_unshift($args, $having);
- $having = new CompositeExpression(CompositeExpression::TYPE_AND, $args);
- }
- return $this->add('having', $having);
- }
- /**
- * Adds a restriction over the groups of the query, forming a logical
- * disjunction with any existing having restrictions.
- *
- * @param mixed $having The restriction to add.
- *
- * @return $this This QueryBuilder instance.
- */
- public function orHaving($having)
- {
- $args = func_get_args();
- $having = $this->getQueryPart('having');
- if ($having instanceof CompositeExpression && $having->getType() === CompositeExpression::TYPE_OR) {
- $having->addMultiple($args);
- } else {
- array_unshift($args, $having);
- $having = new CompositeExpression(CompositeExpression::TYPE_OR, $args);
- }
- return $this->add('having', $having);
- }
- /**
- * Specifies an ordering for the query results.
- * Replaces any previously specified orderings, if any.
- *
- * @param string $sort The ordering expression.
- * @param string $order The ordering direction.
- *
- * @return $this This QueryBuilder instance.
- */
- public function orderBy($sort, $order = null)
- {
- return $this->add('orderBy', $sort . ' ' . (! $order ? 'ASC' : $order), false);
- }
- /**
- * Adds an ordering to the query results.
- *
- * @param string $sort The ordering expression.
- * @param string $order The ordering direction.
- *
- * @return $this This QueryBuilder instance.
- */
- public function addOrderBy($sort, $order = null)
- {
- return $this->add('orderBy', $sort . ' ' . (! $order ? 'ASC' : $order), true);
- }
- /**
- * Gets a query part by its name.
- *
- * @param string $queryPartName
- *
- * @return mixed
- */
- public function getQueryPart($queryPartName)
- {
- return $this->sqlParts[$queryPartName];
- }
- /**
- * Gets all query parts.
- *
- * @return mixed[]
- */
- public function getQueryParts()
- {
- return $this->sqlParts;
- }
- /**
- * Resets SQL parts.
- *
- * @param string[]|null $queryPartNames
- *
- * @return $this This QueryBuilder instance.
- */
- public function resetQueryParts($queryPartNames = null)
- {
- if ($queryPartNames === null) {
- $queryPartNames = array_keys($this->sqlParts);
- }
- foreach ($queryPartNames as $queryPartName) {
- $this->resetQueryPart($queryPartName);
- }
- return $this;
- }
- /**
- * Resets a single SQL part.
- *
- * @param string $queryPartName
- *
- * @return $this This QueryBuilder instance.
- */
- public function resetQueryPart($queryPartName)
- {
- $this->sqlParts[$queryPartName] = is_array($this->sqlParts[$queryPartName])
- ? [] : null;
- $this->state = self::STATE_DIRTY;
- return $this;
- }
- /**
- * @return string
- *
- * @throws QueryException
- */
- private function getSQLForSelect()
- {
- $query = 'SELECT ' . implode(', ', $this->sqlParts['select']);
- $query .= ($this->sqlParts['from'] ? ' FROM ' . implode(', ', $this->getFromClauses()) : '')
- . ($this->sqlParts['where'] !== null ? ' WHERE ' . ((string) $this->sqlParts['where']) : '')
- . ($this->sqlParts['groupBy'] ? ' GROUP BY ' . implode(', ', $this->sqlParts['groupBy']) : '')
- . ($this->sqlParts['having'] !== null ? ' HAVING ' . ((string) $this->sqlParts['having']) : '')
- . ($this->sqlParts['orderBy'] ? ' ORDER BY ' . implode(', ', $this->sqlParts['orderBy']) : '');
- if ($this->isLimitQuery()) {
- return $this->connection->getDatabasePlatform()->modifyLimitQuery(
- $query,
- $this->maxResults,
- $this->firstResult
- );
- }
- return $query;
- }
- /**
- * @return string[]
- */
- private function getFromClauses()
- {
- $fromClauses = [];
- $knownAliases = [];
- // Loop through all FROM clauses
- foreach ($this->sqlParts['from'] as $from) {
- if ($from['alias'] === null) {
- $tableSql = $from['table'];
- $tableReference = $from['table'];
- } else {
- $tableSql = $from['table'] . ' ' . $from['alias'];
- $tableReference = $from['alias'];
- }
- $knownAliases[$tableReference] = true;
- $fromClauses[$tableReference] = $tableSql . $this->getSQLForJoins($tableReference, $knownAliases);
- }
- $this->verifyAllAliasesAreKnown($knownAliases);
- return $fromClauses;
- }
- /**
- * @param string[] $knownAliases
- *
- * @throws QueryException
- */
- private function verifyAllAliasesAreKnown(array $knownAliases)
- {
- foreach ($this->sqlParts['join'] as $fromAlias => $joins) {
- if (! isset($knownAliases[$fromAlias])) {
- throw QueryException::unknownAlias($fromAlias, array_keys($knownAliases));
- }
- }
- }
- /**
- * @return bool
- */
- private function isLimitQuery()
- {
- return $this->maxResults !== null || $this->firstResult !== null;
- }
- /**
- * Converts this instance into an INSERT string in SQL.
- *
- * @return string
- */
- private function getSQLForInsert()
- {
- return 'INSERT INTO ' . $this->sqlParts['from']['table'] .
- ' (' . implode(', ', array_keys($this->sqlParts['values'])) . ')' .
- ' VALUES(' . implode(', ', $this->sqlParts['values']) . ')';
- }
- /**
- * Converts this instance into an UPDATE string in SQL.
- *
- * @return string
- */
- private function getSQLForUpdate()
- {
- $table = $this->sqlParts['from']['table'] . ($this->sqlParts['from']['alias'] ? ' ' . $this->sqlParts['from']['alias'] : '');
- return 'UPDATE ' . $table
- . ' SET ' . implode(', ', $this->sqlParts['set'])
- . ($this->sqlParts['where'] !== null ? ' WHERE ' . ((string) $this->sqlParts['where']) : '');
- }
- /**
- * Converts this instance into a DELETE string in SQL.
- *
- * @return string
- */
- private function getSQLForDelete()
- {
- $table = $this->sqlParts['from']['table'] . ($this->sqlParts['from']['alias'] ? ' ' . $this->sqlParts['from']['alias'] : '');
- return 'DELETE FROM ' . $table . ($this->sqlParts['where'] !== null ? ' WHERE ' . ((string) $this->sqlParts['where']) : '');
- }
- /**
- * Gets a string representation of this QueryBuilder which corresponds to
- * the final SQL query being constructed.
- *
- * @return string The string representation of this QueryBuilder.
- */
- public function __toString()
- {
- return $this->getSQL();
- }
- /**
- * 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.
- *
- * For more information see {@link http://php.net/pdostatement-bindparam}
- *
- * Example:
- * <code>
- * $value = 2;
- * $q->eq( 'id', $q->bindValue( $value ) );
- * $stmt = $q->executeQuery(); // executed with 'id = 2'
- * </code>
- *
- * @link http://www.zetacomponents.org
- *
- * @param mixed $value
- * @param mixed $type
- * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
- *
- * @return string the placeholder name used.
- */
- public function createNamedParameter($value, $type = ParameterType::STRING, $placeHolder = null)
- {
- if ($placeHolder === null) {
- $this->boundCounter++;
- $placeHolder = ':dcValue' . $this->boundCounter;
- }
- $this->setParameter(substr($placeHolder, 1), $value, $type);
- return $placeHolder;
- }
- /**
- * 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.
- *
- * Example:
- * <code>
- * $qb = $conn->createQueryBuilder();
- * $qb->select('u.*')
- * ->from('users', 'u')
- * ->where('u.username = ' . $qb->createPositionalParameter('Foo', ParameterType::STRING))
- * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', ParameterType::STRING))
- * </code>
- *
- * @param mixed $value
- * @param int $type
- *
- * @return string
- */
- public function createPositionalParameter($value, $type = ParameterType::STRING)
- {
- $this->boundCounter++;
- $this->setParameter($this->boundCounter, $value, $type);
- return '?';
- }
- /**
- * @param string $fromAlias
- * @param string[] $knownAliases
- *
- * @return string
- *
- * @throws QueryException
- */
- private function getSQLForJoins($fromAlias, array &$knownAliases)
- {
- $sql = '';
- if (isset($this->sqlParts['join'][$fromAlias])) {
- foreach ($this->sqlParts['join'][$fromAlias] as $join) {
- if (array_key_exists($join['joinAlias'], $knownAliases)) {
- throw QueryException::nonUniqueAlias($join['joinAlias'], array_keys($knownAliases));
- }
- $sql .= ' ' . strtoupper($join['joinType'])
- . ' JOIN ' . $join['joinTable'] . ' ' . $join['joinAlias']
- . ' ON ' . ((string) $join['joinCondition']);
- $knownAliases[$join['joinAlias']] = true;
- }
- foreach ($this->sqlParts['join'][$fromAlias] as $join) {
- $sql .= $this->getSQLForJoins($join['joinAlias'], $knownAliases);
- }
- }
- return $sql;
- }
- /**
- * Deep clone of all expression objects in the SQL parts.
- *
- * @return void
- */
- public function __clone()
- {
- foreach ($this->sqlParts as $part => $elements) {
- if (is_array($this->sqlParts[$part])) {
- foreach ($this->sqlParts[$part] as $idx => $element) {
- if (! is_object($element)) {
- continue;
- }
- $this->sqlParts[$part][$idx] = clone $element;
- }
- } elseif (is_object($elements)) {
- $this->sqlParts[$part] = clone $elements;
- }
- }
- foreach ($this->params as $name => $param) {
- if (! is_object($param)) {
- continue;
- }
- $this->params[$name] = clone $param;
- }
- }
- }
|