documentation/manual/en/module_specs/Zend_Server_Reflection.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.server.reflection">
   4     <title>Zend_Server_Reflection</title>
   5
   6     <sect2 id="zend.server.reflection.introduction">
   7         <title>Introduction</title>
   8
   9         <para>
  10             <classname>Zend_Server_Reflection</classname> provides a standard mechanism for
  11             performing function and class introspection for use with server classes. It is
  12             based on <acronym>PHP</acronym> 5's Reflection <acronym>API</acronym>, augmenting it
  13             with methods for retrieving parameter and return value types and descriptions, a
  14             full list of function and method prototypes (i.e., all possible
  15             valid calling combinations), and function or method descriptions.
  16         </para>
  17
  18         <para>
  19             Typically, this functionality will only be used by developers of
  20             server classes for the framework.
  21         </para>
  22     </sect2>
  23
  24     <sect2 id="zend.server.reflection.usage">
  25         <title>Usage</title>
  26
  27         <para>
  28             Basic usage is simple:
  29         </para>
  30
  31         <programlisting language="php"><![CDATA[
  32 $class    = Zend_Server_Reflection::reflectClass('My_Class');
  33 $function = Zend_Server_Reflection::reflectFunction('my_function');
  34
  35 // Get prototypes
  36 $prototypes = $reflection->getPrototypes();
  37
  38 // Loop through each prototype for the function
  39 foreach ($prototypes as $prototype) {
  40
  41     // Get prototype return type
  42     echo "Return type: ", $prototype->getReturnType(), "\n";
  43
  44     // Get prototype parameters
  45     $parameters = $prototype->getParameters();
  46
  47     echo "Parameters: \n";
  48     foreach ($parameters as $parameter) {
  49         // Get parameter type
  50         echo "    ", $parameter->getType(), "\n";
  51     }
  52 }
  53
  54 // Get namespace for a class, function, or method.
  55 // Namespaces may be set at instantiation time (second argument), or using
  56 // setNamespace()
  57 $reflection->getNamespace();
  58 ]]></programlisting>
  59
  60         <para>
  61             <methodname>reflectFunction()</methodname> returns a
  62             <classname>Zend_Server_Reflection_Function</classname> object;
  63             <methodname>reflectClass()</methodname> returns a
  64             <classname>Zend_Server_Reflection_Class</classname> object. Please refer to
  65             the <acronym>API</acronym> documentation to see what methods are available to each.
  66         </para>
  67     </sect2>
  68 </sect1>
  69 <!--
  70 vim:se ts=4 sw=4 et:
  71 -->