HumHub Documentation (unofficial)

Attribute
in package

Laminas\Ldap\Attribute is a collection of LDAP attribute related functions.

Table of Contents

Constants

PASSWORD_HASH_MD5  = 'md5'
PASSWORD_HASH_SHA  = 'sha'
PASSWORD_HASH_SMD5  = 'smd5'
PASSWORD_HASH_SSHA  = 'ssha'
PASSWORD_UNICODEPWD  = 'unicodePwd'

Methods

attributeHasValue()  : bool
Checks if the given value(s) exist in the attribute
createPassword()  : string
Creates a LDAP password.
getAttribute()  : array<string|int, mixed>|mixed
Gets a LDAP attribute.
getDateTimeAttribute()  : array<string|int, mixed>|int
Gets a LDAP date/time attribute.
removeDuplicatesFromAttribute()  : void
Removes duplicate values from a LDAP attribute
removeFromAttribute()  : void
Remove given values from a LDAP attribute
setAttribute()  : void
Sets a LDAP attribute.
setDateTimeAttribute()  : mixed
Sets a LDAP date/time attribute.
setPassword()  : mixed
Sets a LDAP password.
valueFromLdap()  : mixed
valueFromLdapDateTime()  : int|null
valueToLdap()  : string|null
valueToLdapDateTime()  : string|null

Constants

PASSWORD_HASH_MD5

public mixed PASSWORD_HASH_MD5 = 'md5'

PASSWORD_HASH_SHA

public mixed PASSWORD_HASH_SHA = 'sha'

PASSWORD_HASH_SMD5

public mixed PASSWORD_HASH_SMD5 = 'smd5'

PASSWORD_HASH_SSHA

public mixed PASSWORD_HASH_SSHA = 'ssha'

PASSWORD_UNICODEPWD

public mixed PASSWORD_UNICODEPWD = 'unicodePwd'

Methods

attributeHasValue()

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

public static attributeHasValue(array<string|int, mixed> &$data, string $attribName, mixed|array<string|int, mixed> $value) : bool
Parameters
$data : array<string|int, mixed>
$attribName : string
$value : mixed|array<string|int, mixed>
Return values
bool

createPassword()

Creates a LDAP password.

public static createPassword(string $password[, string $hashType = self::PASSWORD_HASH_MD5 ]) : string
Parameters
$password : string
$hashType : string = self::PASSWORD_HASH_MD5
Return values
string

getAttribute()

Gets a LDAP attribute.

public static getAttribute(array<string|int, mixed> $data, string $attribName[, int $index = null ]) : array<string|int, mixed>|mixed
Parameters
$data : array<string|int, mixed>
$attribName : string
$index : int = null
Return values
array<string|int, mixed>|mixed

getDateTimeAttribute()

Gets a LDAP date/time attribute.

public static getDateTimeAttribute(array<string|int, mixed> $data, string $attribName[, int $index = null ]) : array<string|int, mixed>|int
Parameters
$data : array<string|int, mixed>
$attribName : string
$index : int = null
Return values
array<string|int, mixed>|int

removeDuplicatesFromAttribute()

Removes duplicate values from a LDAP attribute

public static removeDuplicatesFromAttribute(array<string|int, mixed> &$data, string $attribName) : void
Parameters
$data : array<string|int, mixed>
$attribName : string

removeFromAttribute()

Remove given values from a LDAP attribute

public static removeFromAttribute(array<string|int, mixed> &$data, string $attribName, mixed|array<string|int, mixed> $value) : void
Parameters
$data : array<string|int, mixed>
$attribName : string
$value : mixed|array<string|int, mixed>

setAttribute()

Sets a LDAP attribute.

public static setAttribute(array<string|int, mixed> &$data, string $attribName, string|array<string|int, mixed>|Traversable $value[, bool $append = false ]) : void
Parameters
$data : array<string|int, mixed>
$attribName : string
$value : string|array<string|int, mixed>|Traversable
$append : bool = false

setDateTimeAttribute()

Sets a LDAP date/time attribute.

public static setDateTimeAttribute(array<string|int, mixed> &$data, string $attribName, int|array<string|int, mixed>|Traversable $value[, bool $utc = false ][, bool $append = false ]) : mixed
Parameters
$data : array<string|int, mixed>
$attribName : string
$value : int|array<string|int, mixed>|Traversable
$utc : bool = false
$append : bool = false

setPassword()

Sets a LDAP password.

public static setPassword(array<string|int, mixed> &$data, string $password[, string $hashType = self::PASSWORD_HASH_MD5 ][, string $attribName = null ]) : mixed
Parameters
$data : array<string|int, mixed>
$password : string
$hashType : string = self::PASSWORD_HASH_MD5

Optional by default MD5

$attribName : string = null

Optional

valueFromLdap()

private static valueFromLdap(string $value) : mixed
Parameters
$value : string

valueFromLdapDateTime()

private static valueFromLdapDateTime(string|DateTime $value) : int|null
Parameters
$value : string|DateTime
Return values
int|null

valueToLdap()

private static valueToLdap(mixed $value) : string|null
Parameters
$value : mixed
Return values
string|null

valueToLdapDateTime()

private static valueToLdapDateTime(int $value, bool $utc) : string|null
Parameters
$value : int
$utc : bool
Return values
string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results