escapeshellarg.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 590013355f30e3862ea9d9d48b9ceec7b562691a Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<!-- 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>Escapar una cadena a ser usada como argumento del
   intérprete de comandos</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> agrega comillas sencillas
   alrededor de una cadena y rodea de comillas/escapa cualquier
   comilla sencilla existente, permitiéndole pasar la cadena
   directamente a una función del intérprete de
   comandos, y logrando que sea tratada como un solo argumento
   seguro. Esta función debe ser usada para escapar argumentos
   individuales a funciones del intérprete de comandos que
   provienen de la entrada del usuario. Las funciones del
   intérprete de comandos incluyen <function>exec</function>,
   <function>system</function> y el <link
   linkend="language.operators.execution">operador de comilla
   invertida</link>.
  </para>
  <para>
   En Windows, <function>escapeshellarg</function> elimina en su lugar los signos de
   porcentaje, remplaza las comillas dobles por espacios y añade comillas dobles al
   string.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>arg</parameter></term>
     <listitem>
      <para>
       El argumento que será escapado.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La cadena escapada.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo 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
     comilla invertida</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
-->