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

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.reflection.examples">
    <title>Zend_Reflection Examples</title>

    <example id="zend.reflection.examples.file">
        <title>Performing reflection on a file</title>

        <programlisting language="php"><![CDATA[
$r = new Zend_Reflection_File($filename);
printf(
    "===> The %s file\n".
    "     has %d lines\n",
    $r->getFileName(),
    $r->getEndLine()
);

$classes = $r->getClasses();
echo "     It has " . count($classes) . ":\n";
foreach ($classes as $class) {
    echo "         " . $class->getName() . "\n";
}

$functions = $r->getFunctions();
echo "     It has " . count($functions) . ":\n";
foreach ($functions as $function) {
    echo "         " . $function->getName() . "\n";
}
]]></programlisting>
    </example>

    <example id="zend.reflection.examples.class">
        <title>Performing reflection on a class</title>

        <programlisting language="php"><![CDATA[
$r = new Zend_Reflection_Class($class);

printf(
    "The class level docblock has the short description: %s\n".
    "The class level docblock has the long description:\n%s\n",
    $r->getDocblock()->getShortDescription(),
    $r->getDocblock()->getLongDescription(),
);

// Get the declaring file reflection
$file = $r->getDeclaringFile();
]]></programlisting>
    </example>

    <example id="zend.reflection.examples.method">
        <title>Performing reflection on a method</title>

        <programlisting language="php"><![CDATA[
$r = new Zend_Reflection_Method($class, $name);

printf(
"The method '%s' has a return type of %s",
    $r->getName(),
    $r->getReturn()
);

foreach ($r->getParameters() as $key => $param) {
    printf(
        "Param at position '%d' is of type '%s'\n",
        $key,
        $param->getType()
    );
}
]]></programlisting>
    </example>

    <example id="zend.reflection.examples.docblock">
        <title>Performing reflection on a docblock</title>

        <programlisting language="php"><![CDATA[
$r = new Zend_Reflection_Method($class, $name);
$docblock = $r->getDocblock();

printf(
    "The short description: %s\n".
    "The long description:\n%s\n",
    $r->getDocblock()->getShortDescription(),
    $r->getDocblock()->getLongDescription(),
);

foreach ($docblock->getTags() as $tag) {
    printf(
        "Annotation tag '%s' has the description '%s'\n",
        $tag->getName(),
        $tag->getDescription()
    );
}
]]></programlisting>
    </example>
</sect1>