__construct()
create()
debug()
dispatch()
getNamespace()
getNamespaceAliases()
log()
setDescription()
setName()
setNamespace()
setNamespaceAliases()
setReference()
setTypes()
configure()
expandType()
$event_dispatcher
$namespace
$namespace_aliases
$tag
$xml
Generic Definition which adds the basic tag information to the structure file.
| 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)
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
| todo | replace the switch statement with an intelligent container / plugin system. |
|---|
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() |
|---|
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() |
|---|
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
stringgetNamespaceAliases() : array
arraylog(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Parser_Abstract::log() |
|---|
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
setDescription(string $description) : void
stringDescription for this definition.
setName(string $name) : void
stringName for this definition.
setNamespace(string $namespace) : void
stringNamespace name for this definition.
setNamespaceAliases(\string[] $namespace_aliases) : void
\string[]Array of aliases.
setReference(string $name) : void
stringName of the element to which is referred.
setTypes(\string[] $types) : void
| todo | Move this method to a better spot with namespace and alias access (together with namespace and alias stuff). |
|---|
\string[]Array with types in any format; will be transformed to FQCN.
configure() : void
$event_dispatcher : \sfEventDispatcher | null
| inherited_from | \phpDocumentor_Parser_Abstract::$$event_dispatcher |
|---|
$namespace : string
$namespace_aliases : array