documentation/manual/en/module_specs/Zend_Reflection-Examples.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.reflection.examples">
   4     <title>Zend_Reflection Examples</title>
   5
   6     <example id="zend.reflection.examples.file">
   7         <title>Performing reflection on a file</title>
   8
   9         <programlisting language="php"><![CDATA[
  10 $r = new Zend_Reflection_File($filename);
  11 printf(
  12     "===> The %s file\n".
  13     "     has %d lines\n",
  14     $r->getFileName(),
  15     $r->getEndLine()
  16 );
  17
  18 $classes = $r->getClasses();
  19 echo "     It has " . count($classes) . ":\n";
  20 foreach ($classes as $class) {
  21     echo "         " . $class->getName() . "\n";
  22 }
  23
  24 $functions = $r->getFunctions();
  25 echo "     It has " . count($functions) . ":\n";
  26 foreach ($functions as $function) {
  27     echo "         " . $function->getName() . "\n";
  28 }
  29 ]]></programlisting>
  30     </example>
  31
  32     <example id="zend.reflection.examples.class">
  33         <title>Performing reflection on a class</title>
  34
  35         <programlisting language="php"><![CDATA[
  36 $r = new Zend_Reflection_Class($class);
  37
  38 printf(
  39     "The class level docblock has the short description: %s\n".
  40     "The class level docblock has the long description:\n%s\n",
  41     $r->getDocblock()->getShortDescription(),
  42     $r->getDocblock()->getLongDescription(),
  43 );
  44
  45 // Get the declaring file reflection
  46 $file = $r->getDeclaringFile();
  47 ]]></programlisting>
  48     </example>
  49
  50     <example id="zend.reflection.examples.method">
  51         <title>Performing reflection on a method</title>
  52
  53         <programlisting language="php"><![CDATA[
  54 $r = new Zend_Reflection_Method($class, $name);
  55
  56 printf(
  57 "The method '%s' has a return type of %s",
  58     $r->getName(),
  59     $r->getReturn()
  60 );
  61
  62 foreach ($r->getParameters() as $key => $param) {
  63     printf(
  64         "Param at position '%d' is of type '%s'\n",
  65         $key,
  66         $param->getType()
  67     );
  68 }
  69 ]]></programlisting>
  70     </example>
  71
  72     <example id="zend.reflection.examples.docblock">
  73         <title>Performing reflection on a docblock</title>
  74
  75         <programlisting language="php"><![CDATA[
  76 $r = new Zend_Reflection_Method($class, $name);
  77 $docblock = $r->getDocblock();
  78
  79 printf(
  80     "The short description: %s\n".
  81     "The long description:\n%s\n",
  82     $r->getDocblock()->getShortDescription(),
  83     $r->getDocblock()->getLongDescription(),
  84 );
  85
  86 foreach ($docblock->getTags() as $tag) {
  87     printf(
  88         "Annotation tag '%s' has the description '%s'\n",
  89         $tag->getName(),
  90         $tag->getDescription()
  91     );
  92 }
  93 ]]></programlisting>
  94     </example>
  95 </sect1>