- Documented/fixed arguments for ReflectionMethod class methods: invoke and invokeArgs

- Documented exceptions for ReflectionMethod class methods: invoke and invokeArgs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@301456 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joris van de Sande 2010-07-21 21:38:42 +00:00
parent f1b4419dc7
commit 587df982a2
2 changed files with 35 additions and 11 deletions

View file

@ -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,7 +52,18 @@
<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>

View file

@ -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,7 +50,18 @@
<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>