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
|
<?php
//
// +------------------------------------------------------------------------+
// | phpDocumentor |
// +------------------------------------------------------------------------+
// | Copyright (c) 2000-2003 Joshua Eichorn, Gregory Beaver |
// | Email jeichorn@phpdoc.org, cellog@phpdoc.org |
// | Web http://www.phpdoc.org |
// | Mirror http://phpdocu.sourceforge.net/ |
// | PEAR http://pear.php.net/package-info.php?pacid=137 |
// +------------------------------------------------------------------------+
// | This source file is subject to version 3.00 of the PHP License, |
// | that is available at http://www.php.net/license/3_0.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. |
// +------------------------------------------------------------------------+
//
/**
* Linking to element documentation is performed by the classes in this file.
*
* abstractLink descendants contain enough information to differentiate every
* documentable element, and so can be converted to a link string by
* {@link Converter::returnSee()}
* @package phpDocumentor
* @subpackage Links
*/
/**
* linking classes parent
* @package phpDocumentor
* @subpackage Links
*/
class abstractLink
{
/**#@+ @var string */
var $path;
/**
* phpdoc alias _phpdoc_inc for phpdoc.inc
*/
var $fileAlias = '';
/**
* element type linked to.
* can only be a documentable element
*/
var $type = '';
var $name = '';
var $category = '';
var $package = '';
var $subpackage = '';
/**#@-*/
/**
* @param string full path to file containing element
* @param string page name, as configured by {@link Parser::parse}
* @param string element name
* @param string package element is in
* @param string subpackage element is in
* @param string optional category that documentation is in
*/
function addLink($path, $fileAlias, $name, $package, $subpackage, $category = false)
{
$this->path = $path;
$this->fileAlias = $fileAlias;
$this->name = $name;
$this->category = $category;
$this->package = $package;
$this->subpackage = $subpackage;
}
}
/**
* procedural page link
* @package phpDocumentor
* @subpackage Links
*/
class pageLink extends abstractLink
{
/** @var string */
var $type = 'page';
}
/**
* function link
* @package phpDocumentor
* @subpackage Links
*/
class functionLink extends abstractLink
{
/** @var string */
var $type = 'function';
}
/**
* define link
* @package phpDocumentor
* @subpackage Links
*/
class defineLink extends abstractLink
{
/** @var string */
var $type = 'define';
}
/**
* global variable link
* @package phpDocumentor
* @subpackage Links
*/
class globalLink extends abstractLink
{
/** @var string */
var $type = 'global';
}
/**
* class link
* @package phpDocumentor
* @subpackage Links
*/
class classLink extends abstractLink
{
/** @var string */
var $type = 'class';
}
/**
* method link
* @package phpDocumentor
* @subpackage Links
*/
class methodLink extends abstractLink
{
/** @var string */
var $type = 'method';
/** @var string */
var $class = '';
/**
* @param string class name
* @param string full path to file containing element
* @param string page name, as configured by {@link Parser::parse}
* @param string element name
* @param string package element is in
* @param string subpackage element is in
*/
function addLink($class, $path ,$fileAlias,$name,$package,$subpackage, $category = false)
{
$this->class = $class;
abstractLink::addLink($path, $fileAlias,$name,$package,$subpackage, $category);
}
}
/**
* class variable link
* @package phpDocumentor
* @subpackage Links
*/
class varLink extends methodLink
{
/** @var string */
var $type = 'var';
}
/**
* class constant link
* @package phpDocumentor
* @subpackage Links
*/
class constLink extends methodLink
{
/** @var string */
var $type = 'const';
}
/**
* tutorial link
* @package phpDocumentor
* @subpackage Links
*/
class tutorialLink extends abstractLink
{
/**#@+ @var string */
var $type = 'tutorial';
var $section = '';
var $title = false;
/**#@-*/
/**
* @param string section/subsection name
* @param string full path to file containing element
* @param string page name, as configured by {@link Parser::parse}
* @param string element name
* @param string package element is in
* @param string subpackage element is in
* @param string title of tutorial
*/
function addLink($section,$path,$name,$package,$subpackage,$title = false, $category = false)
{
$this->section = $section;
$this->title = $title;
parent::addLink($path,'',$name,$package,$subpackage, $category);
}
}
?>
|
