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

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