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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
<html>
<head>
<title>Package lib Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">lib</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="classtrees_lib.html" class="menu">class tree: lib</a> ]
[ <a href="elementindex_lib.html" class="menu">index: lib</a> ]
[ <a href="elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="ric_README.html">README</a></p>
</div>
<div id="todolist">
<p><a href="todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="li_PDF.html">PDF</a><br />
<a href="li_profiles.html">profiles</a><br />
<a href="li_main.html">main</a><br />
<a href="li_LDAP.html">LDAP</a><br />
<a href="li_tools.html">tools</a><br />
<a href="li_types.html">types</a><br />
<a href="li_lists.html">lists</a><br />
<a href="li_lib.html">lib</a><br />
<a href="li_modules.html">modules</a><br />
<a href="li_metaHTML.html">metaHTML</a><br />
<a href="li_selfService.html">selfService</a><br />
<a href="li_configuration.html">configuration</a><br />
<a href="li_PHP_Compat.html">PHP_Compat</a><br />
<a href="li_Net_SSH1.html">Net_SSH1</a><br />
<a href="li_Net_SSH2.html">Net_SSH2</a><br />
<a href="li_Net_SFTP.html">Net_SFTP</a><br />
<a href="li_Math_BigInteger.html">Math_BigInteger</a><br />
<a href="li_Crypt_RSA.html">Crypt_RSA</a><br />
<a href="li_Crypt_Hash.html">Crypt_Hash</a><br />
<a href="li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
<a href="li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
<a href="li_Crypt_AES.html">Crypt_AES</a><br />
<a href="li_Crypt_RC4.html">Crypt_RC4</a><br />
<a href="li_Crypt_DES.html">Crypt_DES</a><br />
<a href="li_Crypt_Random.html">Crypt_Random</a><br />
<a href="li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
<a href="li_Help.html">Help</a><br />
<a href="li_phpLDAPadmin.html">phpLDAPadmin</a><br />
<a href="li_horde-cipher.html">horde-cipher</a><br />
<a href="li_lam.html">lam</a><br />
<a href="li_default.html">default</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="lib/_lib---account.inc.html"> account.inc
</a><br>
<a href="lib/_lib---schema.inc.html"> schema.inc
</a><br>
<a href="lib/_lib---security.inc.html"> security.inc
</a><br>
<a href="lib/_lib---status.inc.html"> status.inc
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="lib/AttributeType.html">AttributeType</a><br />
<a href="lib/MatchingRule.html">MatchingRule</a><br />
<a href="lib/MatchingRuleUse.html">MatchingRuleUse</a><br />
<a href="lib/ObjectClass.html">ObjectClass</a><br />
<a href="lib/ObjectClassAttribute.html">ObjectClassAttribute</a><br />
<a href="lib/SchemaItem.html">SchemaItem</a><br />
<a href="lib/Syntax.html">Syntax</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<a name="top"></a>
<h1>Element index for package lib</h1>
[ <a href="elementindex_lib.html#a">a</a> ]
[ <a href="elementindex_lib.html#c">c</a> ]
[ <a href="elementindex_lib.html#d">d</a> ]
[ <a href="elementindex_lib.html#e">e</a> ]
[ <a href="elementindex_lib.html#f">f</a> ]
[ <a href="elementindex_lib.html#g">g</a> ]
[ <a href="elementindex_lib.html#i">i</a> ]
[ <a href="elementindex_lib.html#l">l</a> ]
[ <a href="elementindex_lib.html#m">m</a> ]
[ <a href="elementindex_lib.html#n">n</a> ]
[ <a href="elementindex_lib.html#o">o</a> ]
[ <a href="elementindex_lib.html#p">p</a> ]
[ <a href="elementindex_lib.html#r">r</a> ]
[ <a href="elementindex_lib.html#s">s</a> ]
[ <a href="elementindex_lib.html#t">t</a> ]
[ <a href="elementindex_lib.html#u">u</a> ]
[ <a href="elementindex_lib.html#_">_</a> ]
<hr />
<a name="_"></a>
<div>
<h2>_</h2>
<dl>
<dt><b>_get_raw_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#function_get_raw_schema">_get_raw_schema()</a><br> Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".</dd>
<dt><b>_get_schema_dn</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#function_get_schema_dn">_get_schema_dn()</a><br> Helper for _get_raw_schema() which fetches the DN of the schema object</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>$aliases</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$aliases">AttributeType::$aliases</a><br> An array of alias attribute names, strings</dd>
<dt><b>addAlias</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddAlias">AttributeType::addAlias()</a><br> Adds an attribute name to the alias array.</dd>
<dt><b>addChildObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddChildObjectClass">ObjectClass::addChildObjectClass()</a><br> Adds an objectClass to the list of objectClasses that inherit from this objectClass.</dd>
<dt><b>addMayAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddMayAttrs">ObjectClass::addMayAttrs()</a><br> Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.</dd>
<dt><b>addMustAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddMustAttrs">ObjectClass::addMustAttrs()</a><br> Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.</dd>
<dt><b>addRequiredByObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddRequiredByObjectClass">AttributeType::addRequiredByObjectClass()</a><br> Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.</dd>
<dt><b>addUsedByAttr</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodaddUsedByAttr">MatchingRule::addUsedByAttr()</a><br> Adds an attribute name to the list of attributes who use this MatchingRule</dd>
<dt><b>addUsedInObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddUsedInObjectClass">AttributeType::addUsedInObjectClass()</a><br> Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.</dd>
<dt><b>add_aliases_to_attrs</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionadd_aliases_to_attrs">add_aliases_to_attrs()</a><br> For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.</dd>
<dt><b>add_sup_to_attrs</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionadd_sup_to_attrs">add_sup_to_attrs()</a><br> Adds inherited values to each attributeType specified by the SUP directive.</dd>
<dt><b>array_delete</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionarray_delete">array_delete()</a><br> This function will return all values from $array without values of $values.</dd>
<dt><b>AttributeType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodAttributeType">AttributeType::AttributeType()</a><br> Creates a new AttributeType objcet from a raw LDAP AttributeType string.</dd>
<dt><b>AttributeType</b></dt>
<dd>in file schema.inc, class <a href="lib/AttributeType.html">AttributeType</a><br> Represents an LDAP AttributeType</dd>
<dt><b>account.inc</b></dt>
<dd>procedural page <a href="lib/_lib---account.inc.html">account.inc</a></dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>$children_objectclasses</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$children_objectclasses">ObjectClass::$children_objectclasses</a><br> array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)</dd>
<dt><b>cached_schema_available</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functioncached_schema_available">cached_schema_available()</a><br> Returns true if the schema for $schema_type has been cached and</dd>
<dt><b>checkClientIP</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functioncheckClientIP">checkClientIP()</a><br> Checks if the client's IP address is on the list of allowed IPs.</dd>
<dt><b>checkIfPasswordChangeIsAllowed</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functioncheckIfPasswordChangeIsAllowed">checkIfPasswordChangeIsAllowed()</a><br> Checks if passwords may be changed.</dd>
<dt><b>checkIfWriteAccessIsAllowed</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functioncheckIfWriteAccessIsAllowed">checkIfWriteAccessIsAllowed()</a><br> Checks if write access to LDAP is allowed.</dd>
<dt><b>checkPasswordStrength</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functioncheckPasswordStrength">checkPasswordStrength()</a><br> Checks if the password fulfills the password policies.</dd>
<dt><b>cleanLDAPResult</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functioncleanLDAPResult">cleanLDAPResult()</a><br> Cleans the result of an LDAP search.</dd>
<dt><b>compareDN</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functioncompareDN">compareDN()</a><br> Helper function to sort DNs.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="d"></a>
<div>
<h2>d</h2>
<dl>
<dt><b>$description</b></dt>
<dd>in file schema.inc, variable <a href="lib/SchemaItem.html#var$description">SchemaItem::$description</a><br> The description of this schema item.</dd>
<dt><b>deobfuscateText</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiondeobfuscateText">deobfuscateText()</a><br> Simple function to deobfuscate strings.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="e"></a>
<div>
<h2>e</h2>
<dl>
<dt><b>$equality</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$equality">AttributeType::$equality</a><br> The equality rule used</dd>
<dt><b>escapeDN</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionescapeDN">escapeDN()</a><br> Escapes any special characters in an LDAP DN.</dd>
<dt><b>extractDNSuffix</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionextractDNSuffix">extractDNSuffix()</a><br> Extracts the DN suffix from a given DN.</dd>
<dt><b>extractRDNAttribute</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionextractRDNAttribute">extractRDNAttribute()</a><br> Extracts the RDN attribute name from a given DN.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="f"></a>
<div>
<h2>f</h2>
<dl>
<dt><b>formatLDAPTimestamp</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionformatLDAPTimestamp">formatLDAPTimestamp()</a><br> Formats an LDAP time string (e.g. from createTimestamp).</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<dt><b>generateRandomPassword</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiongenerateRandomPassword">generateRandomPassword()</a><br> Generates a random password with 12 digits.</dd>
<dt><b>getAbstractDN</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiongetAbstractDN">getAbstractDN()</a><br> Transforms a DN into a more user friendly format.</dd>
<dt><b>getAliases</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetAliases">AttributeType::getAliases()</a><br> Gets the names of attributes that are an alias for this attribute (if any).</dd>
<dt><b>getChildObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetChildObjectClasses">ObjectClass::getChildObjectClasses()</a><br> Returns the array of objectClass names which inherit from this objectClass.</dd>
<dt><b>getdays</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiongetdays">getdays()</a><br> This function will return the days from 1.1.1970 until now.</dd>
<dt><b>getDescription</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodgetDescription">SchemaItem::getDescription()</a></dd>
<dt><b>getEquality</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetEquality">AttributeType::getEquality()</a><br> Gets this attribute's equality string</dd>
<dt><b>getIsCollective</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsCollective">AttributeType::getIsCollective()</a><br> Gets whether this attribute is collective.</dd>
<dt><b>getIsNoUserModification</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsNoUserModification">AttributeType::getIsNoUserModification()</a><br> Gets whether this attribute is not modifiable by users.</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetIsObsolete">ObjectClass::getIsObsolete()</a><br> Gets whether this objectClass is flagged as obsolete by the LDAP server.</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetIsObsolete">MatchingRule::getIsObsolete()</a><br> Gets whether this MatchingRule is flagged as obsolete by the LDAP server.</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsObsolete">AttributeType::getIsObsolete()</a><br> Gets whether this attribute has been flagged as obsolete by the LDAP server</dd>
<dt><b>getIsSingleValue</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsSingleValue">AttributeType::getIsSingleValue()</a><br> Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.</dd>
<dt><b>getLastLDAPError</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiongetLastLDAPError">getLastLDAPError()</a><br> Returns the parameters for a StatusMessage of the last LDAP search.</dd>
<dt><b>getMaxLength</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetMaxLength">AttributeType::getMaxLength()</a><br> Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.</dd>
<dt><b>getMayAttrNames</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMayAttrNames">ObjectClass::getMayAttrNames()</a><br> Gets an array of attribute names (strings) that entries of this ObjectClass must define.</dd>
<dt><b>getMayAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMayAttrs">ObjectClass::getMayAttrs()</a><br> Gets an array of AttributeType objects that entries of this ObjectClass may define.</dd>
<dt><b>getMustAttrNames</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMustAttrNames">ObjectClass::getMustAttrNames()</a><br> Gets an array of attribute names (strings) that entries of this ObjectClass must define.</dd>
<dt><b>getMustAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMustAttrs">ObjectClass::getMustAttrs()</a><br> Gets an array of AttributeType objects that entries of this ObjectClass must define.</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodgetName">ObjectClassAttribute::getName()</a><br> Gets this attribute's name</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodgetName">MatchingRuleUse::getName()</a><br> Gets this MatchingRuleUse's name</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetName">MatchingRule::getName()</a><br> Gets this MatchingRule's name.</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetName">AttributeType::getName()</a><br> Gets this attribute's name</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetName">ObjectClass::getName()</a><br> Gets the name of this objectClass (ie, "inetOrgPerson")</dd>
<dt><b>getOID</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodgetOID">SchemaItem::getOID()</a></dd>
<dt><b>getOrdering</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetOrdering">AttributeType::getOrdering()</a><br> Gets this attribute's ordering specification.</dd>
<dt><b>getRequiredByObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetRequiredByObjectClasses">AttributeType::getRequiredByObjectClasses()</a><br> Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.</dd>
<dt><b>getshells</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functiongetshells">getshells()</a><br> Returns a list of shells listed in config/shells.</dd>
<dt><b>getSource</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodgetSource">ObjectClassAttribute::getSource()</a><br> Gets the name of the ObjectClass which originally specified this attribute.</dd>
<dt><b>getSubstr</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSubstr">AttributeType::getSubstr()</a><br> Gets this attribute's substring matching specification</dd>
<dt><b>getSupAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSupAttribute">AttributeType::getSupAttribute()</a><br> Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.</dd>
<dt><b>getSupClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetSupClasses">ObjectClass::getSupClasses()</a><br> Gets the objectClass names from which this objectClass inherits.</dd>
<dt><b>getSyntaxOID</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSyntaxOID">AttributeType::getSyntaxOID()</a><br> Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.</dd>
<dt><b>getSyntaxString</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSyntaxString">AttributeType::getSyntaxString()</a><br> Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").</dd>
<dt><b>getType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetType">AttributeType::getType()</a><br> Gets this attribute's type</dd>
<dt><b>getType</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetType">ObjectClass::getType()</a><br> Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.</dd>
<dt><b>getUsage</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetUsage">AttributeType::getUsage()</a><br> Gets this attribute's usage string as defined by the LDAP server</dd>
<dt><b>getUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodgetUsedByAttrs">MatchingRuleUse::getUsedByAttrs()</a><br> Gets an array of attribute names (strings) which use this MatchingRuleUse object.</dd>
<dt><b>getUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetUsedByAttrs">MatchingRule::getUsedByAttrs()</a><br> Gets an array of attribute names (strings) which use this MatchingRule</dd>
<dt><b>getUsedInObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetUsedInObjectClasses">AttributeType::getUsedInObjectClasses()</a><br> Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.</dd>
<dt><b>get_cached_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_cached_schema">get_cached_schema()</a><br> Returns the cached array of schemaitem objects for the specified</dd>
<dt><b>get_preg</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionget_preg">get_preg()</a><br> Checks if a given value matches the selected regular expression.</dd>
<dt><b>get_schema_attribute</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_attribute">get_schema_attribute()</a><br> Gets a single AttributeType object specified by name.</dd>
<dt><b>get_schema_attributes</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_attributes">get_schema_attributes()</a><br> Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.</dd>
<dt><b>get_schema_matching_rules</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_matching_rules">get_schema_matching_rules()</a><br> Returns an array of MatchingRule objects for the specified server.</dd>
<dt><b>get_schema_objectclass</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_objectclass">get_schema_objectclass()</a><br> Gets a single ObjectClass object specified by name.</dd>
<dt><b>get_schema_objectclasses</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_objectclasses">get_schema_objectclasses()</a><br> Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.</dd>
<dt><b>get_schema_syntaxes</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionget_schema_syntaxes">get_schema_syntaxes()</a><br> Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="i"></a>
<div>
<h2>i</h2>
<dl>
<dt><b>$is_collective</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_collective">AttributeType::$is_collective</a><br> boolean: is collective?</dd>
<dt><b>$is_no_user_modification</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_no_user_modification">AttributeType::$is_no_user_modification</a><br> boolean: can use modify?</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$is_obsolete">ObjectClass::$is_obsolete</a><br> boolean value indicating whether this objectClass is obsolete</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_obsolete">AttributeType::$is_obsolete</a><br> string: the description</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$is_obsolete">MatchingRule::$is_obsolete</a><br> Boolean value indicating whether this MatchingRule is obsolete</dd>
<dt><b>$is_single_value</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_single_value">AttributeType::$is_single_value</a><br> boolean: is single valued only?</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodinitVars">SchemaItem::initVars()</a><br> Initialize class members to default values.</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/Syntax.html#methodinitVars">Syntax::initVars()</a><br> Initializes the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodinitVars">ObjectClass::initVars()</a><br> Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodinitVars">MatchingRuleUse::initVars()</a><br> Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodinitVars">MatchingRule::initVars()</a><br> Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodinitVars">AttributeType::initVars()</a><br> Initialize the class' member variables</dd>
<dt><b>in_array_ignore_case</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionin_array_ignore_case">in_array_ignore_case()</a><br> Checks if a string exists in an array, ignoring case.</dd>
<dt><b>isAliasFor</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodisAliasFor">AttributeType::isAliasFor()</a><br> Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).</dd>
<dt><b>isObfuscatedText</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionisObfuscatedText">isObfuscatedText()</a><br> Checks if the given text is obfuscated.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="l"></a>
<div>
<h2>l</h2>
<dl>
<dt><b>ldapGetDN</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionldapGetDN">ldapGetDN()</a><br> Returns the given DN.</dd>
<dt><b>lmPassword</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionlmPassword">lmPassword()</a><br> Generates the LM hash of a password.</dd>
<dt><b>logNewMessage</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functionlogNewMessage">logNewMessage()</a><br> Puts a new message in the log file.</dd>
<dt><b>logoffAndBackToLoginPage</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functionlogoffAndBackToLoginPage">logoffAndBackToLoginPage()</a><br> Logs off the user and displays the login page.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="m"></a>
<div>
<h2>m</h2>
<dl>
<dt><b>$max_length</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$max_length">AttributeType::$max_length</a><br> The max number of characters this attribute can be</dd>
<dt><b>$may_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$may_attrs">ObjectClass::$may_attrs</a><br> arrays of attribute names that this objectClass allows, but does not require</dd>
<dt><b>$must_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$must_attrs">ObjectClass::$must_attrs</a><br> arrays of attribute names that this objectClass requires</dd>
<dt><b>MatchingRule</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodMatchingRule">MatchingRule::MatchingRule()</a><br> Creates a new MatchingRule object from a raw LDAP MatchingRule string.</dd>
<dt><b>MatchingRule</b></dt>
<dd>in file schema.inc, class <a href="lib/MatchingRule.html">MatchingRule</a><br> Represents an LDAP MatchingRule</dd>
<dt><b>MatchingRuleUse</b></dt>
<dd>in file schema.inc, class <a href="lib/MatchingRuleUse.html">MatchingRuleUse</a><br> Represents an LDAP schema matchingRuleUse entry</dd>
<dt><b>MatchingRuleUse</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodMatchingRuleUse">MatchingRuleUse::MatchingRuleUse()</a></dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="n"></a>
<div>
<h2>n</h2>
<dl>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$name">ObjectClass::$name</a><br> This objectClass' name, ie "inetOrgPerson"</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClassAttribute.html#var$name">ObjectClassAttribute::$name</a><br> This Attribute's name</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRuleUse.html#var$name">MatchingRuleUse::$name</a><br> The name of the MathingRule this applies to</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$name">MatchingRule::$name</a><br> This rule's name</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$name">AttributeType::$name</a><br> The name of this attributeType</dd>
<dt><b>ntPassword</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionntPassword">ntPassword()</a><br> Generates the NT hash of a password.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="o"></a>
<div>
<h2>o</h2>
<dl>
<dt><b>$oid</b></dt>
<dd>in file schema.inc, variable <a href="lib/SchemaItem.html#var$oid">SchemaItem::$oid</a><br> The OID of this schema item.</dd>
<dt><b>$ordering</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$ordering">AttributeType::$ordering</a><br> The ordering of the attributeType</dd>
<dt><b>obfuscateText</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionobfuscateText">obfuscateText()</a><br> Simple function to obfuscate strings.</dd>
<dt><b>ObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodObjectClass">ObjectClass::ObjectClass()</a><br> Creates a new ObjectClass object given a raw LDAP objectClass string.</dd>
<dt><b>ObjectClass</b></dt>
<dd>in file schema.inc, class <a href="lib/ObjectClass.html">ObjectClass</a><br> Represents an LDAP objectClass</dd>
<dt><b>ObjectClassAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodObjectClassAttribute">ObjectClassAttribute::ObjectClassAttribute()</a><br> Creates a new ObjectClassAttribute with specified name and source objectClass.</dd>
<dt><b>ObjectClassAttribute</b></dt>
<dd>in file schema.inc, class <a href="lib/ObjectClassAttribute.html">ObjectClassAttribute</a><br> A simple class for representing AttributeTypes used only by the ObjectClass class.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>pwd_disable</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionpwd_disable">pwd_disable()</a><br> Marks an password hash as disabled and returns the new hash string</dd>
<dt><b>pwd_enable</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionpwd_enable">pwd_enable()</a><br> Marks an password hash as enabled and returns the new hash string</dd>
<dt><b>pwd_hash</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionpwd_hash">pwd_hash()</a><br> Returns the hash value of a plain text password the hash algorithm depends on the configuration file</dd>
<dt><b>pwd_is_enabled</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionpwd_is_enabled">pwd_is_enabled()</a><br> Checks if a password hash is enabled/disabled</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="r"></a>
<div>
<h2>r</h2>
<dl>
<dt><b>$required_by_object_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$required_by_object_classes">AttributeType::$required_by_object_classes</a><br> A list of object class names that require this attribute type.</dd>
<dt><b>removeAlias</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodremoveAlias">AttributeType::removeAlias()</a><br> Removes an attribute name from this attribute's alias array.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>$source</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClassAttribute.html#var$source">ObjectClassAttribute::$source</a><br> This Attribute's root</dd>
<dt><b>$sub_str</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$sub_str">AttributeType::$sub_str</a><br> Boolean: supports substring matching?</dd>
<dt><b>$sup_attribute</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$sup_attribute">AttributeType::$sup_attribute</a><br> The attribute from which this attribute inherits (if any)</dd>
<dt><b>$sup_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$sup_classes">ObjectClass::$sup_classes</a><br> array of objectClass names from which this objectClass inherits</dd>
<dt><b>$syntax</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$syntax">MatchingRule::$syntax</a><br> This rule's syntax OID</dd>
<dt><b>$syntax</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$syntax">AttributeType::$syntax</a><br> The full syntax string, ie 1.2.3.4{16}</dd>
<dt><b>schema.inc</b></dt>
<dd>procedural page <a href="lib/_lib---schema.inc.html">schema.inc</a></dd>
<dt><b>security.inc</b></dt>
<dd>procedural page <a href="lib/_lib---security.inc.html">security.inc</a></dd>
<dt><b>status.inc</b></dt>
<dd>procedural page <a href="lib/_lib---status.inc.html">status.inc</a></dd>
<dt><b>SchemaItem</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodSchemaItem">SchemaItem::SchemaItem()</a><br> Default constructor.</dd>
<dt><b>SchemaItem</b></dt>
<dd>in file schema.inc, class <a href="lib/SchemaItem.html">SchemaItem</a><br> Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</dd>
<dt><b>SCHEMA_SESSION_CACHE_ENABLED</b></dt>
<dd>in file schema.inc, constant <a href="lib/_lib---schema.inc.html#defineSCHEMA_SESSION_CACHE_ENABLED">SCHEMA_SESSION_CACHE_ENABLED</a><br> To enable/disable session-based schema caching (1: enabled, 0: disabled).</dd>
<dt><b>searchLDAP</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionsearchLDAP">searchLDAP()</a><br> Runs an LDAP search.</dd>
<dt><b>searchLDAPByAttribute</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionsearchLDAPByAttribute">searchLDAPByAttribute()</a><br> This will search the given LDAP suffix for all entries which have the given attribute.</dd>
<dt><b>searchLDAPByFilter</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionsearchLDAPByFilter">searchLDAPByFilter()</a><br> This will search the given LDAP suffix for all entries which match the given filter.</dd>
<dt><b>search_domains</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionsearch_domains">search_domains()</a><br> Returns an array with all Samba 3 domain entries under the given suffix</dd>
<dt><b>setAliases</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetAliases">AttributeType::setAliases()</a><br> Sets this attribute's list of aliases.</dd>
<dt><b>setDescription</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodsetDescription">SchemaItem::setDescription()</a></dd>
<dt><b>setIsSingleValue</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetIsSingleValue">AttributeType::setIsSingleValue()</a><br> Sets whether this attribute is single-valued.</dd>
<dt><b>setName</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetName">AttributeType::setName()</a><br> Sets this attriute's name.</dd>
<dt><b>setOID</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodsetOID">SchemaItem::setOID()</a></dd>
<dt><b>setSupAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetSupAttribute">AttributeType::setSupAttribute()</a><br> Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).</dd>
<dt><b>setType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetType">AttributeType::setType()</a><br> Sets this attribute's type.</dd>
<dt><b>setUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodsetUsedByAttrs">MatchingRule::setUsedByAttrs()</a><br> Sets the list of used_by_attrs to the array specified by $attrs;</dd>
<dt><b>set_cached_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionset_cached_schema">set_cached_schema()</a><br> Caches the specified $schema_type.</dd>
<dt><b>set_schema_cache_unavailable</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib---schema.inc.html#functionset_schema_cache_unavailable">set_schema_cache_unavailable()</a><br> Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.</dd>
<dt><b>smbflag</b></dt>
<dd>in file account.inc, function <a href="lib/_lib---account.inc.html#functionsmbflag">smbflag()</a><br> Takes a list of Samba flags and creates the corresponding flag string.</dd>
<dt><b>startSecureSession</b></dt>
<dd>in file security.inc, function <a href="lib/_lib---security.inc.html#functionstartSecureSession">startSecureSession()</a><br> Starts a session and checks the environment.</dd>
<dt><b>StatusMessage</b></dt>
<dd>in file status.inc, function <a href="lib/_lib---status.inc.html#functionStatusMessage">StatusMessage()</a><br> This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.</dd>
<dt><b>Syntax</b></dt>
<dd>in file schema.inc, method <a href="lib/Syntax.html#methodSyntax">Syntax::Syntax()</a><br> Creates a new Syntax object from a raw LDAP syntax string.</dd>
<dt><b>Syntax</b></dt>
<dd>in file schema.inc, class <a href="lib/Syntax.html">Syntax</a><br> Represents an LDAP Syntax</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="t"></a>
<div>
<h2>t</h2>
<dl>
<dt><b>$type</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$type">ObjectClass::$type</a><br> one of STRUCTURAL, ABSTRACT, or AUXILIARY</dd>
<dt><b>$type</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$type">AttributeType::$type</a><br> A string description of the syntax type (taken from the LDAPSyntaxes)</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="u"></a>
<div>
<h2>u</h2>
<dl>
<dt><b>$usage</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$usage">AttributeType::$usage</a><br> The usage string set by the LDAP schema</dd>
<dt><b>$used_by_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$used_by_attrs">MatchingRule::$used_by_attrs</a><br> An array of attribute names who use this MatchingRule</dd>
<dt><b>$used_by_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRuleUse.html#var$used_by_attrs">MatchingRuleUse::$used_by_attrs</a><br> An array of attributeType names who make use of the mathingRule</dd>
<dt><b>$used_in_object_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$used_in_object_classes">AttributeType::$used_in_object_classes</a><br> An array of objectClasses which use this attributeType (must be set by caller)</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<div class="credit">
<hr />
Documentation generated on Sun, 25 Mar 2012 19:35:18 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|
