Zend_Ldap-API-Ldap-Node-RootDse.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20115 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.ldap.api.reference.zend-ldap-node-rootdse">
  5. <title>Zend_Ldap_Node_RootDse</title>
  6. <para>
  7. Die folgenden Methoden sind in allen Hersteller-Spezifischen Unterklassen vorhanden.
  8. </para>
  9. <para>
  10. <classname>Zend_Ldap_Node_RootDse</classname> enthält die magischen Zugriffsmethoden
  11. <methodname>__get()</methodname> und <methodname>__isset()</methodname> um auf die Attribute
  12. durch Ihren Namen zugreifen zu können. Sie verweisen auf
  13. <methodname>Zend_Ldap_Node_RootDse::getAttribute()</methodname> und auf
  14. <methodname>Zend_Ldap_Node_RootDse::existsAttribute()</methodname>.
  15. <methodname>__set()</methodname> und <methodname>__get()</methodname> sind auch
  16. implementiert, werfen aber eine <code>BadMethodCallException</code> da Änderungen auf
  17. RootDSE Nodes nicht erlaubt sind. Weiters implementiert die Klasse <code>ArrayAccess</code>
  18. für Array-Artigen Zugriff auf die Attribute. <methodname>offsetSet()</methodname> und
  19. <methodname>offsetUnset()</methodname> werfen auch eine
  20. <code>BadMethodCallException</code> aus den bekannten Gründen.
  21. </para>
  22. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.table">
  23. <title>Zend_Ldap_Node_RootDse API</title>
  24. <tgroup cols="2">
  25. <thead>
  26. <row>
  27. <entry>Methode</entry>
  28. <entry>Beschreibung</entry>
  29. </row>
  30. </thead>
  31. <tbody>
  32. <row>
  33. <entry><code>Zend_Ldap_Dn getDn()</code></entry>
  34. <entry>Gibt den DN des aktuellen Nodes als Zend_Ldap_Dn zurück.</entry>
  35. </row>
  36. <row>
  37. <entry><code>string getDnString(string $caseFold)</code></entry>
  38. <entry>Gibt den DN des aktuellen Nodes als String zurück.</entry>
  39. </row>
  40. <row>
  41. <entry><code>array getDnArray(string $caseFold)</code></entry>
  42. <entry>Gibt den DN des aktuellen Nodes als Array zurück.</entry>
  43. </row>
  44. <row>
  45. <entry><code>string getRdnString(string $caseFold)</code></entry>
  46. <entry>
  47. Gibt den <acronym>RDN</acronym> des aktuellen Nodes als String zurück.
  48. </entry>
  49. </row>
  50. <row>
  51. <entry><code>array getRdnArray(string $caseFold)</code></entry>
  52. <entry>
  53. Gibt den <acronym>RDN</acronym> des aktuellen Nodes als Array zurück.
  54. </entry>
  55. </row>
  56. <row>
  57. <entry><code>array getObjectClass()</code></entry>
  58. <entry>Gibt die objectClass des Nodes zurück.</entry>
  59. </row>
  60. <row>
  61. <entry><code>string toString()</code></entry>
  62. <entry>
  63. Gibt den DN des aktuellen Nodes zurück - verweist auf
  64. <methodname>Zend_Ldap_Dn::getDnString()</methodname>.
  65. </entry>
  66. </row>
  67. <row>
  68. <entry><code>string __toString()</code></entry>
  69. <entry>
  70. Castet auf eine String Darstellung - verweist auf
  71. <methodname>Zend_Ldap_Dn::toString()</methodname>.
  72. </entry>
  73. </row>
  74. <row>
  75. <entry>
  76. <code>array toArray(boolean
  77. $includeSystemAttributes)</code>
  78. </entry>
  79. <entry>
  80. Gibt eine Array Darstellung des aktuellen Nodes zurück. Wenn
  81. <varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
  82. (der Standardwert ist <constant>TRUE</constant>) werden die System
  83. spezifischen Attribute vom Array entfernt. Anders als
  84. <methodname>Zend_Ldap_Node_RootDse::getAttributes()</methodname> enthält
  85. das produzierte Array den DN mit dem Schlüssel <code>'dn'</code>.
  86. </entry>
  87. </row>
  88. <row>
  89. <entry>
  90. <code>string toJson(boolean
  91. $includeSystemAttributes)</code>
  92. </entry>
  93. <entry>
  94. Gibt eine <acronym>JSON</acronym> Darstellung des aktuellen Nodes zurück
  95. indem <methodname>Zend_Ldap_Node_RootDse::toArray()</methodname> verwendet
  96. wird.
  97. </entry>
  98. </row>
  99. <row>
  100. <entry>
  101. <code>array getData(boolean
  102. $includeSystemAttributes)</code>
  103. </entry>
  104. <entry>
  105. Gibt die Attribute der Nodes zurück. Das Array enthält alle Attribute in
  106. Ihrem internen Format (keine Konvertierung).
  107. </entry>
  108. </row>
  109. <row>
  110. <entry>
  111. <code>boolean existsAttribute(string $name, boolean
  112. $emptyExists)</code>
  113. </entry>
  114. <entry>
  115. Prüft ob ein angegebenes Attribut existiert. Wenn
  116. <varname>$emptyExists</varname> <constant>FALSE</constant> ist werden leere
  117. Attribute (welche nur array() enthalten) als nicht existierend betrachtet
  118. und geben <constant>FALSE</constant> zurück. Wenn
  119. <varname>$emptyExists</varname> <constant>TRUE</constant> ist werden leere
  120. Attribute als existent betrachtet und geben <varname>$emptyExists</varname>
  121. zurück. In diesem Fall gibt die Methode nur dann <constant>FALSE</constant>
  122. zurück wenn der Name des Attributs in der Sammlung der Schlüssel fehlt.
  123. </entry>
  124. </row>
  125. <row>
  126. <entry>
  127. <code>boolean attributeHasValue(string $name, mixed|array
  128. $value)</code>
  129. </entry>
  130. <entry>
  131. Prüft ob die gegebenen Werte im Attribut existieren. Die Methode gibt nur
  132. dann <constant>TRUE</constant> zurück wenn alle Werte in
  133. <varname>$value</varname> im Attribut vorhanden sind. Der Vergleich wird
  134. strikt durchgeführt (und respektiert den Datentyp).
  135. </entry>
  136. </row>
  137. <row>
  138. <entry><code>integer count()</code></entry>
  139. <entry>
  140. Gibt die Anzahl der Attribute im Node zurück. Implementiert Countable.
  141. </entry>
  142. </row>
  143. <row>
  144. <entry>
  145. <code>mixed getAttribute(string $name, integer|null
  146. $index)</code>
  147. </entry>
  148. <entry>
  149. Gibt ein <acronym>LDAP</acronym> Attribut zurück. Die Daten Konvertierung
  150. wird angewendet indem
  151. <methodname>Zend_Ldap_Attribute::getAttribute()</methodname> verwendet wird.
  152. </entry>
  153. </row>
  154. <row>
  155. <entry>
  156. <code>array getAttributes(boolean
  157. $includeSystemAttributes)</code>
  158. </entry>
  159. <entry>
  160. Gibt alle Attribute des Nodes zurück. Wenn
  161. <varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
  162. (der Standardwert ist <constant>TRUE</constant>), werden die System
  163. spezifischen Attribute vom Array entfernt.
  164. </entry>
  165. </row>
  166. <row>
  167. <entry>
  168. <code>array|integer getDateTimeAttribute(string $name,
  169. integer|null $index)</code>
  170. </entry>
  171. <entry>
  172. Gibt ein <acronym>LDAP</acronym> Datum/Zeit Attribut zurück. Die
  173. Datenkonvertierung wird angewendet indem
  174. <methodname>Zend_Ldap_Attribute::getDateTimeAttribute()</methodname>
  175. verwendet wird.
  176. </entry>
  177. </row>
  178. <row>
  179. <entry>
  180. <code>Zend_Ldap_Node_RootDse reload(Zend_Ldap
  181. $ldap)</code>
  182. </entry>
  183. <entry>
  184. Lädt die Attribute des aktuellen Nodes nochmalig vom angegebenen
  185. <acronym>LDAP</acronym> Server.
  186. </entry>
  187. </row>
  188. <row>
  189. <entry>
  190. <emphasis><code>Zend_Ldap_Node_RootDse create(Zend_Ldap
  191. $ldap)</code> </emphasis>
  192. </entry>
  193. <entry>Eine Factory Methode um den RootDSE zu erstellen.</entry>
  194. </row>
  195. <row>
  196. <entry><code>array getNamingContexts()</code></entry>
  197. <entry>Holt die namingContexts.</entry>
  198. </row>
  199. <row>
  200. <entry><code>string|null getSubschemaSubentry()</code></entry>
  201. <entry>Holt den subschemaSubentry.</entry>
  202. </row>
  203. <row>
  204. <entry>
  205. <code>boolean supportsVersion(string|int|array
  206. $versions)</code>
  207. </entry>
  208. <entry>Erkennt ob die <acronym>LDAP</acronym> Version unterstützt wird.</entry>
  209. </row>
  210. <row>
  211. <entry>
  212. <code>boolean supportsSaslMechanism(string|array
  213. $mechlist)</code>
  214. </entry>
  215. <entry>Erkennt ob der sasl Mechanismus unterstützt wird.</entry>
  216. </row>
  217. <row>
  218. <entry><code>integer getServerType()</code></entry>
  219. <entry>
  220. Gibt den Server Typ zurück. Retourniert wird
  221. <variablelist>
  222. <varlistentry>
  223. <term>
  224. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_GENERIC</constant></term>
  225. <listitem>
  226. <para>für unbekannte <acronym>LDAP</acronym> Server</para>
  227. </listitem>
  228. </varlistentry>
  229. <varlistentry>
  230. <term>
  231. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant></term>
  232. <listitem><para>für OpenLDAP Server</para></listitem>
  233. </varlistentry>
  234. <varlistentry>
  235. <term>
  236. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant></term>
  237. <listitem><para>für Microsoft ActiveDirectory Server</para></listitem>
  238. </varlistentry>
  239. <varlistentry>
  240. <term>
  241. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant></term>
  242. <listitem><para>für Novell eDirectory Server</para></listitem>
  243. </varlistentry>
  244. </variablelist>
  245. </entry>
  246. </row>
  247. <row>
  248. <entry><methodname>Zend_Ldap_Dn getSchemaDn()</methodname></entry>
  249. <entry>Gibt das DN Schema zurück.</entry>
  250. </row>
  251. </tbody>
  252. </tgroup>
  253. </table>
  254. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.openldap">
  255. <title>OpenLDAP</title>
  256. <para>
  257. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  258. <classname>Zend_Ldap_Node_RootDse_OpenLdap</classname> angewendet werden.
  259. </para>
  260. <note>
  261. <para>
  262. Sehen Sie unter <ulink url="http://www.zytrax.com/books/ldap/ch3/#operational">LDAP
  263. Operational Attributes and Objects</ulink> für Informationen über Attribute von
  264. OpenLDAP RootDSE.
  265. </para>
  266. </note>
  267. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.openldap.table">
  268. <title>Zend_Ldap_Node_RootDse_OpenLdap API</title>
  269. <tgroup cols="2">
  270. <thead>
  271. <row>
  272. <entry>Methode</entry>
  273. <entry>Beschreibung</entry>
  274. </row>
  275. </thead>
  276. <tbody>
  277. <row>
  278. <entry><code>integer getServerType()</code></entry>
  279. <entry>
  280. Holt den Servertyp. Gibt
  281. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant>
  282. zurück.
  283. </entry>
  284. </row>
  285. <row>
  286. <entry><code>string|null getConfigContext()</code></entry>
  287. <entry>Holt den configContext.</entry>
  288. </row>
  289. <row>
  290. <entry><code>string|null getMonitorContext()</code></entry>
  291. <entry>Holt den monitorContext.</entry>
  292. </row>
  293. <row>
  294. <entry>
  295. <code>boolean supportsControl(string|array
  296. $oids)</code>
  297. </entry>
  298. <entry>Erkennt ob control unterstützt wird.</entry>
  299. </row>
  300. <row>
  301. <entry>
  302. <code>boolean supportsExtension(string|array
  303. $oids)</code>
  304. </entry>
  305. <entry>Erkennt ob extension unterstützt wird.</entry>
  306. </row>
  307. <row>
  308. <entry>
  309. <code>boolean supportsFeature(string|array
  310. $oids)</code>
  311. </entry>
  312. <entry>Erkennt ob feature unterstützt wird.</entry>
  313. </row>
  314. </tbody>
  315. </tgroup>
  316. </table>
  317. </sect4>
  318. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.activedirectory">
  319. <title>ActiveDirectory</title>
  320. <para>
  321. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  322. <classname>Zend_Ldap_Node_RootDse_ActiveDirectory</classname> angewendet werden.
  323. </para>
  324. <note>
  325. <para>
  326. Sehen Sie unter <ulink
  327. url="http://msdn.microsoft.com/en-us/library/ms684291(VS.85).aspx">
  328. RootDSE</ulink> für Informationen über Attribute von Microsoft ActiveDirectory
  329. RootDSE.
  330. </para>
  331. </note>
  332. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.activedirectory.table">
  333. <title>Zend_Ldap_Node_RootDse_ActiveDirectory API</title>
  334. <tgroup cols="2">
  335. <thead>
  336. <row>
  337. <entry>Methode</entry>
  338. <entry>Beschreibung</entry>
  339. </row>
  340. </thead>
  341. <tbody>
  342. <row>
  343. <entry><code>integer getServerType()</code></entry>
  344. <entry>
  345. Holt den Server Typ. Gibt
  346. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant>
  347. zurück.
  348. </entry>
  349. </row>
  350. <row>
  351. <entry>
  352. <code>string|null
  353. getConfigurationNamingContext()</code>
  354. </entry>
  355. <entry>Holt configurationNamingContext.</entry>
  356. </row>
  357. <row>
  358. <entry><code>string|null getCurrentTime()</code></entry>
  359. <entry>Holt currentTime.</entry>
  360. </row>
  361. <row>
  362. <entry>
  363. <code>string|null
  364. getDefaultNamingContext()</code>
  365. </entry>
  366. <entry>Holt defaultNamingContext.</entry>
  367. </row>
  368. <row>
  369. <entry><code>string|null getDnsHostName()</code></entry>
  370. <entry>Holt dnsHostName.</entry>
  371. </row>
  372. <row>
  373. <entry>
  374. <code>string|null
  375. getDomainControllerFunctionality()</code>
  376. </entry>
  377. <entry>Holt domainControllerFunctionality.</entry>
  378. </row>
  379. <row>
  380. <entry>
  381. <code>string|null
  382. getDomainFunctionality()</code>
  383. </entry>
  384. <entry>Holt domainFunctionality.</entry>
  385. </row>
  386. <row>
  387. <entry><code>string|null getDsServiceName()</code></entry>
  388. <entry>Holt dsServiceName.</entry>
  389. </row>
  390. <row>
  391. <entry>
  392. <code>string|null
  393. getForestFunctionality()</code>
  394. </entry>
  395. <entry>Holt forestFunctionality.</entry>
  396. </row>
  397. <row>
  398. <entry>
  399. <code>string|null
  400. getHighestCommittedUSN()</code>
  401. </entry>
  402. <entry>Holt highestCommittedUSN.</entry>
  403. </row>
  404. <row>
  405. <entry>
  406. <code>string|null
  407. getIsGlobalCatalogReady()</code>
  408. </entry>
  409. <entry>Holt isGlobalCatalogReady.</entry>
  410. </row>
  411. <row>
  412. <entry><code>string|null getIsSynchronized()</code></entry>
  413. <entry>Holt isSynchronized.</entry>
  414. </row>
  415. <row>
  416. <entry><code>string|null getLdapServiceName()</code></entry>
  417. <entry>Holt ldapServiceName.</entry>
  418. </row>
  419. <row>
  420. <entry>
  421. <code>string|null
  422. getRootDomainNamingContext()</code>
  423. </entry>
  424. <entry>Holt rootDomainNamingContext.</entry>
  425. </row>
  426. <row>
  427. <entry>
  428. <code>string|null
  429. getSchemaNamingContext()</code>
  430. </entry>
  431. <entry>Holt schemaNamingContext.</entry>
  432. </row>
  433. <row>
  434. <entry><code>string|null getServerName()</code></entry>
  435. <entry>Holt serverName.</entry>
  436. </row>
  437. <row>
  438. <entry>
  439. <code>boolean supportsCapability(string|array
  440. $oids)</code>
  441. </entry>
  442. <entry>Erkennt ob capability unterstützt wird.</entry>
  443. </row>
  444. <row>
  445. <entry>
  446. <code>boolean supportsControl(string|array
  447. $oids)</code>
  448. </entry>
  449. <entry>Erkennt ob control unterstützt wird.</entry>
  450. </row>
  451. <row>
  452. <entry>
  453. <code>boolean supportsPolicy(string|array
  454. $policies)</code>
  455. </entry>
  456. <entry>Erkennt ob version unterstützt wird.</entry>
  457. </row>
  458. </tbody>
  459. </tgroup>
  460. </table>
  461. </sect4>
  462. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.edirectory">
  463. <title>eDirectory</title>
  464. <para>
  465. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  466. <code>Zend_Ldap_Node_RootDse_eDirectory</code> angewendet werden.
  467. </para>
  468. <note>
  469. <para>
  470. Sehen Sie auf <ulink
  471. url="http://www.novell.com/documentation/edir88/edir88/index.html?page=/documentation/edir88/edir88/data/ah59jqq.html">
  472. Getting Information about the <acronym>LDAP</acronym> Server</ulink> für
  473. Informationen über Attribute von Novell eDirectory RootDSE.
  474. </para>
  475. </note>
  476. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.edirectory.table">
  477. <title>Zend_Ldap_Node_RootDse_eDirectory API</title>
  478. <tgroup cols="2">
  479. <thead>
  480. <row>
  481. <entry>Methode</entry>
  482. <entry>Beschreibung</entry>
  483. </row>
  484. </thead>
  485. <tbody>
  486. <row>
  487. <entry><code>integer getServerType()</code></entry>
  488. <entry>
  489. Holt den Server Typ. Gibt
  490. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant>
  491. zurück.
  492. </entry>
  493. </row>
  494. <row>
  495. <entry>
  496. <code>boolean supportsExtension(string|array
  497. $oids)</code>
  498. </entry>
  499. <entry>Erkennt ob extension unterstützt wird.</entry>
  500. </row>
  501. <row>
  502. <entry><code>string|null getVendorName()</code></entry>
  503. <entry>Holt vendorName.</entry>
  504. </row>
  505. <row>
  506. <entry><code>string|null getVendorVersion()</code></entry>
  507. <entry>Holt vendorVersion.</entry>
  508. </row>
  509. <row>
  510. <entry><code>string|null getDsaName()</code></entry>
  511. <entry>Holt dsaName.</entry>
  512. </row>
  513. <row>
  514. <entry><code>string|null getStatisticsErrors()</code></entry>
  515. <entry>Holt die Server Statistik "errors".</entry>
  516. </row>
  517. <row>
  518. <entry>
  519. <code>string|null
  520. getStatisticsSecurityErrors()</code>
  521. </entry>
  522. <entry>Holt die Server Statistik "securityErrors".</entry>
  523. </row>
  524. <row>
  525. <entry>
  526. <code>string|null
  527. getStatisticsChainings()</code>
  528. </entry>
  529. <entry>Holt die Server Statistik "chainings".</entry>
  530. </row>
  531. <row>
  532. <entry>
  533. <code>string|null
  534. getStatisticsReferralsReturned()</code>
  535. </entry>
  536. <entry>Holt die Server Statistik "referralsReturned".</entry>
  537. </row>
  538. <row>
  539. <entry>
  540. <code>string|null
  541. getStatisticsExtendedOps()</code>
  542. </entry>
  543. <entry>Holt die Server Statistik "extendedOps".</entry>
  544. </row>
  545. <row>
  546. <entry>
  547. <code>string|null
  548. getStatisticsAbandonOps()</code>
  549. </entry>
  550. <entry>Holt die Server Statistik "abandonOps".</entry>
  551. </row>
  552. <row>
  553. <entry>
  554. <code>string|null
  555. getStatisticsWholeSubtreeSearchOps()</code>
  556. </entry>
  557. <entry>Holt die Server Statistik "wholeSubtreeSearchOps".</entry>
  558. </row>
  559. </tbody>
  560. </tgroup>
  561. </table>
  562. </sect4>
  563. </sect3>