PHP Class Turba_Data_Ldif, horde

Copyright 2007-2016 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/apache.
Author: Rita Selsky ([email protected])
Inheritance: extends Horde_Data_Base
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_contentType
$_extension
$_mozillaAttr array Useful Mozilla address book attribute names.
$_turbaAttr array Useful Turba address book attribute names.
$_turbaMozillaMap array Turba address book attribute names and the corresponding Mozilla name.

Public Methods

Method Description
exportData ( array $data, boolean $header = false ) : string Builds a LDIF file from a given data structure and returns it as a string.
exportFile ( string $filename, array $data, boolean $header = false ) Builds a LDIF file from a given data structure and triggers its download.
importData ( $contents, $header = false )
nextStep ( integer $action, array $param = [] ) : mixed Takes all necessary actions for the given import step, parameters and form values and returns the next necessary step.

Protected Methods

Method Description
_is_safe_string ( string $str ) : boolean Checks if a string is safe according to RFC 2849, or if it needs to be base64 encoded.

Method Details

_is_safe_string() protected method

Checks if a string is safe according to RFC 2849, or if it needs to be base64 encoded.
protected _is_safe_string ( string $str ) : boolean
$str string The string to check.
return boolean True if the string is safe.

exportData() public method

Builds a LDIF file from a given data structure and returns it as a string.
public exportData ( array $data, boolean $header = false ) : string
$data array A two-dimensional array containing the data set.
$header boolean If true, the rows of $data are associative arrays with field names as their keys.
return string The LDIF data.

exportFile() public method

It DOES NOT exit the current script but only outputs the correct headers and data.
public exportFile ( string $filename, array $data, boolean $header = false )
$filename string The name of the file to be downloaded.
$data array A two-dimensional array containing the data set.
$header boolean If true, the rows of $data are associative arrays with field names as their keys.

importData() public method

public importData ( $contents, $header = false )

nextStep() public method

Takes all necessary actions for the given import step, parameters and form values and returns the next necessary step.
public nextStep ( integer $action, array $param = [] ) : mixed
$action integer The current step. One of the IMPORT_* constants.
$param array An associative array containing needed parameters for the current step.
return mixed Either the next step as an integer constant or imported data set after the final step.

Property Details

$_contentType protected property

protected $_contentType

$_extension protected property

protected $_extension

$_mozillaAttr protected property

Useful Mozilla address book attribute names.
protected array $_mozillaAttr
return array

$_turbaAttr protected property

Useful Turba address book attribute names.
protected array $_turbaAttr
return array

$_turbaMozillaMap protected property

Turba address book attribute names and the corresponding Mozilla name.
protected array $_turbaMozillaMap
return array