Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Collections;
Chris@0: 
Chris@0: use Doctrine\Common\Collections\Expr\Comparison;
Chris@0: use Doctrine\Common\Collections\Expr\CompositeExpression;
Chris@0: use Doctrine\Common\Collections\Expr\Value;
Chris@0: 
Chris@0: /**
Chris@0:  * Builder for Expressions in the {@link Selectable} interface.
Chris@0:  *
Chris@0:  * Important Notice for interoperable code: You have to use scalar
Chris@12:  * values only for comparisons, otherwise the behavior of the comparison
Chris@0:  * may be different between implementations (Array vs ORM vs ODM).
Chris@0:  *
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  * @since  2.3
Chris@0:  */
Chris@0: class ExpressionBuilder
Chris@0: {
Chris@0:     /**
Chris@0:      * @param mixed $x
Chris@0:      *
Chris@0:      * @return CompositeExpression
Chris@0:      */
Chris@0:     public function andX($x = null)
Chris@0:     {
Chris@0:         return new CompositeExpression(CompositeExpression::TYPE_AND, func_get_args());
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param mixed $x
Chris@0:      *
Chris@0:      * @return CompositeExpression
Chris@0:      */
Chris@0:     public function orX($x = null)
Chris@0:     {
Chris@0:         return new CompositeExpression(CompositeExpression::TYPE_OR, func_get_args());
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function eq($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::EQ, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function gt($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::GT, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function lt($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::LT, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function gte($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::GTE, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function lte($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::LTE, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function neq($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::NEQ, new Value($value));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function isNull($field)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::EQ, new Value(null));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $values
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function in($field, array $values)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::IN, new Value($values));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $values
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function notIn($field, array $values)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::NIN, new Value($values));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $field
Chris@0:      * @param mixed  $value
Chris@0:      *
Chris@0:      * @return Comparison
Chris@0:      */
Chris@0:     public function contains($field, $value)
Chris@0:     {
Chris@0:         return new Comparison($field, Comparison::CONTAINS, new Value($value));
Chris@0:     }
Chris@12: 
Chris@12:     /**
Chris@12:      * @param string $field
Chris@12:      * @param mixed  $value
Chris@12:      *
Chris@12:      * @return Comparison
Chris@12:      */
Chris@12:     public function memberOf ($field, $value)
Chris@12:     {
Chris@12:         return new Comparison($field, Comparison::MEMBER_OF, new Value($value));
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@12:      * @param string $field
Chris@12:      * @param mixed  $value
Chris@12:      *
Chris@12:      * @return Comparison
Chris@12:      */
Chris@12:     public function startsWith($field, $value)
Chris@12:     {
Chris@12:         return new Comparison($field, Comparison::STARTS_WITH, new Value($value));
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@12:      * @param string $field
Chris@12:      * @param mixed  $value
Chris@12:      *
Chris@12:      * @return Comparison
Chris@12:      */
Chris@12:     public function endsWith($field, $value)
Chris@12:     {
Chris@12:         return new Comparison($field, Comparison::ENDS_WITH, new Value($value));
Chris@12:     }    
Chris@12: 
Chris@0: }