Ldap/Ldif/Encoder.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Ldap
- Subpackage
- Ldif
- Version
- $Id$
\Zend_Ldap_Ldif_Encoder
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-2014 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 value
array('sort' => true, 'version' => 1, 'wrap' => 78)Details- Type
- array
boolean $_versionWritten = falseDefault value
falseDetails- Type
- boolean
Methods
__construct(array $options = array()) : voidConstructor.
Parameters
| Name | Type | Description |
|---|---|---|
| $options | array | Additional options used during encoding |
_decode(string $string) : arrayDecodes the string $string into an array of LDIF items
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $string | string |
| Type | Description |
|---|---|
| array |
_encode(mixed $value) : stringRecursive driver which determines the type of value to be encoded and then dispatches to the appropriate method.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | mixed | The value to be encoded |
| Type | Description |
|---|---|
| string | Encoded value |
_encodeAttribute(string $name, array | string $value) : stringEncodes an attribute with $name and $value according to RFC2849
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | array | string |
| Type | Description |
|---|---|
| string |
_encodeAttributes(array $attributes) : stringEncodes a collection of attributes according to RFC2849
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $attributes | array |
| Type | Description |
|---|---|
| string |
_encodeString(string $string, \boolen $base64 = null) : stringEncodes $string according to RFC2849
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $string | string | |
| $base64 | \boolen |
| Type | Description |
|---|---|
| string |
_pushAttribute(array $attribute, array $entry) : voidPushes a decoded attribute to the stack
Parameters
| Name | Type | Description |
|---|---|---|
| $attribute | array | |
| $entry | array |
decode(string $string) : arraystatic
Decodes the string $string into an array of LDIF items
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $string | string |
| Type | Description |
|---|---|
| array |
encode(mixed $value, array $options = array()) : stringstatic
Encode $value into a LDIF representation
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | mixed | The value to be encoded |
| $options | array | Additional options used during encoding |
| Type | Description |
|---|---|
| string | The encoded value |