Ldap/Ldif/Encoder.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
subpackage: Ldif
version: $Id: Encoder.php 21007 2010-02-09 13:40:16Z sgehrig $
Classes: Zend_Ldap_Ldif_Encoder

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_Ldif_Encoder
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
subpackage: Ldif
Properties: $_options; $_versionWritten
Methods: __construct; decode; _decode; _pushAttribute; encode; _encode; _encodeString; _encodeAttribute; _encodeAttributes

Description

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

Properties

$_options
jump to class

array $_options = 'array'

Additional options used during encoding

Details

$_options: array
visibility: protected
default: array
final: false
static: false

$_versionWritten
jump to class

boolean $_versionWritten = 'false'

Details

$_versionWritten: boolean
visibility: protected
default: false
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor.

Arguments

$options: array
Additional options used during encoding

Details

visibility: protected
final: false
static: false

_decode
jump to class

_decode(
          string $string
          )
        
        :
        array

Decodes the string $string into an array of LDIF items

Arguments

$string: string

Output

array

Details

visibility: protected
final: false
static: false

_encode
jump to class

_encode(
          mixed $value
          )
        
        :
        string

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

Arguments

$value: mixed
The value to be encoded

Output

string: Encoded value

Details

visibility: protected
final: false
static: false

_encodeAttribute
jump to class

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

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

Arguments

$name: string
$value: arraystring

Output

string

Details

visibility: protected
final: false
static: false
link: http://www.faqs.org/rfcs/rfc2849.html

_encodeAttributes
jump to class

_encodeAttributes(
          array $attributes
          )
        
        :
        string

Encodes a collection of attributes according to RFC2849

Arguments

$attributes: array

Output

string

Details

visibility: protected
final: false
static: false
link: http://www.faqs.org/rfcs/rfc2849.html

_encodeString
jump to class

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

Encodes $string according to RFC2849

Arguments

$string: string
$base64: boolen

Output

string

Details

visibility: protected
final: false
static: false
link: http://www.faqs.org/rfcs/rfc2849.html

_pushAttribute
jump to class

_pushAttribute(
          array $attribute, array $entry
          )
        
        :

Pushes a decoded attribute to the stack

Arguments

$attribute: array
$entry: array

Details

visibility: protected
final: false
static: false

decode
jump to class

decode(
          string $string
          )
        
        :
        array

Decodes the string $string into an array of LDIF items

Arguments

$string: string

Output

array

Details

visibility: public
final: false
static: true

encode
jump to class

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

Encode $value into a LDIF representation

Arguments

$value: mixed
The value to be encoded
$options: array
Additional options used during encoding

Output

string: The encoded value

Details

visibility: public
final: false
static: true

API Documentation

Ldap/Ldif/Encoder.php

Description

Zend_Ldap_Ldif_Encoderjump to top

Description

Properties

$_optionsjump to class

Details

$_versionWrittenjump to class

Details

Methods

__constructjump to class

Arguments

Details

_decodejump to class

Arguments

Output

Details

_encodejump to class

Arguments

Output

Details

_encodeAttributejump to class

Arguments

Output

Details

_encodeAttributesjump to class

Arguments

Output

Details

_encodeStringjump to class

Arguments

Output

Details

_pushAttributejump to class

Arguments

Details

decodejump to class

Arguments

Output

Details

encodejump to class

Arguments

Output

Details

Zend_Ldap_Ldif_Encoder
jump to top

$_options
jump to class

$_versionWritten
jump to class

__construct
jump to class

_decode
jump to class

_encode
jump to class

_encodeAttribute
jump to class

_encodeAttributes
jump to class

_encodeString
jump to class

_pushAttribute
jump to class

decode
jump to class

encode
jump to class