class ReturnTag in Zircon Profile 8.0

Reflection class for a @author Mike van Riel <[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\ReturnTag

1 file declares its use of ReturnTag

DocBlockTest.php in vendor/phpdocumentor/reflection-docblock/tests/phpDocumentor/Reflection/DocBlockTest.php

File

vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php, line 25

Namespace

phpDocumentor\Reflection\DocBlock\Tag

class ReturnTag extends Tag {

  /** @var string The raw type component. */
  protected $type = '';

  /** @var Collection The parsed type component. */
  protected $types = null;

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

  /**
   * {@inheritdoc}
   */
  public function setContent($content) {
    parent::setContent($content);
    $parts = preg_split('/\\s+/Su', $this->description, 2);

    // any output is considered a type
    $this->type = $parts[0];
    $this->types = null;
    $this
      ->setDescription(isset($parts[1]) ? $parts[1] : '');
    $this->content = $content;
    return $this;
  }

  /**
   * Returns the unique types of the variable.
   *
   * @return string[]
   */
  public function getTypes() {
    return $this
      ->getTypesCollection()
      ->getArrayCopy();
  }

  /**
   * Returns the type section of the variable.
   *
   * @return string
   */
  public function getType() {
    return (string) $this
      ->getTypesCollection();
  }

  /**
   * Returns the type collection.
   *
   * @return void
   */
  protected function getTypesCollection() {
    if (null === $this->types) {
      $this->types = new Collection(array(
        $this->type,
      ), $this->docblock ? $this->docblock
        ->getContext() : null);
    }
    return $this->types;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ReturnTag::$type	protected	property	@var string The raw type component.
ReturnTag::$types	protected	property	@var Collection The parsed type component.
ReturnTag::getContent	public	function	Gets the content of this tag. Overrides Tag::getContent	2
ReturnTag::getType	public	function	Returns the type section of the variable.
ReturnTag::getTypes	public	function	Returns the unique types of the variable.
ReturnTag::getTypesCollection	protected	function	Returns the type collection.
ReturnTag::setContent	public	function	Sets the content of this tag. Overrides Tag::setContent	2
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