Reflection/File.php
Show:
inherited
inherited
Classes
Zend Framework
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Reflection
- Version
- $Id$
\Zend_Reflection_File
Package: Zend_Reflection
Details
Details
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(string $file) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $file | string |
__toString() : stringSerialize to string
Required by the Reflector interface
Returns| Type | Description |
|---|---|
| string |
- Todo
- What should this serialization look like?
export() : nullstatic
Export
Required by the Reflector interface.
Returns| Type | Description |
|---|---|
| null |
- Todo
- What should this do?
findRealpathInIncludePath(string $fileName) : stringstatic
Find realpath of file based on include_path
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $fileName | string |
| Type | Description |
|---|---|
| string |
getClass(null | string $name = null, string $reflectionClass = 'Zend_Reflection_Class') : \Zend_Reflection_ClassRetrieve the reflection class of a given class found in this file
Parameters
Returns
Throws
| 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') : arrayReturn the reflection classes of the classes found inside this file
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $reflectionClass | string | Name of reflection class to use for instances |
| Type | Description |
|---|---|
| array | Array of Zend_Reflection_Class instances |
getContents() : stringReturn the full contents of file
Returns
| Type | Description |
|---|---|
| string |
getDocComment() : stringReturn the doc comment
Returns
| Type | Description |
|---|---|
| string |
getDocblock(string $reflectionClass = 'Zend_Reflection_Docblock') : \Zend_Reflection_DocblockReturn the docblock
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $reflectionClass | string | Reflection class to use |
| Type | Description |
|---|---|
| \Zend_Reflection_Docblock |
getEndLine() : intGet the end line / number of lines
Returns
| Type | Description |
|---|---|
| int |
getFileName() : stringReturn the file name of the reflected file
Returns
| Type | Description |
|---|---|
| string |
getFunctions(string $reflectionClass = 'Zend_Reflection_Function') : arrayReturn the reflection functions of the functions found inside this file
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $reflectionClass | string | Name of reflection class to use for instances |
| Type | Description |
|---|---|
| array | Array of Zend_Reflection_Functions |
getStartLine() : intGet the start line - Always 1, staying consistent with the Reflection API
Returns
| Type | Description |
|---|---|
| int |