Ldap/Attribute.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Ldap
version: $Id: Attribute.php 22997 2010-09-22 17:04:28Z sgehrig $
Classes: Zend_Ldap_Attribute

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Ldap_Attribute
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Ldap
Constants: PASSWORD_HASH_MD5; PASSWORD_HASH_SMD5; PASSWORD_HASH_SHA; PASSWORD_HASH_SSHA; PASSWORD_UNICODEPWD
Methods: setAttribute; getAttribute; attributeHasValue; removeDuplicatesFromAttribute; removeFromAttribute; _valueToLdap; _valueFromLdap; convertToLdapValue; convertFromLdapValue; convertToLdapDateTimeValue; convertFromLdapDateTimeValue; setPassword; createPassword; setDateTimeAttribute; _valueToLdapDateTime; getDateTimeAttribute; _valueFromLdapDateTime

Description

Zend_Ldap_Attribute is a collection of LDAP attribute related functions.

Constants

PASSWORD_HASH_MD5
jump to class

 PASSWORD_HASH_MD5 = 'md5'

Details

value: md5

PASSWORD_HASH_SMD5
jump to class

 PASSWORD_HASH_SMD5 = 'smd5'

Details

value: smd5

PASSWORD_HASH_SHA
jump to class

 PASSWORD_HASH_SHA = 'sha'

Details

value: sha

PASSWORD_HASH_SSHA
jump to class

 PASSWORD_HASH_SSHA = 'ssha'

Details

value: ssha

PASSWORD_UNICODEPWD
jump to class

 PASSWORD_UNICODEPWD = 'unicodePwd'

Details

value: unicodePwd

Methods

_valueFromLdap
jump to class

_valueFromLdap(
          string $value
          )
        
        :
        mixed

Arguments

$value: string

Output

mixed

Details

visibility: private
final: false
static: true

_valueFromLdapDateTime
jump to class

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

Arguments

$value: stringDateTime

Output

integer|null

Details

visibility: private
final: false
static: true

_valueToLdap
jump to class

_valueToLdap(
          mixed $value
          )
        
        :
        string|null

Arguments

$value: mixed

Output

string|null

Details

visibility: private
final: false
static: true

_valueToLdapDateTime
jump to class

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

Arguments

$value: integer
$utc: boolean

Output

string|null

Details

visibility: private
final: false
static: true

attributeHasValue
jump to class

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

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

Arguments

$data: array
$attribName: string
$value: mixedarray

Output

boolean

Details

visibility: public
final: false
static: true

convertFromLdapDateTimeValue
jump to class

convertFromLdapDateTimeValue(
          string $value
          )
        
        :
        integer|null

Converts LDAP date/time representation into a timestamp

Arguments

$value: string

Output

integer|null: - null if the value cannot be converted.

Details

visibility: public
final: false
static: true

convertFromLdapValue
jump to class

convertFromLdapValue(
          string $value
          )
        
        :
        mixed

Converts an LDAP value into its PHP data type

Arguments

$value: string

Output

mixed

Details

visibility: public
final: false
static: true
deprected: use Zend_Ldap_Converter instead

convertToLdapDateTimeValue
jump to class

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

Converts a timestamp into its LDAP date/time representation

Arguments

$value: integer
$utc: boolean

Output

string|null: - null if the value cannot be converted.

Details

visibility: public
final: false
static: true

convertToLdapValue
jump to class

convertToLdapValue(
          mixed $value
          )
        
        :
        string|null

Converts a PHP data type into its LDAP representation

Arguments

$value: mixed

Output

string|null: - null if the PHP data type cannot be converted.

Details

visibility: public
final: false
static: true
deprected: use Zend_Ldap_Converter instead

createPassword
jump to class

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

Creates a LDAP password.

Arguments

$password: string
$hashType: string

Output

string

Details

visibility: public
final: false
static: true

getAttribute
jump to class

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

Gets a LDAP attribute.

Arguments

$data: array
$attribName: string
$index: integer

Output

array|mixed

Details

visibility: public
final: false
static: true

getDateTimeAttribute
jump to class

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

Gets a LDAP date/time attribute.

Arguments

$data: array
$attribName: string
$index: integer

Output

array|integer

Details

visibility: public
final: false
static: true

removeDuplicatesFromAttribute
jump to class

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

Removes duplicate values from a LDAP attribute

Arguments

$data: array
$attribName: string

Details

visibility: public
final: false
static: true

removeFromAttribute
jump to class

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

Remove given values from a LDAP attribute

Arguments

$data: array
$attribName: string
$value: mixedarray

Details

visibility: public
final: false
static: true

setAttribute
jump to class

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

Sets a LDAP attribute.

Arguments

$data: array
$attribName: string
$value: scalararrayTraversable
$append: boolean

Details

visibility: public
final: false
static: true

setDateTimeAttribute
jump to class

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

Sets a LDAP date/time attribute.

Arguments

$data: array
$attribName: string
$value: integerarrayTraversable
$utc: boolean
$append: boolean

Output

null

Details

visibility: public
final: false
static: true

setPassword
jump to class

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

Sets a LDAP password.

Arguments

$data: array
$password: string
$hashType: string
$attribName: stringnull

Output

null

Details

visibility: public
final: false
static: true

API Documentation

Ldap/Attribute.php

Description

Zend_Ldap_Attributejump to top

Description

Constants

PASSWORD_HASH_MD5jump to class

Details

PASSWORD_HASH_SMD5jump to class

Details

PASSWORD_HASH_SHAjump to class

Details

PASSWORD_HASH_SSHAjump to class

Details

PASSWORD_UNICODEPWDjump to class

Details

Methods

_valueFromLdapjump to class

Arguments

Output

Details

_valueFromLdapDateTimejump to class

Arguments

Output

Details

_valueToLdapjump to class

Arguments

Output

Details

_valueToLdapDateTimejump to class

Arguments

Output

Details

attributeHasValuejump to class

Arguments

Output

Details

convertFromLdapDateTimeValuejump to class

Arguments

Output

Details

convertFromLdapValuejump to class

Arguments

Output

Details

convertToLdapDateTimeValuejump to class

Arguments

Output

Details

convertToLdapValuejump to class

Arguments

Output

Details

createPasswordjump to class

Arguments

Output

Details

getAttributejump to class

Arguments

Output

Details

getDateTimeAttributejump to class

Arguments

Output

Details

removeDuplicatesFromAttributejump to class

Arguments

Details

removeFromAttributejump to class

Arguments

Details

setAttributejump to class

Arguments

Details

setDateTimeAttributejump to class

Arguments

Output

Details

setPasswordjump to class

Arguments

Zend_Ldap_Attribute
jump to top

PASSWORD_HASH_MD5
jump to class

PASSWORD_HASH_SMD5
jump to class

PASSWORD_HASH_SHA
jump to class

PASSWORD_HASH_SSHA
jump to class

PASSWORD_UNICODEPWD
jump to class

_valueFromLdap
jump to class

_valueFromLdapDateTime
jump to class

_valueToLdap
jump to class

_valueToLdapDateTime
jump to class

attributeHasValue
jump to class

convertFromLdapDateTimeValue
jump to class

convertFromLdapValue
jump to class

convertToLdapDateTimeValue
jump to class

convertToLdapValue
jump to class

createPassword
jump to class

getAttribute
jump to class

getDateTimeAttribute
jump to class

removeDuplicatesFromAttribute
jump to class

removeFromAttribute
jump to class

setAttribute
jump to class

setDateTimeAttribute
jump to class

setPassword
jump to class