Class: Contact_AddressBook_Converter_CSV

Source Location: /Contact_AddressBook-0.5.1/Contact/AddressBook/Converter/CSV.php

Class Overview

Contact_AddressBook_Converter
   |
   --Contact_AddressBook_Converter_CSV

Class for handling CSV address book data structure converting.

Author(s):

Firman Wandayandi <firman at php.net>

Version:

Release: 0.5.1

Copyright:

Methods

Inherited Variables

Class: Contact_AddressBook_Converter

Contact_AddressBook_Converter::$definition
Contact_AddressBook_Converter::$definitionDir
Contact_AddressBook_Converter::$isPrepared
Contact_AddressBook_Converter::$mapFrom
Contact_AddressBook_Converter::$mapTo

Inherited Methods

Class: Contact_AddressBook_Converter

Contact_AddressBook_Converter::Contact_AddressBook_Converter()
Contact_AddressBook_Converter::convertFrom(): Convert from default data structure into external structure.
Contact_AddressBook_Converter::convertTo(): Convert from default data structure into external structure.
Contact_AddressBook_Converter::performConvert(): Perform data converting.
Contact_AddressBook_Converter::setDefinition(): Set converting definition.
Contact_AddressBook_Converter::setDefinitionDir()
Contact_AddressBook_Converter::setDefinitionFile(): Load the definition file.
Contact_AddressBook_Converter::setFormat(): Set the address book format to convert.

Class Details

[line 105]
Class for handling CSV address book data structure converting.

Author: Firman Wandayandi <firman@php.net>
Version: Release: 0.5.1
Copyright: Copyright (c) 2004-2005 Firman Wandayandi
Since: Class available since Release 0.4.0alpha1
License: BSD License

[ Top ]

Method Detail

Contact_AddressBook_Converter_CSV (Constructor) [line 142]

Contact_AddressBook_Converter_CSV Contact_AddressBook_Converter_CSV(
)

Constructor.

Access: public

[ Top ]

convertFrom [line 254]

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

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

Parameters:

array $data — Address book data.

[ Top ]

performConvertByHeader [line 214]

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

Perform converting based on header.

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

Parameters:

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

[ Top ]

setFormat [line 160]

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

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

Parameters:

string $format — The address book format.

[ Top ]

setLanguage [line 195]

void setLanguage(
string
$language)

Set the language.

Access: public

Parameters:

string $language — Language.

[ Top ]