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
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.ldap.api.reference.zend-ldap-attribute">
<title>Zend_Ldap_Attribute</title>
<para>
<classname>Zend_Ldap_Attribute</classname> ist eine Helfer Klasse die nur Statische Methoden
anbietet für die Manipulation von Arrays die zur Struktur passen welche in den
<classname>Zend_Ldap</classname> Data Änderungs Methoden verwendet werden und zum
Datenformat das vom <classname>Zend_Ldap</classname> Server benötigt wird.
<acronym>PHP</acronym> Datentypen werden wie folgt konvertiert:
</para>
<variablelist>
<varlistentry>
<term><code>string</code></term>
<listitem><para>Es wird keine Konvertierung durchgeführt.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>integer</code> und <code>float</code></term>
<listitem><para>Der Wert wird zu einem String konvertiert.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>boolean</code></term>
<listitem>
<para>
<constant>TRUE</constant> wird zu
<emphasis>'<constant>TRUE</constant>'</emphasis> konvertiert und
<constant>FALSE</constant> zu <emphasis>'<constant>FALSE</constant>'</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>object</code> und <code>array</code></term>
<listitem>
<para>
Diese Werte werden zu einem String konvertiert indem
<methodname>serialize()</methodname> verwendet wird.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>resource</code></term>
<listitem>
<para>
Wenn eine <code>stream</code> Ressource angegeben wurde, werden die Daten
durch den Aufruf von <methodname>stream_get_contents()</methodname> geholt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>others</term>
<listitem>
<para>
Alle anderen Datentypen (speziell nicht-Stream Ressourcen) werden verweigert.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>Beim Lesen von Attributwerten werden die folgenden Konvertierungen durchgeführt:</para>
<variablelist>
<varlistentry>
<term><emphasis>'<constant>TRUE</constant>'</emphasis></term>
<listitem><para>Wird zu <constant>TRUE</constant> konvertiert.</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>'<constant>FALSE</constant>'</emphasis></term>
<listitem><para>Wird zu <constant>FALSE</constant> konvertiert.</para></listitem>
</varlistentry>
<varlistentry>
<term>others</term>
<listitem>
<para>
Alle anderen Strings werden nicht automatisch konvertiert und so wie Sie sind
übergeben.
</para>
</listitem>
</varlistentry>
</variablelist>
<table id="zend.ldap.api.reference.zend-ldap-attribute.table">
<title>Zend_Ldap_Attribute API</title>
<tgroup cols="2">
<thead>
<row>
<entry>Methode</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<emphasis><code>void setAttribute(array &$data, string
$attribName, mixed $value, boolean $append)</code>
</emphasis>
</entry>
<entry>
Setzt die Attribute <varname>$attribName</varname> in
<varname>$data</varname> auf den Wert <varname>$value</varname>. Wenn
<varname>$append</varname> <constant>TRUE</constant> ist (standardmäßig
<constant>FALSE</constant>) wird <varname>$value</varname> an das Attribut
angehängt. <varname>$value</varname> kann ein skalarer Wert oder ein Array
von skalaren Werten sein. Eine Konvertierung wird durchgeführt.
</entry>
</row>
<row>
<entry>
<emphasis><code>array|mixed getAttribute(array $data,
string $attribName, integer|null $index)</code></emphasis>
</entry>
<entry>
Gibt das Attribut <varname>$attribName</varname> von
<varname>$data</varname> zurück. Wenn <varname>$index</varname>
<constant>NULL</constant> ist (Standardwert) wird ein Array zurückgegeben
welches alle Werte für das angegebene Attribut enthält. Ein leeres Array
wird zurückgegeben wenn das Attribut im angegebenen Array nicht existiert.
Wenn ein Integer für den Index spezifiziert wird, dann wird der
korrespondierende Wert mit dem gegebenen Index zurückgegeben. Wenn der Index
ausserhalb der Grenzen ist wird <constant>NULL</constant> zurückgegeben.
Eine Konvertierung wird durchgeführt.
</entry>
</row>
<row>
<entry>
<emphasis><code>boolean attributeHasValue(array &$data,
string $attribName, mixed|array $value)</code></emphasis>
</entry>
<entry>
Prüft ob das Attribut <varname>$attribName</varname> in
<varname>$data</varname> den Wert oder die Werte welche in
<varname>$value</varname> angegeben wurden hat. Die Methode gibt nur dann
<constant>TRUE</constant> zurück wenn alle Werte von
<varname>$value</varname> im Attribut enthalten sind. Der Vergleich wird
strikt durchgeführt (der Datentyp wird respektiert).
</entry>
</row>
<row>
<entry>
<emphasis><code>void removeDuplicatesFromAttribute(array
&$data, string $attribName)</code></emphasis>
</entry>
<entry>
Entfernt alle Duplikate vom Attribut <varname>$attribName</varname> in
<varname>$data</varname>.
</entry>
</row>
<row>
<entry>
<emphasis><code>void removeFromAttribute(array &$data,
string $attribName, mixed|array $value)</code></emphasis>
</entry>
<entry>
Entfernt den Wert oder die Werte vom Attribut <varname>$attribName</varname>
die in <varname>$value</varname> angegeben werden von
<varname>$data</varname>.
</entry>
</row>
<row>
<entry>
<emphasis><code>string|null convertToLdapValue(mixed
$value)</code></emphasis>
</entry>
<entry>
Konvertiert einen <acronym>PHP</acronym> Datentyp in seine
<acronym>LDAP</acronym> Repräsentation. Siehe die Einleitung für Details.
</entry>
</row>
<row>
<entry>
<emphasis><code>mixed convertFromLdapValue(string
$value)</code></emphasis>
</entry>
<entry>
Konvertiert einen <acronym>LDAP</acronym> Wert in seinen
<acronym>PHP</acronym> Datentyp. Siehe die Einleitung für Details.
</entry>
</row>
<row>
<entry>
<emphasis><code>string|null
convertToLdapDateTimeValue(integer $value, boolean $utc)</code>
</emphasis>
</entry>
<entry>
Konvertiert einen Zeitpunkt in seine <acronym>LDAP</acronym> Datum und Zeit
Repräsentation. Wenn <varname>$utc</varname> <constant>TRUE</constant> ist
(standardmäßig ist es <constant>FALSE</constant>) dann wird der
resultierende <acronym>LDAP</acronym> Datum und Zeit String in
<acronym>UTC</acronym> sein, andernfalls wird ein lokaler Datum und Zeit
String zurückgegeben.
</entry>
</row>
<row>
<entry>
<emphasis><code>integer|null
convertFromLdapDateTimeValue(string $value)</code>
</emphasis>
</entry>
<entry>
Konvertiert eine Datum und Zeit Repräsentation für <acronym>LDAP</acronym>
in einen Zeitpunkt. Die Methode gibt <constant>NULL</constant> zurück wenn
<varname>$value</varname> nicht in einen <acronym>PHP</acronym> Zeitpunkt
zurückkonvertiert werden kann.
</entry>
</row>
<row>
<entry>
<emphasis><code>void setPassword(array &$data, string
$password, string $hashType, string $attribName)</code></emphasis>
</entry>
<entry>
Setzt ein <acronym>LDAP</acronym> Passwort für das Attribut
<varname>$attribName</varname> in <varname>$data</varname> zurück.
<varname>$attribName</varname> ist standardmäßig <code>'userPassword'</code>
welches das standardmäßige Attribut für Passwörter ist. Der Hash für das
Passwort kann mit <varname>$hashType</varname> spezifiziert werden. Der
Standardwert ist <constant>Zend_Ldap_Attribute::PASSWORD_HASH_MD5</constant>
wobei <constant>Zend_Ldap_Attribute::PASSWORD_HASH_SHA</constant> die andere
Möglichkeit ist.
</entry>
</row>
<row>
<entry>
<emphasis><code>string createPassword(string $password,
string $hashType)</code></emphasis>
</entry>
<entry>
Erstellt ein <acronym>LDAP</acronym> Passwort. Der Hash für das Passwort
kann mit <varname>$hashType</varname> spezifiziert werden. Der Standardwert
ist <constant>Zend_Ldap_Attribute::PASSWORD_HASH_MD5</constant> wobei
<constant>Zend_Ldap_Attribute::PASSWORD_HASH_SHA</constant> die andere
Möglichkeit ist.
</entry>
</row>
<row>
<entry>
<emphasis><code>void setDateTimeAttribute(array &$data,
string $attribName, integer|array $value, boolean $utc, boolean
$append)</code></emphasis>
</entry>
<entry>
Setzt das Attribut <varname>$attribName</varname> in
<varname>$data</varname> auf den Datum und Zeitwert
<varname>$value</varname>. Wenn <varname>$append</varname>
<constant>TRUE</constant> ist (standardmäßig ist er
<constant>FALSE</constant>) dann wird <varname>$value</varname> an das
Attribut angehängt. <varname>$value</varname> kann ein Integerwert oder ein
Array von Integerwerten sein. Die Konvertierung von Datum und Zeit wird
entsprechend zu
<methodname>Zend_Ldap_Attribute::convertToLdapDateTimeValue()</methodname>
durchgeführt.
</entry>
</row>
<row>
<entry>
<emphasis><code>array|integer getDateTimeAttribute(array
$data, string $attribName, integer|null $index)</code></emphasis>
</entry>
<entry>
Gibt das Datum und Zeit Attribut <varname>$attribName</varname> von
<varname>$data</varname> zurück. Wenn <varname>$index</varname>
<constant>NULL</constant> ist (das ist der Standardwert) dann wird ein Array
zurückgegeben welches alle Datum und Zeitwerte für das angegebene Attribut
enthält. Ein leeres Array wird zurückgegeben wenn das Attribut im
angegebenen Array nicht existiert. Wenn ein Integer Index spezifiziert wird,
dann wird der korrespondierende Datum und Zeitwert vom angegebenen Index
zurückgegeben. Wenn der Index ausserhalb der Grenzen ist dann wird
<constant>NULL</constant> zurückgegeben. Die Konvertierung von Datum und
Zeit wird entsprechend zu
<methodname>Zend_Ldap_Attribute::convertFromLdapDateTimeValue()</methodname>
durchgeführt.
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect3>
|