Files
2025-04-10 11:26:35 -03:00

190 lines
5.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b412bbd26214f7281ac7dd858710e09952a275f2 Maintainer: leonardolara Status: ready --><!-- CREDITS: fernandoc,leonardolara -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 -->
<refentry xml:id="function.exec" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>exec</refname>
<refpurpose>Executa um programa externo</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> executa o comando informado em
<parameter>command</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
O comando que será executado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output</parameter></term>
<listitem>
<para>
Se o argumento <parameter>output</parameter> estiver presente, então o
array especificado será prenchido com cada linha da saída do
comando. Espaço ao final, como <literal>\n</literal>, não é
incluído neste array. Note que se o array já contiver alguns
elementos, <function>exec</function> irá adicionar ao final do array.
Se nnão houver intenção de que a função adicione elementos, use
<function>unset</function> no array antes de passá-lo para
<function>exec</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>result_code</parameter></term>
<listitem>
<para>
Se o argumento <parameter>result_code</parameter> estiver presente
junto com o argumento <parameter>output</parameter>, então o
estado de retorno do comando executado será escrito nesta
variável.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A última linha do resultado do comando. Se for necessário executar um
comando e ter todos os dados dele passados diretamente de volta sem
qualquer interferência, use a função <function>passthru</function>.
</para>
<para>
Retorna &false; em caso de falha.
</para>
<para>
Para obter a saída do comando executado, certifique-se de definir e usar
o parâmetro <parameter>output</parameter>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emite um erro de nível <constant>E_WARNING</constant> se <function>exec</function>
for incapaz de executar o comando em <parameter>command</parameter>.
</para>
<para>
Lança uma exceção <classname>ValueError</classname> se <parameter>command</parameter>
estiver vazio ou contiver bytes nulos.
</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>
Se <parameter>command</parameter> estiver vazio ou contiver bytes nulos,
<function>exec</function> agora lança uma exceção <classname>ValueError</classname>.
Anteriormente emitia um erro de nível <constant>E_WARNING</constant> e retornava &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Um exemplo <function>exec</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Mostra o nome de quem é o dono do processo php/httpd
// (em um sistema com o executável "whoami" no path)
$output=null;
$retval=null;
exec('whoami', $output, $retval);
echo "Retornou com estado $retval e saída:\n";
print_r($output);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Retornou com estado 0 e saída:
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">operador de execução</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
-->