DocCommentParser.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Reflection;

class DocCommentParser {

    protected $description = '';

    protected $tags = array();

    public function parseDocComment($docComment) {
        $this->description = '';
        $this->tags = array();
        $lines = explode(chr(10), $docComment);
        foreach ($lines as $line) {
            if (strlen($line) > 0 && strpos($line, '@') !== FALSE) {
                $this->parseTag(substr($line, strpos($line, '@')));
            } elseif (count($this->tags) === 0) {
                $this->description .= preg_replace('/\\s*\\/?[\\\\*]*(.*)$/', '$1', $line) . chr(10);
            }
        }
        $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 (count($tagAndValue) > 1) {
            $this->tags[$tag][] = trim($tagAndValue[1]);
        } else {
            $this->tags[$tag] = array();
        }
    }
}