urlencode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 767338231c3e14c7be5399b8e2e0c3b60f7ae8dd Maintainer: yago Status: ready -->
<!-- Reviewed: no Maintainer: yago -->
<refentry xml:id="function.urlencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>urlencode</refname>
  <refpurpose>Codifica como URL una cadena</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>urlencode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   Esta función es conveniente cuando se codifica una cadena a ser usada
   como la parte de consulta de una URL, como método práctico para pasar
   variables a la siguiente página.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La cadena a ser codificada.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve una cadena en la que todos los caracteres no-alfanuméricos
   excepto <literal>-_.</literal> han sido reemplazados con un signo de
   porcentaje (<literal>%</literal>) seguido por dos dígitos hexadecimales y
   los espacios son codificados como signos de suma (<literal>+</literal>).
   Esta es la misma codificación usada en los datos publicados desde un
   formulario WWW, es decir, el mismo mecanismo usado para el tipo de medios
   <literal>application/x-www-form-urlencoded</literal>. Este mecanismo
   difiere de la codificación en el <link xlink:href="&url.rfc;3986">RFC
   3986</link> (vea <function>rawurlencode</function>) en que, por razones
   históricas, los espacios son codificados como signos de suma (+).
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>urlencode</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$userinput = 'Data123!@-_ +';
echo "UserInput: $userinput\n";
echo '<a href="mycgi?foo=', urlencode($userinput), '">';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="html">
<![CDATA[
UserInput: Data123!@-_ +
<a href="mycgi?foo=Data123%21%40-_+%2B">
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de <function>urlencode</function> y ejemplo de <function>htmlentities</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$foo = 'Data123!@-_ +';
$bar = "Not the same content as $foo";
echo "foo: $foo\n";
echo "bar: $bar\n";
$query_string = 'foo=' . urlencode($foo) . '&bar=' . urlencode($bar);
echo '<a href="mycgi?' . htmlentities($query_string) . '">';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="html">
<![CDATA[
foo: Data123!@-_ +
bar: Not the same content as Data123!@-_ +
<a href="mycgi?foo=Data123%21%40-_+%2B&amp;bar=Not+the+same+content+as+Data123%21%40-_+%2B">
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Tenga cuidado con las variables que puedan coincidir con entidades HTML.
    Secuencias como &amp;amp, &amp;copy y &amp;pound son procesadas por el
    navegador y la entidad real es usada en lugar del nombre de variable
    deseado. Este es un problema obvio sobre el cual el consorcio W3 ha
    estado alertando a las personas por años. La referencia esta aquí: <link
    xlink:href="&url.argsep;">&url.argsep;</link>.
   </para>
   <para>
    PHP soporta la modificación del separador de argumentos al punto-y-coma
    sugerido por el W3C a través de la directiva .ini arg_separator.
    Desafortunadamente, la mayoría de agentes de usuario no envían datos de
    formularios en este formato separado por punto-y-coma. Una forma más
    portable es usar &amp;amp; en lugar de &amp; como separador. No es
    necesario modificar el valor arg_separator de PHP para esto. Déjelo como
    &amp;, y simplemente codifique sus URLs usando
    <function>htmlentities</function> o
    <function>htmlspecialchars</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>urldecode</function></member>
    <member><function>htmlentities</function></member>
    <member><function>rawurlencode</function></member>
    <member><function>rawurldecode</function></member>
    <member><link xlink:href="&url.rfc;3986">RFC 3986</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
-->