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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
<?php
/**
* Renders Index lists.
*/
class PhpdocHTMLIndexRenderer extends PhpdocHTMLRenderer {
/**
* Some container in the package list.
* @var array
* @see renderPackagelist()
*/
var $packageFields = array("class", "module");
/**
* Packagelist from the PhpdocIndexAccessor
* @var array
*/
var $packages = array();
/**
* Array with classtree informations
* @var array
*/
var $classtree = array();
/**
* IntegratedTemplate Object used be renderClasstree()
*
* @var object IntegratedTemplate
* @see renderClasstree()
*/
var $treeTpl;
/**
* IntegratedTemplateObject used by renderModulegroup()
*
* @var object IntegratedTemplate
* @see renderModulegroup()
*/
var $moduleTpl;
/**
* Sets the xml and template root directory.
*
* @param string XML file path
* @param string Template file path
* @param string Name of the application
* @see setPath(), setTemplateRoot()
*/
function PhpdocHTMLIndexRenderer($path, $templateRoot, $application) {
$this->setPath($path);
$this->setTemplateRoot($templateRoot);
$this->application = $application;
$this->accessor = new PhpdocIndexAccessor;
$this->tpl = new IntegratedTemplate($this->templateRoot);
$this->fileHandler = new PhpdocFileHandler;
} // end constructor
/**
* Builds all index files phpdoc needs assuming that the xml files have default names
*
* @access public
* @see renderElementlist(), renderPackagelist(), renderFramelementlist(), renderFramePackageSummary()
*/
function generate() {
$this->renderElementlist("elementlist.xml");
$this->renderFrameElementlist("elementlist.xml");
$this->renderPackagelist("packagelist.xml");
$this->renderFramePackageSummary("packagelist.xml");
$this->renderFrameElementlist("packagelist.xml");
} // end function generate
/**
* Saves the generated classtree summary to disk.
*
* @see renderClasstree()
* @access public
*/
function finishClasstree() {
if (!is_object($this->treeTpl))
return;
$this->treeTpl->setVariable("APPNAME", $this->application);
$this->fileHandler->createFile($this->path."phpdoc_classtree.html", $this->treeTpl->get() );
$this->treeTpl = "";
} // end func finishClasstree
/**
* Adds a classtree to the classtree summary template.
*
* @param string XML Classtree file
* @see finishClasstree()
* @access public
*/
function addClasstree($xmlfile) {
$this->accessor->loadXMLFile($this->path.$xmlfile);
if (!is_object($this->treeTpl)) {
$this->treeTpl = new IntegratedTemplate($this->templateRoot);
$this->treeTpl->loadTemplatefile("classtree.html");
}
$this->classtree = $this->accessor->getClasstree();
$this->treeTpl->setCurrentBlock("classtree");
$this->treeTpl->setVariable("BASECLASS", $this->classtree["baseclass"]);
$this->treeTpl->setVariable("TREE", "<ul>".$this->buildClasstreeHTML($this->classtree["baseclass"])."</ul>");
$this->treeTpl->parseCurrentBlock();
return true;
} // end func addClasstree
function finishModulegroup() {
if (!is_object($this->moduleTpl))
return;
$this->moduleTpl->setVariable("APPNAME", $this->application);
$this->fileHandler->createFile($this->path."phpdoc_modulegroup.html", $this->moduleTpl->get() );
$this->moduleTpl = "";
} // end func finishModulegroups
/**
* Renders a modulegroup xml file.
* @param string XML File
*/
function addModulegroup($xmlfile) {
$this->accessor->loadXMLFile($this->path.$xmlfile);
if (!is_object($this->moduleTpl)) {
$this->moduleTpl = new IntegratedTemplate($this->templateRoot);
$this->moduleTpl->loadTemplateFile("modulegroup.html");
}
$modulegroup = $this->accessor->getModulegroup();
$modules = "<ul>";
reset($modulegroup["modules"]);
while (list($k, $module)=each($modulegroup["modules"]))
$modules.= sprintf('<li><a href="%s.html">%s</a>', $this->nameToUrl($module), $module);
$modules.= "</ul>";
$this->moduleTpl->setCurrentBlock("modulegroup");
$this->moduleTpl->setVariable("MODULEGROUP", $modulegroup["group"]);
$this->moduleTpl->setVariable("MODULES", $modules);
$this->moduleTpl->parseCurrentBlock();
} // end func addModulegroup
/**
* Renders the element index list.
*
* @param string XML file
* @access public
* @see generate()
*/
function renderElementlist($xmlfile) {
$this->accessor->loadXMLFile($this->path.$xmlfile);
$this->tpl->loadTemplatefile("elementlist.html");
$chapters = $this->accessor->getChapternames();
if (0!=count($chapters)) {
$this->tpl->setCurrentBlock("chaptersummary_loop");
reset($chapters);
while (list($k, $chapter)=each($chapters)) {
$this->tpl->setVariable("CHAPTER", $chapter);
$this->tpl->parseCurrentBlock();
}
$chapters = $this->accessor->getChapters();
reset($chapters);
while (list($name, $elements)=each($chapters)) {
if (!isset($elements["element"][0]))
$elements["element"] = array($elements["element"]);
$this->tpl->setCurrentBlock("chapter_loop");
reset($elements["element"]);
while (list($k, $element)=each($elements["element"])) {
switch($element["type"]) {
case "package":
$desc = "Package";
break;
case "class":
$desc = sprintf('Class <a href="%s.html">%s</a>.',
$this->nameToUrl($element["name"]),
$element["name"]
);
break;
case "module":
$desc = sprintf('Module <a href="%s.html">%s</a>.',
$this->nameToUrl($element["name"]),
$element["name"]
);
break;
case "functions":
$desc = sprintf('Function in %s <a href="%s.html">%s</a>',
$element["sourcetype"],
$this->nameToUrl($element["source"]),
$element["source"]
);
break;
case "variables":
$desc = sprintf('Variable in Class <a href="%s.html">%s</a>',
$this->nameToUrl($element["source"]),
$element["source"]
);
break;
case "uses":
$desc = sprintf('Included file in %s <a href="%s.html">%s</a>',
$element["sourcetype"],
$this->nameToUrl($element["source"]),
$element["source"]
);
break;
break;
case "consts":
$desc = sprintf('Constant defined in %s <a href="%s.html">%s</a>',
$element["sourcetype"],
$this->nameToUrl($element["source"]),
$element["source"]
);
break;
}
$this->tpl->setVariable("ELEMENTNAME", $element["name"]);
$this->tpl->setVariable("ELEMENT", $desc);
$this->tpl->setVariable("SHORTDESCRIPTION", $element["value"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("chapter");
$this->tpl->setVariable("CHAPTER", $name);
$this->tpl->parseCurrentBlock();
}
}
$this->tpl->setVariable("APPNAME", $this->application);
$this->fileHandler->createFile($this->path."phpdoc_elementlist.html", $this->tpl->get() );
$this->tpl->free();
} // end func renderElementlist
/**
* Renders a complete packagelist.
*
* @param string XML file
* @access public
* @see renderFrameElementlist(), renderFramePackagesummary()
*/
function renderPackagelist($xmlfile) {
$this->loadPackagelist($xmlfile);
$this->tpl->loadTemplatefile("packagelist.html");
reset($this->packages);
while (list($packagename, $package)=each($this->packages)) {
reset($this->packageFields);
while (list($k, $field)=each($this->packageFields)) {
if (!isset($package[$field]))
continue;
$this->tpl->setCurrentBlock("package_".$field."_loop");
reset($package[$field]);
while (list($k, $element)=each($package[$field])) {
$this->tpl->setVariable("ELEMENT", sprintf('<a href="%s.html">%s</a>',
$this->nameToUrl($element),
$element
)
);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("package_".$field);
$this->tpl->setVariable("EMPTY", "");
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("package");
$this->tpl->setVariable("PACKAGE_NAME", $packagename);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable("APPNAME", $this->application);
$this->fileHandler->createFile($this->path."phpdoc_packagelist.html", $this->tpl->get() );
$this->tpl->free();
} // end func renderPackagelist
/**
* Renders files for the lower left frame with the elements of a certain file.
*
* @param string This function needs the packagelist.xml to work!
* @access public
* @see renderFramePackagesummary(), renderPackagelist()
*/
function renderFrameElementlist($xmlfile) {
$this->loadPackagelist($xmlfile);
reset($this->packages);
while (list($packagename, $package)=each($this->packages)) {
$this->tpl->loadTemplatefile("frame_packageelementlist.html");
reset($this->packageFields);
while (list($k, $field)=each($this->packageFields)) {
if (!isset($package[$field]))
continue;
$this->tpl->setCurrentBlock("package_".$field."_loop");
reset($package[$field]);
while (list($k, $element)=each($package[$field])) {
$this->tpl->setVariable("ELEMENT", sprintf('<a href="%s.html" target="main">%s</a>',
$this->nameToUrl($element),
$element
)
);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("package_".$field);
$this->tpl->setVariable("EMPTY", "");
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("package");
$this->tpl->setVariable("PACKAGE_NAME", $packagename);
$this->tpl->parseCurrentBlock();
$this->tpl->setVariable("APPNAME", $this->application);
$packagename = $this->nameToUrl($packagename);
$this->fileHandler->createFile($this->path."packageelementlist_".$packagename.".html", $this->tpl->get() );
}
$this->tpl->free();
} // end func renderFrameElementlist
/**
* Renders a Packagesummary for the frameset.
*
* @param string XML file.
* @access public
* @see renderPackagelist(), renderFrameElementlist()
*/
function renderFramePackagesummary($xmlfile) {
$this->loadPackagelist($xmlfile);
$this->tpl->loadTemplatefile("frame_packagelist.html");
$this->tpl->setCurrentBlock("package");
reset($this->packages);
while (list($packagename, $v)=each($this->packages)) {
$this->tpl->setVariable("PACKAGE", sprintf('<a href="packageelementlist_%s.html" target="packageelements">%s</a>',
$this->nameToUrl($packagename),
$packagename )
);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable("APPNAME", $this->application);
$this->fileHandler->createFile($this->path."frame_packagelist.html", $this->tpl->get() );
$this->tpl->free();
} // end func renderFramePackagesummary
/**
* Imports the packagelist from the PhpdocIndexAccessor if not done previously.
*
* @param string XMl file.
* @see $packages
*/
function loadPackagelist($xmlfile) {
if (0==count($this->packages)) {
$this->accessor->loadXMLFile($this->path.$xmlfile);
$this->packages = $this->accessor->getPackagelist();
}
} // end func loadPackagelist
/**
* Recursivly builds an HTML class tree using <ul><li></ul>.
*
* @param string Name of the class the recursive loop starts with
* @see renderClasstree()
*/
function buildClasstreeHTML($class) {
$html = "";
if (0==count($this->classtree["classes"][$class])) {
$html.= sprintf('<li><a href="%s.html">%s</a>', $this->nameToUrl($class), $class);
} else {
$html.= sprintf('<li><a href="%s.html">%s</a>', $this->nameToUrl($class), $class);
$html.= "<ul>";
reset($this->classtree["classes"][$class]);
while (list($k, $subclass)=each($this->classtree["classes"][$class]))
$html.= $this->buildClasstreeHTML($subclass);
$html.= "</ul>";
}
return $html;
} // end func buildClasstreeHTML
} // end class PhpdocHTMLIndexRenderer
?>
|
