-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathjson-validate.xml
More file actions
164 lines (158 loc) · 4.83 KB
/
json-validate.xml
File metadata and controls
164 lines (158 loc) · 4.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d715365c098db000eaf7dcd987ee6093f6e83091 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.json-validate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>json_validate</refname>
<refpurpose>Vérifie si une chaîne contient du JSON valide</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>
Renvoie si la &string; donnée est du JSON syntaxiquement valide.
Si <function>json_validate</function> renvoie &true;, <function>json_decode</function>
décodera avec succès la chaîne donnée en utilisant les mêmes
<parameter>depth</parameter> et <parameter>flags</parameter>.
</para>
<para>
Si <function>json_validate</function> renvoie &false;, la cause
peut être récupérée en utilisant <function>json_last_error</function> et
<function>json_last_error_msg</function>.
</para>
<para>
<function>json_validate</function> utilise moins de mémoire que
<function>json_decode</function> si le contenu JSON décodé n'est pas
utilisé, car il n'a pas besoin de construire la structure de tableau
ou d'objet contenant le contenu.
</para>
<caution>
<para>
Appeler <function>json_validate</function> immédiatement avant
<function>json_decode</function> analysera inutilement la chaîne
deux fois, car <function>json_decode</function> effectue
implicitement une validation lors du décodage.
</para>
<para>
<function>json_validate</function> ne doit donc être utilisé
que si le décodage du contenu JSON n'est pas immédiatement utilisé
et que savoir si la chaîne contient du JSON valide est nécessaire.
</para>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
<para>
La chaîne à valider.
</para>
<para>
Cette fonction ne fonctionne qu'avec des chaînes encodées en UTF-8.
</para>
&json.implementation.superset;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
<para>
Le niveau de profondeur maximum de la structure à décoder.
La valeur doit être supérieure à <literal>0</literal>,
et inférieure ou égale à <literal>2147483647</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Actuellement, seul
<constant>JSON_INVALID_UTF8_IGNORE</constant>
est accepté.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie &true; si la chaîne donnée est du JSON syntaxiquement valide, sinon
renvoie &false;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Si <parameter>depth</parameter> est en dehors de la plage autorisée,
une <classname>ValueError</classname> est lancée.
</para>
<para>
Si <parameter>flags</parameter> n'est pas un drapeau valide,
une <classname>ValueError</classname> est lancée.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemples 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
-->