archived-doc-es/reference/strings/functions/parse-str.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: da15b6674ac1900c7d065bd746a04b53d7e963bf Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.parse-str" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>parse_str</refname>
  <refpurpose>Analiza una string como una cadena de consulta URL</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>parse_str</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">result</parameter></methodparam>
  </methodsynopsis>
  <para>
   Analiza la string <parameter>string</parameter> como si se tratara de los parámetros pasados a través de la URL. Todas las variables que identifica son creadas con sus valores respectivos (o en el array si <parameter>result</parameter> es proporcionado).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La string de entrada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       Una variable pasada por referencia, que será definida como un array conteniendo los pares clave-valor extraídos de <parameter>string</parameter>. Si el parámetro <parameter>result</parameter> no es pasado, una variable separada es definida en el ámbito local para cada clave.
      </para>
      <warning>
       <para>
        El uso de esta función sin el parámetro <parameter>result</parameter> está muy fuertemente <emphasis>desaconsejado</emphasis> y <emphasis>no recomendado</emphasis> a partir de PHP 7.2. A partir de PHP 8.0.0, el parámetro <parameter>result</parameter> es <emphasis>obligatorio</emphasis>.
       </para>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>result</parameter> ya no es opcional.
      </entry>
     </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        El uso de <function>parse_str</function> sin el segundo argumento emite una nota <constant>E_DEPRECATED</constant>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>parse_str</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$str = "first=value&arr[]=foo+bar&arr[]=baz";

// Recomendado
parse_str($str, $output);
echo $output['first'], PHP_EOL;  // value
echo $output['arr'][0], PHP_EOL; // foo bar
echo $output['arr'][1], PHP_EOL; // baz
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   Cualquier espacio o punto en los nombres de parámetros es convertido a guión bajo al crear claves de array o variables locales. Esto se debe a que los nombres de variables en PHP no pueden contener espacios o puntos, pero esto se aplica incluso cuando se utiliza esta función con el parámetro <parameter>result</parameter>.
   <example>
    <title>Deformación de nombres por <function>parse_str</function></title>
    <programlisting role="php">
<![CDATA[
<?php
parse_str("My Value=Something", $output);
echo $output['My_Value']; // Something
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;

   <note>
    <para>
     La función <function>parse_str</function> se ve afectada por la directiva <link linkend="ini.max-input-vars">max_input_vars</link>. Exceder este límite genera una advertencia <constant>E_WARNING</constant>, y cualquier variable más allá de este límite no es añadida al array de resultado. El valor por omisión es 1000; ajuste <link linkend="ini.max-input-vars">max_input_vars</link> según sus necesidades.
    </para>
   </note>

   <note>
   <para>
    Todos los valores añadidos en el array <parameter>result</parameter> (o las variables creadas si el segundo parámetro no está definido) ya están decodificados con las mismas reglas que <function>urldecode</function>.
   </para>
  </note>
  <note>
   <para>
    Para obtener la cadena de consulta de la petición actual, se puede utilizar la variable <varname>$_SERVER['QUERY_STRING']</varname>. Asimismo, puede ser de interés leer la sección sobre las <link linkend="language.variables.external">variables de fuentes externas</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>parse_url</function></member>
    <member><function>pathinfo</function></member>
    <member><function>http_build_query</function></member>
    <member><function>urldecode</function></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
-->