Criteria.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2020 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\persistence;
 
use wcmf\lib\persistence\Criteria;
 
/**
 * Criteria defines a condition on a PersistentObject's attribute
 * used to select specific instances.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class Criteria {
 
  const OPERATOR_AND = 'AND'; // the and operator
  const OPERATOR_OR = 'OR'; // the or operator
 
  protected $type = null;
  protected $attribute = null;
  protected $operator = null;
  protected $value = null;
  protected $combineOperator = Criteria::OPERATOR_AND;
 
  /**
   * Constructor.
   * @param $type The PersistentObject type that has the attribute
   * @param $attribute The name of the attribute
   * @param $operator The comparison operator used to compare the given value with
   *   the attribute's value
   * @param $value The value to compare the object with
   * @param $combineOperator The Criteria::OPERATOR to use, when this criteria is
   *   combined with other criteria (optional, default: _Criteria::OPERATOR_AND_)
   */
  public function __construct($type, $attribute, $operator, $value, $combineOperator=Criteria::OPERATOR_AND) {
    $this->type = $type;
    $this->attribute = $attribute;
    $this->operator = $operator;
    $this->value = $value;
    $this->combineOperator = $combineOperator;
  }
 
  /**
   * Factory method for constructing a Criteria that may be used as value on
   * a PersistentObject's attribute (no type, attribute parameter needed)
   * @param $operator The comparison operator used to compare the given value with
   *  the attribute's value
   * @param $value The value to compare the object with
   * @return Criteria
   */
  public static function asValue($operator, $value) {
    return new Criteria(null, null, $operator, $value);
  }
 
  /**
   * Set the PersistentObject type that has the attribute
   * @param $type The type name
   */
  public function setType($type) {
    $this->type = $type;
  }
 
  /**
   * Get the PersistentObject type that has the attribute
   * @return String
   */
  public function getType() {
    return $this->type;
  }
 
  /**
   * Set the name of the attribute
   * @param $attribute The attribute name
   */
  public function setAttribute($attribute) {
    $this->attribute = $attribute;
  }
 
  /**
   * Get the name of the attribute
   * @return String
   */
  public function getAttribute() {
    return $this->attribute;
  }
 
  /**
   * Set the comparison operator used to compare the given value with
   * the attribute's value
   * @param $operator The operator
   */
  public function setOperator($operator) {
    $this->operator = $operator;
  }
 
  /**
   * Get the comparison operator used to compare the given value with
   * the attribute's value
   * @return String
   */
  public function getOperator() {
    return $this->operator;
  }
 
  /**
   * Set the value to compare the object with
   * @param $value The value
   */
  public function setValue($value) {
    $this->value = $value;
  }
 
  /**
   * Get the value to compare the object with
   * @return Mixed
   */
  public function getValue() {
    return $this->value;
  }
 
  /**
   * Set the Criteria::OPERATOR to use, when this criteria is combined with other criteria
   * @param $combineOperator One of the Criteria::OPERATOR constants
   */
  public function setCombineOperator($combineOperator) {
    $this->combineOperator = $combineOperator;
  }
 
  /**
   * Get the Criteria::OPERATOR to use, when this criteria is combined with other criteria
   * @return One of the Criteria::OPERATOR constants
   */
  public function getCombineOperator() {
    return $this->combineOperator;
  }
 
  /**
   * Get an identifier for the instance
   * @return String
   */
  public function getId() {
    $str = "[".$this->combineOperator."] ".$this->type.".".$this->attribute.
            " ".$this->operator.(is_array($this->value) ? sizeof($this->value) : "");
    return $str;
  }
 
  /**
   * Get a string representation of the criteria
   * @return String
   */
  public function __toString() {
    return $this->getId()." ".print_r($this->value, true);
  }
}
?>