ReadOnlyProtectedMembers.inc

<?php

/**
 * @file
 *
 */
module_load_include('inc', 'php_lib', 'Backtrace');
module_load_include('inc', 'php_lib', 'Array');

/**
 *
 */
class ReadOnlyProtectedMembers {

  /**
   *
   * @var string
   */
  protected $owner;
  /**
   * Call depth.
   *
   * @var int
   */
  protected $depth;
  /**
   * The list of protected members.
   *
   * @var array
   */
  protected $members;
  /**
   *
   * @var type
   */
  protected $values;

  /**
   *
   * @param array $members
   * @param array $params
   *   Optional parameters that set what the owning class is.
   */
  public function __construct(array $members, array $params = NULL) {
    $this->owner = isset($params['owner']) ? $params['owner'] : get_caller_class(1);
    $this->depth = isset($params['depth']) ? $params['depth'] : 2;
    $this->members = array_keys($members);
    $this->values = $members;
  }

  /**
   * Clone this object, deeply.
   */
  public function __clone() {
    $this->members = $this->members; // Copy the array
    $this->values = $this->values; // References stored in values are shallow copied.
  }

  /**
   *
   * @param string $name
   */
  public function has($name) {
    return array_search($name, $this->members) !== FALSE;
  }

  /**
   *
   * @param string $name
   * @return boolean
   */
  public function exists($name) {
    if ($this->has($name)) {
      return isset($this->values[$name]);
    }
    return FALSE;
  }

  /**
   *
   */
  public function add($name, $value = NULL) {
    if (is_array($name)) {
      foreach ($name as $key => &$value) {
        $this->add($key, $value);
      }
    }
    elseif (is_string($name)) {
      array_push($this->members, $name);
      $this->values[$name] = $value;
    }
  }

  /**
   * Removes a member
   *
   * @param string $name
   */
  public function remove($name) {
    unset($this->members[$name]);
  }

  /**
   * Any one can access this member.
   */
  public function __get($name) {
    if ($this->exists($name)) {
      return $this->values[$name];
    }
    return NULL;
  }

  /**
   *
   * @param string $name
   * @param mixed $value
   */
  public function __set($name, $value) {
    if ($this->has($name)) {
      if (is_or_descends_from(get_caller_object($this->depth), $this->owner)) {
        $this->values[$name] = $value;
      }
    }
  }

  public function __isset($name) {
    return $this->exists($name);
  }

  public function __unset($name) {
    unset($this->values[$name]);
  }

}