Menu

[r241]: / trunk / src / reporter / XmlNCSSReporter.php  Maximize  Restore  History

Download this file

357 lines (286 with data), 11.8 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
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<?php
require_once PHPCHECKSTYLE_HOME_DIR."/src/reporter/Reporter.php";
/**
* Writes the count of lines of codes in an XML file.
* Format compatible with javancss:
* ================================
* <?xml version="1.0"?>
<javancss>
<date>2009-09-01</date>
<time>10:23:07</time>
<packages>
<package>
<name>fr.ifn.calcul</name>
<classes>3</classes>
<functions>9</functions>
<ncss>186</ncss>
<javadocs>12</javadocs>
<javadoc_lines>41</javadoc_lines>
<single_comment_lines>24</single_comment_lines>
<multi_comment_lines>0</multi_comment_lines>
</package>
* ================================
*
*/
class XmlNCSSReporter {
private $document = false;
private $root = false;
private $packages = false;
private $objects = false;
private $outputFile;
private $lastPackageName = false;
private $lastPackageChild = false;
private $nbPackages = 0;
private $packageClasses = 0;
private $packageInterfaces = 0;
private $packageFunctions = 0;
private $packageNCSS = 0;
private $packageJavadocs = 0;
private $packageJavadocLines = 0;
private $packageSingleCommentLines = 0;
private $packageMultiCommentLines = 0;
/**
* Constructor; calls parent's constructor
*
* @param $ofolder the output folder
* @param $ofile the output filename
*/
public function XmlNCSSReporter($ofolder = false, $ofile = null) {
$this->outputFile = $ofolder.$ofile;
if (!$this->outputFile) {
$this->outputFile = "php://output";
}
//creating the folder if it does not already exist.
if (!file_exists($ofolder)) {
mkdir($ofolder, 0755, true);
}
}
/**
* @see Reporter::start
* create the document root (<phpcheckstyle>)
*
*/
public function start() {
$this->_initXml();
}
/**
* @see Reporter::start
* add the last element to the tree and save the DOM tree to the
* xml file
*
*/
public function stop() {
$this->root->appendChild($this->objects);
$this->document->save($this->outputFile);
}
/**
* @see Reporter::currentlyProcessing
* add the previous element to the tree and start a new elemtn
* for the new file
*
* @param $phpFile the file currently processed
* @SuppressWarnings checkUnusedFunctionParameters The parameter is inherited
*/
public function currentlyProcessing($phpFile) {
}
/**
* Write the count of lines for one file
*
* @param $fileName the file name
* @param $classes the number of classes in the file
* @param $interfaces the number of interfaces in the file
* @param $functions the number of functions
* @param $ncss the number of non empty lines of code
* @param $javadocs the number of PHPDoc blocks
* @param $javadocLines the number of PHPDoc lines
* @param $singleCommentLines the number of single line comments
* @param $multiCommentLines the number of multi-line comments
*/
public function writeFileCount($fileName, $classes, $interfaces, $functions, $ncss, $javadocs, $javadocLines, $singleCommentLines, $multiCommentLines) {
$fileName = str_replace('/', '.', $fileName);
while (strpos($fileName, '.') == 0) {
$fileName = substr($fileName, 1);
}
if (strlen($fileName) > 4) { // remove the .php at the end
$fileName = substr($fileName, 0, -4);
}
// Identify the package name
$packageName = substr($fileName, 0, strrpos($fileName, '.'));
if ($this->lastPackageName === $packageName) {
// Add the values
$this->packageClasses = $this->packageClasses + $classes;
$this->packageInterfaces = $this->packageInterfaces + $interfaces;
$this->packageFunctions = $this->packageFunctions + $functions;
$this->packageNCSS = $this->packageNCSS + $ncss;
$this->packageJavadocs = $this->packageJavadocs + $javadocs;
$this->packageJavadocLines = $this->packageJavadocLines + $javadocLines;
$this->packageSingleCommentLines = $this->packageSingleCommentLines + $singleCommentLines;
$this->packageMultiCommentLines = $this->packageMultiCommentLines + $multiCommentLines;
// Remove the last node
$this->packages->removeChild($this->lastPackageChild);
} else {
$this->nbPackages++;
// Reset the values
$this->packageClasses = $classes;
$this->packageInterfaces = $interfaces;
$this->packageFunctions = $functions;
$this->packageNCSS = $ncss;
$this->packageJavadocs = $javadocs;
$this->packageJavadocLines = $javadocLines;
$this->packageSingleCommentLines = $singleCommentLines;
$this->packageMultiCommentLines = $multiCommentLines;
}
//
// Create the package bloc
//
$e = $this->document->createElement("package");
$name = $this->document->createElement('name', $packageName);
$e->appendChild($name);
$classesE = $this->document->createElement('classes', $this->packageClasses);
$e->appendChild($classesE);
$interfacesE = $this->document->createElement('interfaces', $this->packageInterfaces);
$e->appendChild($interfacesE);
$functionsE = $this->document->createElement('functions', $this->packageFunctions);
$e->appendChild($functionsE);
$ncssE = $this->document->createElement('ncss', $this->packageNCSS);
$e->appendChild($ncssE);
$javadocsE = $this->document->createElement('javadocs', $this->packageJavadocs);
$e->appendChild($javadocsE);
$javadocLinesE = $this->document->createElement('javadoc_lines', $this->packageJavadocLines);
$e->appendChild($javadocLinesE);
$singleCommentLinesE = $this->document->createElement('single_comment_lines', $this->packageSingleCommentLines);
$e->appendChild($singleCommentLinesE);
$multiCommentLinesE = $this->document->createElement('multi_comment_lines', $this->packageMultiCommentLines);
$e->appendChild($multiCommentLinesE);
$this->packages->appendChild($e);
$this->lastPackageChild = $e;
//
// Create the object bloc
//
$obj = $this->document->createElement("object");
$objname = $this->document->createElement('name', $fileName);
$obj->appendChild($objname);
$objncss = $this->document->createElement('ncss', $ncss);
$obj->appendChild($objncss);
$objfunctions = $this->document->createElement('functions', $functions);
$obj->appendChild($objfunctions);
$objclasses = $this->document->createElement('classes', $classes);
$obj->appendChild($objclasses);
$objjavadocs = $this->document->createElement('javadocs', $javadocs);
$obj->appendChild($objjavadocs);
$this->objects->appendChild($obj);
$this->lastPackageName = $packageName;
}
/**
* Write the total count of lines for the project.
*
* @param $nbFiles the number of files.
* @param $classes the number of classes
* @param $interfaces the number of interfaces
* @param $functions the number of functions
* @param $ncss the number of non empty lines of code
* @param $javadocs the number of PHPDoc blocks
* @param $javadocLines the number of PHPDoc lines
* @param $singleCommentLines the number of single line comments
* @param $multiCommentLines the number of multi-line comments
*/
public function writeTotalCount($nbFiles, $classes, $interfaces, $functions, $ncss, $javadocs, $javadocLines, $singleCommentLines, $multiCommentLines) {
//
// Create the total bloc
//
$e = $this->document->createElement("total");
$classesE = $this->document->createElement('classes', $classes);
$e->appendChild($classesE);
$interfacesE = $this->document->createElement('interfaces', $interfaces);
$e->appendChild($interfacesE);
$functionsE = $this->document->createElement('functions', $functions);
$e->appendChild($functionsE);
$ncssE = $this->document->createElement('ncss', $ncss);
$e->appendChild($ncssE);
$javadocsE = $this->document->createElement('javadocs', $javadocs);
$e->appendChild($javadocsE);
$javadocLinesE = $this->document->createElement('javadoc_lines', $javadocLines);
$e->appendChild($javadocLinesE);
$singleCommentLinesE = $this->document->createElement('single_comment_lines', $singleCommentLines);
$e->appendChild($singleCommentLinesE);
$multiCommentLinesE = $this->document->createElement('multi_comment_lines', $multiCommentLines);
$e->appendChild($multiCommentLinesE);
$this->packages->appendChild($e);
//
// Create the table bloc
//
$table = $this->document->createElement("table");
$this->packages->appendChild($table);
$header = $this->_createDOMLine("Packages", "Classes", "Functions", "NCSS", "Javadocs", "per");
$table->appendChild($header);
$projectLine = $this->_createDOMLine($this->nbPackages, $classes, $functions, $ncss, $javadocs, "Project");
$table->appendChild($projectLine);
if ($this->nbPackages == 0) {
$packageLine = $this->_createDOMLine("", "", "", "", "", "Package");
} else {
$packageLine = $this->_createDOMLine("", $classes / $this->nbPackages, $functions / $this->nbPackages, $ncss / $this->nbPackages, $javadocs / $this->nbPackages, "Package");
}
$table->appendChild($packageLine);
if ($classes == 0) {
$packageLine = $this->_createDOMLine("", "", "", "", "", "Class");
} else {
$packageLine = $this->_createDOMLine("", "", $functions / $classes, $ncss / $classes, $javadocs / $classes, "Class");
}
$table->appendChild($packageLine);
if ($functions == 0) {
$packageLine = $this->_createDOMLine("", "", "", "", "", "Function");
} else {
$packageLine = $this->_createDOMLine("", "", "", $ncss / $functions, $javadocs / $functions, "Function");
}
$table->appendChild($packageLine);
//
// Create the averages bloc
//
$averages = $this->document->createElement("averages");
$avgNcss = $this->document->createElement('ncss', ($nbFiles == 0) ? 0 : ($ncss / $nbFiles));
$averages->appendChild($avgNcss);
$avgNcss = $this->document->createElement('functions', ($nbFiles == 0) ? 0 : ($functions / $nbFiles));
$averages->appendChild($avgNcss);
$avgNcss = $this->document->createElement('classes', ($nbFiles == 0) ? 0 : ($classes / $nbFiles));
$averages->appendChild($avgNcss);
$avgNcss = $this->document->createElement('javadoc', ($nbFiles == 0) ? 0 : ($javadocs / $nbFiles));
$averages->appendChild($avgNcss);
$this->objects->appendChild($averages);
//
// Complete the objects bloc
//
$ncssobj = $this->document->createElement('ncss', $ncss);
$this->objects->appendChild($ncssobj);
}
/**
* Create the DOM for a line of a table
*/
private function _createDOMLine($a, $b, $c, $d, $e, $f) {
$line = $this->document->createElement("tr");
$cola = $this->document->createElement("td", $a);
$colb = $this->document->createElement("td", $b);
$colc = $this->document->createElement("td", $c);
$cold = $this->document->createElement("td", $d);
$cole = $this->document->createElement("td", $e);
$colf = $this->document->createElement("td", $f);
$line->appendChild($cola);
$line->appendChild($colb);
$line->appendChild($colc);
$line->appendChild($cold);
$line->appendChild($cole);
$line->appendChild($colf);
return $line;
}
private function _initXml() {
$this->document = new DomDocument("1.0");
$this->root = $this->document->createElement('javancss');
$this->document->appendChild($this->root);
$date = $this->document->createElement('date', date("Y-m-d"));
$this->root->appendChild($date);
$time = $this->document->createElement('time', date("G:i:s"));
$this->root->appendChild($time);
$this->packages = $this->document->createElement('packages');
$this->root->appendChild($this->packages);
$this->objects = $this->document->createElement('objects'); // added later
}
}
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.