1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-27 00:22:08 +01:00
Files
archived-doc-ja/reference/strings/functions/parse-str.xml
Yoshinari Takaoka 63a2708cd9 some tweaks
2022-08-24 06:13:46 +09:00

200 lines
5.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e35fbbaa52702ebf45c5e7284351e136ed67f3bb Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.parse-str" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_str</refname>
<refpurpose>文字列を処理し、変数に代入する</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>
URL 経由で渡されるクエリ文字列と同様に <parameter>string</parameter>
を処理し、現在のスコープに変数をセットします。
(<parameter>result</parameter> が指定された場合は、配列 <parameter>result</parameter> にセットします)
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
入力文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
2 番目の引数
<parameter>result</parameter> が指定された場合、
変数は、代わりに配列の要素としてこの変数に保存されます。
</para>
<warning>
<para>
この関数を <parameter>result</parameter> パラメータを指定せずに使うことは
絶対に <emphasis>おすすめしません</emphasis> し、
PHP 7.2 以降では <emphasis>推奨されません</emphasis>
PHP 8.0.0 以降では、<parameter>result</parameter> パラメータの指定が
<emphasis>必須</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> は、オプションではなくなりました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
<function>parse_str</function>関数を
第二引数を指定せずに使うと
<constant>E_DEPRECATED</constant> レベルの警告が発生するようになりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>parse_str</function> の使用法</title>
<programlisting role="php">
<![CDATA[
<?php
$str = "first=value&arr[]=foo+bar&arr[]=baz";
// 推奨
parse_str($str, $output);
echo $output['first']; // value
echo $output['arr'][0]; // foo bar
echo $output['arr'][1]; // baz
// お勧めできない
parse_str($str);
echo $first; // value
echo $arr[0]; // foo bar
echo $arr[1]; // baz
?>
]]>
</programlisting>
</example>
</para>
<para>
PHP における変数は、名前にドットやスペースを許容しないので、
そういった値はアンダースコアに変換されます。同じことは、
この関数に <parameter>result</parameter> パラメータを指定した
場合の、配列のキーの名前にも当てはまります。
<example>
<title><function>parse_str</function> name mangling</title>
<programlisting role="php">
<![CDATA[
<?php
parse_str("My Value=Something");
echo $My_Value; // Something
parse_str("My Value=Something", $output);
echo $output['My_Value']; // Something
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
全ての作成された変数 (第二引数が設定された場合は配列に設定される値)
の値は、既に <function>urldecode</function> されています。
</para>
</note>
<note>
<para>
現在の <literal>QUERY_STRING</literal> を取得するには、変数
<varname>$_SERVER['QUERY_STRING']</varname>
を使用する事ができます。また、
<link linkend="language.variables.external">外部から来る変数</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
-->