1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
Yoshinari Takaoka 4773312462 [ext/strings] followed all updates made on or after November 1, 2024.
- WASM の example 修正
- number_format まわりの誤訳
- その他細かい修正全てに追随

https://github.com/php/doc-en/commits/master/reference/strings
2025-08-23 15:55:59 +09:00

211 lines
6.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: da15b6674ac1900c7d065bd746a04b53d7e963bf Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.parse-str" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_str</refname>
<refpurpose>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>
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>
リファレンスで渡される変数。
<parameter>string</parameter> から展開された、
キーと値のペアを含む配列に設定されます。
<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'], PHP_EOL; // value
echo $output['arr'][0], PHP_EOL; // foo bar
echo $output['arr'][1], PHP_EOL; // baz
?>
]]>
</programlisting>
</example>
</para>
<para>
パラメータ名に含まれるスペースやドットは、
配列のキーやローカル変数を作成する際にアンダースコアに置換されます。
こうなっている理由は、
PHP の変数名がスペースやドットを許容していないからですが、
この関数に、お勧めのパラメータ <parameter>result</parameter>
を指定しても同じ処理が適用されます。
<example>
<title><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>
<function>parse_str</function> は、
<link linkend="ini.max-input-vars">max_input_vars</link>
の影響を受けます。
この値の制限を超えると <constant>E_WARNING</constant>
が発生し、その制限を越えた変数は結果の配列に設定されません。
この値のデフォルトは 1000 です。
<link linkend="ini.max-input-vars">max_input_vars</link>
を必要に応じて調整してください。
</para>
</note>
<note>
<para>
配列 <parameter>result</parameter>
(または第二引数が設定されない場合に作成される変数)
に設定される全ての値は、<function>urldecode</function>
と同じルールで URLデコード されています。
</para>
</note>
<note>
<para>
現在のリクエストのクエリストリングを取得するには、変数
<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
-->