Stream.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

class Stream extends Component{

  public $protocol = 'fred';
  public $className = __CLASS__ . '\\Wrapper';

  public $handlers = [];

  protected function init(){
    parent::init();
    stream_wrapper_register($this->protocol,$this->className);
  }
  /**
   * Check if the handlers exist.
   * @param array $handlers
   * @return bool  True if all handlers exist.
   */
  public function handlersExist($handlers){
    foreach($handlers as $handler) if(!array_key_exists($handler,$this->handlers)) return false;
    return true;
  }
  /**
   * Get a stream handler.
   * @param string $name  Stream handler name.
   * @return Stream\\Handler
   */
  public function handler($name){
    if(!array_key_exists($name,$this->handlers)) throw new \OutOfRangeException('Unknown stream handler');
    if(!array_key_exists(null,$config =& $this->handlers[$name])){
      $class_name = \Rsi\Record::get($config,'className',__CLASS__ . '\\Handler\\' . ucfirst($name));
      $config[null] = new $class_name($this,$config);
    }
    return $config[null];
  }
  /**
   * Search for files.
   * @param array $handlers  Downstream handlers.
   * @param string $mask  Filter mask.
   * @return array  Filenames found.
   */
  public function search($handlers,$mask = '*'){
    if(!$handlers) return [];
    $handler = array_shift($handlers);
    return $this->handler($handler)->search($handlers,$mask);
  }
  /**
   * Check if a file exists.
   * @param array $handlers  Downstream handlers.
   * @param string $filename  Filename.
   * @param array $params  Parameters.
   * @return bool
   */
  public function exists($handlers,$filename,$params = null){
    if(!$handlers) return false;
    $handler = array_shift($handlers);
    return $this->handler($handler)->exists($handlers,$filename,$params);
  }
  /**
   * Modification time of a file.
   * @param array $handlers  Downstream handlers.
   * @param string $filename  Filename.
   * @param array $params  Parameters.
   * @return int  Unix timestamp.
   */
  public function time($handlers,$filename,$params = null){
    if(!$handlers) return false;
    $handler = array_shift($handlers);
    return $this->handler($handler)->time($handlers,$filename,$params);
  }
  /**
   * Read a file.
   * @param array $handlers  Downstream handlers.
   * @param string $filename  Filename.
   * @param array $params  Parameters.
   * @return string  Binary data.
   */
  public function read($handlers,$filename,$params = null){
    if(!$handlers) return false;
    $handler = array_shift($handlers);
    return $this->handler($handler)->read($handlers,$filename,$params);
  }
  /**
   * Save a file.
   * @param array $handlers  Downstream handlers.
   * @param string $filename  Filename.
   * @param array $params  Parameters.
   * @param string $data  Binary data.
   * @return bool  True when succesful.
   */
  public function save($handlers,$filename,$params,$data){
    if(!$handlers) return false;
    $handler = array_shift($handlers);
    return $this->handler($handler)->save($handlers,$filename,$params,$data);
  }
  /**
   * Save a file.
   * @param array $handlers  Downstream handlers.
   * @param string $filename  Filename.
   * @param array $params  Parameters.
   * @return bool  True when succesful.
   */
  public function delete($handlers,$filename,$params = null){
    if(!$handlers) return false;
    $handler = array_shift($handlers);
    return $this->handler($handler)->delete($handlers,$filename,$params);
  }

}