svn: /phpdoc/en/trunk/reference/reflection/reflectionmethod/ invoke.xml invokeargs.xml
| From: | Joris van de Sande | Date: | Wed, 21 Jul 2010 21:38:42 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/reflection/reflectionmethod/ invoke.xml invokeargs.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-6909@lists.php.net to get a copy of this message | ||
joris Wed, 21 Jul 2010 21:38:42 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=301456
Log:
- Documented/fixed arguments for ReflectionMethod class methods: invoke and invokeArgs
- Documented exceptions for ReflectionMethod class methods: invoke and invokeArgs
Changed paths:
U phpdoc/en/trunk/reference/reflection/reflectionmethod/invoke.xml
U phpdoc/en/trunk/reference/reflection/reflectionmethod/invokeargs.xml
Modified: phpdoc/en/trunk/reference/reflection/reflectionmethod/invoke.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionmethod/invoke.xml 2010-07-21 20:46:21 UTC (rev
301455)
+++ phpdoc/en/trunk/reference/reflection/reflectionmethod/invoke.xml 2010-07-21 21:38:42 UTC (rev
301456)
@@ -12,7 +12,8 @@
<methodsynopsis>
<modifier>public</modifier>
<type>mixed</type><methodname>ReflectionMethod::invoke</methodname>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>args</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
Invokes a reflected method.
@@ -30,17 +31,17 @@
<term><parameter>object</parameter></term>
<listitem>
<para>
- The object to invoke.
+ The object to invoke the method on. In case of static methods, you can pass
+ <type>null</type> to this parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>args</parameter></term>
+ <term><parameter>parameter</parameter></term>
<listitem>
<para>
- The passed in argument list. It accepts a variable number of
- arguments which are passed to the function much like
- <function>call_user_func</function> is.
+ Zero or more parameters to be passed to the method.
+ It accepts a variable number of parameters which are passed to the method.
</para>
</listitem>
</varlistentry>
@@ -51,10 +52,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns the method result.
</para>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ A <classname>ReflectionException</classname> if the
<parameter>object</parameter>
+ parameter does not contain an instance of the class that this method was declared in.
+ </para>
+ <para>
+ A <classname>ReflectionException</classname> if the method invocation failed.
+ </para>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Modified: phpdoc/en/trunk/reference/reflection/reflectionmethod/invokeargs.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionmethod/invokeargs.xml 2010-07-21 20:46:21 UTC
(rev 301455)
+++ phpdoc/en/trunk/reference/reflection/reflectionmethod/invokeargs.xml 2010-07-21 21:38:42 UTC
(rev 301456)
@@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>mixed</type><methodname>ReflectionMethod::invokeArgs</methodname>
-
<methodparam><type>string</type><parameter>object</parameter></methodparam>
+
<methodparam><type>object</type><parameter>object</parameter></methodparam>
<methodparam><type>array</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
@@ -30,7 +30,8 @@
<term><parameter>object</parameter></term>
<listitem>
<para>
-
+ The object to invoke the method on. In case of static methods, you can pass
+ <type>null</type> to this parameter.
</para>
</listitem>
</varlistentry>
@@ -38,7 +39,7 @@
<term><parameter>args</parameter></term>
<listitem>
<para>
-
+ The parameters to be passed to the function, as an <type>array</type>.
</para>
</listitem>
</varlistentry>
@@ -49,10 +50,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns the method result.
</para>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ A <classname>ReflectionException</classname> if the
<parameter>object</parameter>
+ parameter does not contain an instance of the class that this method was declared in.
+ </para>
+ <para>
+ A <classname>ReflectionException</classname> if the method invocation failed.
+ </para>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>