Ldap/Converter.php

Show:

inherited

Classes
- \Zend_Ldap_Converter

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Ldap
Version: $Id: Converter.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Ldap_Converter
jump to top

Package: Zend\Ldap

Zend_Ldap_Converter is a collection of useful LDAP related conversion functions.

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

Constants

 
                STANDARD
                = 0

 
                BOOLEAN
                = 1

 
                GENERALIZED_TIME
                = 2

Methods

ascToHex32(string $string) : string

static

Converts all ASCII chars < 32 to "\HEX"

Parameters

Name	Type	Description
$string	string	String to convert

Returns

Type	Description
string

Details

Author: Benedikt Hallinger
Link: http://pear.php.net/package/Net_LDAP2
See: from Benedikt Hallinger

fromLdap(string $value, $type = self::STANDARD, boolean $dateTimeAsUtc = true) : mixed

static

Convert an LDAP-compatible value to a corresponding PHP-value.

By setting the $type-parameter the conversion of a certain type can be forced .

Parameters

Name	Type	Description
$value	string	The value to convert
$type
$dateTimeAsUtc	boolean	Return DateTime values in UTC timezone

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Ldap_Converter_Exception

fromLdapBoolean(string $value) : boolean

static

Convert an LDAP-compatible boolean value into a PHP-compatible one

Parameters

Name	Type	Description
$value	string	The value to convert

Returns

Type	Description
boolean

Throws

Exception	Description
\InvalidArgumentException

fromLdapDateTime(string $date, boolean $asUtc = true) : \DateTime

static

Convert an LDAP-Generalized-Time-entry into a DateTime-Object

CAVEAT: The DateTime-Object returned will alwasy be set to UTC-Timezone.

Parameters

Name	Type	Description
$date	string	The generalized-Time
$asUtc	boolean	Return the DateTime with UTC timezone

Returns

Type	Description
\DateTime

Throws

Exception	Description
\InvalidArgumentException	if a non-parseable-format is given

fromLdapUnserialize(string $value) : mixed

static

Unserialize a serialized value to return the corresponding object

Parameters

Name	Type	Description
$value	string	The value to convert

Returns

Type	Description
mixed

Throws

Exception	Description
\UnexpectedValueException

hex32ToAsc(string $string) : string

static

Converts all Hex expressions ("\HEX") to their original ASCII characters

Parameters

Name	Type	Description
$string	string	String to convert

Returns

Type	Description
string

Details

Author: Benedikt Hallinger , heavily based on work from DavidSmith@byu.net
Link: http://pear.php.net/package/Net_LDAP2
See: from Benedikt Hallinger , heavily based on work from DavidSmith@byu.net

toLdap(mixed $value, $type = self::STANDARD) : string

static

Convert any value to an LDAP-compatible value.

By setting the $type-parameter the conversion of a certain type can be forced

Parameters

Name	Type	Description
$value	mixed	The value to convert
$type

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Ldap_Converter_Exception

Details

Todo: write more tests

toLdapBoolean(boolean | integer | string $value) : string

static

Convert a boolean value to an LDAP-compatible string

This converts a boolean value of TRUE, an integer-value of 1 and a case-insensitive string 'true' to an LDAP-compatible 'TRUE'. All other other values are converted to an LDAP-compatible 'FALSE'.

Parameters

Name	Type	Description
$value	boolean \| integer \| string	The boolean value to encode

Returns

Type	Description
string

toLdapDateTime(integer | string | \DateTimt | \Zend_Date $date, boolean $asUtc = true) : string

static

Converts a date-entity to an LDAP-compatible date-string

The date-entity $date can be either a timestamp, a DateTime Object, a string that is parseable by strtotime() or a Zend_Date Object.

Parameters

Name	Type	Description
$date	integer \| string \| \DateTimt \| \Zend_Date	The date-entity
$asUtc	boolean	Whether to return the LDAP-compatible date-string as UTC or as local value

Returns

Type	Description
string

Throws

Exception	Description
\InvalidArgumentException

toLdapSerialize(mixed $value) : string

static

Serialize any value for storage in LDAP

Parameters

Name	Type	Description
$value	mixed	The value to serialize

Returns

Type	Description
string

Ldap/Converter.php

\Zend_Ldap_Converterjump to top

Constants

Methods

\Zend_Ldap_Converter
jump to top