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 611 612 613 614
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.ldap.api.reference.zend-ldap-node">
<title>Zend_Ldap_Node</title>
<para>
<classname>Zend_Ldap_Node</classname> enthält die magischen Zugriffsmethoden
<methodname>__set()</methodname>, <methodname>__get()</methodname>,
<methodname>__unset()</methodname> und <methodname>__isset()</methodname> um auf die
Attribute mit Ihrem Namen zugreifen zu können. Sie verweisen auf
<methodname>Zend_Ldap_Node::setAttribute()</methodname>,
<methodname>Zend_Ldap_Node::getAttribute()</methodname>,
<methodname>Zend_Ldap_Node::deleteAttribute()</methodname> und
<methodname>Zend_Ldap_Node::existsAttribute()</methodname>. Weiters implementiert die Klasse
<code>ArrayAccess</code> für einen Array-artigen Zugriff auf die Attribute.
<classname>Zend_Ldap_Node</classname> implementiert auch <code>Iterator</code> und
<code>RecursiveIterator</code> um rekursive Suchen im Baum zu erlauben.
</para>
<table id="zend.ldap.api.reference.zend-ldap-node.table">
<title>Zend_Ldap_Node API</title>
<tgroup cols="2">
<thead>
<row>
<entry>Methode</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry><code>Zend_Ldap getLdap()</code></entry>
<entry>
Gibt die aktuelle <acronym>LDAP</acronym> Verbindung zurück. Wirft eine
<classname>Zend_Ldap_Exception</classname> wenn der aktuelle Node im
abgehängten Modus ist (nicht mit einer <classname>Zend_Ldap</classname>
Instanz verbunden).
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node attachLdap(Zend_Ldap$ldap)</code></entry>
<entry>
Hängt den aktuellen Node an die <classname>Zend_Ldap</classname> Instanz
<varname>$ldap</varname> an. Wirft eine
<classname>Zend_Ldap_Exception</classname> wenn <varname>$ldap</varname>
für den aktuellen Node nicht verantwortlich ist (wenn der Node kein Kind
der Basis DN von <varname>$ldap</varname> ist).
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node detachLdap()</code></entry>
<entry>Hängt den Node von der <acronym>LDAP</acronym> Verbindung ab.</entry>
</row>
<row>
<entry><code>boolean isAttached()</code></entry>
<entry>
Prüft ob der aktuelle Node an eine <acronym>LDAP</acronym> Verbindung
angehängt ist.
</entry>
</row>
<row>
<entry>
<emphasis>
<code>Zend_Ldap_Node create(string|array|Zend_Ldap_Dn $dn, array
$objectClass)</code>
</emphasis>
</entry>
<entry>
Factory Methode um einen neuen abgehängten
<classname>Zend_Ldap_Node</classname> für einen angegebenen DN zu erstellen.
Erstellt einen neuen <classname>Zend_Ldap_Node</classname> mit dem DN
<varname>$dn</varname> und der Objektklasse <varname>$objectClass</varname>.
</entry>
</row>
<row>
<entry>
<emphasis>
<code>Zend_Ldap_Node fromLdap(string|array|Zend_Ldap_Dn $dn, Zend_Ldap
$ldap)</code>
</emphasis>
</entry>
<entry>
Factory Methode um einen angehängten <classname>Zend_Ldap_Node</classname>
für einen angegebenen DN zu erstellen. Lädt einen existierenden
<classname>Zend_Ldap_Node</classname> mit dem DN <varname>$dn</varname> von
der <acronym>LDAP</acronym> Verbindung <varname>$ldap</varname>.
</entry>
</row>
<row>
<entry>
<emphasis>
<code>Zend_Ldap_Node fromArray((array $data, boolean
$fromDataSource)</code>
</emphasis>
</entry>
<entry>
Factory Methode um einen abgehängten <classname>Zend_Ldap_Node</classname>
aus den Array Daten <varname>$data</varname> zu erstellen. Wenn
<varname>$fromDataSource</varname> <constant>TRUE</constant> ist (der
Standardwert ist <constant>FALSE</constant>), werden die Daten als, in einem
<acronym>LDAP</acronym> Baum vorhanden, betrachtet.
</entry>
</row>
<row>
<entry><code>boolean isNew()</code></entry>
<entry>
Sagt ob der Node als Neu betrachtet wird (nicht auf dem Server vorhanden).
Es ist zu beachten dass das nicht sagt ob der Node wirklich auf dem Server
vorhanden ist. Man muss <methodname>Zend_Ldap_Node::exists()</methodname>
verwenden um zu sehen ob der Node dort bereits existiert.
</entry>
</row>
<row>
<entry><code>boolean willBeDeleted()</code></entry>
<entry>
Sagt ob dieser Node gelöscht wird sobald
<methodname>Zend_Ldap_Node::update()</methodname> aufgerufen wird.
Tells if this node is going to be deleted once
<methodname>Zend_Ldap_Node::update()</methodname> is called.
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node delete()</code></entry>
<entry>
Markiert den Node als gelöscht. Nodes werden beim Aufruf von
<methodname>Zend_Ldap_Node::update()</methodname> gelöscht, wenn
<methodname>Zend_Ldap_Node::willBeDeleted()</methodname>
<constant>TRUE</constant> ist.
</entry>
</row>
<row>
<entry><code>boolean willBeMoved()</code></entry>
<entry>
Sagt ob dieser Node verschoben wird sobald
<methodname>Zend_Ldap_Node::update()</methodname> aufgerufen wird.
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node update(Zend_Ldap $ldap)</code></entry>
<entry>
Sendet alle wartenden Änderungen an den <acronym>LDAP</acronym> Server. Wenn
<varname>$ldap</varname> unterdrückt wird, dann wird die aktuelle
<acronym>LDAP</acronym> Verbindung verwendet. Wenn der aktuelle Node von
einer <acronym>LDAP</acronym> Verbindung getrennt ist, wird eine
<classname>Zend_Ldap_Exception</classname> geworfen. Wenn
<varname>$ldap</varname> angegeben wird, dann wird der aktuelle Node an die
angegebene <acronym>LDAP</acronym> Verbindung angehängt.
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Dn getCurrentDn()</code></entry>
<entry>
Gibt den aktuellen DN des aktuellen Nodes als
<classname>Zend_Ldap_Dn</classname> zurück. Das reflektiert mögliche
rename-Operationen.
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Dn getDn()</code></entry>
<entry>
Gibt den originalen DN des aktuellen Nodes als
<classname>Zend_Ldap_Dn</classname> zurück. Das reflektiert mögliche
rename-Operationen.
</entry>
</row>
<row>
<entry><code>string getDnString(string $caseFold)</code></entry>
<entry>
Gibt den originalen DN des aktuellen Nodes als String zurück. Das
reflektiert mögliche rename-Operationen.
</entry>
</row>
<row>
<entry><code>array getDnArray(string $caseFold)</code></entry>
<entry>
Gibt den originalen DN des aktuellen Nodes als Array zurück. Das reflektiert
mögliche rename-Operationen.
</entry>
</row>
<row>
<entry><code>string getRdnString(string $caseFold)</code></entry>
<entry>
Gibt den <acronym>RDN</acronym> des aktuellen Nodes als String zurück. Das
reflektiert mögliche rename-Operationen.
</entry>
</row>
<row>
<entry><code>array getRdnArray(string $caseFold)</code></entry>
<entry>
Gibt den <acronym>RDN</acronym> des aktuellen Nodes als Array zurück. Das
reflektiert mögliche rename-Operationen.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node setDn(Zend_Ldap_Dn|string|array $newDn)</code>
</entry>
<entry>
Setzt den neuen DB für diesen Node und verschiebt diesen Node effektiv
sobald <methodname>Zend_Ldap_Node::update()</methodname> aufgerufen wird.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node move(Zend_Ldap_Dn|string|array $newDn)</code>
</entry>
<entry>
Das ist ein Alias für <methodname>Zend_Ldap_Node::setDn()</methodname>.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node rename(Zend_Ldap_Dn|string|array $newDn)</code>
</entry>
<entry>
Das ist ein Alias für <methodname>Zend_Ldap_Node::setDn()</methodname>.
</entry>
</row>
<row>
<entry><code>array getObjectClass()</code></entry>
<entry>Gibt objectClass des Nodes zurück.</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node setObjectClass(array|string $value)</code>
</entry>
<entry>Setzt das objectClass Attribut.</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node appendObjectClass(array|string $value)</code>
</entry>
<entry>Stellt dem objectClass Attribut voran.</entry>
</row>
<row>
<entry><code>string toLdif(array $options)</code></entry>
<entry>
Gibt eine <acronym>LDIF</acronym> Repräsentation des aktuellen Nodes zurück.
<varname>$options</varname> wird an
<classname>Zend_Ldap_Ldif_Encoder</classname> übergeben.
</entry>
</row>
<row>
<entry><code>array getChangedData()</code></entry>
<entry>
Gibt geänderte Node Daten zurück. Das Array enthält alle geänderten
Attribute. Dieses format kann in <methodname>Zend_Ldap::add()</methodname>
und <methodname>Zend_Ldap::update()</methodname> verwendet werden.
</entry>
</row>
<row>
<entry><code>array getChanges()</code></entry>
<entry>Gibt alle gemachten Änderungen zurück.</entry>
</row>
<row>
<entry><code>string toString()</code></entry>
<entry>
Gibt den DN des aktuellen Nodes zurück - leitet auf
<methodname>Zend_Ldap_Dn::getDnString()</methodname> weiter.
</entry>
</row>
<row>
<entry><code>string __toString()</code></entry>
<entry>
Castet auf eine String Repräsentation - leitet auf
<methodname>Zend_Ldap_Dn::toString()</methodname> weiter.
</entry>
</row>
<row>
<entry><code>array toArray(boolean $includeSystemAttributes)</code></entry>
<entry>
Gibt eine Array Repräsentation des aktuellen Nodes zurück. Wenn
<varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
(der Standardwert ist <constant>TRUE</constant>), werden Systemspezifische
Attribute vom Array entfernt. Anders als
<methodname>Zend_Ldap_Node::getAttributes()</methodname> 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> Repräsentation des aktuellen Nodes zurück
wobei <methodname>Zend_Ldap_Node::toArray()</methodname> 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
<varname>$emptyExists</varname> <constant>FALSE</constant> ist werden leere
Attrbute (welche nur array() enthalten) als nicht-existent betrachtet und es
wird <constant>FALSE</constant> zurückgegeben. Wenn
<varname>$emptyExists</varname> <constant>TRUE</constant> ist werden leere
Attribute als existent betrachtet und es wird <constant>TRUE</constant>
zurückgegeben. In diesem Fall gibt die Methode nur dann
<constant>FALSE</constant> zurck 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 die angegebenen Werte im Attribut existieren. Die Methode gibt nur
dann <constant>TRUE</constant> zurück wenn alle Werte von
<varname>$value</varname> im Attribut vorhanden 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. Die Datenkonvertierung wird
angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::getAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>array getAttributes(boolean $includeSystemAttributes)</code>
</entry>
<entry>
Holt alle Attribute des Nodes. Wenn
<varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
(der Standardwert ist <constant>TRUE</constant>) dann werden die System
spezifischen Attribute vom Array entfernt.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node setAttribute(string $name, mixed $value)</code>
</entry>
<entry>
Setzt ein <acronym>LDAP</acronym> Attribut. Die Datenkonvertierung wird
angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::setAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node appendToAttribute(string $name, mixed $value)</code>
</entry>
<entry>
Hängt etwas an ein <acronym>LDAP</acronym> Attribut an. Die
Datenkonvertierung wird angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::setAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>array|integer getDateTimeAttribute(string $name,
integer|null $index)</code>
</entry>
<entry>
Holt ein <acronym>LDAP</acronym> Date/Time Attribut. Die Datenkonvertierung
wird angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::setDateTimeAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node setDateTimeAttribute(string $name,
integer|array $value, boolean $utc)</code>
</entry>
<entry>
Setzt ein <acronym>LDAP</acronym> Date/Time Attribut. Die Datenkonvertierung
wird angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::setDateTimeAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node appendToDateTimeAttribute(string $name,
integer|array $value, boolean $utc)</code>
</entry>
<entry>
Hängt etwas an ein <acronym>LDAP</acronym> Date/Time Attribut an. Die
Datenkonvertierung wird angewendet durch Verwendung von
<methodname>Zend_Ldap_Attribute::setDateTimeAttribute()</methodname>.
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node setPasswordAttribute(string $password,
string $hashType, string $attribName)</code>
</entry>
<entry>
Setzt ein <acronym>LDAP</acronym> Passwort bei
<varname>$attribName</varname> (der Standardwert ist
<code>'userPassword'</code>) auf <varname>$password</varname> mit dem
Hashtyp <varname>$hashType</varname> (der Standardwert ist
<constant>Zend_Ldap_Attribute::PASSWORD_HASH_MD5</constant>).
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node deleteAttribute(string $name)</code></entry>
<entry>Löscht ein <acronym>LDAP</acronym> Attribut.</entry>
</row>
<row>
<entry><code>void removeDuplicatesFromAttribute(string $name)</code></entry>
<entry>
Entfernt doppelte Werte von einem <acronym>LDAP</acronym> Attribut.
</entry>
</row>
<row>
<entry>
<code>void removeFromAttribute(string $attribName,
mixed|array $value)</code>
</entry>
<entry>
Entfernt die angegebenen Werte von einem <acronym>LDAP</acronym> Attribut.
</entry>
</row>
<row>
<entry><code>boolean exists(Zend_Ldap $ldap)</code></entry>
<entry>
Prüft ob der aktuelle Node im angegebenen <acronym>LDAP</acronym> Server
existiert (der aktuelle Server wird verwendet wenn
<constant>NULL</constant> übergeben wird).
</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node reload(Zend_Ldap $ldap)</code></entry>
<entry>
Lädt die Attribute des aktuellen Nodes nochmalig vom angegebenen
<acronym>LDAP</acronym> Server (der aktuelle Server wird verwendet wenn
<constant>NULL</constant> übergeben wird).
</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node_Collection
searchSubtree(string|Zend_Ldap_Filter_Abstract $filter, integer
$scope, string $sort)</code>
</entry>
<entry>
Sucht den Unterbaum des Nodes mit dem angegebenen <varname>$filter</varname>
und den angegebenen Suchparametern ab. Siehe
<methodname>Zend_Ldap::search()</methodname> für Details über die
Parameter <varname>$scope</varname> und <varname>$sort</varname>.
</entry>
</row>
<row>
<entry>
<code>integer countSubtree(string|Zend_Ldap_Filter_Abstract
$filter, integer $scope)</code>
</entry>
<entry>
Zählt die Elemente des Unterbaums vom Node welche dem angegebenen
<varname>$filter</varname> entsprechen und dem angegebenen Suchbereich.
Siehe <methodname>Zend_Ldap::search()</methodname> für Details über den
<varname>$scope</varname> Parameter.
</entry>
</row>
<row>
<entry><code>integer countChildren()</code></entry>
<entry>Zählt die Kinder des Nodes.</entry>
</row>
<row>
<entry>
<code>Zend_Ldap_Node_Collection
searchChildren(string|Zend_Ldap_Filter_Abstract $filter, string
$sort)</code>
</entry>
<entry>
Sucht nach Kindern des Nodes die dem angegebenen <varname>$filter</varname>
entsprechen. Siehe <methodname>Zend_Ldap::search()</methodname> für Details
über den <varname>$sort</varname> Parameter.
</entry>
</row>
<row>
<entry><code>boolean hasChildren()</code></entry>
<entry>Gibt zurück ob der aktuelle Node Kinder hat.</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node_ChildrenIterator getChildren()</code></entry>
<entry>Gibt alle Kinder des aktuellen Nodes zurück.</entry>
</row>
<row>
<entry><code>Zend_Ldap_Node getParent(Zend_Ldap $ldap)</code></entry>
<entry>
Gibt den Elternteil des aktuellen Nodes zurück wobei die
<acronym>LDAP</acronym> Verbindung <varname>$ldap</varname> verwendet wird
(verwendet die aktuelle <acronym>LDAP</acronym> Verbindung wenn diese nicht
angegeben wird).
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect3>
|