dataPattern = '/(?<=\\'. self::TOKEN_ANNOTATION_IDENTIFIER .')(' . self::TOKEN_ANNOTATION_NAME .')(((?!\s\\'. self::TOKEN_ANNOTATION_IDENTIFIER .').)*)/s'; } /** * Parse a given docblock * * @param string $docblock * @return array */ public function parse($docblock) { $docblock = $this->getDocblockTagsSection($docblock); $annotations = $this->parseAnnotations($docblock); foreach ($annotations as &$value) { if (1 == count($value)) { $value = $value[0]; } } return $annotations; } /** * Filters docblock tags section, removing unwanted long and short descriptions * * @param string $docblock A docblok string without delimiters * @return string Tag section from given docblock */ protected function getDocblockTagsSection($docblock) { $docblock = $this->sanitizeDocblock($docblock); preg_match('/^\s*\\'.self::TOKEN_ANNOTATION_IDENTIFIER.'/m', $docblock, $matches, PREG_OFFSET_CAPTURE); // return found docblock tag section or empty string return isset($matches[0]) ? substr($docblock, $matches[0][1]) : ''; } /** * Filters docblock delimiters * * @param string $docblock A raw docblok string * @return string A docblok string without delimiters */ protected function sanitizeDocblock($docblock) { return preg_replace('/\s*\*\/$|^\s*\*\s{0,1}|^\/\*{1,2}/m', '', $docblock); } /** * Creates raw [annotation => value, [...]] tree * * @param string $str * @return array */ protected function parseAnnotations($str) { $annotations = []; preg_match_all($this->dataPattern, $str, $found); foreach ($found[2] as $key => $value) { $annotations[ $this->sanitizeKey($found[1][$key]) ][] = $this->parseValue($value, $found[1][$key]); } return $annotations; } /** * Parse a single annotation value * * @param string $value * @param string $key * @return mixed */ protected function parseValue($value, $key = null) { return (new DynamicType)->parse(trim($value), $key); } /** * Just a hook so derived parsers can transform annotation identifiers before they go to AST * * @param string $key * @return string */ protected function sanitizeKey($key) { return $key; } }