Zend Framework: Zend_Reflection Component Proposal

Proposed Component Name	Zend_Reflection
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Reflection
Proposers	Ralph Schindler
Zend Liaison	TBD
Revision	1.0 - 24 June 2008: Initial Draft. (wiki revision: 8)

The purpose of Zend_Reflection is to build upon and add value to the base Reflection classes in PHP. In several instances within the Zend Framework, there are cases where the base PHP Reflection classes are extended with functionality that is "missing" from their PHP counterparts. This functionality will be implemented in Zend_Reflection by extending the PHP Reflection classes. By extending the base PHP classes, this allows developers to interchangeable use both Zend_Reflection and PHP Reflection in their libraries, modules and applications.

Most immediately, this component will add the ability to Reflect PHP Files, gather Reflection contents and reflect Docblocks and their principal parts.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will extend PHP's Reflection Classes where possible.
This component will implement new reflectable elements not handled by PHP Reflection.
This component will decompose PHPDocumentor (Docblock) comments.
This component will not reflect non PHP code.
This component will standardize use cases already seen within Zend Framework, specifically with respect to Zend_Server_Reflection.
This component will not attempt to load unrecognized elements.

4. Dependencies on Other Framework Components

PHP Reflection
Zend_Exception

5. Theory of Operation

This component will be instantiable in the same manner that current reflectable objects are instantiated. This component can be seen as a working extension of the PHP Reflection API.

6. Milestones / Tasks

DONE Milestone 1: design notes will be published here
Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ...
Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
Milestone 4: Unit tests exist, work, and are checked into SVN.
Milestone 5: Initial documentation exists.

7. Class Index

Zend_Reflection_Class
Zend_Reflection_Docblock
Zend_Reflection_Docblock_Tag
Zend_Reflection_Docblock_Tag_Param
Zend_Reflection_Docblock_Tag_Return
Zend_Reflection_Docblock_Tag
Zend_Reflection_Docblock
Zend_Reflection_Exception
Zend_Reflection_Extension
Zend_Reflection_File
Zend_Reflection_Function
Zend_Reflection_Method
Zend_Reflection_Parameter
Zend_Reflection_Property

8. Use Cases

UC-01

require_once 'My/Class.php';

$fileReflect = new Zend_Reflection_File('My/Class.php');
$methods = $fileReflect->getClass('My_Class')->getMethods();
var_dump($methods);

UC-02

// get type from parameter reflection object
$parameter = new Zend_Reflection_Parameter(array('Zend_Reflection_TestSampleClass5','doSomething'), 'two');
$parameter->getType() // 'int'

UC-03

// get classes from within a file

$fileToRequire = dirname(__FILE__) . '/_files/TestSampleClass.php';
require_once $fileToRequire;
$reflectionFile = new Zend_Reflection_File($fileToRequire);
        
echo count($reflectionFile->getClasses()); // 5 (the number of classes found within a file
$reflectionFile->getClass('Zend_Reflection_TestSampleClass2') // will return a Zend_Refleciton_Class of the class found within the file.

UC-04

$classReflection = new Zend_Reflection_Class('Zend_Reflection_TestSampleClass5');
echo $classReflection->getDocblock()->getTag('author'); // Ralph Schindler <ralph.schindler@zend.com>

9. Class Skeletons

Why have skeletons when you can have code?
http://framework.zend.com/svn/framework/standard/branches/user/ralph/ZendTool/library/Zend/Reflection/

SVN LINK

Page Operations

Browse Space

Zend_Reflection - Ralph Schindler

Labels