Reflection/File.php

Show:

inherited

Classes
- \Zend_Reflection_File

Table of Contents

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-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
jump to top

Package: Zend\Reflection

Implements
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Reflection_Class[] $_classes = array()

Default valuearray()Details

Type: \Zend_Reflection_Class[]

string $_contents = null

Default valuenullDetails

Type: string

string $_docComment = null

Default valuenullDetails

Type: string

int $_endLine = null

Default valuenullDetails

Type: int

string $_filepath = null

Default valuenullDetails

Type: string

\Zend_Reflection_Function[] $_functions = array()

Default valuearray()Details

Type: \Zend_Reflection_Function[]

string[] $_requiredFiles = array()

Default valuearray()Details

Type: string[]

int $_startLine = 1

Default value1Details

Type: int

Methods

__construct(string $file) : void

Constructor

Parameters

Name	Type	Description
$file	string

__toString() : string

Serialize to string

Required by the Reflector interface

Returns

Type	Description
string

Details

Todo: What should this serialization look like?

_checkFileDocBlock(array $tokens) : void

Validate / check a file level docblock

Parameters

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

static

Export

Required by the Reflector interface.

Returns

Type	Description
null

Details

Todo: What should this do?

findRealpathInIncludePath(string $fileName) : string

static

Find realpath of file based on include_path

Parameters

Name	Type	Description
$fileName	string

Returns

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

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

getClasses(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

getContents() : string

Return the full contents of file

Returns

Type	Description
string

getDocComment() : string

Return the doc comment

Returns

Type	Description
string

getDocblock(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

getEndLine() : int

Get the end line / number of lines

Returns

Type	Description
int

getFileName() : string

Return the file name of the reflected file

Returns

Type	Description
string

getFunctions(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

getStartLine() : int

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

Returns

Type	Description
int

Reflection/File.php

\Zend_Reflection_Filejump to top

Properties

Methods

\Zend_Reflection_File
jump to top