mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
153 lines
3.5 KiB
XML
153 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.17 $ -->
|
|
<refentry xml:id="function.call-user-func" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>call_user_func</refname>
|
|
<refpurpose>Call a user function given by the first parameter</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>call_user_func</methodname>
|
|
<methodparam><type>callback</type><parameter>function</parameter></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Call a user defined function given by the <parameter>function</parameter>
|
|
parameter.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The function to be called. Class methods may also be invoked
|
|
statically using this function by passing
|
|
<literal>array($classname, $methodname)</literal> to this parameter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Zero or more parameters to be passed to the function.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Note that the parameters for <function>call_user_func</function> are
|
|
not passed by reference.
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function increment(&$var)
|
|
{
|
|
$var++;
|
|
}
|
|
|
|
$a = 0;
|
|
call_user_func('increment', $a);
|
|
echo $a; // 0
|
|
|
|
call_user_func_array('increment', array(&$a)); // You can use this instead
|
|
echo $a; // 1
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the function result, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>call_user_func</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function barber($type)
|
|
{
|
|
echo "You wanted a $type haircut, no problem";
|
|
}
|
|
call_user_func('barber', "mushroom");
|
|
call_user_func('barber', "shave");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>Using a class method</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class myclass {
|
|
function say_hello()
|
|
{
|
|
echo "Hello!\n";
|
|
}
|
|
}
|
|
|
|
$classname = "myclass";
|
|
|
|
call_user_func(array($classname, 'say_hello'));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>call_user_func_array</function></member>
|
|
<member><function>is_callable</function></member>
|
|
<member>&seealso.callback;</member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|