src/DocBlox/Reflection/File.php

Show: inherited

Constants
- T_NAMESPACE
Functions
Classes
- \DocBlox_Reflection_File

Table of Contents

DocBlox

PHP Version 5

Author: Mike van Riel
Category: DocBlox
Copyright: 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
License: MIT
Link: http://docblox-project.org
Package: Reflection

Constants

int 
                T_NAMESPACE
                = 377

: int
This constant is PHP 5.3+, but is necessary for correct parsing

\DocBlox_Reflection_File
jump to top

Package: Reflection

Reflection class for a full file.

Parent(s): \DocBlox_Reflection_DocBlockedAbstract < \DocBlox_Reflection_Abstract
Author: Mike van Riel
Category: DocBlox
License: MIT
Link: http://docblox-project.org

Properties

\string[] $_token_method_cache = array()

staticinherited

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

Inherited from: \DocBlox_Reflection_Abstract::$$_token_method_cache \DocBlox_Reflection_DocBlockedAbstract::$$_token_method_cache

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.

Default valuearray()Details

Type: \string[]
Inherited_from: \DocBlox_Reflection_Abstract::$$_token_method_cache
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$_token_method_cache

string $active_namespace = 'default'

The currently active namespace is during parsing.

Default value'default'Details

Type: string

\DocBlox_Reflection_Class[] $classes = array()

every contained class

Default valuearray()Details

Type: \DocBlox_Reflection_Class[]

\DocBlox_Reflection_Constant[] $constants = array()

Every contained global constants

Default valuearray()Details

Type: \DocBlox_Reflection_Constant[]

string $contents = ''

Contents of the given file.

Default value''Details

Type: string

$default_package_name = 'Default'

inheritedInherited from: \DocBlox_Reflection_DocBlockedAbstract::$$default_package_name

Default value'Default'Details

Type: n/a
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$default_package_name

\DocBlox_Reflection_DocBlock|null $doc_block = null

inherited

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::$$doc_block

Default valuenullDetails

Type: \DocBlox_Reflection_DocBlock | null
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$doc_block

\sfEventDispatcher|null $event_dispatcher = null

staticinherited

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

Inherited from: \DocBlox_Reflection_Abstract::$$event_dispatcher \DocBlox_Reflection_DocBlockedAbstract::$$event_dispatcher

Default valuenullDetails

Type: \sfEventDispatcher | null
Inherited_from: \DocBlox_Reflection_Abstract::$$event_dispatcher
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$event_dispatcher

string $filename = ''

inherited

The path of the file.Inherited from: \DocBlox_Reflection_Abstract::$$filename \DocBlox_Reflection_DocBlockedAbstract::$$filename

Default value''Details

Type: string
Inherited_from: \DocBlox_Reflection_Abstract::$$filename
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$filename

\DocBlox_Reflection_Function[] $functions = array()

Every contained function

Default valuearray()Details

Type: \DocBlox_Reflection_Function[]

string|null $hash = null

A unique (MD5) hash of this file

Default valuenullDetails

Type: string | null

\DocBlox_Reflection_Include[] $includes = array()

Every contained include and require

Default valuearray()Details

Type: \DocBlox_Reflection_Include[]

\DocBlox_Reflection_Interface[] $interfaces = array()

Every contained interface

Default valuearray()Details

Type: \DocBlox_Reflection_Interface[]

int $line_start = 0

inherited

Stores the line where the initial token was found.

Inherited from: \DocBlox_Reflection_Abstract::$$line_start \DocBlox_Reflection_DocBlockedAbstract::$$line_start

Default value0Details

Type: int
Inherited_from: \DocBlox_Reflection_Abstract::$$line_start
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$line_start

\string[] $marker_terms = array('TODO', 'FIXME')

A list of all marker types to search for in this file.

Default valuearray('TODO', 'FIXME')Details

Type: \string[]

\string[] $markers = array()

A list of markers contained in this file.

Default valuearray()Details

Type: \string[]

string $name = 'Unknown'

inherited

Stores the name for this Reflection object.

Inherited from: \DocBlox_Reflection_Abstract::$$name \DocBlox_Reflection_DocBlockedAbstract::$$name

Default value'Unknown'Details

Type: string
Inherited_from: \DocBlox_Reflection_Abstract::$$name
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$name

string $namespace = 'default'

inherited

Stores the name of the namespace to which this belongs.

Inherited from: \DocBlox_Reflection_Abstract::$$namespace \DocBlox_Reflection_DocBlockedAbstract::$$namespace

Default value'default'Details

Type: string
Inherited_from: \DocBlox_Reflection_Abstract::$$namespace
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$namespace

\string[] $namespace_aliases = array()

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::$$namespace_aliases \DocBlox_Reflection_DocBlockedAbstract::$$namespace_aliases

Default valuearray()Details

Type: \string[]
Inherited_from: \DocBlox_Reflection_Abstract::$$namespace_aliases
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$namespace_aliases

\string[] $parse_markers = array()

A list of errors during processing

Default valuearray()Details

Type: \string[]

int $token_end = 0

inherited

Stores the end position by token index.

Inherited from: \DocBlox_Reflection_Abstract::$$token_end \DocBlox_Reflection_DocBlockedAbstract::$$token_end

Default value0Details

Type: int
Inherited_from: \DocBlox_Reflection_Abstract::$$token_end
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$token_end

int $token_start = 0

inherited

Stores the start position by token index.

Inherited from: \DocBlox_Reflection_Abstract::$$token_start \DocBlox_Reflection_DocBlockedAbstract::$$token_start

Default value0Details

Type: int
Inherited_from: \DocBlox_Reflection_Abstract::$$token_start
Inherited_from: \DocBlox_Reflection_DocBlockedAbstract::$$token_start

\DocBlox_Reflection_TokenIterator $tokens = null

Default valuenullDetails

Type: \DocBlox_Reflection_TokenIterator

Methods

__construct(string $file, boolean $validate = false) : void

Opens the file and retrieves its contents.

During construction the given file is checked whether it is readable and if the $validate argument is true a PHP Lint action is executed to check whether the there are no parse errors.

By default the Lint check is disable because of the performance hit introduced by this action.

If the validation checks out the file's contents are read; converted to UTF-8 and the has is created from those contents.

Parameters

Name	Type	Description
$file	string	Name of the file.
$validate	boolean	Whether to check the file using PHP Lint.

Throws

Exception	Description
\DocBlox_Reflection_Exception	when the filename is incorrect or the file can not be opened

__toString() : string

inherited

Default behavior of the toString method is to return the name of this reflection.

Inherited from: \DocBlox_Reflection_Abstract::__toString()\DocBlox_Reflection_DocBlockedAbstract::__toString()

Returns

Type	Description
string

_detectEncodingFallback(string $string) : string

This is a fallback mechanism to detect the encoding of a string; if no finfo or mbstring extension is present then this is used.

WARNING: try to prevent this; it is assumed that this method is not fool-proof nor performing as well as the other options.

Parameters

Name	Type	Description
$string	string	String to detect the encoding of.

Returns

Type	Description
string	Name of the encoding to return.

addMarker(string $name) : void

Adds a marker to scan the contents of this file for.

Parameters

Name	Type	Description
$name	string	The Marker term, i.e. FIXME or TODO.

addParserMarker(\sfEvent $data) : void

Adds a parse error to the system

Parameters

Name	Type	Description
$data	\sfEvent	The event containing the marker details.

convertToUtf8(string $filename, string $contents) : string

Converts a piece of text to UTF-8 if it isn't.

This method tries to detect the encoding of the given string when necessary using the finfo extension (packaged with PHP 5.3 by default; available as extension before that) and then uses iconv to convert the contents from the found encoding to UTF-8.

If the finfo class is not available we try to detect the encoding using the mbstring extension and if that isn't available then we try to brute-force detect the encoding using iconv.

If the encoding does not register as UTF-8 we try to re-encode to UTF-8; if that fails the original content is returned and en error is logged.

Parameters

Name	Type	Description
$filename	string	Path to the file; finfo directly reads the file instead of the contents.
$contents	string	File's contents to convert.

Returns

Type	Description
string

debug(string $message) : void

inherited

Dispatches a logging request to log a debug message.

Inherited from: \DocBlox_Reflection_Abstract::debug()\DocBlox_Reflection_DocBlockedAbstract::debug()

Parameters

Name	Type	Description
$message	string	The message to log.

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

inherited

Dispatches an event to the Event Dispatcher.

Inherited from: \DocBlox_Reflection_Abstract::dispatch()\DocBlox_Reflection_DocBlockedAbstract::dispatch()

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.

Parameters

Name	Type	Description
$name	string	Name of the event to dispatch.
$arguments	\string[]	Arguments for this event.

Returns

Type	Description
mixed \| null

Throws

Exception	Description
\DocBlox_Parser_Exception	if there is a dispatcher but it is not of type sfEventDispatcher

expandType(string $type, bool $ignore_non_objects = false) : string

inherited

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

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::expandType()

Parameters

Name	Type	Description
$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

Type	Description
string

findAbstract(\DocBlox_Reflection_TokenIterator $tokens) : \DocBlox_Reflection_Token | null

inherited

Determine whether this token has the abstract keyword.

Inherited from: \DocBlox_Reflection_Abstract::findAbstract()\DocBlox_Reflection_DocBlockedAbstract::findAbstract()

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

Returns

Type	Description
\DocBlox_Reflection_Token \| null

findDefault(\DocBlox_Reflection_TokenIterator $tokens) : string | null

inherited

Find the Default value for this object.

Inherited from: \DocBlox_Reflection_Abstract::findDefault()\DocBlox_Reflection_DocBlockedAbstract::findDefault()

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

Returns

Type	Description
string \| null

findDocBlock(\DocBlox_Reflection_TokenIterator $tokens) : \DocBlox_Reflection_DocBlock | null

Tries to find the DocBlox belonging to this file (page-level DocBlock).

A page level DocBlock is a DocBlock that is at the top of a file and is not directly followed by a class definition. Page level DocBlocks MUST contain a @package tag or they are 'disqualified'.

If no page level docblox is found we throw a warning to indicate to the user that this is missing.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Token array to parse.

Returns

Type	Description
\DocBlox_Reflection_DocBlock \| null

findFinal(\DocBlox_Reflection_TokenIterator $tokens) : \DocBlox_Reflection_Token | null

inherited

Determine whether this token has the final keyword.

Inherited from: \DocBlox_Reflection_Abstract::findFinal()\DocBlox_Reflection_DocBlockedAbstract::findFinal()

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

Returns

Type	Description
\DocBlox_Reflection_Token \| null

findStatic(\DocBlox_Reflection_TokenIterator $tokens) : \DocBlox_Reflection_Token | null

inherited

Determine whether this token has the static keyword.

Inherited from: \DocBlox_Reflection_Abstract::findStatic()\DocBlox_Reflection_DocBlockedAbstract::findStatic()

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

Returns

Type	Description
\DocBlox_Reflection_Token \| null

findType(\DocBlox_Reflection_TokenIterator $tokens) : string | null

inherited

Find the Type for this object.

Inherited from: \DocBlox_Reflection_Abstract::findType()\DocBlox_Reflection_DocBlockedAbstract::findType()

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

Returns

Type	Description
string \| null

findVisibility(\DocBlox_Reflection_TokenIterator $tokens) : string

inherited

Searches for visibility specifiers with the current token.

Inherited from: \DocBlox_Reflection_Abstract::findVisibility()\DocBlox_Reflection_DocBlockedAbstract::findVisibility()

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Token iterator to search in.

Returns

Type	Description
string	public\|private\|protected

getClass(string $name) : \DocBlox_Reflection_Class | null

Returns the class object with the given name.

Parameters

Name	Type	Description
$name	string	Name of the requested class.

Returns

Type	Description
\DocBlox_Reflection_Class \| null

getClasses() : \DocBlox_Reflection_Class

Returns all classes in this file.

Returns

Type	Description
\DocBlox_Reflection_Class

getConstants() : \DocBlox_Reflection_Constants

Returns all constants in this file.

Returns

Type	Description
\DocBlox_Reflection_Constants

getContents() : string

Returns the file's contents.

Returns

Type	Description
string

getDefaultPackageName() : string

inherited

Returns the name of the default package.

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::getDefaultPackageName()

Returns

Type	Description
string

getDocBlock() : \DocBlox_Reflection_Docblock | null

inherited

Returns the DocBlock reflection object.

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::getDocBlock()

Returns

Type	Description
\DocBlox_Reflection_Docblock \| null

getEndTokenId() : int

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::getEndTokenId()\DocBlox_Reflection_DocBlockedAbstract::getEndTokenId()

Returns

Type	Description
int

getFilename() : string

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::getFilename()\DocBlox_Reflection_DocBlockedAbstract::getFilename()

Returns

Type	Description
string

getFunctions() : \DocBlox_Reflection_Function

Returns all functions in this file.

Returns

Type	Description
\DocBlox_Reflection_Function

getHash() : string

Returns the hash identifying this file.

Returns

Type	Description
string

getIncludes() : \DocBlox_Reflection_Constants

Returns all constants in this file.

Returns

Type	Description
\DocBlox_Reflection_Constants

getInterfaces() : \DocBlox_Reflection_Interface

Returns all Interfaces in this file.

Returns

Type	Description
\DocBlox_Reflection_Interface

getLineNumber() : int

inherited

Returns the line number where this token starts.

Inherited from: \DocBlox_Reflection_Abstract::getLineNumber()\DocBlox_Reflection_DocBlockedAbstract::getLineNumber()

Returns

Type	Description
int

getMarkers() : void

getName() : string

inherited

Returns the name for this Reflection object.

Inherited from: \DocBlox_Reflection_Abstract::getName()\DocBlox_Reflection_DocBlockedAbstract::getName()

Returns

Type	Description
string

getNamespace() : string

inherited

Returns the name of the namespace to which this belongs.

Inherited from: \DocBlox_Reflection_Abstract::getNamespace()\DocBlox_Reflection_DocBlockedAbstract::getNamespace()

Returns

Type	Description
string

getNamespaceAliases() : \string[]

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::getNamespaceAliases()\DocBlox_Reflection_DocBlockedAbstract::getNamespaceAliases()

Returns

Type	Description
\string[]

getParseErrors() : array | \string[]

Returns

Type	Description
array \| \string[]

getStartTokenId() : int

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::getStartTokenId()\DocBlox_Reflection_DocBlockedAbstract::getStartTokenId()

Returns

Type	Description
int

initializeTokens(string $contents, string $filename = null) : \DocBlox_Reflection_TokenIterator

Extracts all tokens from this file and initializes the iterator used to walk through this file.

Parameters

Name	Type	Description
$contents	string	The text to parse into tokens.
$filename	string	The path of this file, if present.

Returns

Type	Description
\DocBlox_Reflection_TokenIterator

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

inherited

Dispatches a logging request.

Inherited from: \DocBlox_Reflection_Abstract::log()\DocBlox_Reflection_DocBlockedAbstract::log()

Parameters

Name	Type	Description
$message	string	The message to log.
$priority	int	The logging priority, the lower, the more important. Ranges from 1 to 7

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

inherited

Helper method which merges a $document into $origin.

Inherited from: \DocBlox_Reflection_Abstract::mergeDomDocuments()\DocBlox_Reflection_DocBlockedAbstract::mergeDomDocuments()

Parameters

Name	Type	Description
$origin	\DOMDocument	The document to accept the changes.
$document	\DOMDocument	The changes which are to be merged into the origin.

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

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::mergeXmlToDomDocument()\DocBlox_Reflection_DocBlockedAbstract::mergeXmlToDomDocument()

Parameters

Name	Type	Description
$origin	\DOMDocument	Destination to merge the XML into.
$xml	string	The XML to merge with the document.

parseTokenizer(\DocBlox_Reflection_TokenIterator $tokens) : void

inherited

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

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::parseTokenizer()

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator

process() : void

Starts the parsing of this file.

processClass(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses a class definition and adds it to the classes array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processConst(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses a global constant definition and adds it to the constants array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processFunction(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses a function definition and adds it to the functions array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processGenericInformation(\DocBlox_Reflection_TokenIterator $tokens) : void

Hook method where you can determine the generic properties for this file before it is scanned for structures.

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

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Token array to parse.

processInclude(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses an include definition and adds it to the includes array.

This method is also used for the include once, require and require once tokens.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

Details

See: \DocBlox_Reflection_File::processIncludeOnce
See: \DocBlox_Reflection_File::processRequireOnce
See: \DocBlox_Reflection_File::processRequire

processIncludeOnce(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses an include once definition and adds it to the includes array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processInterface(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses an interface definition and adds it to the interfaces array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processNamespace(\DocBlox_Reflection_TokenIterator $tokens) : void

Changes the active namespace indicator when a namespace token is encountered to indicate that the space has changed.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processRequire(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses a require definition and adds it to the includes array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processRequireOnce(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses a require once definition and adds it to the includes array.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processString(\DocBlox_Reflection_TokenIterator $tokens) : void

Parses any T_STRING token to find generic keywords to process.

This token is used to find any:

define, thus constants which are defined using the define keyword
Globals

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

processToken(\DocBlox_Reflection_Token $token, \DocBlox_Reflection_TokenIterator $tokens) : void

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::processToken()\DocBlox_Reflection_DocBlockedAbstract::processToken()

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.

Parameters

Name	Type	Description
$token	\DocBlox_Reflection_Token	The specific token which needs processing.
$tokens	\DocBlox_Reflection_TokenIterator	The iterator with tokens.

processTokens(\DocBlox_Reflection_TokenIterator $tokens) : void

Iterates through all tokens and when one is found we invoke the processToken method to handle the details.

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)

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	The list of tokens to scan.

Details

See: \DocBlox_Reflection_Abstract::processTokens
See: \DocBlox_Reflection_Abstract::processToken

processUse(\DocBlox_Reflection_TokenIterator $tokens) : void

Processes the T_USE token and extracts all namespace aliases.

Parameters

Name	Type	Description
$tokens	\DocBlox_Reflection_TokenIterator	Tokens to interpret with the pointer at the token to be processed.

setDefaultPackageName(string $default_package_name) : void

inherited

Sets the name of the Default package.

Inherited from: \DocBlox_Reflection_DocBlockedAbstract::setDefaultPackageName()

Parameters

Name	Type	Description
$default_package_name	string	The name that needs to be adopted by elements without package tags.

setFilename(string $filename) : void

inherited

Sets the file name for this file.

Inherited from: \DocBlox_Reflection_Abstract::setFilename()\DocBlox_Reflection_DocBlockedAbstract::setFilename()

Parameters

Name	Type	Description
$filename	string	The path of this file.

setHash(string $hash) : void

Sets the hash which identifies this file.

Parameters

Name	Type	Description
$hash	string	A piece of text (possibly MD5 hash) which identifies the contents of this file.

setMarkers(\string[] $markers) : void

Sets a list of markers to search for.

Parameters

Name	Type	Description
$markers	\string[]	A list of marker terms to scan for.

Details

See: \DocBlox_Reflection_File::addMarker()

setName(string $name) : void

inherited

Sets the name for this Reflection Object.

Inherited from: \DocBlox_Reflection_Abstract::setName()\DocBlox_Reflection_DocBlockedAbstract::setName()

Parameters

Name	Type	Description
$name	string	String with unlimited length.

Throws

Exception	Description
\InvalidArgumentException

setNamespace(string $namespace) : void

inherited

Sets the name of the namespace to which this belongs.

Inherited from: \DocBlox_Reflection_Abstract::setNamespace()\DocBlox_Reflection_DocBlockedAbstract::setNamespace()

Parameters

Name	Type	Description
$namespace	string	Full name of namespace.

Throws

Exception	Description
\InvalidArgumentException

setNamespaceAliases(\string[] $namespace_aliases) : void

inherited

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

Inherited from: \DocBlox_Reflection_Abstract::setNamespaceAliases()\DocBlox_Reflection_DocBlockedAbstract::setNamespaceAliases()

Parameters

Name	Type	Description
$namespace_aliases	\string[]	List of aliases to apply.

Throws

Exception	Description
\InvalidArgumentException

src/DocBlox/Reflection/File.php

Constants

\DocBlox_Reflection_Filejump to top

Properties

Methods

\DocBlox_Reflection_File
jump to top