You are here

class DrupalStatic in X Autoload 7.5

Hierarchy

Expanded class hierarchy of DrupalStatic

File

tests/src/VirtualDrupal/DrupalStatic.php, line 7

Namespace

Drupal\xautoload\Tests\VirtualDrupal
View source
class DrupalStatic {

  /**
   * @var array
   */
  private $data = array();

  /**
   * @var array
   */
  private $default = array();

  /**
   * Replicates drupal_static($name, $default_value, FALSE).
   *
   * @see drupal_static()
   *
   * @param string $name
   * @param mixed|null $default_value
   *
   * @return array
   */
  public function &get($name, $default_value = NULL) {
    if (!isset($name)) {
      throw new \InvalidArgumentException('$name cannot be NULL.');
    }

    // First check if dealing with a previously defined static variable.
    if (isset($this->data[$name]) || array_key_exists($name, $this->data)) {

      // Non-NULL $name and both $this->data[$name] and $this->default[$name] statics exist.
      return $this->data[$name];
    }

    // Neither $this->data[$name] nor $this->default[$name] static variables exist.
    // First call with new non-NULL $name. Initialize a new static variable.
    $this->default[$name] = $this->data[$name] = $default_value;
    return $this->data[$name];
  }

  /**
   * Replicates drupal_static($name, NULL, TRUE).
   *
   * @see drupal_static()
   *
   * @param string $name
   *
   * @return array
   */
  public function &resetKey($name) {
    if (!isset($name)) {
      throw new \InvalidArgumentException('$name cannot be NULL.');
    }

    // First check if dealing with a previously defined static variable.
    if (isset($this->data[$name]) || array_key_exists($name, $this->data)) {

      // Non-NULL $name and both $this->data[$name] and $this->default[$name] statics exist.
      // Reset pre-existing static variable to its default value.
      $this->data[$name] = $this->default[$name];
      return $this->data[$name];
    }

    // Neither $this->data[$name] nor $this->default[$name] static variables exist.
    // Reset was called before a default is set and yet a variable must be
    // returned.
    return $this->data;
  }

  /**
   * Replicates drupal_static(NULL, NULL, TRUE).
   *
   * @see drupal_static()
   *
   * @return array
   */
  public function &resetAll() {

    // Reset all: ($name == NULL). This needs to be done one at a time so that
    // references returned by earlier invocations of drupal_static() also get
    // reset.
    foreach ($this->default as $name => $value) {
      $this->data[$name] = $value;
    }

    // As the function returns a reference, the return should always be a
    // variable.
    return $this->data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalStatic::$data private property
DrupalStatic::$default private property
DrupalStatic::get public function Replicates drupal_static($name, $default_value, FALSE).
DrupalStatic::resetAll public function Replicates drupal_static(NULL, NULL, TRUE).
DrupalStatic::resetKey public function Replicates drupal_static($name, NULL, TRUE).