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
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>LDAP Account Manager » \SchemaItem</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">LDAP Account Manager</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Crypt.html"><i class="icon-folder-open"></i> Crypt</a></li>
<li><a href="../packages/Help.html"><i class="icon-folder-open"></i> Help</a></li>
<li><a href="../packages/LDAP.html"><i class="icon-folder-open"></i> LDAP</a></li>
<li><a href="../packages/Math.html"><i class="icon-folder-open"></i> Math</a></li>
<li><a href="../packages/Net.html"><i class="icon-folder-open"></i> Net</a></li>
<li><a href="../packages/PDF.html"><i class="icon-folder-open"></i> PDF</a></li>
<li><a href="../packages/PHP.html"><i class="icon-folder-open"></i> PHP</a></li>
<li><a href="../packages/configuration.html"><i class="icon-folder-open"></i> configuration</a></li>
<li><a href="../packages/horde.html"><i class="icon-folder-open"></i> horde</a></li>
<li><a href="../packages/lam.html"><i class="icon-folder-open"></i> lam</a></li>
<li><a href="../packages/lib.html"><i class="icon-folder-open"></i> lib</a></li>
<li><a href="../packages/lists.html"><i class="icon-folder-open"></i> lists</a></li>
<li><a href="../packages/main.html"><i class="icon-folder-open"></i> main</a></li>
<li><a href="../packages/metaHTML.html"><i class="icon-folder-open"></i> metaHTML</a></li>
<li><a href="../packages/modules.html"><i class="icon-folder-open"></i> modules</a></li>
<li><a href="../packages/phpLDAPadmin.html"><i class="icon-folder-open"></i> phpLDAPadmin</a></li>
<li><a href="../packages/profiles.html"><i class="icon-folder-open"></i> profiles</a></li>
<li><a href="../packages/selfService.html"><i class="icon-folder-open"></i> selfService</a></li>
<li><a href="../packages/tools.html"><i class="icon-folder-open"></i> tools</a></li>
<li><a href="../packages/types.html"><i class="icon-folder-open"></i> types</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
<span class="label label-info">1055</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
<ul><li>todo
<span class="label label-info">15</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#SchemaItem" title="SchemaItem :: Default constructor."><span class="description">Default constructor.</span><pre>SchemaItem()</pre></a></li>
<li class="method public "><a href="#getDescription" title="getDescription :: "><span class="description">getDescription()
</span><pre>getDescription()</pre></a></li>
<li class="method public "><a href="#getOID" title="getOID :: "><span class="description">getOID()
</span><pre>getOID()</pre></a></li>
<li class="method public "><a href="#initVars" title="initVars :: Initialize class members to default values."><span class="description">Initialize class members to default values.</span><pre>initVars()</pre></a></li>
<li class="method public "><a href="#setDescription" title="setDescription :: "><span class="description">setDescription()
</span><pre>setDescription()</pre></a></li>
<li class="method public "><a href="#setOID" title="setOID :: "><span class="description">setOID()
</span><pre>setOID()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24description" title="$description :: The description of this schema item."><span class="description">The description of this schema item.</span><pre>$description</pre></a></li>
<li class="property public "><a href="#%24oid" title="$oid :: The OID of this schema item."><span class="description">The OID of this schema item.</span><pre>$oid</pre></a></li>
</ul>
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#getDescription" title="getDescription :: "><span class="description">getDescription()
</span><pre>getDescription()</pre></a></li>
<li class="method public "><a href="#getIsObsolete" title="getIsObsolete :: Gets whether this objectClass is flagged as obsolete by the LDAP server."><span class="description">Gets whether this objectClass is flagged as obsolete by the LDAP server.</span><pre>getIsObsolete()</pre></a></li>
<li class="method public "><a href="#getName" title="getName :: Return the objects name."><span class="description">Return the objects name.</span><pre>getName()</pre></a></li>
<li class="method public "><a href="#getOID" title="getOID :: "><span class="description">getOID()
</span><pre>getOID()</pre></a></li>
<li class="method public "><a href="#setDescription" title="setDescription :: "><span class="description">setDescription()
</span><pre>setDescription()</pre></a></li>
<li class="method public "><a href="#setOID" title="setOID :: "><span class="description">setOID()
</span><pre>setOID()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24description" title="$description :: "><span class="description">$description</span><pre>$description</pre></a></li>
<li class="property protected "><a href="#%24name" title="$name :: "><span class="description">$name</span><pre>$name</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24is_obsolete" title="$is_obsolete :: "><span class="description">$is_obsolete</span><pre>$is_obsolete</pre></a></li>
<li class="property private "><a href="#%24oid" title="$oid :: "><span class="description">$oid</span><pre>$oid</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CSchemaItem" id="\SchemaItem"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/SchemaItem.html">SchemaItem</a>
</li>
</ul>
<div href="../classes/SchemaItem.html" class="element class">
<p class="short_description">Generic parent class for all schema items.</p>
<div class="details">
<p class="long_description"><p>A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</p></p>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/lib.html">lib</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="SchemaItem" id="SchemaItem"></a><div class="element clickable method public SchemaItem" data-toggle="collapse" data-target=".SchemaItem .collapse">
<h2>Default constructor.</h2>
<pre>SchemaItem() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="getDescription" id="getDescription"></a><div class="element clickable method public getDescription" data-toggle="collapse" data-target=".getDescription .collapse">
<h2>getDescription()
</h2>
<pre>getDescription() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="getOID" id="getOID"></a><div class="element clickable method public getOID" data-toggle="collapse" data-target=".getOID .collapse">
<h2>getOID()
</h2>
<pre>getOID() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="initVars" id="initVars"></a><div class="element clickable method public initVars" data-toggle="collapse" data-target=".initVars .collapse">
<h2>Initialize class members to default values.</h2>
<pre>initVars() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="setDescription" id="setDescription"></a><div class="element clickable method public setDescription" data-toggle="collapse" data-target=".setDescription .collapse">
<h2>setDescription()
</h2>
<pre>setDescription($new_desc) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$new_desc</h4></div>
</div></div>
</div>
<a name="setOID" id="setOID"></a><div class="element clickable method public setOID" data-toggle="collapse" data-target=".setOID .collapse">
<h2>setOID()
</h2>
<pre>setOID($new_oid) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$new_oid</h4></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24description" id="$description"> </a><div class="element clickable property public $description" data-toggle="collapse" data-target=".$description .collapse">
<h2>The description of this schema item.</h2>
<pre>$description </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24oid" id="$oid"> </a><div class="element clickable property public $oid" data-toggle="collapse" data-target=".$oid .collapse">
<h2>The OID of this schema item.</h2>
<pre>$oid </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
<a name="%5CSchemaItem" id="\SchemaItem"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/SchemaItem.html">SchemaItem</a>
</li>
</ul>
<div href="../classes/SchemaItem.html" class="element class">
<p class="short_description">Generic parent class for all schema items.</p>
<div class="details">
<p class="long_description"><p>A schema item is
an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
All schema items have at least two things in common: An OID
and a description. This class provides an implementation for
these two data.</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="../packages/phpLDAPadmin.Schema.html">phpLDAPadmin</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Schema</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="getDescription" id="getDescription"></a><div class="element clickable method public getDescription" data-toggle="collapse" data-target=".getDescription .collapse">
<h2>getDescription()
</h2>
<pre>getDescription() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="getIsObsolete" id="getIsObsolete"></a><div class="element clickable method public getIsObsolete" data-toggle="collapse" data-target=".getIsObsolete .collapse">
<h2>Gets whether this objectClass is flagged as obsolete by the LDAP server.</h2>
<pre>getIsObsolete() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="getName" id="getName"></a><div class="element clickable method public getName" data-toggle="collapse" data-target=".getName .collapse">
<h2>Return the objects name.</h2>
<pre>getName($lower) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>param boolean $lower Return the name in lower case (default)</p></p>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$lower</h4></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The name</div>
</div></div>
</div>
<a name="getOID" id="getOID"></a><div class="element clickable method public getOID" data-toggle="collapse" data-target=".getOID .collapse">
<h2>getOID()
</h2>
<pre>getOID() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="setDescription" id="setDescription"></a><div class="element clickable method public setDescription" data-toggle="collapse" data-target=".setDescription .collapse">
<h2>setDescription()
</h2>
<pre>setDescription($desc) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$desc</h4></div>
</div></div>
</div>
<a name="setOID" id="setOID"></a><div class="element clickable method public setOID" data-toggle="collapse" data-target=".setOID .collapse">
<h2>setOID()
</h2>
<pre>setOID($oid) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$oid</h4></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24description" id="$description"> </a><div class="element clickable property protected $description" data-toggle="collapse" data-target=".$description .collapse">
<h2>$description</h2>
<pre>$description </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24name" id="$name"> </a><div class="element clickable property protected $name" data-toggle="collapse" data-target=".$name .collapse">
<h2>$name</h2>
<pre>$name </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24is_obsolete" id="$is_obsolete"> </a><div class="element clickable property private $is_obsolete" data-toggle="collapse" data-target=".$is_obsolete .collapse">
<h2>$is_obsolete</h2>
<pre>$is_obsolete </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24oid" id="$oid"> </a><div class="element clickable property private $oid" data-toggle="collapse" data-target=".$oid .collapse">
<h2>$oid</h2>
<pre>$oid </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
generated on 2013-06-17T21:08:54+02:00.<br></footer></div>
</div>
</body>
</html>
|