reference/intl/spoofchecker.xml
1cf6bcae736d6c7390c90849b869474e40b9a292
1cf6bcae736d6c7390c90849b869474e40b9a292
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<phpdoc:classref xml:id="class.spoofchecker" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
5
4
6
5
<title>The Spoofchecker class</title>
...
...
@@ -12,7 +11,15 @@
12
11
<section xml:id="spoofchecker.intro">
13
12
&reftitle.intro;
14
13
<para>
15
-
14
+
This class is provided because Unicode contains large number of characters
15
+
and incorporates the varied writing systems of the world and their incorrect
16
+
usage can expose programs or systems to possible security attacks using
17
+
characters similarity.
18
+
</para>
19
+
<para>
20
+
Provided methods allow to check whether an individual string is likely an attempt
21
+
at confusing the reader (<literal>spoof detection</literal>), such as "pаypаl"
22
+
spelled with Cyrillic 'а' characters.
16
23
</para>
17
24
</section>
18
25
<!-- }}} -->
...
...
@@ -21,132 +28,253 @@
21
28
&reftitle.classsynopsis;
22
29
23
30
<!-- {{{ Synopsis -->
24
-
<classsynopsis>
25
-
<ooclass><classname>Spoofchecker</classname></ooclass>
26
-
27
-
<!-- {{{ Class synopsis -->
28
-
<classsynopsisinfo>
29
-
<ooclass>
30
-
<classname>Spoofchecker</classname>
31
-
</ooclass>
32
-
</classsynopsisinfo>
33
-
<!-- }}} -->
34
-
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
31
+
<classsynopsis class="class">
32
+
<ooclass>
33
+
<classname>Spoofchecker</classname>
34
+
</ooclass>
35
+
36
+
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
35
37
<fieldsynopsis>
38
+
<modifier>public</modifier>
36
39
<modifier>const</modifier>
37
-
<type>integer</type>
40
+
<type>int</type>
38
41
<varname linkend="spoofchecker.constants.single-script-confusable">Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</varname>
39
-
<initializer>1</initializer>
40
42
</fieldsynopsis>
41
43
<fieldsynopsis>
44
+
<modifier>public</modifier>
42
45
<modifier>const</modifier>
43
-
<type>integer</type>
46
+
<type>int</type>
44
47
<varname linkend="spoofchecker.constants.mixed-script-confusable">Spoofchecker::MIXED_SCRIPT_CONFUSABLE</varname>
45
-
<initializer>2</initializer>
46
48
</fieldsynopsis>
47
49
<fieldsynopsis>
50
+
<modifier>public</modifier>
48
51
<modifier>const</modifier>
49
-
<type>integer</type>
52
+
<type>int</type>
50
53
<varname linkend="spoofchecker.constants.whole-script-confusable">Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</varname>
51
-
<initializer>4</initializer>
52
54
</fieldsynopsis>
53
55
<fieldsynopsis>
56
+
<modifier>public</modifier>
54
57
<modifier>const</modifier>
55
-
<type>integer</type>
58
+
<type>int</type>
56
59
<varname linkend="spoofchecker.constants.any-case">Spoofchecker::ANY_CASE</varname>
57
-
<initializer>8</initializer>
58
60
</fieldsynopsis>
59
61
<fieldsynopsis>
62
+
<modifier>public</modifier>
60
63
<modifier>const</modifier>
61
-
<type>integer</type>
64
+
<type>int</type>
62
65
<varname linkend="spoofchecker.constants.single-script">Spoofchecker::SINGLE_SCRIPT</varname>
63
-
<initializer>16</initializer>
64
66
</fieldsynopsis>
65
67
<fieldsynopsis>
68
+
<modifier>public</modifier>
66
69
<modifier>const</modifier>
67
-
<type>integer</type>
70
+
<type>int</type>
68
71
<varname linkend="spoofchecker.constants.invisible">Spoofchecker::INVISIBLE</varname>
69
-
<initializer>32</initializer>
70
72
</fieldsynopsis>
71
73
<fieldsynopsis>
74
+
<modifier>public</modifier>
72
75
<modifier>const</modifier>
73
-
<type>integer</type>
76
+
<type>int</type>
74
77
<varname linkend="spoofchecker.constants.char-limit">Spoofchecker::CHAR_LIMIT</varname>
75
-
<initializer>64</initializer>
78
+
</fieldsynopsis>
79
+
<fieldsynopsis>
80
+
<modifier>public</modifier>
81
+
<modifier>const</modifier>
82
+
<type>int</type>
83
+
<varname linkend="spoofchecker.constants.ascii">Spoofchecker::ASCII</varname>
84
+
</fieldsynopsis>
85
+
<fieldsynopsis>
86
+
<modifier>public</modifier>
87
+
<modifier>const</modifier>
88
+
<type>int</type>
89
+
<varname linkend="spoofchecker.constants.highly-restrictive">Spoofchecker::HIGHLY_RESTRICTIVE</varname>
90
+
</fieldsynopsis>
91
+
<fieldsynopsis>
92
+
<modifier>public</modifier>
93
+
<modifier>const</modifier>
94
+
<type>int</type>
95
+
<varname linkend="spoofchecker.constants.moderately-restrictive">Spoofchecker::MODERATELY_RESTRICTIVE</varname>
96
+
</fieldsynopsis>
97
+
<fieldsynopsis>
98
+
<modifier>public</modifier>
99
+
<modifier>const</modifier>
100
+
<type>int</type>
101
+
<varname linkend="spoofchecker.constants.minimally-restrictive">Spoofchecker::MINIMALLY_RESTRICTIVE</varname>
102
+
</fieldsynopsis>
103
+
<fieldsynopsis>
104
+
<modifier>public</modifier>
105
+
<modifier>const</modifier>
106
+
<type>int</type>
107
+
<varname linkend="spoofchecker.constants.unrestrictive">Spoofchecker::UNRESTRICTIVE</varname>
108
+
</fieldsynopsis>
109
+
<fieldsynopsis>
110
+
<modifier>public</modifier>
111
+
<modifier>const</modifier>
112
+
<type>int</type>
113
+
<varname linkend="spoofchecker.constants.single-script-restrictive">Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</varname>
114
+
</fieldsynopsis>
115
+
<fieldsynopsis>
116
+
<modifier>public</modifier>
117
+
<modifier>const</modifier>
118
+
<type>int</type>
119
+
<varname linkend="spoofchecker.constants.mixed-numbers">Spoofchecker::MIXED_NUMBERS</varname>
120
+
</fieldsynopsis>
121
+
<fieldsynopsis>
122
+
<modifier>public</modifier>
123
+
<modifier>const</modifier>
124
+
<type>int</type>
125
+
<varname linkend="spoofchecker.constants.hidden-overlay">Spoofchecker::HIDDEN_OVERLAY</varname>
76
126
</fieldsynopsis>
77
127
78
128
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
79
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
129
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Spoofchecker'])">
130
+
<xi:fallback/>
131
+
</xi:include>
132
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Spoofchecker'])">
133
+
<xi:fallback/>
134
+
</xi:include>
80
135
</classsynopsis>
81
136
<!-- }}} -->
82
137
83
138
</section>
84
139
85
-
<!-- {{{ Spoofchecker constants -->
140
+
86
141
<section xml:id="spoofchecker.constants">
87
142
&reftitle.constants;
88
143
<variablelist>
89
-
90
144
<varlistentry xml:id="spoofchecker.constants.single-script-confusable">
91
145
<term><constant>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</constant></term>
92
146
<listitem>
93
-
<para></para>
147
+
<para/>
94
148
</listitem>
95
149
</varlistentry>
96
150
97
151
<varlistentry xml:id="spoofchecker.constants.mixed-script-confusable">
98
152
<term><constant>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</constant></term>
99
153
<listitem>
100
-
<para></para>
154
+
<para/>
101
155
</listitem>
102
156
</varlistentry>
103
157
104
158
<varlistentry xml:id="spoofchecker.constants.whole-script-confusable">
105
159
<term><constant>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</constant></term>
106
160
<listitem>
107
-
<para></para>
161
+
<para/>
108
162
</listitem>
109
163
</varlistentry>
110
164
111
165
<varlistentry xml:id="spoofchecker.constants.any-case">
112
166
<term><constant>Spoofchecker::ANY_CASE</constant></term>
113
167
<listitem>
114
-
<para></para>
168
+
<para/>
115
169
</listitem>
116
170
</varlistentry>
117
171
118
172
<varlistentry xml:id="spoofchecker.constants.single-script">
119
173
<term><constant>Spoofchecker::SINGLE_SCRIPT</constant></term>
120
174
<listitem>
121
-
<para></para>
175
+
<para/>
122
176
</listitem>
123
177
</varlistentry>
124
178
125
179
<varlistentry xml:id="spoofchecker.constants.invisible">
126
180
<term><constant>Spoofchecker::INVISIBLE</constant></term>
127
181
<listitem>
128
-
<para></para>
182
+
<para/>
129
183
</listitem>
130
184
</varlistentry>
131
185
132
186
<varlistentry xml:id="spoofchecker.constants.char-limit">
133
187
<term><constant>Spoofchecker::CHAR_LIMIT</constant></term>
134
188
<listitem>
135
-
<para></para>
189
+
<para/>
136
190
</listitem>
137
191
</varlistentry>
138
192
193
+
<varlistentry xml:id="spoofchecker.constants.ascii">
194
+
<term><constant>Spoofchecker::ASCII</constant></term>
195
+
<listitem>
196
+
<para/>
197
+
</listitem>
198
+
</varlistentry>
199
+
200
+
<varlistentry xml:id="spoofchecker.constants.highly-restrictive">
201
+
<term><constant>Spoofchecker::HIGHLY_RESTRICTIVE</constant></term>
202
+
<listitem>
203
+
<para/>
204
+
</listitem>
205
+
</varlistentry>
206
+
207
+
<varlistentry xml:id="spoofchecker.constants.moderately-restrictive">
208
+
<term><constant>Spoofchecker::MODERATELY_RESTRICTIVE</constant></term>
209
+
<listitem>
210
+
<para/>
211
+
</listitem>
212
+
</varlistentry>
213
+
214
+
<varlistentry xml:id="spoofchecker.constants.minimally-restrictive">
215
+
<term><constant>Spoofchecker::MINIMALLY_RESTRICTIVE</constant></term>
216
+
<listitem>
217
+
<para/>
218
+
</listitem>
219
+
</varlistentry>
220
+
221
+
<varlistentry xml:id="spoofchecker.constants.unrestrictive">
222
+
<term><constant>Spoofchecker::UNRESTRICTIVE</constant></term>
223
+
<listitem>
224
+
<para/>
225
+
</listitem>
226
+
</varlistentry>
227
+
228
+
<varlistentry xml:id="spoofchecker.constants.single-script-restrictive">
229
+
<term><constant>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</constant></term>
230
+
<listitem>
231
+
<para/>
232
+
</listitem>
233
+
</varlistentry>
234
+
235
+
<varlistentry xml:id="spoofchecker.constants.mixed-numbers">
236
+
<term><constant>Spoofchecker::MIXED_NUMBERS</constant></term>
237
+
<listitem>
238
+
<para/>
239
+
</listitem>
240
+
</varlistentry>
241
+
242
+
<varlistentry xml:id="spoofchecker.constants.hidden-overlay">
243
+
<term><constant>Spoofchecker::HIDDEN_OVERLAY</constant></term>
244
+
<listitem>
245
+
<para/>
246
+
</listitem>
247
+
</varlistentry>
139
248
</variablelist>
140
249
</section>
141
-
<!-- }}} -->
142
250
251
+
<section role="changelog">
252
+
&reftitle.changelog;
253
+
<informaltable>
254
+
<tgroup cols="2">
255
+
<thead>
256
+
<row>
257
+
<entry>&Version;</entry>
258
+
<entry>&Description;</entry>
259
+
</row>
260
+
</thead>
261
+
<tbody>
262
+
<row>
263
+
<entry>7.3.0</entry>
264
+
<entry>
265
+
Class constants used by <function>Spoofchecker::setRestrictionLevel</function> such as <constant>Spoofchecker::ASCII</constant>, <constant>Spoofchecker::HIGHLY_RESTRICTIVE</constant>, <constant>Spoofchecker::MODERATELY_RESTRICTIVE</constant>, <constant>Spoofchecker::MINIMALLY_RESTRICTIVE</constant>, <constant>Spoofchecker::UNRESTRICTIVE</constant>, <constant>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</constant> has been added.
266
+
</entry>
267
+
</row>
268
+
</tbody>
269
+
</tgroup>
270
+
</informaltable>
271
+
</section>
143
272
144
273
</partintro>
145
274
146
275
&reference.intl.entities.spoofchecker;
147
276
148
277
</phpdoc:classref>
149
-
150
278
<!-- Keep this comment at the end of the file
151
279
Local variables:
152
280
mode: sgml
153
281