class SourceTag in Zircon Profile 8.0

Reflection class for a @source 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\SourceTag

File

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

Namespace

phpDocumentor\Reflection\DocBlock\Tag

class SourceTag extends Tag {

  /**
   * @var int The starting line, relative to the structural element's
   *     location.
   */
  protected $startingLine = 1;

  /**
   * @var int|null The number of lines, relative to the starting line. NULL
   *     means "to the end".
   */
  protected $lineCount = null;

  /**
   * {@inheritdoc}
   */
  public function getContent() {
    if (null === $this->content) {
      $this->content = "{$this->startingLine} {$this->lineCount} {$this->description}";
    }
    return $this->content;
  }

  /**
   * {@inheritdoc}
   */
  public function setContent($content) {
    parent::setContent($content);
    if (preg_match('/^
                # Starting line
                ([1-9]\\d*)
                \\s*
                # Number of lines
                (?:
                    ((?1))
                    \\s+
                )?
                # Description
                (.*)
            $/sux', $this->description, $matches)) {
      $this->startingLine = (int) $matches[1];
      if (isset($matches[2]) && '' !== $matches[2]) {
        $this->lineCount = (int) $matches[2];
      }
      $this
        ->setDescription($matches[3]);
      $this->content = $content;
    }
    return $this;
  }

  /**
   * Gets the starting line.
   *
   * @return int The starting line, relative to the structural element's
   *     location.
   */
  public function getStartingLine() {
    return $this->startingLine;
  }

  /**
   * Sets the starting line.
   *
   * @param int $startingLine The new starting line, relative to the
   *     structural element's location.
   *
   * @return $this
   */
  public function setStartingLine($startingLine) {
    $this->startingLine = $startingLine;
    $this->content = null;
    return $this;
  }

  /**
   * Returns the number of lines.
   *
   * @return int|null The number of lines, relative to the starting line. NULL
   *     means "to the end".
   */
  public function getLineCount() {
    return $this->lineCount;
  }

  /**
   * Sets the number of lines.
   *
   * @param int|null $lineCount The new number of lines, relative to the
   *     starting line. NULL means "to the end".
   *
   * @return $this
   */
  public function setLineCount($lineCount) {
    $this->lineCount = $lineCount;
    $this->content = null;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SourceTag::$lineCount	protected	property	means "to the end".
SourceTag::$startingLine	protected	property	location.
SourceTag::getContent	public	function	Gets the content of this tag. Overrides Tag::getContent	1
SourceTag::getLineCount	public	function	Returns the number of lines.
SourceTag::getStartingLine	public	function	Gets the starting line.
SourceTag::setContent	public	function	Sets the content of this tag. Overrides Tag::setContent	1
SourceTag::setLineCount	public	function	Sets the number of lines.
SourceTag::setStartingLine	public	function	Sets the starting line.
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