Docs For Class Contact

__construct (Constructor) [line 107]

Contact_AddressBook __construct(
[array
$options = null])

PHP5 compatible constructor.

Access: public

Parameters:

array $options — Options.

[ Top ]

Contact_AddressBook (Constructor) [line 95]

Contact_AddressBook Contact_AddressBook(
[array
$options = null])

PHP4 compatible constructor.

Access: public

Parameters:

array $options — Options.

[ Top ]

createBuilder [line 218]

object Builder &createBuilder(
string
$driver, [
$options = null])

Create builder object for specified driver.

Return: object on success or PEAR_Error on failure.
Access: public

Parameters:

string	`$driver`	—	Driver name.
	`$options`	—

[ Top ]

createConverter [line 247]

object Converter &createConverter(
string
$driver)

Create converter object for specified driver.

Return: object on success or PEAR_Error on failure.
Access: public

Parameters:

string $driver — Driver name.

[ Top ]

createObject [line 170]

object Component &createObject(
string
$file, string
$class)

Create AddressBook component object.

Return: object on success or PEAR_Error on failure.
Access: public

Parameters:

string	`$file`	—	Filename.
string	`$class`	—	Classname.

[ Top ]

createParser [line 193]

object Parser &createParser(
string
$driver)

Create parser object for specified driver.

Return: object on success or PEAR_Error on failure.
Access: public

Parameters:

string $driver — Driver name.

[ Top ]

export [line 337]

array|PEAR_Error export(
array
$data, string
$format)

Export data from internal structure to external format structure.

Return: An array result on success or PEAR_Error on failure.
Access: public

Parameters:

array	`$data`	—	Data.
string	`$format`	—	Structure format.

[ Top ]

exportToFile [line 393]

array|PEAR_Error exportToFile(
string
$filename, string
$format, array
$data, [bool
$via_browser = true])

Export data from internal format to external data structure and save it to file.

Return: An array result on success or PEAR_Error on failure.
Access: public

Parameters:

string	`$filename`	—	Filename.
string	`$format`	—	File format.
array	`$data`	—	Address book contacts data.
bool	`$via_browser`	—	Tell the whether to output via browser (downloading) or not.

[ Top ]

import [line 314]

array|PEAR_Error import(
array
$data, string
$format)

Import data from specified format structure to internal structure.

Return: An array result on success or PEAR_Error on failure.
Access: public

Parameters:

array	`$data`	—	Data.
string	`$format`	—	Structure format.

[ Top ]

importFromFile [line 362]

array|PEAR_Error importFromFile(
string
$filename, string
$format)

Import data from specified format structure saved in the file to internal structure.

Return: An array result on success or PEAR_Error on failure.
Access: public

Parameters:

string	`$filename`	—	Filename.
string	`$format`	—	File format.

[ Top ]

isExportable [line 272]

bool isExportable(
string
$format)

Find out the whether address book format is exportable.

Return: TRUE if exportable, otherwise FALSE.
Access: public

Parameters:

string $format — Address book format name.

[ Top ]

isImportable [line 295]

bool isImportable(
string
$format)

Find out the whether address book format is importable.

Return: TRUE if importable, otherwise FALSE.
Access: public

Parameters:

string $format — Address book format name.

[ Top ]

set [line 137]

bool|PEAR_Error set(
mixed
$option, [mixed
$value = null])

Set the option(s).

Set a single option or multiple options.

Return: TRUE on success, PEAR_Error on failure.
Access: public

Parameters:

mixed	`$option`	—	A string with option name as value for single option or An associative array contains options array('<option>' => <value>) for multiple options.
mixed	`$value`	—	(optional) Option value. Require when $option is string (single option mode).

[ Top ]

Class: Contact_AddressBook

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$options = array(
        'def_dir'       => '',         // Definition directory.
        'languange'     => 'en',       // Language.
        'line_break'    => "\n"        // Line break character for writing a file.
    )

Method Detail

__construct (Constructor) [line 107]

Parameters:

Contact_AddressBook (Constructor) [line 95]

Parameters:

createBuilder [line 218]

Parameters:

createConverter [line 247]

Parameters:

createObject [line 170]

Parameters:

createParser [line 193]

Parameters:

export [line 337]

Parameters:

exportToFile [line 393]

Parameters:

import [line 314]

Parameters:

importFromFile [line 362]

Parameters:

isExportable [line 272]

Parameters:

isImportable [line 295]

Parameters:

set [line 137]

Parameters:

Class: Contact_AddressBook

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$options = array( 'def_dir' => '', // Definition directory. 'languange' => 'en', // Language. 'line_break' => "\n" // Line break character for writing a file. )

Method Detail

__construct (Constructor) [line 107]

Parameters:

Contact_AddressBook (Constructor) [line 95]

Parameters:

createBuilder [line 218]

Parameters:

createConverter [line 247]

Parameters:

createObject [line 170]

Parameters:

createParser [line 193]

Parameters:

export [line 337]

Parameters:

exportToFile [line 393]

Parameters:

import [line 314]

Parameters:

importFromFile [line 362]

Parameters:

isExportable [line 272]

Parameters:

isImportable [line 295]

Parameters:

set [line 137]

Parameters:

$options = array(
'def_dir' => '', // Definition directory.
'languange' => 'en', // Language.
'line_break' => "\n" // Line break character for writing a file.
)