func-get-args.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 06779b06125d020da4a08ef09ed184a95a59e9ff Maintainer: lehmer Status: ready -->
<!-- Reviewed: no Maintainer: lehmer -->
<refentry xml:id="function.func-get-args" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>func_get_args</refname>
  <refpurpose>Devuelve un array que se compone de una lista de argumentos de función</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>func_get_args</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Obtiene un array de la lista de argumentos de una función.
  </para>
  <para>
   Esta función se puede usar junto con
   <function>func_get_arg</function> y <function>func_num_args</function> para permitir
   a las funciones definidas por el usuario aceptar una lista de argumentos de longitud variable.
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array en el que cada elemento es una copia del miembro
   correspondiente de la lista de argumentos de la función definida por el usuario.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Genera una advertencia si se llama desde fuera de una función definida por el usuario.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>func_get_args</function></title>
    <programlisting role="php">
<![CDATA[
<?php
function foo()
{
    $númargs = func_num_args();
    echo "Número de argumentos: $númargs \n";
    if ($númargs >= 2) {
        echo "El segundo argumento es: " . func_get_arg(1) . "\n";
    }
    $arg_list = func_get_args();
    for ($i = 0; $i < $númargs; $i++) {
        echo "El argumento $i es: " . $arg_list[$i] . "\n";
    }
}

foo(1, 2, 3);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Número de argumentos: 3
El segundo argumento es: 2
El argumento 0 es: 1
El argumento 1 es: 2
El argumento 2 es: 3
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>func_get_args</function> ejemplo de argumentos byref (pasa un objeto como referencia) y byval (pasa un objeto como valor)</title>
    <programlisting role="php">
<![CDATA[
<?php
function byVal($arg) {
    echo 'Pasó como     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'Tras el cambio  : ', var_export(func_get_args()), PHP_EOL;
}

function byRef(&$arg) {
    echo 'Pasó como     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'Tras el cambio  : ', var_export(func_get_args()), PHP_EOL;
}

$arg = 'bar';
byVal($arg);
byRef($arg);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
Pasó como     : array (
  0 => 'bar',
)
Tras el cambio  : array (
  0 => 'baz',
)
Pasó como     : array (
  0 => 'bar',
)
Tras el cambio  : array (
  0 => 'baz',
)
    </screen>
   </example>
  </para>

 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.funcbyref;
  <note>
   <simpara>
    Esta función solamente devuelve una copia de los argumentos pasados, y no
    rinde cuentas de los argumentos predeterminados (no pasados).
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="functions.variable-arg-list">La sintaxis de <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
-->