mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 21:38:56 +00:00
ecd72af657
Patch contributed by Sjon Hortensius. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350519 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.1 KiB
XML
131 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="reflectionparameter.getdefaultvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ReflectionParameter::getDefaultValue</refname>
|
|
<refpurpose>Gets default parameter value</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>mixed</type><methodname>ReflectionParameter::getDefaultValue</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the default value of the parameter for any user-defined or internal function or method.
|
|
If the parameter is not optional a <classname>ReflectionException</classname>
|
|
will be thrown.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The parameters default value.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
This method now allows getting the default value of parameters of built-in functions and
|
|
built-in class methods. Previously, a <classname>ReflectionException</classname> was thrown.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Getting default values of function parameters</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function foo($test, $bar = 'baz')
|
|
{
|
|
echo $test . $bar;
|
|
}
|
|
|
|
$function = new ReflectionFunction('foo');
|
|
|
|
foreach ($function->getParameters() as $param) {
|
|
echo 'Name: ' . $param->getName() . PHP_EOL;
|
|
if ($param->isOptional()) {
|
|
echo 'Default value: ' . $param->getDefaultValue() . PHP_EOL;
|
|
}
|
|
echo PHP_EOL;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Name: test
|
|
|
|
Name: bar
|
|
Default value: baz
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ReflectionParameter::isOptional</methodname></member>
|
|
<member><methodname>ReflectionParameter::isDefaultValueAvailable</methodname></member>
|
|
<member><methodname>ReflectionParameter::getDefaultValueConstantName</methodname></member>
|
|
<member><methodname>ReflectionParameter::isPassedByReference</methodname></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:"~/.phpdoc/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
|
|
-->
|