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

139 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b412bbd26214f7281ac7dd858710e09952a275f2 Maintainer: leonardolara Status: ready -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 -->
<refentry xml:id="function.passthru" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>passthru</refname>
<refpurpose>Executa um programa externo e mostra a saída bruta</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>false</type><type>null</type></type><methodname>passthru</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">result_code</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
A função <function>passthru</function> é similar à função
<function>exec</function>, e executa um comando especificado em
<parameter>command</parameter>. Esta função
deve ser usada no lugar de <function>exec</function> ou
<function>system</function> quando a saída do comando Unix
for dado binário que precisa ser passado diretamente de volta ao
navegador. Um uso como para isto é executar algo como os
utilitários pbmplus que podem enviar um fluxo de imagem diretamente. Através
da configuração de Content-type para <literal>image/gif</literal> e
da chamada ao programa pbmplus para saída de um arquivo gif, pode-se criar
scripts PHP que mostram imagens diretamente.
</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>result_code</parameter></term>
<listitem>
<para>
Se o argumento <parameter>result_code</parameter> estiver presente, o
estado de retorno do comando Unix será colocado aqui.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.nullorfalse;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emitirá um <constant>E_WARNING</constant> se <function>passthru</function>
for incapaz de executar o comando especificado no parâmetro <parameter>command</parameter>.
</para>
<para>
Lança uma exceção <classname>ValueError</classname> se <parameter>command</parameter>
estiver vazio ou se 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>passthru</function> agora lança uma exceção <classname>ValueError</classname>.
Anteriormente, emitia um <constant>E_WARNING</constant> e retornava &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.escapeshell;
&note.exec-bg;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>exec</function></member>
<member><function>system</function></member>
<member><function>popen</function></member>
<member><function>escapeshellcmd</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
-->