# Zend_Ldap_Node_Schema

Die folgenden Methoden sind für alle Hersteller-spezifischen Unterklassen vorhanden.

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

## Zend_Ldap_Node_Schema API

Methode | Beschreibung
--- | ---
`Zend_Ldap_Dn getDn()` | Holt den DN des aktuellen Nodes als `Zend_Ldap_Dn`.
`string getDnString(string $caseFold)` | Holt den DN des aktuellen Nodes als String.
`array getDnArray(string $caseFold)` | Holt den DN des aktuellen Nodes als Array.
`string getRdnString(string $caseFold)` | Holt den RDN des aktuellen Nodes als String.
`array getRdnArray(string $caseFold)` | Holt den RDN des aktuellen Nodes als Array.
`array getObjectClass()` | Gibt die objectClass des aktuellen Nodes zurück.
`string toString()` | Gibt den DN des aktuellen Nodes zurück - verweist auf `Zend_Ldap_Dn::getDnString()`.
`string __toString()` | Castet auf eine String Darstellung - leitet auf `Zend_Ldap_Dn::toString()` weiter.
`array toArray(boolean $includeSystemAttributes)` | Gibt eine Array Darstellung des aktuellen Nodes zurück. Wenn `$includeSystemAttributes` `FALSE` ist (Standardmäßig ist es `TRUE`) werden die System spezifischen Attribute vom Array entfernt. Anders als `Zend_Ldap_Node_Schema::getAttributes()` enthält das resultierende Array den DN mit dem Schlüssel `'dn'`.
`string toJson(boolean $includeSystemAttributes)` | Gibt eine JSON Darstellung des aktuellen Nodes zurück indem `Zend_Ldap_Node_Schema::toArray()` verwendet wird.
`array getData(boolean $includeSystemAttributes)` | Gibt die Attribute des Nodes zurück. Das Array enthält alle Attribute in Ihrem internen Format (keine Konvertierung).

`boolean existsAttribute(string $name, boolean $emptyExists)`

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

`boolean attributeHasValue(string $name, mixed|array $value)` | Prüft ob angegebene Werte im Attribut existieren. Die Methode gibt nur dann `FALSE` zurück wenn alle Werte in `$value` auch im Attribut enthalten sind. Der Vergleich wird strikt durchgeführt (er respektiert den Datentyp).
`integer count()` | Gibt die Anzahl der Attribute im Node zurück. Implementiert Countable.
`mixed getAttribute(string $name, integer|null $index)` | Holt ein LDAP Attribut. Datenkonvertierung wird angewendet indem `Zend_Ldap_Attribute::getAttribute()` verwendet wird.
`array getAttributes(boolean $includeSystemAttributes)` | Holt alle Attribute des Nodes. Wenn `$includeSystemAttributes` `FALSE` ist (der Standardwert ist `TRUE`) werden systemspezifische Attribute vom Array entfernt.
`array|integer getDateTimeAttribute(string $name, integer|null $index)` | Holt ein LDAP date/time Attribut. Datenkonvertierung wird angewendet indem `Zend_Ldap_Attribute::getDateTimeAttribute()` verwendet wird.
`Zend_Ldap_Node_Schema reload(Zend_Ldap $ldap)` | Lädt die Attribute des aktuellen Nodes neu vom angegebenen LDAP Server.
`Zend_Ldap_Node_Schema create(Zend_Ldap $ldap)` | Factory Methode um den Schema Node zu erstellen.
`array getAttributeTypes()` | Holt den Typ des Attributs als Array von ``.
`array getObjectClasses()` | Holt das Klassenobjekt als Array von `Zend_Ldap_Node_Schema_ObjectClass_Interface`.

## Zend_Ldap_Node_Schema_AttributeType_Interface API

Methode | Beschreibung
--- | ---
`string getName()` | Holt den Namen des Attributs.
`string getOid()` | Holt die OID des Attributs.
`string getSyntax()` | Holt die Syntax des Attributs.
`int|null getMaxLength()` | Holt die maximale Länge des Attributs.
`boolean isSingleValued()` | Gibt zurück ob das Attribut ein einzelner Wert ist.
`string getDescription()` | holt die Beschreibung des Attributs

## Zend_Ldap_Node_Schema_ObjectClass_Interface API

Methode | Beschreibung
--- | ---
`string getName()` | Gibt den Namen von objectClass zurück.
`string getOid()` | Gibt das OID von objectClass zurück.
`array getMustContain()` | Gibt die Attribute zurück welche diese objectClass enthalten muß.
`array getMayContain()` | Gibt die Attribute zurück welche diese objectClass enthalten kann.
`string getDescription()` | Gibt die Beschreibung des Attributs zurück

`integer getType()`

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

`Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_UNKNOWN`

  für unbekannte Klassentypen

`Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_STRUCTURAL`

  für strukturelle Klassen

`Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_ABSTRACT`

  für abstrakte Klassen

`Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_AUXILIARY`

  für Hilfsklassen

`array getParentClasses()` | Gibt die elterliche objectClass dieser Klasse zurück. Diese enthalten strukturelle, abstrakte und Hilfsklassen.

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

## Zend_Ldap_Node_Schema_Item API

Methode | Beschreibung
--- | ---
`array getData()` | Holt die darunterliegenden Daten vom Schema Informations Node.
`integer count()` | Gibt die Anzahl der Attribute für diesen Schema Informations Node zurück. Implementiert Countable.

## OpenLDAP

Zusätzlich können die üblichen Methoden von oben auf Instanzen von `Zend_Ldap_Node_Schema_OpenLDAP` angewendet werden.

### Zend_Ldap_Node_Schema_OpenLDAP API

Methode | Beschreibung
--- | ---
`array getLdapSyntaxes()` | Holt die LDAP Syntaxe.
`array getMatchingRules()` | Holt die passenden Regeln.
`array getMatchingRuleUse()` | Holt die verwendete passende Regel.

### Zend_Ldap_Node_Schema_AttributeType_OpenLDAP API

Methode | Beschreibung
--- | ---
`Zend_Ldap_Node_Schema_AttributeType_OpenLdap|null getParent()` | Gibt den Type des Elternattributs vom geerbten Baum wenn einer existiert.

### Zend_Ldap_Node_Schema_ObjectClass_OpenLDAP API

Methode | Beschreibung
--- | ---
`array getParents()` | Gibt die elterlichen Objektklassen im vererbten Baum zurück wenn einer existiert. Das zurückgegebene Array ist ein Array von `Zend_Ldap_Node_Schema_ObjectClass_OpenLdap`.

## ActiveDirectory

### Browsen im Schema von ActiveDirectory Servern

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 nicht für Microsoft ActiveDirectory Server vorhanden.

`Zend_Ldap_Node_Schema_ActiveDirectory` bietet keine zusätzlichen Methoden an.

### Zend_Ldap_Node_Schema_AttributeType_ActiveDirectory API

`Zend_Ldap_Node_Schema_AttributeType_ActiveDirectory` bietet keine zusätzlichen Methoden an.

### Zend_Ldap_Node_Schema_ObjectClass_ActiveDirectory API

`Zend_Ldap_Node_Schema_ObjectClass_ActiveDirectory` bietet keine zusätzlichen Methoden an.