DocCommentParser.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Extbase\Reflection;
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
class ‪DocCommentParser
{
    protected static ‪$ignoredTags = ['package', 'subpackage', 'license', 'copyright', 'author', 'version', 'const'];
 
    protected ‪$description = '';
 
    protected ‪$tags = [];
 
    private ‪$useIgnoredTags;
 
    public function ‪__construct(‪$useIgnoredTags = false)
    {
        $this->useIgnoredTags = ‪$useIgnoredTags;
    }
 
    public function ‪parseDocComment($docComment)
    {
        $this->description = '';
        $this->tags = [];
        $lines = explode(LF, $docComment);
        foreach ($lines as $line) {
            if ($line !== '' && strpos($line, '@') !== false) {
                $this->‪parseTag(substr($line, strpos($line, '@')));
            } elseif (empty($this->tags)) {
                $this->description .= preg_replace('#\\s*/?[*/]*(.*)$#', '$1', $line) . LF;
            }
        }
        $this->description = trim($this->description);
    }
 
    public function ‪getTagsValues()
    {
        return ‪$this->tags;
    }
 
    public function ‪getTagValues($tagName)
    {
        if (!$this->‪isTaggedWith($tagName)) {
            throw new \RuntimeException('Tag "' . $tagName . '" does not exist.', 1169128255);
        }
        return $this->tags[$tagName];
    }
 
    public function ‪isTaggedWith($tagName)
    {
        return isset($this->tags[$tagName]);
    }
 
    public function ‪getDescription()
    {
        return ‪$this->description;
    }
 
    protected function ‪parseTag($line)
    {
        $tagAndValue = preg_split('/\\s/', $line, 2);
        $tag = substr($tagAndValue[0], 1);
 
        if ($this->useIgnoredTags && in_array($tag, static::$ignoredTags, true)) {
            return;
        }
 
        if (count($tagAndValue) > 1) {
            $this->tags[$tag][] = trim($tagAndValue[1]);
        } else {
            $this->tags[$tag] = [];
        }
    }
}