class VersionTag in Zircon Profile 8.0

Reflection class for a @version tag in a Docblock.

@author Vasil Rangelov <[e-mail]> @license http://www.opensource.org/licenses/mit-license.php MIT @link http://phpdoc.org

Hierarchy

• class \phpDocumentor\Reflection\DocBlock\Tag implements \phpDocumentor\Reflection\DocBlock\Reflector
  • class \phpDocumentor\Reflection\DocBlock\Tag\VersionTag

2 files declare their use of VersionTag

DeprecatedTag.php in vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock/Tag/DeprecatedTag.php

SinceTag.php in vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock/Tag/SinceTag.php

File

vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock/Tag/VersionTag.php, line 24

Namespace

phpDocumentor\Reflection\DocBlock\Tag

class VersionTag extends Tag {

  /**
   * PCRE regular expression matching a version vector.
   * Assumes the "x" modifier.
   */
  const REGEX_VECTOR = '(?:
        # Normal release vectors.
        \\d\\S*
        |
        # VCS version vectors. Per PHPCS, they are expected to
        # follow the form of the VCS name, followed by ":", followed
        # by the version vector itself.
        # By convention, popular VCSes like CVS, SVN and GIT use "$"
        # around the actual version vector.
        [^\\s\\:]+\\:\\s*\\$[^\\$]+\\$
    )';

  /** @var string The version vector. */
  protected $version = '';
  public function getContent() {
    if (null === $this->content) {
      $this->content = "{$this->version} {$this->description}";
    }
    return $this->content;
  }

  /**
   * {@inheritdoc}
   */
  public function setContent($content) {
    parent::setContent($content);
    if (preg_match('/^
                # The version vector
                (' . self::REGEX_VECTOR . ')
                \\s*
                # The description
                (.+)?
            $/sux', $this->description, $matches)) {
      $this->version = $matches[1];
      $this
        ->setDescription(isset($matches[2]) ? $matches[2] : '');
      $this->content = $content;
    }
    return $this;
  }

  /**
   * Gets the version section of the tag.
   *
   * @return string The version section of the tag.
   */
  public function getVersion() {
    return $this->version;
  }

  /**
   * Sets the version section of the tag.
   *
   * @param string $version The new version section of the tag.
   *     An invalid value will set an empty string.
   *
   * @return $this
   */
  public function setVersion($version) {
    $this->version = preg_match('/^' . self::REGEX_VECTOR . '$/ux', $version) ? $version : '';
    $this->content = null;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Tag::$content	protected	property	When set to NULL, it means it needs to be regenerated.
Tag::$description	protected	property	@var string Description of the content of this tag
Tag::$docblock	protected	property	@var DocBlock The DocBlock which this tag belongs to.
Tag::$location	protected	property	@var Location Location of the tag.
Tag::$parsedDescription	protected	property	When set to NULL, it means it needs to be regenerated.
Tag::$tag	protected	property	@var string Name of the tag
Tag::$tagHandlerMappings	private static	property	handles it as an array value. The class is expected to inherit this class.
Tag::createInstance	final public static	function	Factory method responsible for instantiating the correct sub type.
Tag::export	public static	function	Builds a string representation of this object.
Tag::getDescription	public	function	Gets the description component of this tag.
Tag::getDocBlock	public	function	Gets the docblock this tag belongs to.
Tag::getLocation	public	function	Gets the location of the tag.
Tag::getName	public	function	Gets the name of this tag.
Tag::getParsedDescription	public	function	Gets the parsed text of this description.
Tag::REGEX_TAGNAME		constant	PCRE regular expression matching a tag name.
Tag::registerTagHandler	final public static	function	Registers a handler for tags.
Tag::setDescription	public	function	Sets the description component of this tag.
Tag::setDocBlock	public	function	Sets the docblock this tag belongs to.
Tag::setLocation	public	function	Sets the location of the tag.
Tag::setName	public	function	Sets the name of this tag.
Tag::__construct	public	function	Parses a tag and populates the member variables.
Tag::__toString	public	function	Returns the tag as a serialized string
VersionTag::$version	protected	property	@var string The version vector.
VersionTag::getContent	public	function	Gets the content of this tag. Overrides Tag::getContent
VersionTag::getVersion	public	function	Gets the version section of the tag.
VersionTag::REGEX_VECTOR		constant	PCRE regular expression matching a version vector. Assumes the "x" modifier.
VersionTag::setContent	public	function	Sets the content of this tag. Overrides Tag::setContent
VersionTag::setVersion	public	function	Sets the version section of the tag.