API Documentation

Reflection/File.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Reflection  
version
$Id: File.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Reflection_File

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

Properties

Propertyprotected\Zend_Reflection_Class[]  $_classes= 'array'

Default valuearrayDetails
Type
\Zend_Reflection_Class[]
Propertyprotectedstring  $_contents= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_docComment= 'null'

Default valuenullDetails
Type
string
Propertyprotectedint  $_endLine= 'null'

Default valuenullDetails
Type
int
Propertyprotectedstring  $_filepath= 'null'

Default valuenullDetails
Type
string
Propertyprotected\Zend_Reflection_Function[]  $_functions= 'array'

Default valuearrayDetails
Type
\Zend_Reflection_Function[]
Propertyprotected\string[]  $_requiredFiles= 'array'

Default valuearrayDetails
Type
\string[]
Propertyprotectedint  $_startLine= '1'

Default value1Details
Type
int

Methods

methodpublic__construct( string $file ) : void

Constructor

Parameters
Name Type Description
$file string
methodpublic__toString( ) : string

Serialize to string

Required by the Reflector interface

Returns
Type Description
string
Details
todo
What should this serialization look like?  
methodprotected_checkFileDocBlock( array $tokens ) : void

Validate / check a file level docblock

Parameters
Name Type Description
$tokens array Array of tokenizer tokens
methodprotected_reflect( ) : void

This method does the work of "reflecting" the file

Uses PHP's tokenizer to perform file reflection.

methodpublicexport( ) : null
static

Export

Required by the Reflector interface.

Returns
Type Description
null
Details
todo
What should this do?  
methodpublicfindRealpathInIncludePath( string $fileName ) : string
static

Find realpath of file based on include_path

Parameters
Name Type Description
$fileName string
Returns
Type Description
string
methodpublicgetClass( null|string $name = null, string $reflectionClass = Zend_Reflection_Class ) : \Zend_Reflection_Class

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

Parameters
Name Type Description
$name null|string
$reflectionClass string Reflection class to use when creating reflection instance
Returns
Type Description
\Zend_Reflection_Class
Throws
Exception Description
\Zend_Reflection_Exception for invalid class name or invalid reflection class
methodpublicgetClasses( string $reflectionClass = Zend_Reflection_Class ) : array

Return the reflection classes of the classes found inside this file

Parameters
Name Type Description
$reflectionClass string Name of reflection class to use for instances
Returns
Type Description
array Array of Zend_Reflection_Class instances
methodpublicgetContents( ) : string

Return the full contents of file

Returns
Type Description
string
methodpublicgetDocComment( ) : string

Return the doc comment

Returns
Type Description
string
methodpublicgetDocblock( string $reflectionClass = Zend_Reflection_Docblock ) : \Zend_Reflection_Docblock

Return the docblock

Parameters
Name Type Description
$reflectionClass string Reflection class to use
Returns
Type Description
\Zend_Reflection_Docblock
methodpublicgetEndLine( ) : int

Get the end line / number of lines

Returns
Type Description
int
methodpublicgetFileName( ) : string

Return the file name of the reflected file

Returns
Type Description
string
methodpublicgetFunctions( string $reflectionClass = Zend_Reflection_Function ) : array

Return the reflection functions of the functions found inside this file

Parameters
Name Type Description
$reflectionClass string Name of reflection class to use for instances
Returns
Type Description
array Array of Zend_Reflection_Functions
methodpublicgetStartLine( ) : int

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

Returns
Type Description
int
Documentation was generated by DocBlox 0.13.3.