123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989 |
- <?php
-
-
- namespace Doctrine\Common\Annotations;
-
- use Closure;
- use ReflectionClass;
- use Doctrine\Common\Annotations\Annotation\Target;
- use Doctrine\Common\Annotations\Annotation\Attribute;
- use Doctrine\Common\Annotations\Annotation\Attributes;
-
-
- final class DocParser
- {
-
-
- private static $classIdentifiers = array(DocLexer::T_IDENTIFIER, DocLexer::T_TRUE, DocLexer::T_FALSE, DocLexer::T_NULL);
-
-
-
- private $lexer;
-
-
-
- private $target;
-
-
-
- private static $metadataParser;
-
-
-
- private $isNestedAnnotation = false;
-
-
-
- private $imports = array();
-
-
-
- private $classExists = array();
-
-
-
- private $ignoreNotImportedAnnotations = false;
-
-
-
- private $namespaces = array();
-
-
-
- private $ignoredAnnotationNames = array();
-
-
-
- private $context = '';
-
-
-
- private static $annotationMetadata = array(
- 'Doctrine\Common\Annotations\Annotation\Target' => array(
- 'is_annotation' => true,
- 'has_constructor' => true,
- 'properties' => array(),
- 'targets_literal' => 'ANNOTATION_CLASS',
- 'targets' => Target::TARGET_CLASS,
- 'default_property' => 'value',
- 'attribute_types' => array(
- 'value' => array(
- 'required' => false,
- 'type' =>'array',
- 'array_type'=>'string',
- 'value' =>'array<string>'
- )
- ),
- ),
- 'Doctrine\Common\Annotations\Annotation\Attribute' => array(
- 'is_annotation' => true,
- 'has_constructor' => false,
- 'targets_literal' => 'ANNOTATION_ANNOTATION',
- 'targets' => Target::TARGET_ANNOTATION,
- 'default_property' => 'name',
- 'properties' => array(
- 'name' => 'name',
- 'type' => 'type',
- 'required' => 'required'
- ),
- 'attribute_types' => array(
- 'value' => array(
- 'required' => true,
- 'type' =>'string',
- 'value' =>'string'
- ),
- 'type' => array(
- 'required' =>true,
- 'type' =>'string',
- 'value' =>'string'
- ),
- 'required' => array(
- 'required' =>false,
- 'type' =>'boolean',
- 'value' =>'boolean'
- )
- ),
- ),
- 'Doctrine\Common\Annotations\Annotation\Attributes' => array(
- 'is_annotation' => true,
- 'has_constructor' => false,
- 'targets_literal' => 'ANNOTATION_CLASS',
- 'targets' => Target::TARGET_CLASS,
- 'default_property' => 'value',
- 'properties' => array(
- 'value' => 'value'
- ),
- 'attribute_types' => array(
- 'value' => array(
- 'type' =>'array',
- 'required' =>true,
- 'array_type'=>'Doctrine\Common\Annotations\Annotation\Attribute',
- 'value' =>'array<Doctrine\Common\Annotations\Annotation\Attribute>'
- )
- ),
- ),
- );
-
-
-
- private static $typeMap = array(
- 'float' => 'double',
- 'bool' => 'boolean',
-
- 'Boolean' => 'boolean',
- 'int' => 'integer',
- );
-
-
-
- public function __construct()
- {
- $this->lexer = new DocLexer;
- }
-
-
-
- public function setIgnoredAnnotationNames(array $names)
- {
- $this->ignoredAnnotationNames = $names;
- }
-
-
-
- public function setIgnoreNotImportedAnnotations($bool)
- {
- $this->ignoreNotImportedAnnotations = (Boolean) $bool;
- }
-
-
-
- public function addNamespace($namespace)
- {
- if ($this->imports) {
- throw new \RuntimeException('You must either use addNamespace(), or setImports(), but not both.');
- }
- $this->namespaces[] = $namespace;
- }
-
-
-
- public function setImports(array $imports)
- {
- if ($this->namespaces) {
- throw new \RuntimeException('You must either use addNamespace(), or setImports(), but not both.');
- }
- $this->imports = $imports;
- }
-
-
-
- public function setTarget($target)
- {
- $this->target = $target;
- }
-
-
-
- public function parse($input, $context = '')
- {
- if (false === $pos = strpos($input, '@')) {
- return array();
- }
-
-
- if ($pos > 0) {
- $pos -= 1;
- }
-
- $this->context = $context;
- $this->lexer->setInput(trim(substr($input, $pos), '* /'));
- $this->lexer->moveNext();
-
- return $this->Annotations();
- }
-
-
-
- private function match($token)
- {
- if ( ! $this->lexer->isNextToken($token) ) {
- $this->syntaxError($this->lexer->getLiteral($token));
- }
-
- return $this->lexer->moveNext();
- }
-
-
-
- private function matchAny(array $tokens)
- {
- if ( ! $this->lexer->isNextTokenAny($tokens)) {
- $this->syntaxError(implode(' or ', array_map(array($this->lexer, 'getLiteral'), $tokens)));
- }
-
- return $this->lexer->moveNext();
- }
-
-
-
- private function syntaxError($expected, $token = null)
- {
- if ($token === null) {
- $token = $this->lexer->lookahead;
- }
-
- $message = "Expected {$expected}, got ";
-
- if ($this->lexer->lookahead === null) {
- $message .= 'end of string';
- } else {
- $message .= "'{$token['value']}' at position {$token['position']}";
- }
-
- if (strlen($this->context)) {
- $message .= ' in ' . $this->context;
- }
-
- $message .= '.';
-
- throw AnnotationException::syntaxError($message);
- }
-
-
-
- private function classExists($fqcn)
- {
- if (isset($this->classExists[$fqcn])) {
- return $this->classExists[$fqcn];
- }
-
-
- if (class_exists($fqcn, false)) {
- return $this->classExists[$fqcn] = true;
- }
-
-
- return $this->classExists[$fqcn] = AnnotationRegistry::loadAnnotationClass($fqcn);
- }
-
-
-
- private function collectAnnotationMetadata($name)
- {
- if (self::$metadataParser == null){
- self::$metadataParser = new self();
- self::$metadataParser->setTarget(Target::TARGET_CLASS);
- self::$metadataParser->setIgnoreNotImportedAnnotations(true);
- self::$metadataParser->setImports(array(
- 'target' => 'Doctrine\Common\Annotations\Annotation\Target',
- 'attribute' => 'Doctrine\Common\Annotations\Annotation\Attribute',
- 'attributes' => 'Doctrine\Common\Annotations\Annotation\Attributes'
- ));
- AnnotationRegistry::registerFile(__DIR__ . '/Annotation/Target.php');
- AnnotationRegistry::registerFile(__DIR__ . '/Annotation/Attribute.php');
- AnnotationRegistry::registerFile(__DIR__ . '/Annotation/Attributes.php');
- }
-
- $class = new \ReflectionClass($name);
- $docComment = $class->getDocComment();
-
-
- $metadata = array(
- 'default_property' => null,
- 'has_constructor' => (null !== $constructor = $class->getConstructor()) && $constructor->getNumberOfParameters() > 0,
- 'properties' => array(),
- 'property_types' => array(),
- 'attribute_types' => array(),
- 'targets_literal' => null,
- 'targets' => Target::TARGET_ALL,
- 'is_annotation' => false !== strpos($docComment, '@Annotation'),
- );
-
-
- if ($metadata['is_annotation']) {
- foreach (self::$metadataParser->parse($docComment, 'class @' . $name) as $annotation) {
- if ($annotation instanceof Target) {
- $metadata['targets'] = $annotation->targets;
- $metadata['targets_literal'] = $annotation->literal;
-
- } elseif ($annotation instanceof Attributes) {
- foreach ($annotation->value as $attrib) {
-
- $type = isset(self::$typeMap[$attrib->type]) ? self::$typeMap[$attrib->type] : $attrib->type;
-
-
- if ('mixed' !== $type) {
-
- if (false !== $pos = strpos($type, '<')) {
- $arrayType = substr($type, $pos+1, -1);
- $type = 'array';
-
- if (isset(self::$typeMap[$arrayType])) {
- $arrayType = self::$typeMap[$arrayType];
- }
-
- $metadata['attribute_types'][$attrib->name]['array_type'] = $arrayType;
- }
-
- $metadata['attribute_types'][$attrib->name]['type'] = $type;
- $metadata['attribute_types'][$attrib->name]['value'] = $attrib->type;
- $metadata['attribute_types'][$attrib->name]['required'] = $attrib->required;
- }
- }
- }
- }
-
-
- if (false === $metadata['has_constructor']) {
-
- foreach ($class->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
- $metadata['properties'][$property->name] = $property->name;
-
-
- if ((false !== $propertyComment = $property->getDocComment())
- && false !== strpos($propertyComment, '@var')
- && preg_match('/@var\s+([^\s]+)/',$propertyComment, $matches)) {
-
- $value = $matches[1];
-
-
- $type = isset(self::$typeMap[$value]) ? self::$typeMap[$value] : $value;
-
-
- if ('mixed' !== $type) {
-
- if (false !== $pos = strpos($type, '<')) {
- $arrayType = substr($type, $pos+1, -1);
- $type = 'array';
-
- if (isset(self::$typeMap[$arrayType])) {
- $arrayType = self::$typeMap[$arrayType];
- }
-
- $metadata['attribute_types'][$property->name]['array_type'] = $arrayType;
- }
-
- $metadata['attribute_types'][$property->name]['type'] = $type;
- $metadata['attribute_types'][$property->name]['value'] = $value;
- $metadata['attribute_types'][$property->name]['required'] = false !== strpos($propertyComment, '@Required');
- }
- }
- }
-
-
- $metadata['default_property'] = reset($metadata['properties']);
- }
- }
-
- self::$annotationMetadata[$name] = $metadata;
- }
-
-
-
- private function Annotations()
- {
- $annotations = array();
-
- while (null !== $this->lexer->lookahead) {
- if (DocLexer::T_AT !== $this->lexer->lookahead['type']) {
- $this->lexer->moveNext();
- continue;
- }
-
-
- if (null !== $this->lexer->token && $this->lexer->lookahead['position'] === $this->lexer->token['position'] + strlen($this->lexer->token['value'])) {
- $this->lexer->moveNext();
- continue;
- }
-
-
-
- if ((null === $peek = $this->lexer->glimpse())
- || (DocLexer::T_NAMESPACE_SEPARATOR !== $peek['type'] && !in_array($peek['type'], self::$classIdentifiers, true))
- || $peek['position'] !== $this->lexer->lookahead['position'] + 1) {
- $this->lexer->moveNext();
- continue;
- }
-
- $this->isNestedAnnotation = false;
- if (false !== $annot = $this->Annotation()) {
- $annotations[] = $annot;
- }
- }
-
- return $annotations;
- }
-
-
-
- private function Annotation()
- {
- $this->match(DocLexer::T_AT);
-
-
- $name = $this->Identifier();
-
-
-
- $originalName = $name;
- if ('\\' !== $name[0]) {
- $alias = (false === $pos = strpos($name, '\\'))? $name : substr($name, 0, $pos);
-
- $found = false;
- if ($this->namespaces) {
- foreach ($this->namespaces as $namespace) {
- if ($this->classExists($namespace.'\\'.$name)) {
- $name = $namespace.'\\'.$name;
- $found = true;
- break;
- }
- }
- } elseif (isset($this->imports[$loweredAlias = strtolower($alias)])) {
- if (false !== $pos) {
- $name = $this->imports[$loweredAlias].substr($name, $pos);
- } else {
- $name = $this->imports[$loweredAlias];
- }
- $found = true;
- } elseif (isset($this->imports['__NAMESPACE__']) && $this->classExists($this->imports['__NAMESPACE__'].'\\'.$name)) {
- $name = $this->imports['__NAMESPACE__'].'\\'.$name;
- $found = true;
- } elseif ($this->classExists($name)) {
- $found = true;
- }
-
- if (!$found) {
- if ($this->ignoreNotImportedAnnotations || isset($this->ignoredAnnotationNames[$name])) {
- return false;
- }
-
- throw AnnotationException::semanticalError(sprintf('The annotation "@%s" in %s was never imported. Did you maybe forget to add a "use" statement for this annotation?', $name, $this->context));
- }
- }
-
- if (!$this->classExists($name)) {
- throw AnnotationException::semanticalError(sprintf('The annotation "@%s" in %s does not exist, or could not be auto-loaded.', $name, $this->context));
- }
-
-
-
-
-
-
-
- if (!isset(self::$annotationMetadata[$name])) {
- $this->collectAnnotationMetadata($name);
- }
-
-
- if (self::$annotationMetadata[$name]['is_annotation'] === false) {
- if (isset($this->ignoredAnnotationNames[$originalName])) {
- return false;
- }
-
- throw AnnotationException::semanticalError(sprintf('The class "%s" is not annotated with @Annotation. Are you sure this class can be used as annotation? If so, then you need to add @Annotation to the _class_ doc comment of "%s". If it is indeed no annotation, then you need to add @IgnoreAnnotation("%s") to the _class_ doc comment of %s.', $name, $name, $originalName, $this->context));
- }
-
-
- $target = $this->isNestedAnnotation ? Target::TARGET_ANNOTATION : $this->target;
-
-
- $this->isNestedAnnotation = true;
-
-
- if (0 === (self::$annotationMetadata[$name]['targets'] & $target) && $target) {
- throw AnnotationException::semanticalError(
- sprintf('Annotation @%s is not allowed to be declared on %s. You may only use this annotation on these code elements: %s.',
- $originalName, $this->context, self::$annotationMetadata[$name]['targets_literal'])
- );
- }
-
- $values = array();
- if ($this->lexer->isNextToken(DocLexer::T_OPEN_PARENTHESIS)) {
- $this->match(DocLexer::T_OPEN_PARENTHESIS);
-
- if ( ! $this->lexer->isNextToken(DocLexer::T_CLOSE_PARENTHESIS)) {
- $values = $this->Values();
- }
-
- $this->match(DocLexer::T_CLOSE_PARENTHESIS);
- }
-
-
- foreach (self::$annotationMetadata[$name]['attribute_types'] as $property => $type) {
- if ($property === self::$annotationMetadata[$name]['default_property']
- && !isset($values[$property]) && isset($values['value'])) {
- $property = 'value';
- }
-
-
- if (!isset($values[$property])) {
- if ($type['required']) {
- throw AnnotationException::requiredError($property, $originalName, $this->context, 'a(n) '.$type['value']);
- }
-
- continue;
- }
-
- if ($type['type'] === 'array') {
-
- if (!is_array($values[$property])) {
- $values[$property] = array($values[$property]);
- }
-
-
- if (isset($type['array_type'])) {
- foreach ($values[$property] as $item) {
- if (gettype($item) !== $type['array_type'] && !$item instanceof $type['array_type']) {
- throw AnnotationException::typeError($property, $originalName, $this->context, 'either a(n) '.$type['array_type'].', or an array of '.$type['array_type'].'s', $item);
- }
- }
- }
- } elseif (gettype($values[$property]) !== $type['type'] && !$values[$property] instanceof $type['type']) {
- throw AnnotationException::typeError($property, $originalName, $this->context, 'a(n) '.$type['value'], $values[$property]);
- }
- }
-
-
-
- if (self::$annotationMetadata[$name]['has_constructor'] === true) {
- return new $name($values);
- }
-
- $instance = new $name();
- foreach ($values as $property => $value) {
- if (!isset(self::$annotationMetadata[$name]['properties'][$property])) {
- if ('value' !== $property) {
- throw AnnotationException::creationError(sprintf('The annotation @%s declared on %s does not have a property named "%s". Available properties: %s', $originalName, $this->context, $property, implode(', ', self::$annotationMetadata[$name]['properties'])));
- }
-
-
- if (!$property = self::$annotationMetadata[$name]['default_property']) {
- throw AnnotationException::creationError(sprintf('The annotation @%s declared on %s does not accept any values, but got %s.', $originalName, $this->context, json_encode($values)));
- }
- }
-
- $instance->{$property} = $value;
- }
-
- return $instance;
- }
-
-
-
- private function Values()
- {
- $values = array();
-
-
- if ($this->lexer->isNextToken(DocLexer::T_OPEN_CURLY_BRACES)) {
- $values['value'] = $this->Value();
- return $values;
- }
-
- $values[] = $this->Value();
-
- while ($this->lexer->isNextToken(DocLexer::T_COMMA)) {
- $this->match(DocLexer::T_COMMA);
- $token = $this->lexer->lookahead;
- $value = $this->Value();
-
- if ( ! is_object($value) && ! is_array($value)) {
- $this->syntaxError('Value', $token);
- }
-
- $values[] = $value;
- }
-
- foreach ($values as $k => $value) {
- if (is_object($value) && $value instanceof \stdClass) {
- $values[$value->name] = $value->value;
- } else if ( ! isset($values['value'])){
- $values['value'] = $value;
- } else {
- if ( ! is_array($values['value'])) {
- $values['value'] = array($values['value']);
- }
-
- $values['value'][] = $value;
- }
-
- unset($values[$k]);
- }
-
- return $values;
- }
-
-
-
- private function Constant()
- {
- $identifier = $this->Identifier();
-
- if (!defined($identifier) && false !== strpos($identifier, '::') && '\\' !== $identifier[0]) {
-
- list($className, $const) = explode('::', $identifier);
- $alias = (false === $pos = strpos($className, '\\'))? $className : substr($className, 0, $pos);
-
- $found = false;
- switch (true) {
- case !empty ($this->namespaces):
- foreach ($this->namespaces as $ns) {
- if (class_exists($ns.'\\'.$className) || interface_exists($ns.'\\'.$className)) {
- $className = $ns.'\\'.$className;
- $found = true;
- break;
- }
- }
- break;
-
- case isset($this->imports[$loweredAlias = strtolower($alias)]):
- $found = true;
- if (false !== $pos) {
- $className = $this->imports[$loweredAlias].substr($className, $pos);
- } else {
- $className = $this->imports[$loweredAlias];
- }
- break;
-
- default:
- if(isset($this->imports['__NAMESPACE__'])) {
- $ns = $this->imports['__NAMESPACE__'];
- if (class_exists($ns.'\\'.$className) || interface_exists($ns.'\\'.$className)) {
- $className = $ns.'\\'.$className;
- $found = true;
- }
- }
- break;
- }
-
- if ($found) {
- $identifier = $className . '::' . $const;
- }
- }
-
- if (!defined($identifier)) {
- throw AnnotationException::semanticalErrorConstants($identifier, $this->context);
- }
-
- return constant($identifier);
- }
-
-
-
- private function Identifier()
- {
-
- if ($this->lexer->isNextTokenAny(self::$classIdentifiers)) {
- $this->lexer->moveNext();
- $className = $this->lexer->token['value'];
- } else {
- $this->syntaxError('namespace separator or identifier');
- }
-
- while ($this->lexer->lookahead['position'] === ($this->lexer->token['position'] + strlen($this->lexer->token['value']))
- && $this->lexer->isNextToken(DocLexer::T_NAMESPACE_SEPARATOR)) {
-
- $this->match(DocLexer::T_NAMESPACE_SEPARATOR);
- $this->matchAny(self::$classIdentifiers);
- $className .= '\\' . $this->lexer->token['value'];
- }
-
- return $className;
- }
-
-
-
- private function Value()
- {
- $peek = $this->lexer->glimpse();
-
- if (DocLexer::T_EQUALS === $peek['type']) {
- return $this->FieldAssignment();
- }
-
- return $this->PlainValue();
- }
-
-
-
- private function PlainValue()
- {
- if ($this->lexer->isNextToken(DocLexer::T_OPEN_CURLY_BRACES)) {
- return $this->Arrayx();
- }
-
- if ($this->lexer->isNextToken(DocLexer::T_AT)) {
- return $this->Annotation();
- }
-
- if ($this->lexer->isNextToken(DocLexer::T_IDENTIFIER)) {
- return $this->Constant();
- }
-
- switch ($this->lexer->lookahead['type']) {
- case DocLexer::T_STRING:
- $this->match(DocLexer::T_STRING);
- return $this->lexer->token['value'];
-
- case DocLexer::T_INTEGER:
- $this->match(DocLexer::T_INTEGER);
- return (int)$this->lexer->token['value'];
-
- case DocLexer::T_FLOAT:
- $this->match(DocLexer::T_FLOAT);
- return (float)$this->lexer->token['value'];
-
- case DocLexer::T_TRUE:
- $this->match(DocLexer::T_TRUE);
- return true;
-
- case DocLexer::T_FALSE:
- $this->match(DocLexer::T_FALSE);
- return false;
-
- case DocLexer::T_NULL:
- $this->match(DocLexer::T_NULL);
- return null;
-
- default:
- $this->syntaxError('PlainValue');
- }
- }
-
-
-
- private function FieldAssignment()
- {
- $this->match(DocLexer::T_IDENTIFIER);
- $fieldName = $this->lexer->token['value'];
-
- $this->match(DocLexer::T_EQUALS);
-
- $item = new \stdClass();
- $item->name = $fieldName;
- $item->value = $this->PlainValue();
-
- return $item;
- }
-
-
-
- private function Arrayx()
- {
- $array = $values = array();
-
- $this->match(DocLexer::T_OPEN_CURLY_BRACES);
- $values[] = $this->ArrayEntry();
-
- while ($this->lexer->isNextToken(DocLexer::T_COMMA)) {
- $this->match(DocLexer::T_COMMA);
-
-
- if ($this->lexer->isNextToken(DocLexer::T_CLOSE_CURLY_BRACES)) {
- break;
- }
-
- $values[] = $this->ArrayEntry();
- }
-
- $this->match(DocLexer::T_CLOSE_CURLY_BRACES);
-
- foreach ($values as $value) {
- list ($key, $val) = $value;
-
- if ($key !== null) {
- $array[$key] = $val;
- } else {
- $array[] = $val;
- }
- }
-
- return $array;
- }
-
-
-
- private function ArrayEntry()
- {
- $peek = $this->lexer->glimpse();
-
- if (DocLexer::T_EQUALS === $peek['type']
- || DocLexer::T_COLON === $peek['type']) {
-
- if ($this->lexer->isNextToken(DocLexer::T_IDENTIFIER)) {
- $key = $this->Constant();
- } else {
- $this->matchAny(array(DocLexer::T_INTEGER, DocLexer::T_STRING));
- $key = $this->lexer->token['value'];
- }
-
- $this->matchAny(array(DocLexer::T_EQUALS, DocLexer::T_COLON));
-
- return array($key, $this->PlainValue());
- }
-
- return array(null, $this->Value());
- }
- }
|