exec.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b412bbd26214f7281ac7dd858710e09952a275f2 Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.exec" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>exec</refname>
  <refpurpose>Выполняет внешнюю программу</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>exec</methodname>
   <methodparam><type>string</type><parameter>command</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">output</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">result_code</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>exec</function> выполняет команду
   <parameter>command</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>command</parameter></term>
     <listitem>
      <para>
       Команда, которую выполнит функция.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       Функция заполнит массив строками вывода команды,
       если в списке аргументов передали переменную для параметра <parameter>output</parameter>.
       Функция не включит в массив пробельные символы наподобие <literal>\n</literal>, которые завершают строки.
       Обратите внимание: функция <function>exec</function> добавит новые элементы в конец массива,
       если массив уже содержит элементы.
       Перед передачей элементов в функцию <function>exec</function> на массиве вызывают языковую конструкцию
       <function>unset</function>, если добавлять новые элементы в конец массива не требуется.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_code</parameter></term>
     <listitem>
      <para>
       Функция запишет в эту переменную статус возврата команды, которую выполнила система,
       если аргументы передали и в параметр <parameter>result_code</parameter>,
       и в параметр <parameter>output</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Выдаётся ошибка уровня <constant>E_WARNING</constant>,
   если функция <function>exec</function> не выполнила команду <parameter>command</parameter>.
  </para>
  <para>
   Функция выбрасывает исключение <classname>ValueError</classname>,
   если параметр <parameter>command</parameter> не указали или параметр содержит нулевые байты.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Теперь функция <function>exec</function> выбрасывает исключение <classname>ValueError</classname>,
       если параметр <parameter>command</parameter> не указали или параметр содержит нулевые байты;
       раньше функция выдавала ошибку уровня <constant>E_WARNING</constant> и возвращала &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример выполнения внешней программы функцией <function>exec</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Выводит имя пользователя, от имени которого запустили процесс php/httpd
// (применимо к системам с командой whoami в системном пути)
$output = null;
$retval = null;
exec('whoami', $output, $retval);
echo "Команда вернёт статус $retval и значение:\n";
print_r($output);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Команда вернёт статус 0 и значение:
Array
(
    [0] => cmb
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.escapeshell;
  &note.exec-bg;
  &note.exec-bypass-shell;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>system</function></member>
    <member><function>passthru</function></member>
    <member><function>escapeshellcmd</function></member>
    <member><function>pcntl_exec</function></member>
    <member><link linkend="language.operators.execution">Оператор исполнения</link></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
-->