API Documentation

Reflection/File.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Reflection
version
$Id: File.php 20903 2010-02-04 16:16:47Z matthew $
Classes
Zend_Reflection_File

Description

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.

Zend_Reflection_File
jump to top

Implements
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Reflection
Properties
$_filepath
$_docComment
$_startLine
$_endLine
$_requiredFiles
$_classes
$_functions
$_contents
Methods
__construct
findRealpathInIncludePath
export
getFileName
getStartLine
getEndLine
getDocComment
getDocblock
getClasses
getFunctions
getClass
getContents
__toString
_reflect
_checkFileDocBlock

Description

Properties

$_classes
jump to class

Zend_Reflection_Class[] $_classes = 'array'

Details

$_classes
Zend_Reflection_Class[]
visibility
protected
default
array
final
false
static
false

$_contents
jump to class

string $_contents = 'null'

Details

$_contents
string
visibility
protected
default
null
final
false
static
false

$_docComment
jump to class

string $_docComment = 'null'

Details

$_docComment
string
visibility
protected
default
null
final
false
static
false

$_endLine
jump to class

int $_endLine = 'null'

Details

$_endLine
int
visibility
protected
default
null
final
false
static
false

$_filepath
jump to class

string $_filepath = 'null'

Details

$_filepath
string
visibility
protected
default
null
final
false
static
false

$_functions
jump to class

Zend_Reflection_Function[] $_functions = 'array'

Details

$_functions
Zend_Reflection_Function[]
visibility
protected
default
array
final
false
static
false

$_requiredFiles
jump to class

string[] $_requiredFiles = 'array'

Details

$_requiredFiles
string[]
visibility
protected
default
array
final
false
static
false

$_startLine
jump to class

int $_startLine = '1'

Details

$_startLine
int
visibility
protected
default
1
final
false
static
false

Methods

__construct
jump to class

__construct( string $file ) : void

Constructor

Arguments
$file
string
Details
visibility
public
final
false
static
false

__toString
jump to class

__toString( ) : string

Serialize to string

Required by the Reflector interface

Output
string
Details
visibility
public
final
false
static
false
todo
What should this serialization look like?

_checkFileDocBlock
jump to class

_checkFileDocBlock( array $tokens ) : void

Validate / check a file level docblock

Arguments
$tokens
array
Array of tokenizer tokens
Details
visibility
protected
final
false
static
false

_reflect
jump to class

_reflect( ) : void

This method does the work of "reflecting" the file

Uses PHP's tokenizer to perform file reflection.

Details
visibility
protected
final
false
static
false

export
jump to class

export( ) : null

Export

Required by the Reflector interface.

Output
null
Details
visibility
public
final
false
static
true
todo
What should this do?

findRealpathInIncludePath
jump to class

findRealpathInIncludePath( string $fileName ) : string

Find realpath of file based on include_path

Arguments
$fileName
string
Output
string
Details
visibility
public
final
false
static
true

getClass
jump to class

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

Arguments
$name
nullstring
$reflectionClass
string
Reflection class to use when creating reflection instance
Output
Zend_Reflection_Class
Details
visibility
public
final
false
static
false
throws
for invalid class name or invalid reflection class

getClasses
jump to class

getClasses( string $reflectionClass = Zend_Reflection_Class ) : array

Return the reflection classes of the classes found inside this file

Arguments
$reflectionClass
string
Name of reflection class to use for instances
Output
array
Array of Zend_Reflection_Class instances
Details
visibility
public
final
false
static
false

getContents
jump to class

getContents( ) : string

Return the full contents of file

Output
string
Details
visibility
public
final
false
static
false

getDocComment
jump to class

getDocComment( ) : string

Return the doc comment

Output
string
Details
visibility
public
final
false
static
false

getDocblock
jump to class

getDocblock( string $reflectionClass = Zend_Reflection_Docblock ) : Zend_Reflection_Docblock

Return the docblock

Arguments
$reflectionClass
string
Reflection class to use
Output
Zend_Reflection_Docblock
Details
visibility
public
final
false
static
false

getEndLine
jump to class

getEndLine( ) : int

Get the end line / number of lines

Output
int
Details
visibility
public
final
false
static
false

getFileName
jump to class

getFileName( ) : string

Return the file name of the reflected file

Output
string
Details
visibility
public
final
false
static
false

getFunctions
jump to class

getFunctions( string $reflectionClass = Zend_Reflection_Function ) : array

Return the reflection functions of the functions found inside this file

Arguments
$reflectionClass
string
Name of reflection class to use for instances
Output
array
Array of Zend_Reflection_Functions
Details
visibility
public
final
false
static
false

getStartLine
jump to class

getStartLine( ) : int

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

Output
int
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.