Files
archived-doc-pt-br/reference/exec/functions/escapeshellarg.xml
2025-04-10 11:26:35 -03:00

107 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 60c391265d2a51003e1ed0952e5a2413f81c7fc2 Maintainer: leonardolara Status: ready --><!-- CREDITS: fernandoc,leonardolara -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.8 -->
<refentry xml:id="function.escapeshellarg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>escapeshellarg</refname>
<refpurpose>Escapa uma string para ser usada como um argumento shell</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>escapeshellarg</methodname>
<methodparam><type>string</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
<function>escapeshellarg</function> adiciona aspas simples em torno de uma string
e escapa quaisquer aspas simples existentes permitindo passar uma
string diretamente a uma função shell e tê-la tratada como um único
argumento seguro. Esta função deve ser usada para escapar argumentos
individuais a funções shell vindos de entrada de usuário. As funções shell
incluem <function>exec</function>, <function>system</function> e o
<link linkend="language.operators.execution">operador de execução</link>.
</para>
<para>
Diferentemente, no Windows, <function>escapeshellarg</function> substitui sinais de
porcentagem, sinais de exclamação (subsitituição atrasada de variáveis) e aspas duplas
com espaços e adiciona aspas duplas em torno da string.
Posteriormente, cada sequência de barras invertidas consecutivas (<literal>\</literal>)
é escapada por uma barra invertida adicional.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
O argumento que será escapado.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string escapada.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <function>escapeshellarg</function></title>
<programlisting role="php">
<![CDATA[
<?php
system('ls '.escapeshellarg($dir));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>escapeshellcmd</function></member>
<member><function>exec</function></member>
<member><function>popen</function></member>
<member><function>system</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
-->