archived-doc-ru/reference/funchand/functions/func-get-arg.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: de42b5016e8d9cbfd245d70f65354a86f4e2f031 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.func-get-arg" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>func_get_arg</refname>
  <refpurpose>Возвращает элемент из списка аргументов</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>func_get_arg</methodname>
   <methodparam><type>int</type><parameter>position</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция получает аргумент из списка аргументов пользовательской
   функции по заданной позиции.
  </para>
  <para>
   Функцию допускается использовать совместно с функциями
   <function>func_get_args</function> и <function>func_num_args</function>,
   чтобы создавать функции с переменным количеством аргументов.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>position</parameter></term>
     <listitem>
      <para>
       Смещение аргумента. Аргументы функции отсчитываются с нуля.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает аргумент по позиции или &false;, если возникла ошибка.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция генерирует предупреждение при вызове из-за пределов определения функции
   или если значение позиции <parameter>position</parameter> больше
   количества аргументов, которые действительно передали.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     Пример использования функции <function>func_get_arg</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";
     }
}

foo(1, 2, 3);

?>
]]>
    </programlisting>
        &example.outputs;
    <screen>
<![CDATA[
Количество аргументов: 3
Второй аргумент: 2
]]>
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>
     Пример передачи в функцию <function>func_get_arg</function>
     аргументов по ссылке и по значению
    </title>
    <programlisting role="php">
<![CDATA[
<?php

function byVal($arg) {
    echo 'Передан          : ', var_export(func_get_arg(0)), PHP_EOL;
    $arg = 'baz';
    echo 'После изменения  : ', var_export(func_get_arg(0)), PHP_EOL;
}

function byRef(&$arg) {
    echo 'Передан          : ', var_export(func_get_arg(0)), PHP_EOL;
    $arg = 'baz';
    echo 'После изменения  : ', var_export(func_get_arg(0)), PHP_EOL;
}

$arg = 'bar';
byVal($arg);
byRef($arg);

?>
]]>
    </programlisting>
     &example.outputs;
    <screen>
Передан          : 'bar'
После изменения  : 'baz'
Передан          : 'bar'
После изменения  : '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_args</function></member>
    <member><function>func_num_args</function></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
-->