Zend_Ldap_Attribute is a collection of LDAP attribute related functions.

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

 Methods

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

attributeHasValue(array $data, string $attribName, mixed|array $value) : boolean
Static

Parameters

$data

array

$attribName

string

$value

mixedarray

Returns

boolean

Converts LDAP date/time representation into a timestamp

convertFromLdapDateTimeValue(string $value) : integer | null
Static

Parameters

$value

string

Returns

integernull- null if the value cannot be converted.

Converts an LDAP value into its PHP data type

convertFromLdapValue(string $value) : mixed
Static
deprected use Zend_Ldap_Converter instead

Parameters

$value

string

Returns

mixed

Converts a timestamp into its LDAP date/time representation

convertToLdapDateTimeValue(integer $value, boolean $utc = false) : string | null
Static

Parameters

$value

integer

$utc

boolean

Returns

stringnull- null if the value cannot be converted.

Converts a PHP data type into its LDAP representation

convertToLdapValue(mixed $value) : string | null
Static
deprected use Zend_Ldap_Converter instead

Parameters

$value

mixed

Returns

stringnull- null if the PHP data type cannot be converted.

Creates a LDAP password.

createPassword(string $password, string $hashType = self::PASSWORD_HASH_MD5) : string
Static

Parameters

$password

string

$hashType

string

Returns

string

Gets a LDAP attribute.

getAttribute(array $data, string $attribName, integer $index = null) : array | mixed
Static

Parameters

$data

array

$attribName

string

$index

integer

Returns

arraymixed

Gets a LDAP date/time attribute.

getDateTimeAttribute(array $data, string $attribName, integer $index = null) : array | integer
Static

Parameters

$data

array

$attribName

string

$index

integer

Returns

arrayinteger

Removes duplicate values from a LDAP attribute

removeDuplicatesFromAttribute(array $data, string $attribName) : void
Static

Parameters

$data

array

$attribName

string

Remove given values from a LDAP attribute

removeFromAttribute(array $data, string $attribName, mixed|array $value) : void
Static

Parameters

$data

array

$attribName

string

$value

mixedarray

Sets a LDAP attribute.

setAttribute(array $data, string $attribName, scalar|array|\Traversable $value, boolean $append = false) : void
Static

Parameters

$data

array

$attribName

string

$value

scalararray\Traversable

$append

boolean

Sets a LDAP date/time attribute.

setDateTimeAttribute(array $data, string $attribName, integer|array|\Traversable $value, boolean $utc = false, boolean $append = false) : null
Static

Parameters

$data

array

$attribName

string

$value

integerarray\Traversable

$utc

boolean

$append

boolean

Returns

null

Sets a LDAP password.

setPassword(array $data, string $password, string $hashType = self::PASSWORD_HASH_MD5, string|null $attribName = null) : null
Static

Parameters

$data

array

$password

string

$hashType

string

$attribName

stringnull

Returns

null

_valueFromLdap()

_valueFromLdap(string $value) : mixed
Static

Parameters

$value

string

Returns

mixed

_valueFromLdapDateTime()

_valueFromLdapDateTime(string|\DateTime $value) : integer | null
Static

Parameters

$value

string\DateTime

Returns

integernull

_valueToLdap()

_valueToLdap(mixed $value) : string | null
Static

Parameters

$value

mixed

Returns

stringnull

_valueToLdapDateTime()

_valueToLdapDateTime(integer $value, boolean $utc) : string | null
Static

Parameters

$value

integer

$utc

boolean

Returns

stringnull

 Constants

 

PASSWORD_HASH_MD5

PASSWORD_HASH_MD5 = 'md5' 
 

PASSWORD_HASH_SHA

PASSWORD_HASH_SHA = 'sha' 
 

PASSWORD_HASH_SMD5

PASSWORD_HASH_SMD5 = 'smd5' 
 

PASSWORD_HASH_SSHA

PASSWORD_HASH_SSHA = 'ssha' 
 

PASSWORD_UNICODEPWD

PASSWORD_UNICODEPWD = 'unicodePwd'