|
|
@@ -0,0 +1,400 @@
|
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
|
+<!-- Reviewed: no -->
|
|
|
+<!-- EN-Revision: 15289 -->
|
|
|
+<sect1 id="zend.reflection.reference">
|
|
|
+ <title>Zend_Reflectionリファレンス</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ The various classes in <code>Zend_Reflection</code> mimic the API of
|
|
|
+ PHP's <ulink url="http://php.net/reflection">Reflection API</ulink> -
|
|
|
+ with one important difference. PHP's Reflection API does not provide
|
|
|
+ introspection into docblock annotation tags, nor into parameter variable
|
|
|
+ types or return types.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection</code> analyzes method docblock annotations to
|
|
|
+ determine parameter variable types and the return type. Specifically,
|
|
|
+ the <code>@param</code> and <code>@return</code> annotations are used.
|
|
|
+ However, you can also check for any other annotation tags, as well as
|
|
|
+ the standard "short" and "long" descriptions.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ Each reflection object in <code>Zend_Reflection</code> overrides the
|
|
|
+ <code>getDocblock()</code> method to return an instance of
|
|
|
+ <code>Zend_Reflection_Docblock</code>. This class provides introspection
|
|
|
+ into the docblocks and annotation tags.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_File</code> is a new reflection class that allows
|
|
|
+ introspection of PHP files. With it, you can retrieve the classes,
|
|
|
+ functions, and global PHP code contained in the file.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ Finally, the various methods that return other reflection objects
|
|
|
+ allow a second parameter, the name of the reflection class to use for
|
|
|
+ the returned reflection object.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.docblock">
|
|
|
+ <title>Zend_Reflection_Docblock</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Docblock</code> is the heart of
|
|
|
+ <code>Zend_Reflection</code>'s value-add over PHP's Reflection API.
|
|
|
+ It provides the following methods:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getContents()</code>: docblockの完全な内容を返す
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getStartLine()</code>: 定義されたファイル内での
|
|
|
+ docblock開始位置を返す
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getEndLine()</code>: 定義されたファイル内での
|
|
|
+ docblock終了行を返す
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getShortDescription()</code>: 短い、一行の説明を取得
|
|
|
+ (たいていはdocblockの最初の行)
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getLongDescription()</code>: docblockの長い説明を取得
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>hasTag($name)</code>: 与えられた注釈タグが
|
|
|
+ docblockにあるかどうか判断する。
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getTag($name)</code>: Retrieve the given annotation tag
|
|
|
+ reflection object, or a boolean <code>false</code> if it's not
|
|
|
+ present.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getTags($filter)</code>: Retrieve all tags, or all tags
|
|
|
+ matching the given <code>$filter</code> string. The tags
|
|
|
+ returned will be an array of
|
|
|
+ <code>Zend_Reflection_Docblock_Tag</code> objects.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.docblock-tag">
|
|
|
+ <title>Zend_Reflection_Docblock_Tag</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Docblock_Tag</code> provides reflection for
|
|
|
+ individual annotation tags. Most tags consist of only a name and a
|
|
|
+ description. In the case of some special tags, the class provides a
|
|
|
+ factory method for retrieving an instance of the appropriate class.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ The following methods are defined for
|
|
|
+ <code>Zend_Reflection_Docblock_Tag</code>:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>factory($tagDocblockLine)</code>: instantiate the
|
|
|
+ appropriate tag reflection class and return it.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getName()</code>: 注釈タグの名前を返す
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDescription()</code>: 注釈の説明を返す
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.docblock-tag-param">
|
|
|
+ <title>Zend_Reflection_Docblock_Tag_Param</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Docblock_Tag_Param</code> is a specialized
|
|
|
+ version of <code>Zend_Reflection_Docblock_Tag</code>. The
|
|
|
+ <code>@param</code> annotation tag description consists of the
|
|
|
+ parameter type, variable name, and variable description. It adds the
|
|
|
+ following methods to <code>Zend_Reflection_Docblock_Tag</code>:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getType()</code>: パラメータ変数の型を返す
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getVariableName()</code>: パラメータ変数の名前を返す
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.docblock-tag-return">
|
|
|
+ <title>Zend_Reflection_Docblock_Tag_Return</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ Like <code>Zend_Reflection_Docblock_Tag_Param</code>,
|
|
|
+ <code>Zend_Reflection_Docblock_Tag_Return</code> is a specialized
|
|
|
+ version of <code>Zend_Reflection_Docblock_Tag</code>. The
|
|
|
+ <code>@return</code> annotation tag description consists of the
|
|
|
+ return type and variable description. It adds the following method
|
|
|
+ to <code>Zend_Reflection_Docblock_Tag</code>:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getType()</code>: 戻す型を返す
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.file">
|
|
|
+ <title>Zend_Reflection_File</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_File</code> provides introspection into PHP
|
|
|
+ files. With it, you can introspect the classes, functions, and bare
|
|
|
+ PHP code defined in a file. It defines the following methods:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getFileName()</code>: reflectionを使用したファイルの名前を取得
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getStartLine()</code>: ファイルの開始行を返す（常に１）
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getEndLine()</code> 最終行、ファイル中の行数を取得
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDocComment($reflectionClass =
|
|
|
+ 'Zend_Reflection_Docblock')</code>: retrive the file-level
|
|
|
+ docblock reflection object.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getClasses($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: retrieve an array of
|
|
|
+ reflection objects, one for each class defined in the file.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getFunctions($reflectionClass =
|
|
|
+ 'Zend_Reflection_Function')</code>: retrieve an array of
|
|
|
+ reflection objects, one for each function defined in the file.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getClass($name = null, $reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: retrieve the reflection
|
|
|
+ object for a single class.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getContents()</code>: retrieve the full contents of the
|
|
|
+ file.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.class">
|
|
|
+ <title>Zend_Reflection_Class</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Class</code> extends
|
|
|
+ <code>ReflectionClass</code>, and follows its API. It adds one
|
|
|
+ additional method, <code>getDeclaringFile()</code>, which may be
|
|
|
+ used to retrieve the <code>Zend_Reflection_File</code> reflection
|
|
|
+ object for the defining file.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ Additionally, the following methods add an additional argument for
|
|
|
+ specifying the reflection class to use when fetching a reflection
|
|
|
+ object:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDeclaringFile($reflectionClass = 'Zend_Reflection_File')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDocblock($reflectionClass = 'Zend_Reflection_Docblock')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getInterfaces($reflectionClass = 'Zend_Reflection_Class')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getMethod($reflectionClass = 'Zend_Reflection_Method')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getMethods($filter = -1, $reflectionClass = 'Zend_Reflection_Method')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getParentClass($reflectionClass = 'Zend_Reflection_Class')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getProperty($name, $reflectionClass =
|
|
|
+ 'Zend_Reflection_Property')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getProperties($filter = -1, $reflectionClass =
|
|
|
+ 'Zend_Reflection_Property')</code>
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.extension">
|
|
|
+ <title>Zend_Reflection_Extension</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Extension</code> extends
|
|
|
+ <code>ReflectionExtension</code>, and follows its API. It overrides
|
|
|
+ the following methods to add an additional argument for specifying
|
|
|
+ the reflection class to use when fetching a reflection object:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getFunctions($reflectionClass =
|
|
|
+ 'Zend_Reflection_Function')</code>: retrieve an array of
|
|
|
+ reflection objects representing the functions defined by the
|
|
|
+ extension.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getClasses($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: retrieve an array of
|
|
|
+ reflection objects representing the classes defined by the
|
|
|
+ extension.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.function">
|
|
|
+ <title>Zend_Reflection_Function</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Function</code> adds a method for retrieving
|
|
|
+ the function return type, as well as overrides several methods to
|
|
|
+ allow specifying the reflection class to use for returned reflection
|
|
|
+ objects.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDocblock($reflectionClass =
|
|
|
+ 'Zend_Reflection_Docblock')</code>: retrieve the function
|
|
|
+ docblock reflection object.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getParameters($reflectionClass =
|
|
|
+ 'Zend_Reflection_Parameter')</code>: retrieve an array of
|
|
|
+ all function parameter reflection objects.
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getReturn()</code>: retrieve the return type reflection
|
|
|
+ object.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.method">
|
|
|
+ <title>Zend_Reflection_Method</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Method</code> mirrors
|
|
|
+ <code>Zend_Reflection_Function</code>, and only overrides one
|
|
|
+ additional method:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getParentClass($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: retrieve the parent class
|
|
|
+ reflection object.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.parameter">
|
|
|
+ <title>Zend_Reflection_Parameter</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Parameter</code> adds a method for retrieving
|
|
|
+ the parameter type, as well as overrides methods to allow specifying
|
|
|
+ the reflection class to use on returned reflection objects.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDeclaringClass($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: get the declaring class of
|
|
|
+ the parameter as a reflection object (if available).
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getClass($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: get the class of
|
|
|
+ the parameter as a reflection object (if available).
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDeclaringFunction($reflectionClass =
|
|
|
+ 'Zend_Reflection_Function')</code>: get the function of
|
|
|
+ the parameter as a reflection object (if available).
|
|
|
+ </para></listitem>
|
|
|
+
|
|
|
+ <listitem><para>
|
|
|
+ <code>getType()</code>: パラメータの型を取得
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="zend.reflection.reference.property">
|
|
|
+ <title>Zend_Reflection_Property</title>
|
|
|
+
|
|
|
+ <para>
|
|
|
+ <code>Zend_Reflection_Property</code> overrides a single method in
|
|
|
+ order to allow specifying the returned reflection object class:
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>
|
|
|
+ <code>getDeclaringClass($reflectionClass =
|
|
|
+ 'Zend_Reflection_Class')</code>: retrieve the declaring
|
|
|
+ class of the property as a reflection object.
|
|
|
+ </para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+</sect1>
|
yoshida@zend.co.jp