php-doc-en/reference/mbstring/functions/mb-parse-str.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.3 -->
  <refentry id="function.mb-parse-str">
   <refnamediv>
    <refname>mb_parse_str</refname>
    <refpurpose>
      Parse GET/POST/COOKIE data and set global variable
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>boolean</type><methodname>mb_parse_str</methodname>
      <methodparam><type>string</type><parameter>encoded_string</parameter></methodparam>
      <methodparam choice="opt"><type>array</type><parameter>result</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>mb_parse_str</function> parses GET/POST/COOKIE data and
     sets global variables. Since PHP does not provide raw POST/COOKIE
     data, it can only used for GET data for now. It preses URL
     encoded data, detects encoding, converts coding to internal
     encoding and set values to <parameter>result</parameter> array or
     global variables.
    </para>
    <para>
     <parameter>encoded_string</parameter>: URL encoded data.
    </para>
    <para>
     <parameter>result</parameter>: Array contains decoded and
     character encoding converted values.
    </para>
    <para>
     Return Value: It returns &true; for success or &false; for failure.
    </para>
    <para>
     See also <function>mb_detect_order</function>,
     <function>mb_internal_encoding</function>.
    </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:"../../../../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
-->