mirror of
https://github.com/php/doc-es.git
synced 2026-03-26 08:22:08 +01:00
284b7088ac
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@337499 c90b9560-bf6c-de11-be94-00142212c4b1
410 lines
11 KiB
XML
410 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: f9254e756882a011921138392fa240189dcc3a8c Maintainer: seros Status: ready -->
|
|
<!-- Reviewed: no Maintainer: andresdzphp -->
|
|
<refentry xml:id="function.json-encode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>json_encode</refname>
|
|
<refpurpose>Retorna la representación JSON del valor dado</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>json_encode</methodname>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Devuelve un string con la representación JSON de
|
|
<parameter>value</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
El <parameter>value</parameter> a ser codificado. Puede ser de cualquier
|
|
tipo menos un <type>resource</type>.
|
|
</para>
|
|
<para>
|
|
Todos los datos de tipo string deben estar codificados con UTF-8.
|
|
</para>
|
|
&json.implementation.superset;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Máscara de bits que compuesta por <constant>JSON_HEX_QUOT</constant>,
|
|
<constant>JSON_HEX_TAG</constant>,
|
|
<constant>JSON_HEX_AMP</constant>,
|
|
<constant>JSON_HEX_APOS</constant>,
|
|
<constant>JSON_NUMERIC_CHECK</constant>,
|
|
<constant>JSON_PRETTY_PRINT</constant>,
|
|
<constant>JSON_UNESCAPED_SLASHES</constant>,
|
|
<constant>JSON_FORCE_OBJECT</constant>,
|
|
<constant>JSON_PRESERVE_ZERO_FRACTION</constant>,
|
|
<constant>JSON_UNESCAPED_UNICODE</constant>,
|
|
<constant>JSON_PARTIAL_OUTPUT_ON_ERROR</constant>. El comportamiento de estas
|
|
constantes se describe en la página de
|
|
<link linkend="json.constants">constantes de JSON</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>depth</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Establece la profundidad máxima. Debe ser mayor que cero.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Devuelve un <type>string</type> JSON codificado en caso de éxito &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>5.6.6</entry>
|
|
<entry>
|
|
Se añadió la opción <constant>JSON_PRESERVE_ZERO_FRACTION</constant> del parámetro <parameter>option</parameter>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.5.0</entry>
|
|
<entry>
|
|
Se añadió el parámetro <parameter>depth</parameter>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.4.0</entry>
|
|
<entry>
|
|
Se añadió al parámetro <parameter>options</parameter> las constantes <constant>JSON_PRETTY_PRINT</constant>, <constant>JSON_UNESCAPED_SLASHES</constant>, y <constant>JSON_UNESCAPED_UNICODE</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.3</entry>
|
|
<entry>
|
|
Se añadió al parámetro <parameter>option</parameter> la constante <constant>JSON_NUMERIC_CHECK</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Se añadió el parámetro <parameter>options</parameter>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Un ejemplo de <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>
|
|
Un ejemplo de <function>json_encode</function> mostrando algunas de las opciones en acción
|
|
</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = array('<foo>',"'bar'",'"baz"','&blong&');
|
|
|
|
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 "Array vacío retornado como array: ", json_encode($b), "\n";
|
|
echo "Array vacío retornado como object: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n";
|
|
|
|
$c = array(array(1,2,3));
|
|
|
|
echo "Array no asociativo retornado como array: ", json_encode($c), "\n";
|
|
echo "Array no asociativo retornado como objeto: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n";
|
|
|
|
$d = array('foo' => 'bar', 'baz' => 'long');
|
|
|
|
echo "Array asociativo siempre es retornado como objeto: ", json_encode($d), "\n";
|
|
echo "Array asociativo siempre es retornado como objeto: ", 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&","é"]
|
|
All: ["\u003Cfoo\u003E","\u0027bar\u0027","\u0022baz\u0022","\u0026blong\u0026","é"]
|
|
|
|
Array vacío retornado como array: []
|
|
Array vacío retornado como object: {}
|
|
|
|
Array no asociativo retornado como array: [[1,2,3]]
|
|
Array no asociativo retornado como objeto: {"0":{"0":1,"1":2,"2":3}}
|
|
|
|
Array asociativo siempre es retornado como objeto: {"foo":"bar","baz":"long"}
|
|
Array asociativo siempre es retornado como objeto: {"foo":"bar","baz":"long"}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Ejemplo de la opción JSON_NUMERIC_CHECK</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo "Los string que representan números automáticamente se convierten en números".PHP_EOL;
|
|
$numbers = array('+123123', '-123123', '1.2e3', '0.00001');
|
|
var_dump(
|
|
$numbers,
|
|
json_encode($numbers, JSON_NUMERIC_CHECK)
|
|
);
|
|
echo "String que contienen números formateados incorrectamente".PHP_EOL;
|
|
$strings = array('+a33123456789', 'a123');
|
|
var_dump(
|
|
$strings,
|
|
json_encode($strings, JSON_NUMERIC_CHECK)
|
|
);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Los string que representan números automáticamente se convierten en números
|
|
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]"
|
|
String que contienen números formateados incorrectamente
|
|
array(2) {
|
|
[0]=>
|
|
string(13) "+a33123456789"
|
|
[1]=>
|
|
string(4) "a123"
|
|
}
|
|
string(24) "["+a33123456789","a123"]"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Ejemplo de array secuencial contra array no secuencial</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo "Array sencuencial".PHP_EOL;
|
|
$sequential = array("foo", "bar", "baz", "blong");
|
|
var_dump(
|
|
$sequential,
|
|
json_encode($sequential)
|
|
);
|
|
|
|
echo PHP_EOL."Array no secuencial".PHP_EOL;
|
|
$nonsequential = array(1=>"foo", 2=>"bar", 3=>"baz", 4=>"blong");
|
|
var_dump(
|
|
$nonsequential,
|
|
json_encode($nonsequential)
|
|
);
|
|
|
|
echo PHP_EOL."Array secuencial con una clave destruida".PHP_EOL;
|
|
unset($sequential[1]);
|
|
var_dump(
|
|
$sequential,
|
|
json_encode($sequential)
|
|
);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Array sencuencial
|
|
array(4) {
|
|
[0]=>
|
|
string(3) "foo"
|
|
[1]=>
|
|
string(3) "bar"
|
|
[2]=>
|
|
string(3) "baz"
|
|
[3]=>
|
|
string(5) "blong"
|
|
}
|
|
string(27) "["foo","bar","baz","blong"]"
|
|
|
|
Array no secuencial"
|
|
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"}"
|
|
|
|
Array secuencial con una clave destruida
|
|
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>Ejemplo de la opción <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>
|
|
En el evento de un fallo a codificar, <function>json_last_error</function>
|
|
puede ser usado para determinar la naturaleza exacta del error.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Cuando se codifica un array, si las claves no están en una secuencia numérica
|
|
continua comenzando por 0, todas las claves son codificadas como cadenas, y
|
|
explícitamente especificadas para cada pareja clave-valor.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Al igual que el codificador JSON de referencia, <function>json_encode</function>
|
|
generará JSON que es un valor simple (esto es, ni un objeto ni un
|
|
array) si de proporciona un <type>string</type>, <type>integer</type>,
|
|
<type>float</type> o <type>boolean</type> como entrada de
|
|
<parameter>value</parameter>. Mientras que muchos decodificadores aceptarán estos valores
|
|
como JSON válido, algunos no lo harán, ya que la especificación es ambigua en este
|
|
aspecto.
|
|
</para>
|
|
<para>
|
|
Para resumir, compruebe siempre que el decodificador de JSON puede manejar la salida que se
|
|
genere desde <function>json_encode</function>.
|
|
</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>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
|
|
-->
|