<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: d715365c098db000eaf7dcd987ee6093f6e83091 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.json-validate" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>json_validate</refname>

<refpurpose>Verifica si una string contiene JSON válido</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>json_validate</methodname>

<methodparam><type>string</type><parameter>json</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Devuelve si la &string; dada es sintácticamente JSON válido.

Si <function>json_validate</function> devuelve &true;, <function>json_decode</function>

decodificará con éxito la string dada utilizando los mismos

<parameter>depth</parameter> y <parameter>flags</parameter>.

</para>

<para>

Si <function>json_validate</function> devuelve &false;, la causa

puede ser recuperada utilizando <function>json_last_error</function> y

<function>json_last_error_msg</function>.

</para>

<para>

<function>json_validate</function> utiliza menos memoria que

<function>json_decode</function> si el contenido JSON decodificado no es

utilizado, ya que no necesita construir la estructura de array

o de objeto que contiene el contenido.

</para>

<caution>

<para>

Llamar a <function>json_validate</function> inmediatamente antes

de <function>json_decode</function> analizará innecesariamente la string

dos veces, ya que <function>json_decode</function> realiza

implícitamente una validación durante la decodificación.

</para>

<para>

<function>json_validate</function> no debe ser utilizado

a menos que la decodificación del contenido JSON no sea inmediatamente utilizada

y que sea necesario saber si la string contiene JSON válido.

</para>

</caution>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>json</parameter></term>

<listitem>

<para>

La string a validar.

</para>

<para>

Esta función solo funciona con strings codificadas en UTF-8.

</para>

&json.implementation.superset;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>depth</parameter></term>

<listitem>

<para>

El nivel máximo de profundidad de la estructura a decodificar.

El valor debe ser mayor que <literal>0</literal>,

y menor o igual a <literal>2147483647</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

Actualmente, solo

<constant>JSON_INVALID_UTF8_IGNORE</constant>

es aceptado.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve &true; si la string dada es sintácticamente JSON válido, de lo contrario

devuelve &false;.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

Si <parameter>depth</parameter> está fuera del rango permitido,

se lanza una <classname>ValueError</classname>.

</para>

<para>

Si <parameter>flags</parameter> no es un flag válido,

se lanza una <classname>ValueError</classname>.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplos de <function>json_validate</function></title>

<programlisting role="php">

<![CDATA[

<?php

var_dump(json_validate('{ "test": { "foo": "bar" } }'));

var_dump(json_validate('{ "": "": "" } }'));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

bool(true)

bool(false)

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>json_decode</function></member>

<member><function>json_last_error</function></member>

<member><function>json_last_error_msg</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

-->