category Zend
package Zend_Reflection
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(string $file) : void

Parameters

$file

string

Serialize to string

__toString() : string

Required by the Reflector interface

todo What should this serialization look like?

Returns

string

Export

export() : null
Static

Required by the Reflector interface.

todo What should this do?

Returns

null

Find realpath of file based on include_path

findRealpathInIncludePath(string $fileName) : string
Static

Parameters

$fileName

string

Returns

string

Retrieve the reflection class of a given class found in this file

getClass(null|string $name = null, string $reflectionClass = 'Zend_Reflection_Class') : \Zend_Reflection_Class

Parameters

$name

nullstring

$reflectionClass

string

Reflection class to use when creating reflection instance

Exceptions

\Zend_Reflection_Exception for invalid class name or invalid reflection class

Returns

\Zend_Reflection_Class

Return the reflection classes of the classes found inside this file

getClasses(string $reflectionClass = 'Zend_Reflection_Class') : array

Parameters

$reflectionClass

string

Name of reflection class to use for instances

Returns

arrayArray of Zend_Reflection_Class instances

Return the full contents of file

getContents() : string

Returns

string

Return the doc comment

getDocComment() : string

Returns

string

Return the docblock

getDocblock(string $reflectionClass = 'Zend_Reflection_Docblock') : \Zend_Reflection_Docblock

Parameters

$reflectionClass

string

Reflection class to use

Returns

\Zend_Reflection_Docblock

Get the end line / number of lines

getEndLine() : integer

Returns

integer

Return the file name of the reflected file

getFileName() : string

Returns

string

Return the reflection functions of the functions found inside this file

getFunctions(string $reflectionClass = 'Zend_Reflection_Function') : array

Parameters

$reflectionClass

string

Name of reflection class to use for instances

Returns

arrayArray of Zend_Reflection_Functions

Get the start line - Always 1, staying consistent with the Reflection API

getStartLine() : integer

Returns

integer

Validate / check a file level docblock

_checkFileDocBlock(array $tokens) : void

Parameters

$tokens

array

Array of tokenizer tokens

This method does the work of "reflecting" the file

_reflect() : void

Uses PHP's tokenizer to perform file reflection.

 Properties

 

$_classes

$_classes : array<mixed,\Zend_Reflection_Class>

Default

array()
 

$_contents

$_contents : string

Default

null
 

$_docComment

$_docComment : string

Default

null
 

$_endLine

$_endLine : integer

Default

null
 

$_filepath

$_filepath : string

Default

null
 

$_functions

$_functions : array<mixed,\Zend_Reflection_Function>

Default

array()
 

$_requiredFiles

$_requiredFiles : array<mixed,string>

Default

array()
 

$_startLine

$_startLine : integer

Default

1