class FrxSQLQueryBuilder in Forena Reports 7.4

@file FrxSQLQueryBuilder.inc FrxSQLQuery SQL Builder This class defines a common query builder that is used to make SQL safe queries based on named column filteres. @author metzlerd

Hierarchy

• class \FrxSQLQueryBuilder

File

./FrxSQLQueryBuilder.inc, line 9

FrxSQLQueryBuilder.inc FrxSQLQuery SQL Builder This class defines a common query builder that is used to make SQL safe queries based on named column filteres. @author metzlerd

class FrxSQLQueryBuilder {
  private $repository;
  private $provider;
  private $block_name;
  private $sql;
  private $clauses = array();
  private $descriptions = array();
  private $where_clause = array();
  private $comparison_operators = array(
    '<' => 'is less than',
    '>' => 'is greater than',
    '=' => 'is equal to',
    '<>' => 'is not equal to',
    '= any' => 'is one of',
    'LIKE' => 'is like',
  );
  private $data;

  /**
   * @param unknown_type $block
   * @return FrxSQLQueryBuilder
   */
  public function block($block) {
    list($provider, $block_name) = @explode('/', $block, 2);
    $this->provider = $provider;
    $this->block_name = $block_name;
    $this->repository = Frx::RepoMan()
      ->repository($provider);
    $this
      ->loadBlock();
    return $this;
  }

  /**
   * @return FrxSQLQueryBuilder
   */
  protected function loadblock() {
    if ($this->repository && $this->block_name) {
      $this->block = $this->repository
        ->loadBlock($This->block_name);
    }
    return $this;
  }

  /**
   * Starts the query builder
   * Enter description here ...
   */
  public function query($block, $values = array()) {
    $this->applied_filters = array();
    $this->block = $block;
    $this->data = $values;
    return $this;
  }

  /**
   * Executes the query that was started with query method
   * Enter description here ...
   */
  public function execute() {
    return Frx::RepoMan()
      ->data($this->block, $this->data, $this
      ->sql());
  }

  /**
   * Return the last where clause used for the data block.
   */
  public function sql() {
    $where = '';
    $i = 0;
    if (count($this->where_clause) > 0) {
      foreach ($this->where_clause as $clause) {
        $i++;
        $where .= $i == 1 ? 'WHERE ' : ' AND ';
        $where .= $clause;
      }
    }
    return $where;
  }
  public function where($condition, $include = TRUE) {
    if ($include) {
      $this->where_clause[] = $condition;
    }
    return $this;
  }

  /**
   * Filters the query that is being executed
   * Enter description here ...
   * @param string $field
   * @param string $comparison
   */
  public function filter($field, $comparison, $include = TRUE) {
    if ($include === NULL) {
      $include = !empty($this->data[$field]);
    }
    if ($include && @$this->comparison_operators[$comparison]) {
      $this->where_clause[] = $field . ' ' . $comparison . ' :' . $field;
    }
    return $this;
  }

  /**
   * Removing
   * Enter description here ...
   * @param unknown_type $field
   * @param unknown_type $comparison
   * @param unknown_type $value
   */
  public function condition($field, $value, $comparison = '=') {
    $this->data[$field] = $value;
    $this
      ->filter($field, $comparison);
  }

  /**
   * Filters the query if the value is present
   * Enter description here ...
   * @param string $field
   * @param string $comparison
   */
  public function filter_not_null($field, $comparison) {
    if (!empty($this->data[$field])) {
      $this
        ->filter($field, $comparison);
    }
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FrxSQLQueryBuilder::$block_name	private	property
FrxSQLQueryBuilder::$clauses	private	property
FrxSQLQueryBuilder::$comparison_operators	private	property
FrxSQLQueryBuilder::$data	private	property
FrxSQLQueryBuilder::$descriptions	private	property
FrxSQLQueryBuilder::$provider	private	property
FrxSQLQueryBuilder::$repository	private	property
FrxSQLQueryBuilder::$sql	private	property
FrxSQLQueryBuilder::$where_clause	private	property
FrxSQLQueryBuilder::block	public	function
FrxSQLQueryBuilder::condition	public	function	Removing Enter description here ...
FrxSQLQueryBuilder::execute	public	function	Executes the query that was started with query method Enter description here ...
FrxSQLQueryBuilder::filter	public	function	Filters the query that is being executed Enter description here ...
FrxSQLQueryBuilder::filter_not_null	public	function	Filters the query if the value is present Enter description here ...
FrxSQLQueryBuilder::loadblock	protected	function
FrxSQLQueryBuilder::query	public	function	Starts the query builder Enter description here ...
FrxSQLQueryBuilder::sql	public	function	Return the last where clause used for the data block.
FrxSQLQueryBuilder::where	public	function