Ldap/Ldif/Encoder.php

Show:

inherited

Classes
- \Zend_Ldap_Ldif_Encoder

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 [email protected] 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
Subpackage: Ldif
Version: $Id: Encoder.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Ldap_Ldif_Encoder
jump to top

Package: Zend\Ldap\Ldif

Zend_Ldap_Ldif_Encoder provides methods to encode and decode LDAP data into/from LDIF.

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

Properties

array $_options = array('sort' => true, 'version' => 1, 'wrap' => 78)

Additional options used during encoding

Default valuearray('sort' => true, 'version' => 1, 'wrap' => 78)Details

Type: array

boolean $_versionWritten = false

Default valuefalseDetails

Type: boolean

Methods

__construct(array $options = array()) : void

Constructor.

Parameters

Name	Type	Description
$options	array	Additional options used during encoding

_decode(string $string) : array

Decodes the string $string into an array of LDIF items

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
array

_encode(mixed $value) : string

Recursive driver which determines the type of value to be encoded and then dispatches to the appropriate method.

Parameters

Name	Type	Description
$value	mixed	The value to be encoded

Returns

Type	Description
string	Encoded value

_encodeAttribute(string $name, array | string $value) : string

Encodes an attribute with $name and $value according to RFC2849

Parameters

Name	Type	Description
$name	string
$value	array \| string

Returns

Type	Description
string

Details

Link: http://www.faqs.org/rfcs/rfc2849.html

_encodeAttributes(array $attributes) : string

Encodes a collection of attributes according to RFC2849

Parameters

Name	Type	Description
$attributes	array

Returns

Type	Description
string

Details

Link: http://www.faqs.org/rfcs/rfc2849.html

_encodeString(string $string, \boolen $base64 = null) : string

Encodes $string according to RFC2849

Parameters

Name	Type	Description
$string	string
$base64	\boolen

Returns

Type	Description
string

Details

Link: http://www.faqs.org/rfcs/rfc2849.html

_pushAttribute(array $attribute, array $entry) : void

Pushes a decoded attribute to the stack

Parameters

Name	Type	Description
$attribute	array
$entry	array

decode(string $string) : array

static

Decodes the string $string into an array of LDIF items

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
array

encode(mixed $value, array $options = array()) : string

static

Encode $value into a LDIF representation

Parameters

Name	Type	Description
$value	mixed	The value to be encoded
$options	array	Additional options used during encoding

Returns

Type	Description
string	The encoded value

Ldap/Ldif/Encoder.php

\Zend_Ldap_Ldif_Encoderjump to top

Properties

Methods

\Zend_Ldap_Ldif_Encoder
jump to top