123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313 |
- <?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\Expression;
- use Doctrine\DBAL\Connection;
- /**
- * ExpressionBuilder class is responsible to dynamically create SQL query parts.
- *
- * @link www.doctrine-project.org
- * @since 2.1
- * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
- * @author Benjamin Eberlei <kontakt@beberlei.de>
- */
- class ExpressionBuilder
- {
- const EQ = '=';
- const NEQ = '<>';
- const LT = '<';
- const LTE = '<=';
- const GT = '>';
- const GTE = '>=';
- /**
- * The DBAL Connection.
- *
- * @var \Doctrine\DBAL\Connection
- */
- private $connection;
- /**
- * Initializes a new <tt>ExpressionBuilder</tt>.
- *
- * @param \Doctrine\DBAL\Connection $connection The DBAL Connection.
- */
- public function __construct(Connection $connection)
- {
- $this->connection = $connection;
- }
- /**
- * Creates a conjunction of the given boolean expressions.
- *
- * Example:
- *
- * [php]
- * // (u.type = ?) AND (u.role = ?)
- * $expr->andX('u.type = ?', 'u.role = ?'));
- *
- * @param mixed $x Optional clause. Defaults = null, but requires
- * at least one defined when converting to string.
- *
- * @return \Doctrine\DBAL\Query\Expression\CompositeExpression
- */
- public function andX($x = null)
- {
- return new CompositeExpression(CompositeExpression::TYPE_AND, func_get_args());
- }
- /**
- * Creates a disjunction of the given boolean expressions.
- *
- * Example:
- *
- * [php]
- * // (u.type = ?) OR (u.role = ?)
- * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
- *
- * @param mixed $x Optional clause. Defaults = null, but requires
- * at least one defined when converting to string.
- *
- * @return \Doctrine\DBAL\Query\Expression\CompositeExpression
- */
- public function orX($x = null)
- {
- return new CompositeExpression(CompositeExpression::TYPE_OR, func_get_args());
- }
- /**
- * Creates a comparison expression.
- *
- * @param mixed $x The left expression.
- * @param string $operator One of the ExpressionBuilder::* constants.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function comparison($x, $operator, $y)
- {
- return $x . ' ' . $operator . ' ' . $y;
- }
- /**
- * Creates an equality comparison expression with the given arguments.
- *
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> = <right expr>. Example:
- *
- * [php]
- * // u.id = ?
- * $expr->eq('u.id', '?');
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function eq($x, $y)
- {
- return $this->comparison($x, self::EQ, $y);
- }
- /**
- * Creates a non equality comparison expression with the given arguments.
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> <> <right expr>. Example:
- *
- * [php]
- * // u.id <> 1
- * $q->where($q->expr()->neq('u.id', '1'));
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function neq($x, $y)
- {
- return $this->comparison($x, self::NEQ, $y);
- }
- /**
- * Creates a lower-than comparison expression with the given arguments.
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> < <right expr>. Example:
- *
- * [php]
- * // u.id < ?
- * $q->where($q->expr()->lt('u.id', '?'));
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function lt($x, $y)
- {
- return $this->comparison($x, self::LT, $y);
- }
- /**
- * Creates a lower-than-equal comparison expression with the given arguments.
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> <= <right expr>. Example:
- *
- * [php]
- * // u.id <= ?
- * $q->where($q->expr()->lte('u.id', '?'));
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function lte($x, $y)
- {
- return $this->comparison($x, self::LTE, $y);
- }
- /**
- * Creates a greater-than comparison expression with the given arguments.
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> > <right expr>. Example:
- *
- * [php]
- * // u.id > ?
- * $q->where($q->expr()->gt('u.id', '?'));
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function gt($x, $y)
- {
- return $this->comparison($x, self::GT, $y);
- }
- /**
- * Creates a greater-than-equal comparison expression with the given arguments.
- * First argument is considered the left expression and the second is the right expression.
- * When converted to string, it will generated a <left expr> >= <right expr>. Example:
- *
- * [php]
- * // u.id >= ?
- * $q->where($q->expr()->gte('u.id', '?'));
- *
- * @param mixed $x The left expression.
- * @param mixed $y The right expression.
- *
- * @return string
- */
- public function gte($x, $y)
- {
- return $this->comparison($x, self::GTE, $y);
- }
- /**
- * Creates an IS NULL expression with the given arguments.
- *
- * @param string $x The field in string format to be restricted by IS NULL.
- *
- * @return string
- */
- public function isNull($x)
- {
- return $x . ' IS NULL';
- }
- /**
- * Creates an IS NOT NULL expression with the given arguments.
- *
- * @param string $x The field in string format to be restricted by IS NOT NULL.
- *
- * @return string
- */
- public function isNotNull($x)
- {
- return $x . ' IS NOT NULL';
- }
- /**
- * Creates a LIKE() comparison expression with the given arguments.
- *
- * @param string $x Field in string format to be inspected by LIKE() comparison.
- * @param mixed $y Argument to be used in LIKE() comparison.
- *
- * @return string
- */
- public function like($x, $y)
- {
- return $this->comparison($x, 'LIKE', $y);
- }
-
- /**
- * Creates a NOT LIKE() comparison expression with the given arguments.
- *
- * @param string $x Field in string format to be inspected by NOT LIKE() comparison.
- * @param mixed $y Argument to be used in NOT LIKE() comparison.
- *
- * @return string
- */
- public function notLike($x, $y)
- {
- return $this->comparison($x, 'NOT LIKE', $y);
- }
- /**
- * Creates a IN () comparison expression with the given arguments.
- *
- * @param string $x The field in string format to be inspected by IN() comparison.
- * @param array $y The array of values to be used by IN() comparison.
- *
- * @return string
- */
- public function in($x, array $y)
- {
- return $this->comparison($x, 'IN', '('.implode(', ', $y).')');
- }
- /**
- * Creates a NOT IN () comparison expression with the given arguments.
- *
- * @param string $x The field in string format to be inspected by NOT IN() comparison.
- * @param array $y The array of values to be used by NOT IN() comparison.
- *
- * @return string
- */
- public function notIn($x, array $y)
- {
- return $this->comparison($x, 'NOT IN', '('.implode(', ', $y).')');
- }
- /**
- * Quotes a given input parameter.
- *
- * @param mixed $input The parameter to be quoted.
- * @param string|null $type The type of the parameter.
- *
- * @return string
- */
- public function literal($input, $type = null)
- {
- return $this->connection->quote($input, $type);
- }
- }
|