Docs For Class Contact_AddressBook

$definition = array()

[line 100]

Address Book fields definition.

Access: protected

Type:

array

[ Top ]

$definitionDir = ''

[line 92]

Directory contains definition files.

Access: protected

Type:

string

[ Top ]

$isPrepared = false

[line 124]

Flag tell the whether the map is prepared or not.

Access: protected

Type:

bool

[ Top ]

$mapFrom = array()

[line 108]

Map for converting from external structure into default structure.

Access: protected

Type:

array

[ Top ]

$mapTo = array()

[line 116]

Map for converting from default structure into external structure.

Access: protected

Type:

array

[ Top ]

Contact_AddressBook_Converter (Constructor) [line 129]

Contact_AddressBook_Converter Contact_AddressBook_Converter(
)

[ Top ]

convertFrom [line 332]

array|PEAR_Error convertFrom(
array
$data)

Convert from default data structure into external structure.

Return: An array of converted data on succeed or PEAR_Error on failure
See: Contact_AddressBook_Converter::performConvert()
Access: public

Overridden in child classes as:

Contact_AddressBook_Converter_CSV::convertFrom(): Convert from default data structure into external structure.

Parameters:

array $data — Address book data.

[ Top ]

convertTo [line 307]

array|PEAR_Error convertTo(
array
$data)

Convert from default data structure into external structure.

Return: An array of converted data on succeed or PEAR_Error on failure
See: Contact_AddressBook_Converter::performConvert()
Access: public

Parameters:

array $data — Address book data.

[ Top ]

performConvert [line 274]

array|PEAR_Error performConvert(
array
$map, array
$data)

Perform data converting.

Return: An array of converted data on succeed or PEAR_Error on failure
Access: protected

Parameters:

array	`$map`	—	Converting map.
array	`$data`	—	Address book data to convert.

[ Top ]

setDefinition [line 180]

bool|PEAR_Error setDefinition(
array
$definition)

Set converting definition.

Return: TRUE on succeed or PEAR_Error on failure.
Access: public

Parameters:

array $definition — An array of definition structure.

[ Top ]

setDefinitionDir [line 137]

void setDefinitionDir(
mixed
$dir)

[ Top ]

setDefinitionFile [line 212]

bool|PEAR_Error setDefinitionFile(
string
$file)

Load the definition file.

The bundle default definition files was placed at PEAR data dir.

Return: TRUE on succeed or PEAR_Error on failure.
See: Contact_AddressBook_Converter::setDefinition()
Access: public

Parameters:

string $file — Definition filename.

[ Top ]

setFormat [line 155]

bool|PEAR_Error setFormat(
string
$format)

Set the address book format to convert.

Return: TRUE on success or PEAR_Error on failure.
See: Contact_AddressBook_Converter::setDefinitionFile()
Access: public

Overridden in child classes as:

Contact_AddressBook_Converter_CSV::setFormat(): Set the address book format to convert.

Parameters:

string $format — The address book format.

[ Top ]

Class: Contact_AddressBook_Converter

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$definition = array()

$definitionDir = ''

$isPrepared = false

$mapFrom = array()

$mapTo = array()

Method Detail

Contact_AddressBook_Converter (Constructor) [line 129]

convertFrom [line 332]

Parameters:

convertTo [line 307]

Parameters:

performConvert [line 274]

Parameters:

setDefinition [line 180]

Parameters:

setDefinitionDir [line 137]

setDefinitionFile [line 212]

Parameters:

setFormat [line 155]

Parameters: