<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Return information regarding function argument(s)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.parsekit-compile-string.html">parsekit_compile_string</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.spl.html">SPL</a></div>
<div class="up"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.parsekit-func-arginfo" class="refentry">
<div class="refnamediv">
<h1 class="refname">parsekit_func_arginfo</h1>
<p class="verinfo">(PECL parsekit >= 0.3.0)</p><p class="refpurpose"><span class="refname">parsekit_func_arginfo</span> — <span class="dc-title">Return information regarding function argument(s)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.parsekit-func-arginfo-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>parsekit_func_arginfo</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$function</code></span>
)</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.parsekit-func-arginfo-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">function</code></em></span>
<dd>
<p class="para">
A string describing a function, or an array describing a class/method.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.parsekit-func-arginfo-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array containing argument information.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.parsekit-func-arginfo-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3795">
<p><strong>Example #1 <span class="function"><strong>parsekit_func_arginfo()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">foo</span><span style="color: #007700">(</span><span style="color: #0000BB">$bar</span><span style="color: #007700">, </span><span style="color: #0000BB">stdClass $baz</span><span style="color: #007700">, &</span><span style="color: #0000BB">$bomb</span><span style="color: #007700">, </span><span style="color: #0000BB">$bling </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br />}<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">parsekit_func_arginfo</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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)
}
}
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.parsekit-compile-string.html">parsekit_compile_string</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.spl.html">SPL</a></div>
<div class="up"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
