mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
429 lines
12 KiB
XML
429 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 9f2e30a00afda6d6b6a3e19b13956150c2eaf2c1 Maintainer: takagi Status: ready -->
|
|
<!-- Credits: mumumu -->
|
|
<refentry xml:id="function.json-encode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>json_encode</refname>
|
|
<refpurpose>値を JSON 形式にして返す</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>json_encode</methodname>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
与えられた <parameter>value</parameter> を JSON 形式にした文字列を返します。
|
|
引数が配列やオブジェクトの場合は、JSON 形式に再帰的に変換されます。
|
|
</para>
|
|
<para>
|
|
変換される値がオブジェクトの場合、
|
|
デフォルトでは public としてアクセス可能なプロパティのみが含まれます。
|
|
それ以外のやり方で、値を <acronym>JSON</acronym> 形式に変換する方法は、
|
|
<interfacename>JsonSerializable</interfacename>
|
|
を実装することで制御できます。
|
|
</para>
|
|
<para>
|
|
エンコーディングは、<parameter>flags</parameter> の指定によって影響を受けます。
|
|
さらに、浮動小数点のエンコーディングは、
|
|
<link linkend="ini.serialize-precision">serialize_precision</link>
|
|
の値によっても影響を受けます。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
エンコードする値。
|
|
&resource; 型以外の任意の型を指定できます。
|
|
</para>
|
|
<para>
|
|
すべての文字列データは、UTF-8 エンコードされていなければいけません。
|
|
</para>
|
|
&json.implementation.superset;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<constant>JSON_FORCE_OBJECT</constant>,
|
|
<constant>JSON_HEX_QUOT</constant>,
|
|
<constant>JSON_HEX_TAG</constant>,
|
|
<constant>JSON_HEX_AMP</constant>,
|
|
<constant>JSON_HEX_APOS</constant>,
|
|
<constant>JSON_INVALID_UTF8_IGNORE</constant>,
|
|
<constant>JSON_INVALID_UTF8_SUBSTITUTE</constant>,
|
|
<constant>JSON_NUMERIC_CHECK</constant>,
|
|
<constant>JSON_PARTIAL_OUTPUT_ON_ERROR</constant>,
|
|
<constant>JSON_PRESERVE_ZERO_FRACTION</constant>,
|
|
<constant>JSON_PRETTY_PRINT</constant>,
|
|
<constant>JSON_UNESCAPED_LINE_TERMINATORS</constant>,
|
|
<constant>JSON_UNESCAPED_SLASHES</constant>,
|
|
<constant>JSON_UNESCAPED_UNICODE</constant>,
|
|
<constant>JSON_THROW_ON_ERROR</constant>
|
|
からなるビットマスク。
|
|
各定数の意味については
|
|
<link linkend="json.constants">JSON 定数のページ</link>
|
|
に説明があります。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>depth</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
最大の深さを設定します。正の数でなければいけません。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
成功した場合に、JSON エンコードされた文字列を返します。
|
|
&return.falseforfailure;。
|
|
</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>7.3.0</entry>
|
|
<entry>
|
|
<parameter>flags</parameter> パラメータに
|
|
<constant>JSON_THROW_ON_ERROR</constant> が追加されました。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.2.0</entry>
|
|
<entry>
|
|
<parameter>flags</parameter> パラメータに
|
|
<constant>JSON_INVALID_UTF8_IGNORE</constant> と
|
|
<constant>JSON_INVALID_UTF8_SUBSTITUTE</constant> が追加されました。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.1.0</entry>
|
|
<entry>
|
|
<parameter>flags</parameter> パラメータに
|
|
<constant>JSON_UNESCAPED_LINE_TERMINATORS</constant> が追加されました。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.1.0</entry>
|
|
<entry>
|
|
<type>float</type> 値をエンコードする際に、
|
|
<link linkend="ini.precision">precision</link> ではなく
|
|
<link linkend="ini.serialize-precision">serialize_precision</link> を使うようになりました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>json_encode</function> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$arr = array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5);
|
|
|
|
echo json_encode($arr);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
{"a":1,"b":2,"c":3,"d":4,"e":5}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>
|
|
<function>json_encode</function> で、利用中のいくつかのフラグを表示する例
|
|
</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = array('<foo>',"'bar'",'"baz"','&blong&', "\xc3\xa9");
|
|
|
|
echo "Normal: ", json_encode($a), "\n";
|
|
echo "Tags: ", json_encode($a, JSON_HEX_TAG), "\n";
|
|
echo "Apos: ", json_encode($a, JSON_HEX_APOS), "\n";
|
|
echo "Quot: ", json_encode($a, JSON_HEX_QUOT), "\n";
|
|
echo "Amp: ", json_encode($a, JSON_HEX_AMP), "\n";
|
|
echo "Unicode: ", json_encode($a, JSON_UNESCAPED_UNICODE), "\n";
|
|
echo "All: ", json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), "\n\n";
|
|
|
|
$b = array();
|
|
|
|
echo "Empty array output as array: ", json_encode($b), "\n";
|
|
echo "Empty array output as object: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n";
|
|
|
|
$c = array(array(1,2,3));
|
|
|
|
echo "Non-associative array output as array: ", json_encode($c), "\n";
|
|
echo "Non-associative array output as object: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n";
|
|
|
|
$d = array('foo' => 'bar', 'baz' => 'long');
|
|
|
|
echo "Associative array always output as object: ", json_encode($d), "\n";
|
|
echo "Associative array always output as object: ", json_encode($d, JSON_FORCE_OBJECT), "\n\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Normal: ["<foo>","'bar'","\"baz\"","&blong&","\u00e9"]
|
|
Tags: ["\u003Cfoo\u003E","'bar'","\"baz\"","&blong&","\u00e9"]
|
|
Apos: ["<foo>","\u0027bar\u0027","\"baz\"","&blong&","\u00e9"]
|
|
Quot: ["<foo>","'bar'","\u0022baz\u0022","&blong&","\u00e9"]
|
|
Amp: ["<foo>","'bar'","\"baz\"","\u0026blong\u0026","\u00e9"]
|
|
Unicode: ["<foo>","'bar'","\"baz\"","&blong&","e"]
|
|
All: ["\u003Cfoo\u003E","\u0027bar\u0027","\u0022baz\u0022","\u0026blong\u0026","e"]
|
|
|
|
Empty array output as array: []
|
|
Empty array output as object: {}
|
|
|
|
Non-associative array output as array: [[1,2,3]]
|
|
Non-associative array output as object: {"0":{"0":1,"1":2,"2":3}}
|
|
|
|
Associative array always output as object: {"foo":"bar","baz":"long"}
|
|
Associative array always output as object: {"foo":"bar","baz":"long"}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>JSON_NUMERIC_CHECK の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo "Strings representing numbers automatically turned into numbers".PHP_EOL;
|
|
$numbers = array('+123123', '-123123', '1.2e3', '0.00001');
|
|
var_dump(
|
|
$numbers,
|
|
json_encode($numbers, JSON_NUMERIC_CHECK)
|
|
);
|
|
echo "Strings containing improperly formatted numbers".PHP_EOL;
|
|
$strings = array('+a33123456789', 'a123');
|
|
var_dump(
|
|
$strings,
|
|
json_encode($strings, JSON_NUMERIC_CHECK)
|
|
);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Strings representing numbers automatically turned into numbers
|
|
array(4) {
|
|
[0]=>
|
|
string(7) "+123123"
|
|
[1]=>
|
|
string(7) "-123123"
|
|
[2]=>
|
|
string(5) "1.2e3"
|
|
[3]=>
|
|
string(7) "0.00001"
|
|
}
|
|
string(28) "[123123,-123123,1200,1.0e-5]"
|
|
Strings containing improperly formatted numbers
|
|
array(2) {
|
|
[0]=>
|
|
string(13) "+a33123456789"
|
|
[1]=>
|
|
string(4) "a123"
|
|
}
|
|
string(24) "["+a33123456789","a123"]"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>シーケンシャルな配列とそうでない配列の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo "Sequential array".PHP_EOL;
|
|
$sequential = array("foo", "bar", "baz", "blong");
|
|
var_dump(
|
|
$sequential,
|
|
json_encode($sequential)
|
|
);
|
|
|
|
echo PHP_EOL."Non-sequential array".PHP_EOL;
|
|
$nonsequential = array(1=>"foo", 2=>"bar", 3=>"baz", 4=>"blong");
|
|
var_dump(
|
|
$nonsequential,
|
|
json_encode($nonsequential)
|
|
);
|
|
|
|
echo PHP_EOL."Sequential array with one key unset".PHP_EOL;
|
|
unset($sequential[1]);
|
|
var_dump(
|
|
$sequential,
|
|
json_encode($sequential)
|
|
);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Sequential array
|
|
array(4) {
|
|
[0]=>
|
|
string(3) "foo"
|
|
[1]=>
|
|
string(3) "bar"
|
|
[2]=>
|
|
string(3) "baz"
|
|
[3]=>
|
|
string(5) "blong"
|
|
}
|
|
string(27) "["foo","bar","baz","blong"]"
|
|
|
|
Non-sequential array
|
|
array(4) {
|
|
[1]=>
|
|
string(3) "foo"
|
|
[2]=>
|
|
string(3) "bar"
|
|
[3]=>
|
|
string(3) "baz"
|
|
[4]=>
|
|
string(5) "blong"
|
|
}
|
|
string(43) "{"1":"foo","2":"bar","3":"baz","4":"blong"}"
|
|
|
|
Sequential array with one key unset
|
|
array(3) {
|
|
[0]=>
|
|
string(3) "foo"
|
|
[2]=>
|
|
string(3) "baz"
|
|
[3]=>
|
|
string(5) "blong"
|
|
}
|
|
string(33) "{"0":"foo","2":"baz","3":"blong"}"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title><constant>JSON_PRESERVE_ZERO_FRACTION</constant> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
var_dump(json_encode(12.0, JSON_PRESERVE_ZERO_FRACTION));
|
|
var_dump(json_encode(12.0));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
string(4) "12.0"
|
|
string(2) "12"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
エンコードに失敗した場合は、<function>json_last_error</function>
|
|
を使ってエラーの内容を調べることができます。
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
配列をエンコードする場合、もし配列のキーが 0 からはじまる連続した数値でなければ、
|
|
すべてのキーを文字列としてエンコードします。
|
|
そして、個々のキー/値のペアを明示的に指定します。
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
JSON エンコーダーのリファレンス実装と同様、
|
|
<type>string</type> や <type>int</type>、
|
|
<type>float</type> そして <type>bool</type> を入力として渡したときに
|
|
<function>json_encode</function> が生成する JSON
|
|
はシンプルな値 (オブジェクトでもないし配列でもないもの) となります。
|
|
大半のエンコーダーはこういった値を妥当な JSON として扱いますが、中にはそうでないものもあります。
|
|
そのため、現時点ではこの仕様は不明瞭です。
|
|
</para>
|
|
<para>
|
|
要するに、<function>json_encode</function> で生成した JSON
|
|
が、あなたの使おうとしているデコーダーでデコードできるかどうかを常に確認する必要があるということです。
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><interfacename>JsonSerializable</interfacename></member>
|
|
<member><function>json_decode</function></member>
|
|
<member><function>json_last_error</function></member>
|
|
<member><function>json_last_error_msg</function></member>
|
|
<member><function>serialize</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
|
|
-->
|