__construct()
create()
debug()
dispatch()
getNamespace()
getNamespaceAliases()
log()
setDescription()
setName()
setNamespace()
setNamespaceAliases()
setReference()
setTypes()
configure()
expandType()
findArguments()
$event_dispatcher
$namespace
$namespace_aliases
$tag
$xml
Definition for all Doctrine tags to explode them into subcomponents so they can be better processed in the transformation.
The Doctrine tags follow a deviating syntax from default PHPDoc which is described using the following EBNF: Annotation ::= "@" AnnotationName ["(" [Values] ")"] AnnotationName ::= QualifiedName | SimpleName QualifiedName ::= NameSpacePart "\" {NameSpacePart "\"}* SimpleName NameSpacePart ::= identifier SimpleName ::= identifier | null | false | true Values ::= Array | Value {"," Value}* Value ::= PlainValue | FieldAssignment PlainValue ::= integer|string|float|boolean|Array|Annotation FieldAssignment ::= FieldName "=" PlainValue FieldName ::= identifier Array ::= "{" ArrayEntry {"," ArrayEntry}* "}" ArrayEntry ::= Value | KeyValuePair KeyValuePair ::= Key "=" PlainValue Key ::= string | integer This means that a Doctrine Tag may have the following forms: * @Column(type="string", length=32, unique=true, nullable=false) or * @DiscriminatorMap({"person" = "Person", "employee" = "Employee"}) but also the FQCN notation: * @MyCompany\Annotations\Foo An important note is that the opening ( of the parameter list and the Annotation name do not have any whitespace.
| category | phpDocumentor |
|---|---|
| package | Parser |
| subpackage | Tag_Definitions |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
__construct(string $namespace, \string[] $namespace_aliases, SimpleXMLElement $xml, \phpDocumentor\Reflection\DocBlock\Tag $tag)
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::__construct() |
|---|
stringNamespace where this tag occurs.
\string[]Aliases used for all namespaces at the location of this tag.
create(string $namespace, \string[] $namespace_aliases, SimpleXMLElement $xml, \phpDocumentor\Reflection\DocBlock\Tag $tag) : \phpDocumentor_Parser_DocBlock_Tag_Definition
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::create() |
|---|
stringNamespace where this tag occurs.
\string[]Aliases used for all namespaces at the location of this tag.
\phpDocumentor_Parser_DocBlock_Tag_Definitiondebug(string $message) : void
| inherited_from | \phpDocumentor_Parser_Abstract::debug() |
|---|---|
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::debug() |
stringThe message to log.
dispatch(string $name, \string[] $arguments) : mixed | null
This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.
| inherited_from | \phpDocumentor_Parser_Abstract::dispatch() |
|---|---|
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::dispatch() |
stringName of the event to dispatch.
\string[]Arguments for this event.
\phpDocumentor_Parser_Exception |
if there is a dispatcher but it is not of type sfEventDispatcher |
|---|
mixednull
getNamespace() : string
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::getNamespace() |
|---|
stringgetNamespaceAliases() : array
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::getNamespaceAliases() |
|---|
arraylog(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Parser_Abstract::log() |
|---|---|
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::log() |
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
setDescription(string $description) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setDescription() |
|---|
stringDescription for this definition.
setName(string $name) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setName() |
|---|
stringName for this definition.
setNamespace(string $namespace) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setNamespace() |
|---|
stringNamespace name for this definition.
setNamespaceAliases(\string[] $namespace_aliases) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setNamespaceAliases() |
|---|
\string[]Array of aliases.
setReference(string $name) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setReference() |
|---|
stringName of the element to which is referred.
setTypes(\string[] $types) : void
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::setTypes() |
|---|
\string[]Array with types in any format; will be transformed to FQCN.
configure() : void
findArguments(string $description) : \array[]
See the EBFN in the class' documentation for the business rules used to split the Annotation's arguments.
stringThe arguments string to parse.
\array[]$event_dispatcher : \sfEventDispatcher | null
| inherited_from | \phpDocumentor_Parser_Abstract::$$event_dispatcher |
|---|---|
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::$$event_dispatcher |
$namespace : string
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::$$namespace |
|---|
$namespace_aliases : array
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::$$namespace_aliases |
|---|
$tag : \phpDocumentor\Reflection\DocBlock\Tag
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::$$tag |
|---|
$xml : \SimpleXMLElement
| inherited_from | \phpDocumentor_Plugin_Core_Parser_DocBlock_Tag_Definition::$$xml |
|---|