Reflection/File.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Reflection
- Version
- $Id: File.php 24803 2012-05-14 12:23:46Z adamlundrigan $
\Zend_Reflection_File
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods


__toString() : string
Serialize to string
Required by the Reflector interface
Type | Description |
---|---|
string |
- Todo
- What should this serialization look like?


_checkFileDocBlock(array $tokens) : void
Validate / check a file level docblock
Name | Type | Description |
---|---|---|
$tokens | array | Array of tokenizer tokens |


_reflect() : void
This method does the work of "reflecting" the file
Uses PHP's tokenizer to perform file reflection.


export() : null
Export
Required by the Reflector interface.
Type | Description |
---|---|
null |
- Todo
- What should this do?


findRealpathInIncludePath(string $fileName) : string
Find realpath of file based on include_path
Name | Type | Description |
---|---|---|
$fileName | string |
Type | Description |
---|---|
string |


getClass(null | string $name = null, string $reflectionClass = 'Zend_Reflection_Class') : \Zend_Reflection_Class
Retrieve the reflection class of a given class found in this file
Name | Type | Description |
---|---|---|
$name | null | string | |
$reflectionClass | string | Reflection class to use when creating reflection instance |
Type | Description |
---|---|
\Zend_Reflection_Class |
Exception | Description |
---|---|
\Zend_Reflection_Exception | for invalid class name or invalid reflection class |


getClasses(string $reflectionClass = 'Zend_Reflection_Class') : array
Return the reflection classes of the classes found inside this file
Name | Type | Description |
---|---|---|
$reflectionClass | string | Name of reflection class to use for instances |
Type | Description |
---|---|
array | Array of Zend_Reflection_Class instances |


getDocblock(string $reflectionClass = 'Zend_Reflection_Docblock') : \Zend_Reflection_Docblock
Return the docblock
Name | Type | Description |
---|---|---|
$reflectionClass | string | Reflection class to use |
Type | Description |
---|---|
\Zend_Reflection_Docblock |


getFunctions(string $reflectionClass = 'Zend_Reflection_Function') : array
Return the reflection functions of the functions found inside this file
Name | Type | Description |
---|---|---|
$reflectionClass | string | Name of reflection class to use for instances |
Type | Description |
---|---|
array | Array of Zend_Reflection_Functions |