mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
31e02322db
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@172267 c90b9560-bf6c-de11-be94-00142212c4b1
122 lines
2.5 KiB
XML
122 lines
2.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<refentry id="function.parsekit-func-arginfo">
|
|
<refnamediv>
|
|
<refname>parsekit_func_arginfo</refname>
|
|
<refpurpose>Return information regarding function argument(s)</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>parsekit_func_arginfo</methodname>
|
|
<methodparam><type>mixed</type><parameter>function</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A string describing a function, or an array describing a class/method.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array containing argument information.
|
|
</para>
|
|
</refsect1>
|
|
<!-- No changelog: it's only in PECL. -->
|
|
<refsect1>
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>parsekit_func_arginfo</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function foo($bar, stdClass $baz, &$bomb, $bling = false) {
|
|
}
|
|
|
|
var_dump(parsekit_func_arginfo('foo'));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
array(4) {
|
|
[0]=>
|
|
array(3) {
|
|
["name"]=>
|
|
string(3) "bar"
|
|
["allow_null"]=>
|
|
bool(true)
|
|
["pass_by_reference"]=>
|
|
bool(false)
|
|
}
|
|
[1]=>
|
|
array(4) {
|
|
["name"]=>
|
|
string(3) "baz"
|
|
["class_name"]=>
|
|
string(8) "stdClass"
|
|
["allow_null"]=>
|
|
bool(false)
|
|
["pass_by_reference"]=>
|
|
bool(false)
|
|
}
|
|
[2]=>
|
|
array(3) {
|
|
["name"]=>
|
|
string(4) "bomb"
|
|
["allow_null"]=>
|
|
bool(true)
|
|
["pass_by_reference"]=>
|
|
bool(true)
|
|
}
|
|
[3]=>
|
|
array(3) {
|
|
["name"]=>
|
|
string(5) "bling"
|
|
["allow_null"]=>
|
|
bool(true)
|
|
["pass_by_reference"]=>
|
|
bool(false)
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|