func-get-args.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: de42b5016e8d9cbfd245d70f65354a86f4e2f031 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.func-get-args" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>func_get_args</refname>
  <refpurpose>関数の引数リストを配列として返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>func_get_args</methodname>
   <void/>
  </methodsynopsis>
  <para>
   関数の引数リストを配列で取得します。
  </para>
  <para>
   この関数は <function>func_num_args</function>
   および <function>func_get_arg</function> と組み合わせて使用され、
   これによりユーザー定義の章において可変長の引数リストを使用することができるようになります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   配列を返します。この配列の各要素は、
   現在のユーザー定義関数の引数リストにおける対応するメンバのコピーとなります。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   ユーザー定義関数の外部からコールされた際に警告を発生します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>func_get_args</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
function foo()
{
    $numargs = func_num_args();
    echo "引数の数: $numargs \n";
    if ($numargs >= 2) {
        echo "二番目の引数は: " . func_get_arg(1) . " です。\n";
    }
    $arg_list = func_get_args();
    for ($i = 0; $i < $numargs; $i++) {
        echo "引数 $i は: " . $arg_list[$i] . " です。\n";
    }
}

foo(1, 2, 3);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
引数の数: 3
二番目の引数は: 2 です。
引数 0 は: 1 です。
引数 1 は: 2 です。
引数 2 は: 3 です。
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>func_get_args</function> での引数の参照渡しと値渡しの例</title>
    <programlisting role="php">
<![CDATA[
<?php
function byVal($arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

function byRef(&$arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

$arg = 'bar';
byVal($arg);
byRef($arg);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
As passed     : array (
  0 => 'bar',
)
After change  : array (
  0 => 'baz',
)
As passed     : array (
  0 => 'bar',
)
After change  : array (
  0 => 'baz',
)
    </screen>
   </example>
  </para>

 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.func-named-params;
  &note.funcbyref;
  <note>
   <simpara>
    この関数は、渡された引数のみのコピーを返します。
    デフォルトの（渡されていない）引数については考慮しません。
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="functions.variable-arg-list"><literal>...</literal> 構文</link></member>
    <member><function>func_get_arg</function></member>
    <member><function>func_num_args</function></member>
    <member><methodname>ReflectionFunctionAbstract::getParameters</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
-->