phpDocumentor
Back to top  

Parses an include definition.

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

 Methods

Returns the name for this object.

__toString() : string

Returns

string

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::debug()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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

Tries to expand a type to it's full namespaced equivalent.

expandType(string $type, bool $ignore_non_objects) : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::expandType()

Parameters

$type

string

Type to expand into full namespaced equivalent.

$ignore_non_objects

bool

whether to ignore reserved words, when false it will not expand a set of keywords.

Returns

string

Returns the name of the default package.

getDefaultPackageName() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getDefaultPackageName()

Returns

string

Returns the DocBlock reflection object.

getDocBlock() : \phpDocumentor\Reflection\DocBlock | null
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getDocBlock()

Returns

\phpDocumentor\Reflection\DocBlocknull

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

getEndTokenId() : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getEndTokenId()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getEndTokenId()

Returns

int

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

getFilename() : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getFilename()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getFilename()

Returns

string

Returns the line number where this token starts.

getLineNumber() : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getLineNumber()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getLineNumber()

Returns

int

Returns the name for this Reflection object.

getName() : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getName()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getName()

Returns

string

Returns the name of the namespace to which this belongs.

getNamespace() : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getNamespace()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getNamespaceAliases()

Returns

\string[]

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

getStartTokenId() : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::getStartTokenId()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::getStartTokenId()

Returns

int

Returns the type of this include.

getType() : string

Valid types are: - Include - Include Once - Require - Require Once

Returns

string

Dispatches a logging request.

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

inherited_from \phpDocumentor_Reflection_Abstract::log()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::log()

Parameters

$message

string

The message to log.

$priority

int

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

Override method to add a validation point for the docblock where it has access to all processed tokens.

parseTokenizer(phpDocumentor_Reflection_TokenIterator $tokens) : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::parseTokenizer()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

Sets the name of the Default package.

setDefaultPackageName(string $default_package_name) : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::setDefaultPackageName()

Parameters

$default_package_name

string

The name that needs to be adopted by elements without package tags.

Sets the file name for this file.

setFilename(string $filename) : void
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::setFilename()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::findDefault()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

The iterator with tokens.

Returns

stringnull

Returns the first docblock preceding the active token within 10 tokens.

findDocBlock(phpDocumentor_Reflection_TokenIterator $tokens) : \phpDocumentor\Reflection\DocBlock | null
Inherited

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

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::findDocBlock()

Parameters

$tokens

\phpDocumentor_Reflection_TokenIterator

Tokens to process

Returns

\phpDocumentor\Reflection\DocBlocknull

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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::mergeXmlToDomDocument()

Parameters

$origin

\DOMDocument

Destination to merge the XML into.

$xml

string

The XML to merge with the document.

Get the type and name for this include.

processGenericInformation(phpDocumentor_Reflection_TokenIterator $tokens) : void

Example: for the phpDocumentor_Reflection_Function class this would be the name, parameters, etc.

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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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()
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::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
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$event_dispatcher
 

$default_package_name

$default_package_name 
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$default_package_name
 

$doc_block

$doc_block : \phpDocumentor\Reflection\DocBlock | null
Inherited

inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$doc_block
 

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

$filename : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$filename
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$filename
 

Stores the line where the initial token was found.

$line_start : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$line_start
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$line_start
 

Stores the name for this Reflection object.

$name : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$name
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$name
 

Stores the name of the namespace to which this belongs.

$namespace : string
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$namespace
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$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
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$namespace_aliases
 

Stores the end position by token index.

$token_end : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$token_end
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$token_end
 

Stores the start position by token index.

$token_start : int
Inherited

inherited_from \phpDocumentor_Reflection_Abstract::$$token_start
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$token_start
 

<p>Which type of include is this? Include, Include Once, Require or Require Once?</p> 

$type : string

 

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
inherited_from \phpDocumentor_Reflection_DocBlockedAbstract::$$_token_method_cache