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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
<?php
/*
+----------------------------------------------------------------------+
| Copyright (c) 1997-2023 The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| https://www.php.net/license/3_01.txt. |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net, so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Authors: Mehdi Achour <didou@php.net> |
+----------------------------------------------------------------------+
$Id$
*/
/**
* @todo
* Improve support for deprecated functions (introduce a new entity in phpdoc?)
* Check for role="reference" on parameters
* Check against php-src for parameters/return values (parse the C code, not protos)
* Add various tests for parameters
*/
error_reporting(E_ALL);
$status = array();
foreach (glob('../../en/reference/*/*/*.xml') as $function) {
$path = explode('/', $function);
$extension = $path[count($path) - 3];
$funcname = basename($function);
// Skip main
if ($funcname == 'main.xml' || strpos($funcname, 'entities.') === 0) {
continue;
}
$xmlstr = str_replace('&', '&', file_get_contents($function));
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
if (!@$xml->loadXml($xmlstr)) {
echo "XML Parse Error: $function\n";
continue;
}
// Variables initialisation
$noparameters = false;
$returnvoid = false;
$refsect1s = $xml->getElementsByTagName('refsect1');
foreach ($refsect1s as $refsect1) {
$role = $refsect1->getAttribute('role');
switch ($role) {
case 'description':
// Get text buffer for various checks
$whole_description = $refsect1->nodeValue;
// If not documented, mark it and skip to next function
if (strpos($whole_description, '&warn.undocumented.func;') !== false) {
$status[$extension][$funcname]['undoc'] = 1;
continue 3;
}
// If deprecated, skip to next function
// @todo: add a better way of handling this (new entity in phpdoc?)
if (strpos($whole_description, 'This function is deprecated') !== false) {
continue 3;
}
// If an alias, skip to next function
if (strpos($whole_description, '&info.function.alias;') !== false) {
continue 3;
} else {
$refnamedivs = $xml->getElementsByTagName('refnamediv');
foreach ($refnamedivs as $refnamediv) {
if (stripos($refnamediv->nodeValue, 'alias') !== false) {
continue 4;
}
}
}
// Look into the methodsynopsys tag(s)
$methodsynopsiss = $xml->getElementsByTagName('methodsynopsis');
foreach ($methodsynopsiss as $methodsynopsis) {
foreach ($methodsynopsis->childNodes as $child) {
switch ($child->nodeName) {
case '#comment':
// Skip comments
continue;
case 'type':
// This is the return type
break;
case 'void':
// This either the return type or 0 parameters
if (!isset($methodname)) {
$returnvoid = true;
} else { // no parameters
$noparameters = true;
}
break;
case 'methodname':
$methodname = $child->nodeValue;
break;
case 'methodparam':
case 'modifier':
break;
default:
echo "Unknown child for methodsynopsis: {$child->nodeName} in $function\n";
}
}
}
break;
case 'returnvalues':
case 'parameters':
case 'seealso':
case 'examples':
case 'notes':
case 'changelog':
case 'errors':
case 'unicode':
// test order
switch ($role) {
case 'parameters':
if (isset($notes) && isset($changelog) && isset($returnvalues) && isset($examples) && isset($seealso)) {
$status[$extension][$funcname]['badorder'] = 1;
}
break;
case 'returnvalues':
if (isset($notes) && isset($changelog) && isset($examples) && isset($seealso)) {
$status[$extension][$funcname]['badorder'] = 1;
}
break;
case 'changelog':
if (isset($notes) && isset($examples) && isset($seealso)) {
$status[$extension][$funcname]['badorder'] = 1;
}
break;
case 'examples':
if (isset($notes) && isset($seealso)) {
$status[$extension][$funcname]['badorder'] = 1;
}
break;
case 'notes':
if (isset($seealso)) {
$status[$extension][$funcname]['badorder'] = 1;
}
break;
}
$$role = 1;
$whole_content = $refsect1->nodeValue;
// Check for default stub generated by xml_proto
if ($role == 'returnvalues' && strpos($whole_content, 'What the function returns, first on success, then on failure.') !== false) {
unset($returnvalues);
}
break;
default:
if ($role != '') {
$status[$extension][$funcname]['roleerror'] = 1;
} else {
$status[$extension][$funcname]['oldstyle'] = 1;
// Skip the remaining refsect1
continue 3;
}
}
}
// See also checks
if (!isset($seealso)) {
$status[$extension][$funcname]['noseealso'] = 1;
}
unset($seealso);
// Return Values
if (!isset($returnvalues)) {
$status[$extension][$funcname]['noreturnvalues'] = 1;
}
unset($returnvalues);
// Parameters
if (!isset($parameters) && !$noparameters) {
$status[$extension][$funcname]['noparameters'] = 1;
}
unset($parameters);
// Examples checks
if (!isset($examples)) {
$status[$extension][$funcname]['noexamples'] = 1;
}
unset($examples);
// Errors checks
if (!isset($errors)) {
$status[$extension][$funcname]['noerrors'] = 1;
}
unset($errors);
// ChangeLog
if (!isset($changelog) && preg_match('!PHP \d!', $xmlstr)) {
$status[$extension][$funcname]['nochangelog'] = 1;
}
unset($changelog);
}
$idx = sqlite_open("check_phpdoc.sqlite");
sqlite_query($idx, 'CREATE TABLE reference (
extension char(40),
funcname char(200),
oldstyle integer,
undoc integer,
roleerror integer,
badorder integer,
noseealso integer,
noreturnvalues integer,
noparameters integer,
noexamples integer,
noerrors integer,
nochangelog integer
);');
$qry_str = '';
foreach ($status as $extension => $functions) {
foreach ($functions as $function => $attrs) {
$qry_str .= 'INSERT INTO reference (extension, funcname, ' . implode(', ', array_keys($attrs)) . ') VALUES ("' . $extension . '", "' . $function . '", ' . implode(', ', $attrs) . ');';
}
}
sqlite_query($idx, $qry_str);
unset($qry_str);
sqlite_close($idx);
|
