File: Zend_Ldap-API-Ldap-Node-Schema.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (543 lines) | stat: -rw-r--r-- 21,604 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.ldap.api.reference.zend-ldap-node-schema">
    <title>Zend_Ldap_Node_Schema</title>

    <para>
        Die folgenden Methoden sind für alle Hersteller-spezifischen Unterklassen vorhanden.
    </para>

    <para>
        <code>Zend_Ldap_Node_Schema</code> enthält die magischen Methoden <code>__get()</code> und
        <code>__isset()</code> um auf die Attribute durch Ihren Namen zugreifen zu können. Die
        verweisen auf <code>Zend_Ldap_Node_Schema::getAttribute()</code> und
        <code>Zend_Ldap_Node_Schema::existsAttribute()</code>. <code>__set()</code> und
        <code>__unset()</code> sind auch implementiert, werfen aber eine
        <code>BadMethodCallException</code> da Änderungen auf RootDSE Nodes nicht erlaubt sind.
        Weiters implementiert die Klasse <code>ArrayAccess</code> für Array-Artigen Zugriff und
        wirft eine <code>BadMethodCallException</code> aus den bekannten Gründen.
    </para>

    <table id="zend.ldap.api.reference.zend-ldap-node-schema.table">
        <title>Zend_Ldap_Node_Schema API</title>

        <tgroup cols="2">
            <thead>
                <row>
                    <entry>Methode</entry>
                    <entry>Beschreibung</entry>
                </row>
            </thead>

            <tbody>
                <row>
                    <entry><code>Zend_Ldap_Dn getDn()</code></entry>

                    <entry>
                        Holt den DN des aktuellen Nodes als <classname>Zend_Ldap_Dn</classname>.
                    </entry>
                </row>

                <row>
                    <entry><code>string getDnString(string $caseFold)</code></entry>
                    <entry>Holt den DN des aktuellen Nodes als String.</entry>
                </row>

                <row>
                    <entry><code>array getDnArray(string $caseFold)</code></entry>
                    <entry>Holt den DN des aktuellen Nodes als Array.</entry>
                </row>

                <row>
                    <entry><code>string getRdnString(string $caseFold)</code></entry>
                    <entry>Holt den <acronym>RDN</acronym> des aktuellen Nodes als String.</entry>
                </row>

                <row>
                    <entry><code>array getRdnArray(string $caseFold)</code></entry>
                    <entry>Holt den <acronym>RDN</acronym> des aktuellen Nodes als Array.</entry>
                </row>

                <row>
                    <entry><code>array getObjectClass()</code></entry>
                    <entry>Gibt die objectClass des aktuellen Nodes zurück.</entry>
                </row>

                <row>
                    <entry><code>string toString()</code></entry>

                    <entry>
                        Gibt den DN des aktuellen Nodes zurück - verweist auf
                        <code>Zend_Ldap_Dn::getDnString()</code>.
                    </entry>
                </row>

                <row>
                    <entry><code>string __toString()</code></entry>

                    <entry>
                        Castet auf eine String Darstellung - leitet auf
                        <code>Zend_Ldap_Dn::toString()</code> weiter.
                    </entry>
                </row>

                <row>
                    <entry><code>array toArray(boolean $includeSystemAttributes)</code></entry>

                    <entry>
                        Gibt eine Array Darstellung des aktuellen Nodes zurück. Wenn
                        <code>$includeSystemAttributes</code> <constant>FALSE</constant> ist
                        (Standardmäßig ist es <constant>TRUE</constant>) werden die System
                        spezifischen Attribute vom Array entfernt. Anders als
                        <code>Zend_Ldap_Node_Schema::getAttributes()</code> enthält das
                        resultierende Array den DN mit dem Schlüssel <code>'dn'</code>.
                    </entry>
                </row>

                <row>
                    <entry><code>string toJson(boolean $includeSystemAttributes)</code></entry>

                    <entry>
                        Gibt eine <acronym>JSON</acronym> Darstellung des aktuellen Nodes zurück
                        indem <code>Zend_Ldap_Node_Schema::toArray()</code> verwendet wird.
                    </entry>
                </row>

                <row>
                    <entry><code>array getData(boolean $includeSystemAttributes)</code></entry>

                    <entry>
                        Gibt die Attribute des Nodes zurück. Das Array enthält alle Attribute in
                        Ihrem internen Format (keine Konvertierung).
                    </entry>
                </row>

                <row>
                    <entry>
                        <code>boolean existsAttribute(string $name, boolean $emptyExists)</code>
                    </entry>

                    <entry>
                        Prüft ob ein angegebenes Attribut existiert. Wenn <code>$emptyExists</code>
                        <constant>FALSE</constant> ist werden leere Attribute (welche nur array()
                        enthalten) als nicht existierend betrachtet und geben
                        <constant>FALSE</constant> zurück. Wenn <code>$emptyExists</code>
                        <constant>TRUE</constant> ist werden leere Attribute als existent betrachtet
                        und geben <constant>TRUE</constant> zurück. In diesem Fall gibt die Methode
                        nur dann <constant>FALSE</constant> zurück wenn der Name des Attributs in
                        der Sammlung der Schlüssel fehlt.
                    </entry>
                </row>

                <row>
                    <entry>
                        <code>boolean attributeHasValue(string $name, mixed|array $value)</code>
                    </entry>

                    <entry>
                        Prüft ob angegebene Werte im Attribut existieren. Die Methode gibt nur dann
                        <constant>FALSE</constant> zurück wenn alle Werte in <code>$value</code>
                        auch im Attribut enthalten sind. Der Vergleich wird strikt durchgeführt (er
                        respektiert den Datentyp).
                    </entry>
                </row>

                <row>
                    <entry><code>integer count()</code></entry>

                    <entry>
                        Gibt die Anzahl der Attribute im Node zurück. Implementiert Countable.
                    </entry>
                </row>

                <row>
                    <entry>
                        <code>mixed getAttribute(string $name, integer|null $index)</code>
                    </entry>

                    <entry>
                        Holt ein <acronym>LDAP</acronym> Attribut. Datenkonvertierung wird
                        angewendet indem <code>Zend_Ldap_Attribute::getAttribute()</code> verwendet
                        wird.
                    </entry>
                </row>

                <row>
                    <entry>
                        <code>array getAttributes(boolean $includeSystemAttributes)</code>
                    </entry>

                    <entry>
                        Holt alle Attribute des Nodes. Wenn <code>$includeSystemAttributes</code>
                        <constant>FALSE</constant> ist (der Standardwert ist
                        <constant>TRUE</constant>) werden systemspezifische Attribute vom Array
                        entfernt.
                    </entry>
                </row>

                <row>
                    <entry>
                        <code>array|integer getDateTimeAttribute(string $name,
                            integer|null $index)</code>
                    </entry>

                    <entry>
                        Holt ein <acronym>LDAP</acronym> date/time Attribut. Datenkonvertierung wird
                        angewendet indem <code>Zend_Ldap_Attribute::getDateTimeAttribute()</code>
                        verwendet wird.
                    </entry>
                </row>

                <row>
                    <entry><code>Zend_Ldap_Node_Schema reload(Zend_Ldap $ldap)</code></entry>

                    <entry>
                        Lädt die Attribute des aktuellen Nodes neu vom angegebenen
                        <acronym>LDAP</acronym> Server.
                    </entry>
                </row>

                <row>
                    <entry>
                        <emphasis><code>Zend_Ldap_Node_Schema create(Zend_Ldap
                            $ldap)</code></emphasis>
                    </entry>

                    <entry>Factory Methode um den Schema Node zu erstellen.</entry>
                </row>

                <row>
                    <entry><code>array getAttributeTypes()</code></entry>
                    <entry>Holt den Typ des Attributs als Array von <code/>.</entry>
                </row>

                <row>
                    <entry><code>array getObjectClasses()</code></entry>

                    <entry>
                        Holt das Klassenobjekt als Array von
                        <code>Zend_Ldap_Node_Schema_ObjectClass_Interface</code>.
                    </entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <table id="zend.ldap.api.reference.zend-ldap-node-schema.attributetype-interface.table">
        <title>Zend_Ldap_Node_Schema_AttributeType_Interface API</title>

        <tgroup cols="2">
            <thead>
                <row>
                    <entry>Methode</entry>
                    <entry>Beschreibung</entry>
                </row>
            </thead>

            <tbody>
                <row>
                    <entry><code>string getName()</code></entry>
                    <entry>Holt den Namen des Attributs.</entry>
                </row>

                <row>
                    <entry><code>string getOid()</code></entry>
                    <entry>Holt die <acronym>OID</acronym> des Attributs.</entry>
                </row>

                <row>
                    <entry><code>string getSyntax()</code></entry>
                    <entry>Holt die Syntax des Attributs.</entry>
                </row>

                <row>
                    <entry><code>int|null getMaxLength()</code></entry>
                    <entry>Holt die maximale Länge des Attributs.</entry>
                </row>

                <row>
                    <entry><code>boolean isSingleValued()</code></entry>
                    <entry>Gibt zurück ob das Attribut ein einzelner Wert ist.</entry>
                </row>

                <row>
                    <entry><code>string getDescription()</code></entry>
                    <entry>holt die Beschreibung des Attributs</entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <table id="zend.ldap.api.reference.zend-ldap-node-schema.objectclass-interface.table">
        <title>Zend_Ldap_Node_Schema_ObjectClass_Interface API</title>

        <tgroup cols="2">
            <thead>
                <row>
                    <entry>Methode</entry>
                    <entry>Beschreibung</entry>
                </row>
            </thead>

            <tbody>
                <row>
                    <entry><code>string getName()</code></entry>
                    <entry>Gibt den Namen von objectClass zurück.</entry>
                </row>

                <row>
                    <entry><code>string getOid()</code></entry>
                    <entry>Gibt das <acronym>OID</acronym> von objectClass zurück.</entry>
                </row>

                <row>
                    <entry><code>array getMustContain()</code></entry>

                    <entry>
                        Gibt die Attribute zurück welche diese objectClass enthalten muß.
                    </entry>
                </row>

                <row>
                    <entry><code>array getMayContain()</code></entry>

                    <entry>
                        Gibt die Attribute zurück welche diese objectClass enthalten kann.
                    </entry>
                </row>

                <row>
                    <entry><code>string getDescription()</code></entry>
                    <entry>Gibt die Beschreibung des Attributs zurück</entry>
                </row>

                <row>
                    <entry><code>integer getType()</code></entry>

                    <entry>
                        Gibt den Typ von objectClass zurück. Diese Methode gibt einen der folgenden
                        Werte zurück:

                        <variablelist>
                            <varlistentry>
                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_UNKNOWN</code></term>
                                <listitem><para>für unbekannte Klassentypen</para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_STRUCTURAL</code></term>
                                <listitem><para>für strukturelle Klassen</para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_ABSTRACT</code></term>
                                <listitem><para>für abstrakte Klassen</para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_AUXILIARY</code></term>
                                <listitem><para>für Hilfsklassen</para></listitem>
                            </varlistentry>
                        </variablelist>
                    </entry>
                </row>

                <row>
                    <entry><code>array getParentClasses()</code></entry>

                    <entry>
                        Gibt die elterliche objectClass dieser Klasse zurück. Diese enthalten
                        strukturelle, abstrakte und Hilfsklassen.
                    </entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <para>
        Klassen welche Attributtypen repräsentieren und auch Objektklassen erweitern
        <code>Zend_Ldap_Node_Schema_Item</code> welche einige Kernmethoden bietet um auf eigene
        Attribute im darunterliegenden <acronym>LDAP</acronym> Node zugreifen zu können.
        <code>Zend_Ldap_Node_Schema_Item</code> enthält die magischen Methoden
        <code>__get()</code> und <code>__isset()</code> um auf die Attribute mit Ihrem Namen
        zugreifen zu können. Weiters implementiert die Klasse <code>ArrayAccess</code> für einen
        Array-artigen Zugriff auf die Attribute. <code>offsetSet()</code> und
        <code>offsetUnset()</code> werfen eine <code>BadMethodCallException</code> da Änderungen
        in Schema Informations Nodes nicht erlaubt sind.
    </para>

    <table id="zend.ldap.api.reference.zend-ldap-node-schema.schema-item.table">
        <title>Zend_Ldap_Node_Schema_Item API</title>

        <tgroup cols="2">
            <thead>
                <row>
                    <entry>Methode</entry>
                    <entry>Beschreibung</entry>
                </row>
            </thead>

            <tbody>
                <row>
                    <entry><code>array getData()</code></entry>
                    <entry>Holt die darunterliegenden Daten vom Schema Informations Node.</entry>
                </row>

                <row>
                    <entry><code>integer count()</code></entry>

                    <entry>
                        Gibt die Anzahl der Attribute für diesen Schema Informations Node zurück.
                        Implementiert Countable.
                    </entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <sect4 id="zend.ldap.api.reference.zend-ldap-node-schema.openldap">
        <title>OpenLDAP</title>

        <para>
            Zusätzlich können die üblichen Methoden von oben auf Instanzen von
            <code>Zend_Ldap_Node_Schema_OpenLDAP</code> angewendet werden.
        </para>

        <table id="zend.ldap.api.reference.zend-ldap-node-schema.openldap.table">
            <title>Zend_Ldap_Node_Schema_OpenLDAP API</title>

            <tgroup cols="2">
                <thead>
                    <row>
                        <entry>Methode</entry>
                        <entry>Beschreibung</entry>
                    </row>
                </thead>

                <tbody>
                    <row>
                        <entry><code>array getLdapSyntaxes()</code></entry>
                        <entry>Holt die <acronym>LDAP</acronym> Syntaxe.</entry>
                    </row>

                    <row>
                        <entry><code>array getMatchingRules()</code></entry>
                        <entry>Holt die passenden Regeln.</entry>
                    </row>

                    <row>
                        <entry><code>array getMatchingRuleUse()</code></entry>
                        <entry>Holt die verwendete passende Regel.</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>

        <table
            id="zend.ldap.api.reference.zend-ldap-node-schema.openldap.attributetype-interface.table">
            <title>Zend_Ldap_Node_Schema_AttributeType_OpenLDAP API</title>

            <tgroup cols="2">
                <thead>
                    <row>
                        <entry>Methode</entry>
                        <entry>Beschreibung</entry>
                    </row>
                </thead>

                <tbody>
                    <row>
                        <entry>
                            <code>Zend_Ldap_Node_Schema_AttributeType_OpenLdap|null
                                getParent()</code>
                        </entry>

                        <entry>
                            Gibt den Type des Elternattributs vom geerbten Baum wenn einer
                            existiert.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </table>

        <table
            id="zend.ldap.api.reference.zend-ldap-node-schema.openldap.objectclass-interface.table">
            <title>Zend_Ldap_Node_Schema_ObjectClass_OpenLDAP API</title>

            <tgroup cols="2">
                <thead>
                    <row>
                        <entry>Methode</entry>
                        <entry>Beschreibung</entry>
                    </row>
                </thead>

                <tbody>
                    <row>
                        <entry><code>array getParents()</code></entry>

                        <entry>
                            Gibt die elterlichen Objektklassen im vererbten Baum zurück wenn einer
                            existiert. Das zurückgegebene Array ist ein Array von
                            <code>Zend_Ldap_Node_Schema_ObjectClass_OpenLdap</code>.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
    </sect4>

    <sect4 id="zend.ldap.api.reference.zend-ldap-node-schema.activedirectory">
        <title>ActiveDirectory</title>

        <note>
            <title>Browsen im Schema von ActiveDirectory Servern</title>

            <para>
                Durch eine Einschränkung in Microsoft ActiveDirectory Servern betreffend der Anzahl
                an einträgen die bei generellen Such Routinen zurückgegeben werden, und wegen der
                Struktur des ActiveDirectory Schema Repositories, ist das Schema Browsen aktuell
                <emphasis>nicht</emphasis> für Microsoft ActiveDirectory Server vorhanden.
            </para>
        </note>

        <para>
            <code>Zend_Ldap_Node_Schema_ActiveDirectory</code> bietet keine zusätzlichen Methoden
            an.
        </para>

        <table
            id="zend.ldap.api.reference.zend-ldap-node-schema.activedirectory.attributetype-interface.table">
            <title>Zend_Ldap_Node_Schema_AttributeType_ActiveDirectory API</title>

            <tgroup cols="1">
                <tbody>
                    <row>
                        <entry>
                            <code>Zend_Ldap_Node_Schema_AttributeType_ActiveDirectory</code>
                            bietet keine zusätzlichen Methoden an.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </table>

        <table
            id="zend.ldap.api.reference.zend-ldap-node-schema.activedirectory.objectclass-interface.table">
            <title>Zend_Ldap_Node_Schema_ObjectClass_ActiveDirectory API</title>

            <tgroup cols="1">
                <tbody>
                    <row>
                        <entry>
                            <code>Zend_Ldap_Node_Schema_ObjectClass_ActiveDirectory</code>
                            bietet keine zusätzlichen Methoden an.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
    </sect4>
</sect3>