1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189 |
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the MIT license. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\DBAL\Query;
- use Doctrine\DBAL\Query\Expression\CompositeExpression;
- use Doctrine\DBAL\Connection;
- /**
- * 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.
- *
- * @link www.doctrine-project.org
- * @since 2.1
- * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
- * @author Benjamin Eberlei <kontakt@beberlei.de>
- */
- class QueryBuilder
- {
- /*
- * The query types.
- */
- const SELECT = 0;
- const DELETE = 1;
- const UPDATE = 2;
- /*
- * The builder states.
- */
- const STATE_DIRTY = 0;
- const STATE_CLEAN = 1;
- /**
- * The DBAL Connection.
- *
- * @var \Doctrine\DBAL\Connection
- */
- private $connection;
- /**
- * @var array The array of SQL parts collected.
- */
- private $sqlParts = array(
- 'select' => array(),
- 'from' => array(),
- 'join' => array(),
- 'set' => array(),
- 'where' => null,
- 'groupBy' => array(),
- 'having' => null,
- 'orderBy' => array()
- );
- /**
- * The complete SQL string for this query.
- *
- * @var string
- */
- private $sql;
- /**
- * The query parameters.
- *
- * @var array
- */
- private $params = array();
- /**
- * The parameter type map of this query.
- *
- * @var array
- */
- private $paramTypes = array();
- /**
- * The type of query this is. Can be select, update or delete.
- *
- * @var integer
- */
- private $type = self::SELECT;
- /**
- * The state of the query object. Can be dirty or clean.
- *
- * @var integer
- */
- private $state = self::STATE_CLEAN;
- /**
- * The index of the first result to retrieve.
- *
- * @var integer
- */
- private $firstResult = null;
- /**
- * The maximum number of results to retrieve.
- *
- * @var integer
- */
- private $maxResults = null;
- /**
- * The counter of bound parameters used with {@see bindValue).
- *
- * @var integer
- */
- private $boundCounter = 0;
- /**
- * Initializes a new <tt>QueryBuilder</tt>.
- *
- * @param \Doctrine\DBAL\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 \Doctrine\DBAL\Query\Expression\ExpressionBuilder
- */
- public function expr()
- {
- return $this->connection->getExpressionBuilder();
- }
- /**
- * Gets the type of the currently built query.
- *
- * @return integer
- */
- public function getType()
- {
- return $this->type;
- }
- /**
- * Gets the associated DBAL Connection for this query builder.
- *
- * @return \Doctrine\DBAL\Connection
- */
- public function getConnection()
- {
- return $this->connection;
- }
- /**
- * Gets the state of this query builder instance.
- *
- * @return integer 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 mixed
- */
- public function execute()
- {
- if ($this->type == self::SELECT) {
- return $this->connection->executeQuery($this->getSQL(), $this->params, $this->paramTypes);
- } else {
- 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::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|integer $key The parameter position or name.
- * @param mixed $value The parameter value.
- * @param string|null $type One of the PDO::PARAM_* constants.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder 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 array $params The query parameters to set.
- * @param array $types The query parameters types to set.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function setParameters(array $params, array $types = array())
- {
- $this->paramTypes = $types;
- $this->params = $params;
- return $this;
- }
- /**
- * Gets all defined query parameters for the query being constructed.
- *
- * @return array The currently defined query parameters.
- */
- 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 isset($this->params[$key]) ? $this->params[$key] : null;
- }
- /**
- * Sets the position of the first result to retrieve (the "offset").
- *
- * @param integer $firstResult The first result to return.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder 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 integer The position of the first result.
- */
- public function getFirstResult()
- {
- return $this->firstResult;
- }
- /**
- * Sets the maximum number of results to retrieve (the "limit").
- *
- * @param integer $maxResults The maximum number of results to retrieve.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder 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 integer 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 boolean $append
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function add($sqlPartName, $sqlPart, $append = false)
- {
- $isArray = is_array($sqlPart);
- $isMultiple = is_array($this->sqlParts[$sqlPartName]);
- if ($isMultiple && !$isArray) {
- $sqlPart = array($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;
- }
- } else if ($isArray && is_array($sqlPart[key($sqlPart)])) {
- $key = key($sqlPart);
- $this->sqlParts[$sqlPartName][$key][] = $sqlPart[$key];
- } else if ($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 \Doctrine\DBAL\Query\QueryBuilder 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, false);
- }
- /**
- * 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 \Doctrine\DBAL\Query\QueryBuilder 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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function delete($delete = null, $alias = null)
- {
- $this->type = self::DELETE;
- if ( ! $delete) {
- return $this;
- }
- return $this->add('from', array(
- '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('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where('u.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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function update($update = null, $alias = null)
- {
- $this->type = self::UPDATE;
- if ( ! $update) {
- return $this;
- }
- return $this->add('from', array(
- 'table' => $update,
- 'alias' => $alias
- ));
- }
- /**
- * 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 $alias The alias of the table.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function from($from, $alias)
- {
- return $this->add('from', array(
- '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 \Doctrine\DBAL\Query\QueryBuilder 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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function innerJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', array(
- $fromAlias => array(
- '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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function leftJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', array(
- $fromAlias => array(
- '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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function rightJoin($fromAlias, $join, $alias, $condition = null)
- {
- return $this->add('join', array(
- $fromAlias => array(
- '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('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where('u.id = ?');
- * </code>
- *
- * @param string $key The column to set.
- * @param string $value The value, expression, placeholder, etc.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder 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('u.name')
- * ->from('users', 'u')
- * ->where('u.id = ?');
- *
- * // You can optionally programatically build and/or expressions
- * $qb = $conn->createQueryBuilder();
- *
- * $or = $qb->expr()->orx();
- * $or->add($qb->expr()->eq('u.id', 1));
- * $or->add($qb->expr()->eq('u.id', 2));
- *
- * $qb->update('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where($or);
- * </code>
- *
- * @param mixed $predicates The restriction predicates.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder 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>
- *
- * @param mixed $where The query restrictions.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- *
- * @see where()
- */
- public function andWhere($where)
- {
- $where = $this->getQueryPart('where');
- $args = func_get_args();
- 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>
- *
- * @param mixed $where The WHERE statement.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- *
- * @see where()
- */
- public function orWhere($where)
- {
- $where = $this->getQueryPart('where');
- $args = func_get_args();
- 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 \Doctrine\DBAL\Query\QueryBuilder 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 \Doctrine\DBAL\Query\QueryBuilder 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);
- }
- /**
- * 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 \Doctrine\DBAL\Query\QueryBuilder 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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function andHaving($having)
- {
- $having = $this->getQueryPart('having');
- $args = func_get_args();
- 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 \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function orHaving($having)
- {
- $having = $this->getQueryPart('having');
- $args = func_get_args();
- 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 \Doctrine\DBAL\Query\QueryBuilder 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 \Doctrine\DBAL\Query\QueryBuilder 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 array
- */
- public function getQueryParts()
- {
- return $this->sqlParts;
- }
- /**
- * Resets SQL parts.
- *
- * @param array|null $queryPartNames
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function resetQueryParts($queryPartNames = null)
- {
- if (is_null($queryPartNames)) {
- $queryPartNames = array_keys($this->sqlParts);
- }
- foreach ($queryPartNames as $queryPartName) {
- $this->resetQueryPart($queryPartName);
- }
- return $this;
- }
- /**
- * Resets a single SQL part.
- *
- * @param string $queryPartName
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
- */
- public function resetQueryPart($queryPartName)
- {
- $this->sqlParts[$queryPartName] = is_array($this->sqlParts[$queryPartName])
- ? array() : null;
- $this->state = self::STATE_DIRTY;
- return $this;
- }
- /**
- * @return string
- *
- * @throws \Doctrine\DBAL\Query\QueryException
- */
- private function getSQLForSelect()
- {
- $query = 'SELECT ' . implode(', ', $this->sqlParts['select']) . ' FROM ';
- $fromClauses = array();
- $knownAliases = array();
- // Loop through all FROM clauses
- foreach ($this->sqlParts['from'] as $from) {
- $knownAliases[$from['alias']] = true;
- $fromClause = $from['table'] . ' ' . $from['alias']
- . $this->getSQLForJoins($from['alias'], $knownAliases);
- $fromClauses[$from['alias']] = $fromClause;
- }
- foreach ($this->sqlParts['join'] as $fromAlias => $joins) {
- if ( ! isset($knownAliases[$fromAlias]) ) {
- throw QueryException::unknownAlias($fromAlias, array_keys($knownAliases));
- }
- }
- $query .= implode(', ', $fromClauses)
- . ($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']) : '');
- return ($this->maxResults === null && $this->firstResult == null)
- ? $query
- : $this->connection->getDatabasePlatform()->modifyLimitQuery($query, $this->maxResults, $this->firstResult);
- }
- /**
- * 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'] : '');
- $query = 'UPDATE ' . $table
- . ' SET ' . implode(", ", $this->sqlParts['set'])
- . ($this->sqlParts['where'] !== null ? ' WHERE ' . ((string) $this->sqlParts['where']) : '');
- return $query;
- }
- /**
- * 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'] : '');
- $query = 'DELETE FROM ' . $table . ($this->sqlParts['where'] !== null ? ' WHERE ' . ((string) $this->sqlParts['where']) : '');
- return $query;
- }
- /**
- * 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>
- *
- * @license New BSD License
- * @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 = \PDO::PARAM_STR, $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', PDO::PARAM_STR))
- * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR))
- * </code>
- *
- * @param mixed $value
- * @param integer $type
- *
- * @return string
- */
- public function createPositionalParameter($value, $type = \PDO::PARAM_STR)
- {
- $this->boundCounter++;
- $this->setParameter($this->boundCounter, $value, $type);
- return "?";
- }
- /**
- * @param string $fromAlias
- * @param array $knownAliases
- *
- * @return string
- */
- private function getSQLForJoins($fromAlias, array &$knownAliases)
- {
- $sql = '';
- if (isset($this->sqlParts['join'][$fromAlias])) {
- foreach ($this->sqlParts['join'][$fromAlias] as $join) {
- $sql .= ' ' . strtoupper($join['joinType'])
- . ' JOIN ' . $join['joinTable'] . ' ' . $join['joinAlias']
- . ' ON ' . ((string) $join['joinCondition']);
- $knownAliases[$join['joinAlias']] = true;
- $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)) {
- $this->sqlParts[$part][$idx] = clone $element;
- }
- }
- } else if (is_object($elements)) {
- $this->sqlParts[$part] = clone $elements;
- }
- }
- foreach ($this->params as $name => $param) {
- if(is_object($param)){
- $this->params[$name] = clone $param;
- }
- }
- }
- }
|