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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
|
<html>
<head>
<title>Docs for page schema.inc</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_main.html">main</a><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Crypt_AES.html">Crypt_AES</a><br />
<a href="../li_Crypt_DES.html">Crypt_DES</a><br />
<a href="../li_Crypt_Hash.html">Crypt_Hash</a><br />
<a href="../li_Crypt_Random.html">Crypt_Random</a><br />
<a href="../li_Crypt_RC4.html">Crypt_RC4</a><br />
<a href="../li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
<a href="../li_Crypt_RSA.html">Crypt_RSA</a><br />
<a href="../li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
<a href="../li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
<a href="../li_default.html">default</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_horde-cipher.html">horde-cipher</a><br />
<a href="../li_lam.html">lam</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_Math_BigInteger.html">Math_BigInteger</a><br />
<a href="../li_metaHTML.html">metaHTML</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_Net_SFTP.html">Net_SFTP</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_PDF.html">PDF</a><br />
<a href="../li_phpLDAPadmin.html">phpLDAPadmin</a><br />
<a href="../li_PHP_Compat.html">PHP_Compat</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</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">
<h1>Procedural File: schema.inc</h1>
Source Location: /lib/schema.inc<br /><br />
<br>
<br>
<div class="contents">
<h2>Classes:</h2>
<dt><a href="../lib/SchemaItem.html">SchemaItem</a></dt>
<dd>Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</dd>
<dt><a href="../lib/ObjectClass.html">ObjectClass</a></dt>
<dd>Represents an LDAP objectClass</dd>
<dt><a href="../lib/ObjectClassAttribute.html">ObjectClassAttribute</a></dt>
<dd>A simple class for representing AttributeTypes used only by the ObjectClass class.</dd>
<dt><a href="../lib/AttributeType.html">AttributeType</a></dt>
<dd>Represents an LDAP AttributeType</dd>
<dt><a href="../lib/Syntax.html">Syntax</a></dt>
<dd>Represents an LDAP Syntax</dd>
<dt><a href="../lib/MatchingRule.html">MatchingRule</a></dt>
<dd>Represents an LDAP MatchingRule</dd>
<dt><a href="../lib/MatchingRuleUse.html">MatchingRuleUse</a></dt>
<dd>Represents an LDAP schema matchingRuleUse entry</dd>
</div><br /><br />
<h2>Page Details:</h2>
Classes and functions for fetching and parsing schema from an LDAP server.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b> </td><td>The phpLDAPadmin development team</td>
</tr>
<tr>
<td><b>author:</b> </td><td>Roland Gruber</td>
</tr>
</table>
</div>
<br /><br />
<br /><br />
<br /><br />
<hr />
<a name="defineSCHEMA_SESSION_CACHE_ENABLED"></a>
<h3>SCHEMA_SESSION_CACHE_ENABLED <span class="smalllinenumber">[line 34]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>SCHEMA_SESSION_CACHE_ENABLED = 1</code>
</td></tr></table>
</td></tr></table>
To enable/disable session-based schema caching (1: enabled, 0: disabled).<br /><br /> <br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<br />
<hr />
<a name="functionadd_aliases_to_attrs"></a>
<h3>add_aliases_to_attrs <span class="smalllinenumber">[line 1702]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void add_aliases_to_attrs(
&$attrs)</code>
</td></tr></table>
</td></tr></table><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'.<br /><br /><p>This function will create a unique entry for 'gn' and 'givenName'.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>&$attrs</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionadd_sup_to_attrs"></a>
<h3>add_sup_to_attrs <span class="smalllinenumber">[line 1729]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void add_sup_to_attrs(
&$attrs, &$attrs_oid)</code>
</td></tr></table>
</td></tr></table><br />
Adds inherited values to each attributeType specified by the SUP directive.<br /><br /><p>Supports infinite levels of inheritance. Bug 856832: require a second paramter that has all attributes indexed by OID</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>&$attrs</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>&$attrs_oid</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functioncached_schema_available"></a>
<h3>cached_schema_available <span class="smalllinenumber">[line 1938]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void cached_schema_available(
$schema_type)</code>
</td></tr></table>
</td></tr></table><br />
Returns true if the schema for $schema_type has been cached and<br /><br /><p>is availble. $schema_type may be one of (lowercase) the following: objectclasses attributetypes ldapsyntaxes matchingrules matchingruleuse Note that _get_raw_schema() takes a similar parameter.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$schema_type</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_cached_schema"></a>
<h3>get_cached_schema <span class="smalllinenumber">[line 1975]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void get_cached_schema(
$schema_type)</code>
</td></tr></table>
</td></tr></table><br />
Returns the cached array of schemaitem objects for the specified<br /><br /><p>$schema_type. For list of valid $schema_type values, see above schema_cache_available(). Note that internally, this function utilizes a two-layer cache, one in memory using a static variable for multiple calls within the same page load, and one in a session for multiple calls within the same user session (spanning multiple page loads).</p><p>Returns an array of SchemaItem objects on success or false on failure.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$schema_type</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_attribute"></a>
<h3>get_schema_attribute <span class="smalllinenumber">[line 1589]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code><a href="../lib/AttributeType.html">AttributeType</a> get_schema_attribute(
$attr_name, [string $dn = null], [ $use_cache = true], string $oclass_name)</code>
</td></tr></table>
</td></tr></table><br />
Gets a single AttributeType object specified by name.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The specified AttributeType object or false on error.</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/_lib---schema.inc.html#functionget_schema_attributes">get_schema_attributes()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/AttributeType.html">AttributeType</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$oclass_name</b> </td>
<td>The name of the AttributeType to fetch.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$attr_name</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_attributes"></a>
<h3>get_schema_attributes <span class="smalllinenumber">[line 1610]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array get_schema_attributes(
[string $dn = null], [ $use_cache = true])</code>
</td></tr></table>
</td></tr></table><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.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of AttributeType objects.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_matching_rules"></a>
<h3>get_schema_matching_rules <span class="smalllinenumber">[line 1843]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void get_schema_matching_rules(
[ $dn = null], [ $use_cache = true])</code>
</td></tr></table>
</td></tr></table><br />
Returns an array of MatchingRule objects for the specified server.<br /><br /><p>The key of each entry is the OID of the matching rule.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_objectclass"></a>
<h3>get_schema_objectclass <span class="smalllinenumber">[line 1565]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code><a href="../lib/ObjectClass.html">ObjectClass</a> get_schema_objectclass(
string $oclass_name, [string $dn = null], [ $use_cache = true])</code>
</td></tr></table>
</td></tr></table><br />
Gets a single ObjectClass object specified by name.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The specified ObjectClass object or false on error.</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/_lib---schema.inc.html#functionget_schema_objectclasses">get_schema_objectclasses()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/ObjectClass.html">ObjectClass</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$oclass_name</b> </td>
<td>The name of the objectClass to fetch.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_objectclasses"></a>
<h3>get_schema_objectclasses <span class="smalllinenumber">[line 1525]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array get_schema_objectclasses(
[string $dn = null], [ $use_cache = true])</code>
</td></tr></table>
</td></tr></table><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.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of ObjectClass objects.</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/_lib---schema.inc.html#functionget_schema_objectclass">get_schema_objectclass()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../lib/ObjectClass.html">ObjectClass</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_schema_syntaxes"></a>
<h3>get_schema_syntaxes <span class="smalllinenumber">[line 1897]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void get_schema_syntaxes(
[ $dn = null], [ $use_cache = true])</code>
</td></tr></table>
</td></tr></table><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.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$use_cache</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionset_cached_schema"></a>
<h3>set_cached_schema <span class="smalllinenumber">[line 2006]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void set_cached_schema(
$schema_type, $schema_items)</code>
</td></tr></table>
</td></tr></table><br />
Caches the specified $schema_type.<br /><br /><p>$schema_items should be an array of SchemaItem instances (ie, an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse, or MatchingRule objects.</p><p>Returns true on success of false on failure.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$schema_type</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$schema_items</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionset_schema_cache_unavailable"></a>
<h3>set_schema_cache_unavailable <span class="smalllinenumber">[line 2035]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void set_schema_cache_unavailable(
)</code>
</td></tr></table>
</td></tr></table><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.<br /><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="function_get_raw_schema"></a>
<h3>_get_raw_schema <span class="smalllinenumber">[line 1334]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>an _get_raw_schema(
$schema_to_fetch $schema_to_fetch, [$dn $dn = ''])</code>
</td></tr></table>
</td></tr></table><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".<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>array of strings of this form: Array ( [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">$schema_to_fetch </td>
<td><b>$schema_to_fetch</b> </td>
<td>- A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive.</td>
</tr>
<tr>
<td class="type">$dn </td>
<td><b>$dn</b> </td>
<td>(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="function_get_schema_dn"></a>
<h3>_get_schema_dn <span class="smalllinenumber">[line 1267]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _get_schema_dn(
string $dn, [bool $debug = false])</code>
</td></tr></table>
</td></tr></table><br />
Helper for _get_raw_schema() which fetches the DN of the schema object<br /><br /><p>in an LDAP server based on a DN. Entries should set the subSchemaSubEntry attribute pointing to the DN of the server schema. You can specify the DN whose subSchemaSubEntry you wish to retrieve of specify an empty string to fetch the subScehamSubEntry from the Root DSE.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The DN of the entry which houses this LDAP server's schema.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN.</td>
</tr>
<tr>
<td class="type">bool </td>
<td><b>$debug</b> </td>
<td>Switch to true to see some nice and copious output. :)</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<div class="credit">
<hr />
Documentation generated on Sun, 25 Mar 2012 19:35:56 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|
