Provider.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Controller;

class Provider extends \Rsi\Thing{

  const SEARCH_FROM = 'from'; //!< Search for values larger than the reference value.
  const SEARCH_TO = 'to'; //!< Search for values smaller than the reference value.
  const SEARCH_EXACT = 'exact'; //!< Search for values identical to the reference value (this may also be an array with
    // multiple values).
  const SEARCH_DATE = 'date'; //!< Search for a single date (24 hours).
  const SEARCH_LIKE = 'like'; //!< Search for values that match reference value with wildcard (? = 1 char, * = multiple chars).
  const SEARCH_RANGE = [self::SEARCH_FROM,self::SEARCH_TO];
  const SEARCH_MULTI = 'multi'; //!< Pseudo type to allow for multiple values.

  public $order = []; //!< Basic/default order (same format as search function).
  public $format = null; //!< Format function to apply to each record (called with a single record by reference, and true as a
    // second parameter when it concerns totals.

  protected $_controller = null;
  protected $_id = null;

  public function __construct($controller,$config){
    $this->_controller = $controller;
    $this->configure($config);
  }
  /**
   * Translates a value using the dataset.
   * @param string $column  Column to get the translated value from.
   * @param string $key  Column to use to find the record.
   * @param mixed $value  Value to use to find the record.
   * @param array $params  Extra parameters.
   * @return mixed  Found value for the column (false = not found).
   */
  public function trans($column,$key,$value,$params = null){
    return false;
  }
  /**
   * Check if a record exists in the dataset.
   * @param string $key  Column to use to find the record.
   * @param mixed $value  Value to use to find the record.
   * @param array $params  Extra parameters.
   * @return bool  True if the record exists.
   */
  public function exists($key,$value,$params = null){
    return false;
  }

  protected function _search($search,$order,$params,$offset,$limit){
    return [];
  }
  /**
   * Search for records in the dataset.
   * @param array $search  Search criteria (key = column, value = array with key = search type - see SEARCH_* constants,
   *   value = search reference value).
   * @param array $order  Sort order for the result (key = column name, value = sort order - use PHP's SORT_*
   *   constants; SORT_ASC and SORT_DESC are always supported, combinations with SORT_NUMERIC, SORT_NATURAL and the like are
   *   depending on the type of provider and should also be shifted 4 bits up).
   * @param array $params  Extra parameters.
   * @param int $offset  Number of records to skip.
   * @param int $limit  Maximum number of records to return (empty = all).
   * @return array  Array with found records (key = column name).
   */
  public function search($search,$order = null,$params = null,$offset = 0,$limit = null){
    $records = $this->_search($search,$order,$params,$offset,$limit);
    if($this->format) array_walk($records,$this->format);
    return $records;
  }

  protected function _totals($search,$totals,$params){
    return [];
  }
  /**
   * Return the totals for selected columns.
   * @param array $search  Search criteria (key = search type - see SEARCH_* constants, value = search compare value).
   * @param array $totals  Columns to return the totals for, assoc.array (key = column name, value = total type - see
   *   \\Rsi\\Fred\\controller::TOTAL_* constants, one or multiple in an array).
   * @param array $params  Extra parameters.
   * @return array  Array with totals (key = column name, value = total).
   */
  public function totals($search,$totals,$params = null){
    $totals = $this->_totals($search,$totals,$params);
    if($this->format) call_user_func_array($this->format,[&$totals,true]);
    return $totals;
  }

  protected function _group($search,$group,$column,$total,$limit,$params){
    return null;
  }
  /**
   * Return the grouped totals for a column.
   * @param array $search  Search criteria (key = search type - see SEARCH_* constants, value = search compare value).
   * @param string $group  Column to group by.
   * @param string $column  Column to group the value for.
   * @param string $total  Total type (see \\Rsi\\Fred\\controller::TOTAL_* constants).
   * @param int $limit  Positive for top, negative for bottom, zero for all (sorted by $column).
   * @param array $params  Extra parameters.
   * @return array  Key = group, value = total.
   */
  public function group($search,$group,$column,$total,$limit = null,$params = null){
    $totals = $this->_group($search,$group,$column,$total,$limit,$params);
    if($this->format) foreach($totals as $key => $value){
      $value = [$column => [$total => $value]];
      call_user_func_array($this->format,[&$value,true]);
      $totals[$key] = $value[$column][$total];
    }
    return $totals;
  }

  protected function setId($value){
    $this->_id = $value;
  }

  protected function getId(){
    return $this->_id;
  }

}