File: Zend_Validate-InArray.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (213 lines) | stat: -rwxr-xr-x 7,047 bytes parent folder | download | duplicates (2)
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect2 id="zend.validate.set.in_array">

    <title>InArray</title>

    <para>
        <classname>Zend_Validate_InArray</classname> vous permet de valider qu'une entrée est bien présente
        dans un tableau. Ceci fonctionne aussi avec des tableaux multidimensionnels.
    </para>

    <sect3 id="zend.validate.set.in_array.options">
        <title>Options supportées par Zend_Validate_InArray</title>

        <para>
            Les options suivantes sont supportées par
            <classname>Zend_Validate_InArray</classname>&#160;:
        </para>

        <itemizedlist>
            <listitem>
                <para>
                    <emphasis><property>haystack</property></emphasis>&#160;: spécifie le tableau
                    pour la validation.
                </para>
            </listitem>

            <listitem>
                <para>
                    <emphasis><property>recursive</property></emphasis>&#160;: définit si la
                    validation doit être recursive. Cette option vaut <constant>FALSE</constant>
                    par défaut.
                </para>
            </listitem>

            <listitem>
                <para>
                    <emphasis><property>strict</property></emphasis>&#160;: définit si la validation
                    doit être strict (même type). Cette option vaut <constant>FALSE</constant> par
                    défaut.
                </para>
            </listitem>
        </itemizedlist>
    </sect3>

    <sect3 id="zend.validate.set.in_array.basic">
        <title>Validation tableau simple</title>

        <para>
            Passez simplement un tableau dans lequel rechercher une valeur:
        </para>

        <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_InArray(array('key' => 'value',
                                             'otherkey' => 'othervalue'));
if ($validator->isValid('value')) {
    // value trouvée
} else {
    // value non trouvée
}
]]></programlisting>

        <para>
            C'est le comportement exact de la fonction PHP <methodname>in_array()</methodname>.
        </para>

        <note>
            <para>
                Par défaut la validation est non stricte et ne valide pas les multiples dimensions.
            </para>
        </note>

        <para>
            Bien sûr vous pouvez fournir le tableau à valider plus tard en utilisant la méthode
            <methodname>setHaystack()</methodname>. La méthode
            <methodname>getHaystack()</methodname> retourne le tableau actuellement fourni.
        </para>

        <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_InArray();
$validator->setHaystack(array('key' => 'value', 'otherkey' => 'othervalue'));

if ($validator->isValid('value')) {
    // valeur trouvée
} else {
    // valeur non trouvée
}
]]></programlisting>
    </sect3>

    <sect3 id="zend.validate.set.in_array.strict">
        <title>Validation tableau stricte</title>

        <para>
            Il est possible d'effectuer une validation stricte des données dans le tableau. Par défaut, il n'y aura aucune
            différence entre l'entier <emphasis>0</emphasis> et la chaine <emphasis>"0"</emphasis>. La validation stricte
            fera cette différence.
        </para>

        <para>
            Pour spécifier une validation stricte à l'instanciation de l'objet, agissez comme suit&#160;:
        </para>

        <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_InArray(
    array(
        'haystack' => array('key' => 'value', 'otherkey' => 'othervalue'),
        'strict'   => true
    )
);

if ($validator->isValid('value')) {
    // valeur trouvée
} else {
    // valeur non trouvée
}
]]></programlisting>

        <para>
            La clé <emphasis>haystack</emphasis> contient le tableau dans lequel valider. En mettant la clé
            <emphasis>strict</emphasis> à <constant>TRUE</constant>, la validation sera stricte (valeur et type).
        </para>

        <para>
            Bien sûr vous pouvez la méthode <methodname>setStrict()</methodname> pour changer ce
            réglage et la méthode <methodname>getStrict()</methodname> vous retournera le réglage
            en cours.
        </para>

        <note>
            <para>
                Notez que par défaut, <emphasis>strict</emphasis> a la valeur
                <constant>FALSE</constant>.
            </para>
        </note>
    </sect3>

    <sect3 id="zend.validate.set.in_array.recursive">
        <title>Validation de tableaux récursifs</title>

        <para>
            En plus de la validation type <acronym>PHP</acronym> <methodname>in_array()</methodname>, ce validateur peut
            aussi être utilisé pour valider des tableaux à plusieurs dimensions.
        </para>

        <para>
            Pour cela, utilisez l'option <emphasis>recursive</emphasis>.
        </para>

        <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_InArray(
    array(
        'haystack' => array(
            'firstDimension' => array('key' => 'value',
                                      'otherkey' => 'othervalue'),
            'secondDimension' => array('some' => 'real',
                                       'different' => 'key')),
        'recursive' => true
    )
);

if ($validator->isValid('value')) {
    // value trouvée
} else {
    // value non trouvée
}
]]></programlisting>

        <para>
            Votre tableau sera parcouru récursivement à la recherche de votre valeur. De plus
            vous pouvez utiliser la méthode <methodname>setRecursive()</methodname> pour
            paramétrer cette option plus tard et la méthode
            <methodname>getRecursive()</methodname> pour la retrouver.
         </para>

        <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_InArray(
    array(
        'firstDimension' => array('key' => 'value',
                                  'otherkey' => 'othervalue'),
        'secondDimension' => array('some' => 'real',
                                   'different' => 'key')
    )
);
$validator->setRecursive(true);

if ($validator->isValid('value')) {
    // valeur trouvée
} else {
    // valeur non trouvée
}
]]></programlisting>

         <note>
            <title>Réglage par défaut pour la récursivité</title>

             <para>
                Par défaut, la récursivité n'est pas activée.
             </para>
         </note>

        <note>
            <title>Options pour la "haystack"</title>

            <para>
                Lorsque vous utilisez les clés <property>haystack</property>,
                <property>strict</property> ou <property>recursive</property> à l'intérieur
                de votre pile, vous devez alors envelopper la clé <property>haystack</property>.
            </para>
        </note>
    </sect3>
</sect2>