Docs For Class Zend_Ldap

Description

Zend_Ldap_Attribute is a collection of LDAP attribute related functions.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Ldap/Attribute.php (line 30)

Class Constant Summary

PASSWORD_HASH_MD5 = 'md5'

PASSWORD_HASH_SHA = 'sha'

PASSWORD_HASH_SMD5 = 'smd5'

PASSWORD_HASH_SSHA = 'ssha'

PASSWORD_UNICODEPWD = 'unicodePwd'

Method Summary

static boolean attributeHasValue ( &$data, string $attribName, mixed|array $value, array $data)

static integer|null convertFromLdapDateTimeValue (string $value)

static mixed convertFromLdapValue (string $value)

static string|null convertToLdapDateTimeValue (integer $value, [boolean $utc = false])

static string|null convertToLdapValue (mixed $value)

static string createPassword (string $password, [string $hashType = self::PASSWORD_HASH_MD5])

static array|mixed getAttribute ( $data, string $attribName, [integer $index = null])

static array|integer getDateTimeAttribute ( $data, string $attribName, [integer $index = null])

static void removeDuplicatesFromAttribute ( &$data, string $attribName, array $data)

static void removeFromAttribute ( &$data, string $attribName, mixed|array $value, array $data)

static void setAttribute ( &$data, string $attribName, scalar|array|Traversable $value, [boolean $append = false], array $data)

static null setDateTimeAttribute ( &$data, string $attribName, integer|array|Traversable $value, [boolean $utc = false], [boolean $append = false], array $data)

static null setPassword ( &$data, string $password, [string $hashType = self::PASSWORD_HASH_MD5], [string|null $attribName = null], array $data)

Methods

static attributeHasValue (line 115)

Checks if the given value(s) exist in the attribute

access: public

static boolean attributeHasValue ( &$data, string $attribName, mixed|array $value, array $data)

array $data
string $attribName
mixed|array $value
array &$data

static convertFromLdapDateTimeValue (line 249)

Converts LDAP date/time representation into a timestamp

return: - null if the value cannot be converted.
access: public

static integer|null convertFromLdapDateTimeValue (string $value)

string $value

static convertFromLdapValue (line 226)

Converts an LDAP value into its PHP data type

access: public

static mixed convertFromLdapValue (string $value)

string $value

static convertToLdapDateTimeValue (line 238)

Converts a timestamp into its LDAP date/time representation

return: - null if the value cannot be converted.
access: public

static string|null convertToLdapDateTimeValue (integer $value, [boolean $utc = false])

integer $value
boolean $utc

static convertToLdapValue (line 215)

Converts a PHP data type into its LDAP representation

return: - null if the PHP data type cannot be converted.
access: public

static string|null convertToLdapValue (mixed $value)

mixed $value

static createPassword (line 285)

Creates a LDAP password.

access: public

static string createPassword (string $password, [string $hashType = self::PASSWORD_HASH_MD5])

string $password
string $hashType

static getAttribute (line 84)

Gets a LDAP attribute.

access: public

static array|mixed getAttribute ( $data, string $attribName, [integer $index = null])

array $data
string $attribName
integer $index

static getDateTimeAttribute (line 379)

Gets a LDAP date/time attribute.

access: public

static array|integer getDateTimeAttribute ( $data, string $attribName, [integer $index = null])

array $data
string $attribName
integer $index

static removeDuplicatesFromAttribute (line 140)

Removes duplicate values from a LDAP attribute

access: public

static void removeDuplicatesFromAttribute ( &$data, string $attribName, array $data)

array $data
string $attribName
array &$data

static removeFromAttribute (line 155)

Remove given values from a LDAP attribute

access: public

static void removeFromAttribute ( &$data, string $attribName, mixed|array $value, array $data)

array $data
string $attribName
mixed|array $value
array &$data

static setAttribute (line 47)

Sets a LDAP attribute.

access: public

static void setAttribute ( &$data, string $attribName, scalar|array|Traversable $value, [boolean $append = false], array $data)

array $data
string $attribName
scalar|array|Traversable $value
boolean $append
array &$data

static setDateTimeAttribute (line 339)

Sets a LDAP date/time attribute.

access: public

static null setDateTimeAttribute ( &$data, string $attribName, integer|array|Traversable $value, [boolean $utc = false], [boolean $append = false], array $data)

array $data
string $attribName
integer|array|Traversable $value
boolean $utc
boolean $append
array &$data

static setPassword (line 263)

Sets a LDAP password.

access: public

static null setPassword ( &$data, string $password, [string $hashType = self::PASSWORD_HASH_MD5], [string|null $attribName = null], array $data)

array $data
string $password
string $hashType
string|null $attribName
array &$data

Class Constants

PASSWORD_HASH_MD5 = 'md5' (line 32)

PASSWORD_HASH_SHA = 'sha' (line 34)

PASSWORD_HASH_SMD5 = 'smd5' (line 33)

PASSWORD_HASH_SSHA = 'ssha' (line 35)

PASSWORD_UNICODEPWD = 'unicodePwd' (line 36)