IPPhpDoc.class.php
2.99 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
<?PHP
/**
* The base phpdoc class searches for available classes
*
*@author KnowledgeTree Team
*@package Webservice
*@version Version 0.9
*/
class IPPhpDoc{
/** @var IPReflectionClass[] Array with available classes */
public $classes = array();
/** @var IPReflectionClass The current class */
public $class = "";
/**
* Constructor, initiates the getClasses() method
*
* @return void
*/
function __construct() {
$this->getClasses();
}
/** Sets the current class
* @param string The class name
* @return void
*/
public function setClass($class) {
$this->class = new IPReflectionClass($class);
}
/**
* Get all classes
*
* @return IPReflectionClass[]
*/
function getClasses() {
$ar = get_declared_classes();
foreach($ar as $class){
$c = new reflectionClass($class);
if($c->isUserDefined()){//add only when class is user-defined
$this->classes[$class] = new IPReflectionClass($class);
}
}
ksort($this->classes);
return $this->classes;
}
/**
* Generates the documentation page with all classes, methods etc.
* @TODO FIXME: use the new template class
* @param string Template file (optional)
* @return string
*/
public function getDocumentation($template="classes/soap/templates/docclass.xsl") {
if(!is_file($template))
throw new WSException("Could not find the template file: '$template'");
$xtpl = new IPXSLTemplate($template);
$documentation = Array();
$documentation['menu'] = Array();
//loop menu items
$documentation['menu'] = $this->getClasses();
if($this->class){
if($this->class->isUserDefined()) {
$this->class->properties = $this->class->getProperties(false, false);
$this->class->methods = $this->class->getMethods(false, false);
foreach((array)$this->class->methods as $method) {
$method->params = $method->getParameters();
}
} else {
$documentation['fault'] = "Native class";
}
$documentation['class'] = $this->class;
}
echo $xtpl->execute($documentation);
}
/**
*
* @param $comment String The doccomment
* @param $annotationName String the annotation name
* @param $annotationClass String the annotation class
* @return void
*/
public static function getAnnotation($comment, $annotationName, $annotationClass = null){
if(!$annotationClass){
$annotationClass = $annotationName;
}
$start = 0;
if($start = stripos($comment, "@".$annotationName)){
$obi = new $annotationClass();
$start = strpos($comment, "(", $start);
$end = strpos($comment, ")", $start);
$propString = substr($comment, $start, ($end-$start) + 1);
$eval = "return Array$propString;";
$arr = @eval($eval);
if($arr === false) throw new Exception("Error parsing annotation: $propString");
foreach ((Array)$arr as $name => $value){
$obi->$name= $value;
}
return $obi;
}
throw new Exception("Cannot find annotation @$annotationName ($start, $end): {$this->comment} ");
}
}
?>