/vendor/phpdocumentor/reflection-docblock/src/DocBlock/Tags/Deprecated.php
https://bitbucket.org/alan_cordova/api-sb-map · PHP · 97 lines · 54 code · 12 blank · 31 comment · 2 complexity · 9f948aa2963bd73fa9badee9e53ffc19 MD5 · raw file
- <?php
- /**
- * This file is part of phpDocumentor.
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- *
- * @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
- * @license http://www.opensource.org/licenses/mit-license.php MIT
- * @link http://phpdoc.org
- */
- namespace phpDocumentor\Reflection\DocBlock\Tags;
- use phpDocumentor\Reflection\DocBlock\Description;
- use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
- use phpDocumentor\Reflection\Types\Context as TypeContext;
- use Webmozart\Assert\Assert;
- /**
- * Reflection class for a {@}deprecated tag in a Docblock.
- */
- final class Deprecated extends BaseTag implements Factory\StaticMethod
- {
- protected $name = 'deprecated';
- /**
- * 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. */
- private $version = '';
- public function __construct($version = null, Description $description = null)
- {
- Assert::nullOrStringNotEmpty($version);
- $this->version = $version;
- $this->description = $description;
- }
- /**
- * @return static
- */
- public static function create($body, DescriptionFactory $descriptionFactory = null, TypeContext $context = null)
- {
- Assert::nullOrString($body);
- if (empty($body)) {
- return new static();
- }
- $matches = [];
- if (!preg_match('/^(' . self::REGEX_VECTOR . ')\s*(.+)?$/sux', $body, $matches)) {
- return new static(
- null,
- null !== $descriptionFactory ? $descriptionFactory->create($body, $context) : null
- );
- }
- return new static(
- $matches[1],
- $descriptionFactory->create(isset($matches[2]) ? $matches[2] : '', $context)
- );
- }
- /**
- * Gets the version section of the tag.
- *
- * @return string
- */
- public function getVersion()
- {
- return $this->version;
- }
- /**
- * Returns a string representation for this tag.
- *
- * @return string
- */
- public function __toString()
- {
- return $this->version . ($this->description ? ' ' . $this->description->render() : '');
- }
- }