Options.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Controller\Widget;

class Options extends \Rsi\Fred\Controller\Widget{

  const ESCAPE = 'escape'; //!< Escape the output.
  const MULTI = 'multi'; //!< Allow multiple selections.
  const OPTIONS = 'options'; //!< Available options. This can be an assoc.array, an SQL query, or a translatable string
    // (options split by line feed, key and value seperated by '=').
  const KEYS = 'keys'; //!< Available option keys (sequence).
  const TTL = 'ttl'; //!< Number of seconds the options may stay in the cache.
  const POPULAR = 'popular'; //  Initially show only those popular keys.
  const PLACEHOLDER = 'placeholder';

  public $escape = true;
  public $multi = false;
  public $ttl = null;
  public $placeholder = null;

  public $groupDelimiter = '::';
  public $multiTrailer = null;
  public $popularExtraKey = '...';
  public $popularExtraCaption = '... ([extra]) ...';

  protected $_options = null;

  public function clientConfig(){
    $config = array_merge(parent::clientConfig(),$this->get([self::ESCAPE,self::MULTI,self::TTL]));
    if(!$this->trailer && $this->multi && ($this->min || $this->max) && $this->multiTrailer && ($this->display >= self::DISPLAY_WRITEABLE))
      $config[self::TRAILER] = $this->trans->str($this->multiTrailer,$this->tags);
    if($this->display < self::DISPLAY_READABLE) $config[self::OPTIONS] = $this->options;
    if($this->popular) $config[self::POPULAR] = $this->popularExtraKey;
    if($this->popular || array_key_exists(self::PARAMS,$config)) $config['groupDelimiter'] = $this->groupDelimiter;
    return $config;
  }

  public function purgeBase($value){
    return $this->nothing($value) ? null : ($this->multi ? array_values(\Rsi\Record::explode($value)) : (is_scalar($value) ? $value : null));
  }

  protected function checkMin($value,$index = null){
    return $this->multi ? parent::checkMin(count($value),$index) : true;
  }

  protected function checkMax($value,$index = null){
    return $this->multi ? parent::checkMax(count($value),$index) : true;
  }

  protected function checkRange($value,$index = null){
    foreach(\Rsi\Record::explode($value) as $value)
      if(!array_key_exists($value,$this->options)) return false;
    return true;
  }

  protected function actionOptions(){
    $request = $this->request;
    $keys = [];
    foreach(($options = (strcasecmp($request->popular,'true') ? null : $this->popular) ?: $this->options) as $key => $value) $keys[] = strval($key);
    $request->result = compact('options','keys');
  }

  protected function getOptions(){
    if($this->_options === null){
      $this->_options = $options = $this->config(self::OPTIONS);
      $cache_key = null;
      if($this->ttl){
        $cache_key = md5(serialize([is_callable($options) ? [get_class($options[0]),$options[1]] : $options,$this->params]));
        $this->_options = $this->cache->fetch($cache_key);
      }
      if(!$this->ttl || ($this->_options === false)){
        if(is_callable($options)) $this->_options = call_user_func($options,$this->params);
        elseif(is_string($options)) $this->_options = $this->db->isSelection($options)
          ? $this->db->record($options,$this->params)
          : \Rsi\Record::explode($this->trans->str($options),"\n",'=');
        if($cache_key) $this->cache->save($cache_key,$this->_options,$this->ttl);
      }
    }
    return $this->_options;
  }

  protected function setOptions($value){
    $this->_options = null;
    $this->_config[self::OPTIONS] = $value;
  }

  protected function getPopular(){
    $options = [];
    if($popular = $this->config(self::POPULAR)){
      if(is_callable($popular)) $popular = call_user_func($popular,$this->params);
      if(
        ($options = \Rsi\Record::select($this->options,$popular)) &&
        ($extra = ($count = count($this->options)) - count($options))
      ) $options[$this->popularExtraKey] = $this->trans->str($this->popularExtraCaption,compact('count','extra'));
    }
    return $options;
  }

}