SeeTag.php in Zircon Profile 8

Namespace

phpDocumentor\Reflection\DocBlock\Tag

File

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

<?php

/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @author    Mike van Riel <[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\Tag;

use phpDocumentor\Reflection\DocBlock\Tag;

/**
 * Reflection class for a @see tag in a Docblock.
 *
 * @author  Mike van Riel <[e-mail]>
 * @license http://www.opensource.org/licenses/mit-license.php MIT
 * @link    http://phpdoc.org
 */
class SeeTag extends Tag {

  /** @var string */
  protected $refers = null;

  /**
   * {@inheritdoc}
   */
  public function getContent() {
    if (null === $this->content) {
      $this->content = "{$this->refers} {$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->refers = $parts[0];
    $this
      ->setDescription(isset($parts[1]) ? $parts[1] : '');
    $this->content = $content;
    return $this;
  }

  /**
   * Gets the structural element this tag refers to.
   *
   * @return string
   */
  public function getReference() {
    return $this->refers;
  }

  /**
   * Sets the structural element this tag refers to.
   *
   * @param string $refers The new type this tag refers to.
   *
   * @return $this
   */
  public function setReference($refers) {
    $this->refers = $refers;
    $this->content = null;
    return $this;
  }

}

Classes

Name	Description
SeeTag	Reflection class for a @author Mike van Riel <[e-mail]> @license http://www.opensource.org/licenses/mit-license.php MIT @link http://phpdoc.org