__toString()
debug()
dispatch()
getEndTokenId()
getFilename()
getLineNumber()
getName()
getNamespace()
getNamespaceAliases()
getStartTokenId()
log()
parseTokenizer()
setFilename()
setName()
setNamespace()
setNamespaceAliases()
findAbstract()
findDefault()
findFinal()
findStatic()
findType()
findVisibility()
mergeDomDocuments()
mergeXmlToDomDocument()
processGenericInformation()
processToken()
processTokens()
$event_dispatcher
$filename
$line_start
$name
$namespace
$namespace_aliases
$token_end
$token_start
$_token_method_cache
Provides the basic functionality for every static reflection class.
| category | phpDocumentor |
|---|---|
| package | Reflection |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
__toString() : string
stringdebug(string $message) : void
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.
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
getEndTokenId() : int
intgetFilename() : string
stringgetLineNumber() : int
intgetName() : string
stringgetNamespace() : string
stringgetNamespaceAliases() : \string[]
\string[]getStartTokenId() : int
intlog(string $message, int $priority) : void
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
parseTokenizer(phpDocumentor_Reflection_TokenIterator $tokens) : void
setFilename(string $filename) : void
stringThe path of this file.
setName(string $name) : void
setNamespace(string $namespace) : void
setNamespaceAliases(\string[] $namespace_aliases) : void
\string[]List of aliases to apply.
\InvalidArgumentException |
|---|
findAbstract(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null
Please note that the iterator cursor does not change due to this method
findDefault(phpDocumentor_Reflection_TokenIterator $tokens) : string | null
Usually used with variables or arguments. Please note that the iterator cursor does not change due to this method
stringnull
findFinal(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null
Please note that the iterator cursor does not change due to this method
findStatic(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null
Please note that the iterator cursor does not change due to this method
findType(phpDocumentor_Reflection_TokenIterator $tokens) : string | null
Please note that the iterator cursor does not change due to this method
stringnull
findVisibility(phpDocumentor_Reflection_TokenIterator $tokens) : string
stringpublic|private|protectedmergeDomDocuments(DOMDocument $origin, DOMDocument $document) : void
mergeXmlToDomDocument(DOMDocument $origin, string $xml) : void
stringThe XML to merge with the document.
processGenericInformation(phpDocumentor_Reflection_TokenIterator $tokens) : void
Example: for the phpDocumentor_Reflection_Function class this would be the name, parameters, etc.
processToken(phpDocumentor_Reflection_Token $token, phpDocumentor_Reflection_TokenIterator $tokens) : void
Tokens are automatically parsed by invoking a process* method (i.e. processFunction for a T_FUNCTION). If a method, which conforms to the standard above, does not exist the token is ignored.
processTokens(phpDocumentor_Reflection_TokenIterator $tokens) : \int[]
This is a base class which may be overridden in sub-classes to scan the scope of the current token (i.e. the method body in case of the method)
\int[]Start and End token id$event_dispatcher : \sfEventDispatcher | null
$filename : string
$line_start : int
$name : string
$namespace : string
$namespace_aliases : \string[]
$token_end : int
$token_start : int
$_token_method_cache : \string[]
The generation of method names may be a performance costly task and is quite often executed. As such we cache the method names which are coming from tokens here in this array.