phpDocumentor » \phpDocumentor_Reflection

Parses a method or function Argument.

category	phpDocumentor
package	Reflection
author	Mike van Riel
license	MIT
link	http://phpdoc.org

Methods

Returns the name of this argument.

__toString() : string

Returns

string

Dispatches a logging request to log a debug message.

debug(string $message) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::debug()

Parameters

$message

string

The message to log.

Dispatches an event to the Event Dispatcher.

dispatch(string $name, \string[] $arguments) : mixed | null

Inherited

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_Reflection_Abstract::dispatch()

Parameters

$name

string

Name of the event to dispatch.

$arguments

\string[]

Arguments for this event.

Exceptions

`\phpDocumentor_Parser_Exception`	if there is a dispatcher but it is not of type sfEventDispatcher

Returns

mixednull

Returns the default value or null is none is set.

getDefault() : null | string

Returns

nullstring

Returns the token id which identifies the end of the object.

getEndTokenId() : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getEndTokenId()

Returns

int

Returns the name of the file to which this element is related.

getFilename() : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getFilename()

Returns

string

Returns the line number where this token starts.

getLineNumber() : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getLineNumber()

Returns

int

Returns the name for this Reflection object.

getName() : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getName()

Returns

string

Returns the name of the namespace to which this belongs.

getNamespace() : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getNamespace()

Returns

string

Returns the namespace aliases which can be applied to the types in this object.

getNamespaceAliases() : \string[]

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getNamespaceAliases()

Returns

\string[]

Getter; returns the token id which identifies the start of this object.

getStartTokenId() : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::getStartTokenId()

Returns

int

Returns the typehint, or null if none is set.

getType() : string | null

Returns

stringnull

Dispatches a logging request.

log(string $message, int $priority) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower, the more important. Ranges from 1 to 7

Main function which reads the token iterator and parses the current token.

parseTokenizer(phpDocumentor_Reflection_TokenIterator $tokens) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::parseTokenizer()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Sets the file name for this file.

setFilename(string $filename) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::setFilename()

Parameters

$filename

string

The path of this file.

Sets the name for this Reflection Object.

setName(string $name) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::setName()

Parameters

$name

string

String with unlimited length.

Exceptions

`\InvalidArgumentException`

Sets the name of the namespace to which this belongs.

setNamespace(string $namespace) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::setNamespace()

Parameters

$namespace

string

Full name of namespace.

Exceptions

`\InvalidArgumentException`

Sets the list of namespace aliases in the parent file..

setNamespaceAliases(\string[] $namespace_aliases) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::setNamespaceAliases()

Parameters

$namespace_aliases

\string[]

List of aliases to apply.

Exceptions

`\InvalidArgumentException`

Determine whether this token has the abstract keyword.

findAbstract(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null

Inherited

Please note that the iterator cursor does not change due to this method

inherited_from	\phpDocumentor_Reflection_Abstract::findAbstract()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

\phpDocumentor_Reflection_Tokennull

Find the Default value for this object.

findDefault(phpDocumentor_Reflection_TokenIterator $tokens) : string | null

Inherited

Usually used with variables or arguments. Please note that the iterator cursor does not change due to this method

inherited_from	\phpDocumentor_Reflection_Abstract::findDefault()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

stringnull

Determine whether this token has the final keyword.

findFinal(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null

Inherited

Please note that the iterator cursor does not change due to this method

inherited_from	\phpDocumentor_Reflection_Abstract::findFinal()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

\phpDocumentor_Reflection_Tokennull

Determine whether this token has the static keyword.

findStatic(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor_Reflection_Token | null

Inherited

Please note that the iterator cursor does not change due to this method

inherited_from	\phpDocumentor_Reflection_Abstract::findStatic()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

\phpDocumentor_Reflection_Tokennull

Find the Type for this object.

findType(phpDocumentor_Reflection_TokenIterator $tokens) : string | null

Inherited

Please note that the iterator cursor does not change due to this method

inherited_from	\phpDocumentor_Reflection_Abstract::findType()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

stringnull

Searches for visibility specifiers with the current token.

findVisibility(phpDocumentor_Reflection_TokenIterator $tokens) : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::findVisibility()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

Token iterator to search in.

Returns

stringpublic|private|protected

Helper method which merges a $document into $origin.

mergeDomDocuments(DOMDocument $origin, DOMDocument $document) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::mergeDomDocuments()

Parameters

$origin

\DOMDocument

The document to accept the changes.

$document

\DOMDocument

The changes which are to be merged into the origin.

Helper used to merge a given XML string into a given DOMDocument.

mergeXmlToDomDocument(DOMDocument $origin, string $xml) : void

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::mergeXmlToDomDocument()

Parameters

$origin

\DOMDocument

Destination to merge the XML into.

$xml

string

The XML to merge with the document.

Retrieves the generic information.

processGenericInformation(phpDocumentor_Reflection_TokenIterator $tokens) : void

Find the name, type and default value for this argument.

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

Tokens to interpret with the pointer at the token to be processed.

Processes the current token and invokes the correct process* method.

processToken(phpDocumentor_Reflection_Token $token, phpDocumentor_Reflection_TokenIterator $tokens) : void

Inherited

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.

inherited_from	\phpDocumentor_Reflection_Abstract::processToken()

Parameters

$token

\phpDocumentor_Reflection_Token

The specific token which needs processing.

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Scans all tokens within the scope of the current token and invokes the process* methods.

processTokens(phpDocumentor_Reflection_TokenIterator $tokens) : \int[]

Inherited

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)

inherited_from	\phpDocumentor_Reflection_Abstract::processTokens()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

iterator with the current position

Returns

\int[]Start and End token id

Properties

The event dispatcher object, may be null to not dispatch events.

$event_dispatcher : \sfEventDispatcher | null

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$event_dispatcher

The default value of this argument, or null if none available.

$default : string | null

<p>The path of the file.</p>

$filename : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$filename

Stores the line where the initial token was found.

$line_start : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$line_start

Stores the name for this Reflection object.

$name : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$name

Stores the name of the namespace to which this belongs.

$namespace : string

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$namespace

Stores the aliases and full names of any defined namespace alias (T_USE).

$namespace_aliases : \string[]

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$namespace_aliases

Stores the end position by token index.

$token_end : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$token_end

Stores the start position by token index.

$token_start : int

Inherited

inherited_from	\phpDocumentor_Reflection_Abstract::$$token_start

The type of this argument.

$type : string | null

This is a free text field and thus could contain any typehinting value like stdClass or array. If no typehint was provided this variable contains null.

Stores the method name of the processing method for a token.

$_token_method_cache : \string[]

Inherited

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.

inherited_from	\phpDocumentor_Reflection_Abstract::$$_token_method_cache