Vars.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

/**
 *  Variables component (dynamic configuration).
 */
class Vars extends Component{

  public $lockItem = 'variables';

  protected $_filename = null; //!< Storage file (JSON formatted).

  protected $_items = null;

  /**
   * Retrieve a value.
   * @param string $key
   * @param string $time  Time for historic value (empty = current).
   * @return mixed  Value (false = not found).
   */
  public function value($key,$time = null){
    if(array_key_exists($key,$this->items)){
      $values = $this->items[$key];
      if(!$time) return array_pop($values);
      foreach(array_reverse($values,true) as $start => $value) if(is_numeric($start) && ($start <= $time)) return $value;
    }
    return false;
  }
  /**
   * Add a value.
   * @param string $key
   * @param mixed $value
   * @param int $start  Time from when on the value is to be used (null = now).
   * @return bool  True on success.
   */
  public function add($key,$value,$start = null){
    if($start === null) $start = time();
    $lock = $this->component('lock');
    while(!$lock->request($this->lockItem)) sleep(1);
    $result = false;
    try{
      if(array_key_exists($key,$items = \Rsi\File::jsonDecode($this->_filename))){
        $items[$key][$start] = $value;
        ksort($items[$key]);
      }
      else $items[$key] = [$start => $value];
      $result = \Rsi\File::jsonEncode($this->_filename,$items);
    }
    catch(\Exception $e){
      $this->component('log')->info('Unable to add: ' . $e->getMessage(),__FILE__,__LINE__);
    }
    $lock->release($this->lockItem);
    return $result;
  }
  /**
   * All categories.
   * @return array  Key = category, value = needed right for editing.
   */
  public function categories(){
    $categories = \Rsi\Record::get($this->items,null) ?: [];
    foreach($this->items as $key => $item)
      if($key && ($category = \Rsi\Record::get($item,'category')) && !array_key_exists($category,$categories))
        $categories[$category] = null;
    return $categories;
  }
  /**
   * All config items for a category.
   * @param string $category
   * @return array  Key = item key, value = edit mask (reg-exp or widget params).
   */
  public function items($category){
    $items = [];
    foreach($this->items as $key => $item) if(\Rsi\Record::get($item,'category') == $category)
      $items[$key] = \Rsi\Record::get($item,'mask');
    return $items;
  }

  protected function getItems(){
    if($this->_items === null){
      while($this->component('lock')->exists($this->lockItem)) sleep(1);
      $this->_items = \Rsi\File::jsonDecode($this->_filename);
      if(!$this->_items) throw new Exception('Could not decode items');
    }
    return $this->_items;
  }

  protected function _get($key){
    return $this->value($key);
  }

  protected function _set($key,$value){
    $this->add($key,$value);
  }

}