ExpressionBuilder.php in Zircon Profile 8

Namespace

Doctrine\Common\Collections

File

vendor/doctrine/collections/lib/Doctrine/Common/Collections/ExpressionBuilder.php

<?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\Common\Collections;

use Doctrine\Common\Collections\Expr\Comparison;
use Doctrine\Common\Collections\Expr\CompositeExpression;
use Doctrine\Common\Collections\Expr\Value;

/**
 * Builder for Expressions in the {@link Selectable} interface.
 *
 * Important Notice for interoperable code: You have to use scalar
 * values only for comparisons, otherwise the behavior of the comparision
 * may be different between implementations (Array vs ORM vs ODM).
 *
 * @author Benjamin Eberlei <[e-mail]>
 * @since  2.3
 */
class ExpressionBuilder {

  /**
   * @param mixed $x
   *
   * @return CompositeExpression
   */
  public function andX($x = null) {
    return new CompositeExpression(CompositeExpression::TYPE_AND, func_get_args());
  }

  /**
   * @param mixed $x
   *
   * @return CompositeExpression
   */
  public function orX($x = null) {
    return new CompositeExpression(CompositeExpression::TYPE_OR, func_get_args());
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function eq($field, $value) {
    return new Comparison($field, Comparison::EQ, new Value($value));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function gt($field, $value) {
    return new Comparison($field, Comparison::GT, new Value($value));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function lt($field, $value) {
    return new Comparison($field, Comparison::LT, new Value($value));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function gte($field, $value) {
    return new Comparison($field, Comparison::GTE, new Value($value));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function lte($field, $value) {
    return new Comparison($field, Comparison::LTE, new Value($value));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function neq($field, $value) {
    return new Comparison($field, Comparison::NEQ, new Value($value));
  }

  /**
   * @param string $field
   *
   * @return Comparison
   */
  public function isNull($field) {
    return new Comparison($field, Comparison::EQ, new Value(null));
  }

  /**
   * @param string $field
   * @param mixed  $values
   *
   * @return Comparison
   */
  public function in($field, array $values) {
    return new Comparison($field, Comparison::IN, new Value($values));
  }

  /**
   * @param string $field
   * @param mixed  $values
   *
   * @return Comparison
   */
  public function notIn($field, array $values) {
    return new Comparison($field, Comparison::NIN, new Value($values));
  }

  /**
   * @param string $field
   * @param mixed  $value
   *
   * @return Comparison
   */
  public function contains($field, $value) {
    return new Comparison($field, Comparison::CONTAINS, new Value($value));
  }

}

Classes

Name	Description
ExpressionBuilder	Builder for Expressions in the {@link Selectable} interface.