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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20792 -->
  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><code>array toArray(boolean $includeSystemAttributes)</code></entry>
  76. <entry>
  77. Gibt eine Array Darstellung des aktuellen Nodes zurück. Wenn
  78. <varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
  79. (der Standardwert ist <constant>TRUE</constant>) werden die System
  80. spezifischen Attribute vom Array entfernt. Anders als
  81. <methodname>Zend_Ldap_Node_RootDse::getAttributes()</methodname> enthält
  82. das produzierte Array den DN mit dem Schlüssel <code>'dn'</code>.
  83. </entry>
  84. </row>
  85. <row>
  86. <entry><code>string toJson(boolean $includeSystemAttributes)</code></entry>
  87. <entry>
  88. Gibt eine <acronym>JSON</acronym> Darstellung des aktuellen Nodes zurück
  89. indem <methodname>Zend_Ldap_Node_RootDse::toArray()</methodname> verwendet
  90. wird.
  91. </entry>
  92. </row>
  93. <row>
  94. <entry><code>array getData(boolean $includeSystemAttributes)</code></entry>
  95. <entry>
  96. Gibt die Attribute der Nodes zurück. Das Array enthält alle Attribute in
  97. Ihrem internen Format (keine Konvertierung).
  98. </entry>
  99. </row>
  100. <row>
  101. <entry>
  102. <code>boolean existsAttribute(string $name, boolean
  103. $emptyExists)</code>
  104. </entry>
  105. <entry>
  106. Prüft ob ein angegebenes Attribut existiert. Wenn
  107. <varname>$emptyExists</varname> <constant>FALSE</constant> ist werden leere
  108. Attribute (welche nur array() enthalten) als nicht existierend betrachtet
  109. und geben <constant>FALSE</constant> zurück. Wenn
  110. <varname>$emptyExists</varname> <constant>TRUE</constant> ist werden leere
  111. Attribute als existent betrachtet und geben <varname>$emptyExists</varname>
  112. zurück. In diesem Fall gibt die Methode nur dann <constant>FALSE</constant>
  113. zurück wenn der Name des Attributs in der Sammlung der Schlüssel fehlt.
  114. </entry>
  115. </row>
  116. <row>
  117. <entry>
  118. <code>boolean attributeHasValue(string $name, mixed|array $value)</code>
  119. </entry>
  120. <entry>
  121. Prüft ob die gegebenen Werte im Attribut existieren. Die Methode gibt nur
  122. dann <constant>TRUE</constant> zurück wenn alle Werte in
  123. <varname>$value</varname> im Attribut vorhanden sind. Der Vergleich wird
  124. strikt durchgeführt (und respektiert den Datentyp).
  125. </entry>
  126. </row>
  127. <row>
  128. <entry><code>integer count()</code></entry>
  129. <entry>
  130. Gibt die Anzahl der Attribute im Node zurück. Implementiert Countable.
  131. </entry>
  132. </row>
  133. <row>
  134. <entry>
  135. <code>mixed getAttribute(string $name, integer|null $index)</code>
  136. </entry>
  137. <entry>
  138. Gibt ein <acronym>LDAP</acronym> Attribut zurück. Die Daten Konvertierung
  139. wird angewendet indem
  140. <methodname>Zend_Ldap_Attribute::getAttribute()</methodname> verwendet wird.
  141. </entry>
  142. </row>
  143. <row>
  144. <entry>
  145. <code>array getAttributes(boolean $includeSystemAttributes)</code>
  146. </entry>
  147. <entry>
  148. Gibt alle Attribute des Nodes zurück. Wenn
  149. <varname>$includeSystemAttributes</varname> <constant>FALSE</constant> ist
  150. (der Standardwert ist <constant>TRUE</constant>), werden die System
  151. spezifischen Attribute vom Array entfernt.
  152. </entry>
  153. </row>
  154. <row>
  155. <entry>
  156. <code>array|integer getDateTimeAttribute(string $name,
  157. integer|null $index)</code>
  158. </entry>
  159. <entry>
  160. Gibt ein <acronym>LDAP</acronym> Datum/Zeit Attribut zurück. Die
  161. Datenkonvertierung wird angewendet indem
  162. <methodname>Zend_Ldap_Attribute::getDateTimeAttribute()</methodname>
  163. verwendet wird.
  164. </entry>
  165. </row>
  166. <row>
  167. <entry><code>Zend_Ldap_Node_RootDse reload(Zend_Ldap $ldap)</code></entry>
  168. <entry>
  169. Lädt die Attribute des aktuellen Nodes nochmalig vom angegebenen
  170. <acronym>LDAP</acronym> Server.
  171. </entry>
  172. </row>
  173. <row>
  174. <entry>
  175. <emphasis><code>Zend_Ldap_Node_RootDse create(Zend_Ldap
  176. $ldap)</code></emphasis>
  177. </entry>
  178. <entry>Eine Factory Methode um den RootDSE zu erstellen.</entry>
  179. </row>
  180. <row>
  181. <entry><code>array getNamingContexts()</code></entry>
  182. <entry>Holt die namingContexts.</entry>
  183. </row>
  184. <row>
  185. <entry><code>string|null getSubschemaSubentry()</code></entry>
  186. <entry>Holt den subschemaSubentry.</entry>
  187. </row>
  188. <row>
  189. <entry>
  190. <code>boolean supportsVersion(string|int|array $versions)</code>
  191. </entry>
  192. <entry>Erkennt ob die <acronym>LDAP</acronym> Version unterstützt wird.</entry>
  193. </row>
  194. <row>
  195. <entry>
  196. <code>boolean supportsSaslMechanism(string|array $mechlist)</code>
  197. </entry>
  198. <entry>Erkennt ob der sasl Mechanismus unterstützt wird.</entry>
  199. </row>
  200. <row>
  201. <entry><code>integer getServerType()</code></entry>
  202. <entry>
  203. Gibt den Server Typ zurück. Retourniert wird
  204. <variablelist>
  205. <varlistentry>
  206. <term><constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_GENERIC</constant></term>
  207. <listitem>
  208. <para>für unbekannte <acronym>LDAP</acronym> Server</para>
  209. </listitem>
  210. </varlistentry>
  211. <varlistentry>
  212. <term><constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant></term>
  213. <listitem><para>für OpenLDAP Server</para></listitem>
  214. </varlistentry>
  215. <varlistentry>
  216. <term><constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant></term>
  217. <listitem><para>für Microsoft ActiveDirectory Server</para></listitem>
  218. </varlistentry>
  219. <varlistentry>
  220. <term><constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant></term>
  221. <listitem><para>für Novell eDirectory Server</para></listitem>
  222. </varlistentry>
  223. </variablelist>
  224. </entry>
  225. </row>
  226. <row>
  227. <entry><methodname>Zend_Ldap_Dn getSchemaDn()</methodname></entry>
  228. <entry>Gibt das DN Schema zurück.</entry>
  229. </row>
  230. </tbody>
  231. </tgroup>
  232. </table>
  233. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.openldap">
  234. <title>OpenLDAP</title>
  235. <para>
  236. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  237. <classname>Zend_Ldap_Node_RootDse_OpenLdap</classname> angewendet werden.
  238. </para>
  239. <note>
  240. <para>
  241. Sehen Sie unter <ulink url="http://www.zytrax.com/books/ldap/ch3/#operational">LDAP
  242. Operational Attributes and Objects</ulink> für Informationen über Attribute von
  243. OpenLDAP RootDSE.
  244. </para>
  245. </note>
  246. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.openldap.table">
  247. <title>Zend_Ldap_Node_RootDse_OpenLdap API</title>
  248. <tgroup cols="2">
  249. <thead>
  250. <row>
  251. <entry>Methode</entry>
  252. <entry>Beschreibung</entry>
  253. </row>
  254. </thead>
  255. <tbody>
  256. <row>
  257. <entry><code>integer getServerType()</code></entry>
  258. <entry>
  259. Holt den Servertyp. Gibt
  260. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant>
  261. zurück.
  262. </entry>
  263. </row>
  264. <row>
  265. <entry><code>string|null getConfigContext()</code></entry>
  266. <entry>Holt den configContext.</entry>
  267. </row>
  268. <row>
  269. <entry><code>string|null getMonitorContext()</code></entry>
  270. <entry>Holt den monitorContext.</entry>
  271. </row>
  272. <row>
  273. <entry><code>boolean supportsControl(string|array $oids)</code></entry>
  274. <entry>Erkennt ob control unterstützt wird.</entry>
  275. </row>
  276. <row>
  277. <entry><code>boolean supportsExtension(string|array $oids)</code></entry>
  278. <entry>Erkennt ob extension unterstützt wird.</entry>
  279. </row>
  280. <row>
  281. <entry><code>boolean supportsFeature(string|array $oids)</code></entry>
  282. <entry>Erkennt ob feature unterstützt wird.</entry>
  283. </row>
  284. </tbody>
  285. </tgroup>
  286. </table>
  287. </sect4>
  288. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.activedirectory">
  289. <title>ActiveDirectory</title>
  290. <para>
  291. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  292. <classname>Zend_Ldap_Node_RootDse_ActiveDirectory</classname> angewendet werden.
  293. </para>
  294. <note>
  295. <para>
  296. Sehen Sie unter <ulink
  297. url="http://msdn.microsoft.com/en-us/library/ms684291(VS.85).aspx">
  298. RootDSE</ulink> für Informationen über Attribute von Microsoft ActiveDirectory
  299. RootDSE.
  300. </para>
  301. </note>
  302. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.activedirectory.table">
  303. <title>Zend_Ldap_Node_RootDse_ActiveDirectory API</title>
  304. <tgroup cols="2">
  305. <thead>
  306. <row>
  307. <entry>Methode</entry>
  308. <entry>Beschreibung</entry>
  309. </row>
  310. </thead>
  311. <tbody>
  312. <row>
  313. <entry><code>integer getServerType()</code></entry>
  314. <entry>
  315. Holt den Server Typ. Gibt
  316. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant>
  317. zurück.
  318. </entry>
  319. </row>
  320. <row>
  321. <entry><code>string|null getConfigurationNamingContext()</code></entry>
  322. <entry>Holt configurationNamingContext.</entry>
  323. </row>
  324. <row>
  325. <entry><code>string|null getCurrentTime()</code></entry>
  326. <entry>Holt currentTime.</entry>
  327. </row>
  328. <row>
  329. <entry><code>string|null getDefaultNamingContext()</code></entry>
  330. <entry>Holt defaultNamingContext.</entry>
  331. </row>
  332. <row>
  333. <entry><code>string|null getDnsHostName()</code></entry>
  334. <entry>Holt dnsHostName.</entry>
  335. </row>
  336. <row>
  337. <entry><code>string|null getDomainControllerFunctionality()</code></entry>
  338. <entry>Holt domainControllerFunctionality.</entry>
  339. </row>
  340. <row>
  341. <entry><code>string|null getDomainFunctionality()</code></entry>
  342. <entry>Holt domainFunctionality.</entry>
  343. </row>
  344. <row>
  345. <entry><code>string|null getDsServiceName()</code></entry>
  346. <entry>Holt dsServiceName.</entry>
  347. </row>
  348. <row>
  349. <entry><code>string|null getForestFunctionality()</code></entry>
  350. <entry>Holt forestFunctionality.</entry>
  351. </row>
  352. <row>
  353. <entry><code>string|null getHighestCommittedUSN()</code></entry>
  354. <entry>Holt highestCommittedUSN.</entry>
  355. </row>
  356. <row>
  357. <entry><code>string|null getIsGlobalCatalogReady()</code></entry>
  358. <entry>Holt isGlobalCatalogReady.</entry>
  359. </row>
  360. <row>
  361. <entry><code>string|null getIsSynchronized()</code></entry>
  362. <entry>Holt isSynchronized.</entry>
  363. </row>
  364. <row>
  365. <entry><code>string|null getLdapServiceName()</code></entry>
  366. <entry>Holt ldapServiceName.</entry>
  367. </row>
  368. <row>
  369. <entry><code>string|null getRootDomainNamingContext()</code></entry>
  370. <entry>Holt rootDomainNamingContext.</entry>
  371. </row>
  372. <row>
  373. <entry><code>string|null getSchemaNamingContext()</code></entry>
  374. <entry>Holt schemaNamingContext.</entry>
  375. </row>
  376. <row>
  377. <entry><code>string|null getServerName()</code></entry>
  378. <entry>Holt serverName.</entry>
  379. </row>
  380. <row>
  381. <entry><code>boolean supportsCapability(string|array $oids)</code></entry>
  382. <entry>Erkennt ob capability unterstützt wird.</entry>
  383. </row>
  384. <row>
  385. <entry><code>boolean supportsControl(string|array $oids)</code></entry>
  386. <entry>Erkennt ob control unterstützt wird.</entry>
  387. </row>
  388. <row>
  389. <entry><code>boolean supportsPolicy(string|array $policies)</code></entry>
  390. <entry>Erkennt ob version unterstützt wird.</entry>
  391. </row>
  392. </tbody>
  393. </tgroup>
  394. </table>
  395. </sect4>
  396. <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.edirectory">
  397. <title>eDirectory</title>
  398. <para>
  399. Zusätzlich können die üblichen Methoden von oben auch auf Instanzen von
  400. <code>Zend_Ldap_Node_RootDse_eDirectory</code> angewendet werden.
  401. </para>
  402. <note>
  403. <para>
  404. Sehen Sie auf <ulink
  405. url="http://www.novell.com/documentation/edir88/edir88/index.html?page=/documentation/edir88/edir88/data/ah59jqq.html">Getting
  406. Information about the <acronym>LDAP</acronym> Server</ulink> für
  407. Informationen über Attribute von Novell eDirectory RootDSE.
  408. </para>
  409. </note>
  410. <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.edirectory.table">
  411. <title>Zend_Ldap_Node_RootDse_eDirectory API</title>
  412. <tgroup cols="2">
  413. <thead>
  414. <row>
  415. <entry>Methode</entry>
  416. <entry>Beschreibung</entry>
  417. </row>
  418. </thead>
  419. <tbody>
  420. <row>
  421. <entry><code>integer getServerType()</code></entry>
  422. <entry>
  423. Holt den Server Typ. Gibt
  424. <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant>
  425. zurück.
  426. </entry>
  427. </row>
  428. <row>
  429. <entry><code>boolean supportsExtension(string|array $oids)</code></entry>
  430. <entry>Erkennt ob extension unterstützt wird.</entry>
  431. </row>
  432. <row>
  433. <entry><code>string|null getVendorName()</code></entry>
  434. <entry>Holt vendorName.</entry>
  435. </row>
  436. <row>
  437. <entry><code>string|null getVendorVersion()</code></entry>
  438. <entry>Holt vendorVersion.</entry>
  439. </row>
  440. <row>
  441. <entry><code>string|null getDsaName()</code></entry>
  442. <entry>Holt dsaName.</entry>
  443. </row>
  444. <row>
  445. <entry><code>string|null getStatisticsErrors()</code></entry>
  446. <entry>Holt die Server Statistik "errors".</entry>
  447. </row>
  448. <row>
  449. <entry><code>string|null getStatisticsSecurityErrors()</code></entry>
  450. <entry>Holt die Server Statistik "securityErrors".</entry>
  451. </row>
  452. <row>
  453. <entry><code>string|null getStatisticsChainings()</code></entry>
  454. <entry>Holt die Server Statistik "chainings".</entry>
  455. </row>
  456. <row>
  457. <entry><code>string|null getStatisticsReferralsReturned()</code></entry>
  458. <entry>Holt die Server Statistik "referralsReturned".</entry>
  459. </row>
  460. <row>
  461. <entry><code>string|null getStatisticsExtendedOps()</code></entry>
  462. <entry>Holt die Server Statistik "extendedOps".</entry>
  463. </row>
  464. <row>
  465. <entry><code>string|null getStatisticsAbandonOps()</code></entry>
  466. <entry>Holt die Server Statistik "abandonOps".</entry>
  467. </row>
  468. <row>
  469. <entry><code>string|null getStatisticsWholeSubtreeSearchOps()</code></entry>
  470. <entry>Holt die Server Statistik "wholeSubtreeSearchOps".</entry>
  471. </row>
  472. </tbody>
  473. </tgroup>
  474. </table>
  475. </sect4>
  476. </sect3>