Context.php in Zircon Profile 8

Namespace

phpDocumentor\Reflection\DocBlock

File

vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock/Context.php

<?php

/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @author    Vasil Rangelov <[e-mail]>
 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */
namespace phpDocumentor\Reflection\DocBlock;


/**
 * The context in which a DocBlock occurs.
 *
 * @author  Vasil Rangelov <[e-mail]>
 * @license http://www.opensource.org/licenses/mit-license.php MIT
 * @link    http://phpdoc.org
 */
class Context {

  /** @var string The current namespace. */
  protected $namespace = '';

  /** @var array List of namespace aliases => Fully Qualified Namespace. */
  protected $namespace_aliases = array();

  /** @var string Name of the structural element, within the namespace. */
  protected $lsen = '';

  /**
   * Cteates a new context.
   * @param string $namespace         The namespace where this DocBlock
   *     resides in.
   * @param array  $namespace_aliases List of namespace aliases => Fully
   *     Qualified Namespace.
   * @param string $lsen              Name of the structural element, within
   *     the namespace.
   */
  public function __construct($namespace = '', array $namespace_aliases = array(), $lsen = '') {
    if (!empty($namespace)) {
      $this
        ->setNamespace($namespace);
    }
    $this
      ->setNamespaceAliases($namespace_aliases);
    $this
      ->setLSEN($lsen);
  }

  /**
   * @return string The namespace where this DocBlock resides in.
   */
  public function getNamespace() {
    return $this->namespace;
  }

  /**
   * @return array List of namespace aliases => Fully Qualified Namespace.
   */
  public function getNamespaceAliases() {
    return $this->namespace_aliases;
  }

  /**
   * Returns the Local Structural Element Name.
   *
   * @return string Name of the structural element, within the namespace.
   */
  public function getLSEN() {
    return $this->lsen;
  }

  /**
   * Sets a new namespace.
   *
   * Sets a new namespace for the context. Leading and trailing slashes are
   * trimmed, and the keywords "global" and "default" are treated as aliases
   * to no namespace.
   *
   * @param string $namespace The new namespace to set.
   *
   * @return $this
   */
  public function setNamespace($namespace) {
    if ('global' !== $namespace && 'default' !== $namespace) {

      // Srip leading and trailing slash
      $this->namespace = trim((string) $namespace, '\\');
    }
    else {
      $this->namespace = '';
    }
    return $this;
  }

  /**
   * Sets the namespace aliases, replacing all previous ones.
   *
   * @param array $namespace_aliases List of namespace aliases => Fully
   *     Qualified Namespace.
   *
   * @return $this
   */
  public function setNamespaceAliases(array $namespace_aliases) {
    $this->namespace_aliases = array();
    foreach ($namespace_aliases as $alias => $fqnn) {
      $this
        ->setNamespaceAlias($alias, $fqnn);
    }
    return $this;
  }

  /**
   * Adds a namespace alias to the context.
   *
   * @param string $alias The alias name (the part after "as", or the last
   *     part of the Fully Qualified Namespace Name) to add.
   * @param string $fqnn  The Fully Qualified Namespace Name for this alias.
   *     Any form of leading/trailing slashes are accepted, but what will be
   *     stored is a name, prefixed with a slash, and no trailing slash.
   *
   * @return $this
   */
  public function setNamespaceAlias($alias, $fqnn) {
    $this->namespace_aliases[$alias] = '\\' . trim((string) $fqnn, '\\');
    return $this;
  }

  /**
   * Sets a new Local Structural Element Name.
   *
   * Sets a new Local Structural Element Name. A local name also contains
   * punctuation determining the kind of structural element (e.g. trailing "("
   * and ")" for functions and methods).
   *
   * @param string $lsen The new local name of a structural element.
   *
   * @return $this
   */
  public function setLSEN($lsen) {
    $this->lsen = (string) $lsen;
    return $this;
  }

}

Classes

Name	Description
Context	The context in which a DocBlock occurs.