Docs For Class Contact

Contact_AddressBook (Constructor) [line 191]

Contact_AddressBook Contact_AddressBook(
[array
$options = null])

Constructor.

Access: public

Parameters:

array $options — (optional) The options.

[ Top ]

createBuilder [line 395]

object Builder createBuilder(
string
$format)

Create builder object for the specified address book format.

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

Parameters:

string $format — The address book format name.

[ Top ]

createConverter [line 343]

object Converter createConverter(
string
$format)

Create converter object for the specified address book format.

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

Parameters:

string $format — The address book format name.

[ Top ]

createParser [line 303]

object Parser createParser(
string
$format)

Create parser object for the specified address book format.

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

Parameters:

string $format — The address book format name.

[ Top ]

export [line 491]

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 519]

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`	—	(optional) Tell the whether to output via browser (downloading) or not.

[ Top ]

exportToPrint [line 553]

bool|PEAR_Error exportToPrint(
string
$format, array
$data)

Export data from internal format to external data structure and print it.

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

Parameters:

string	`$format`	—	File format.
array	`$data`	—	Address book contacts data.

[ Top ]

get [line 247]

mixed get(
[string
$option = null])

Get single or all options.

Return: Value of option or an array of all options.
Access: public

Parameters:

string $option — (optional) Option name.

[ Top ]

getDataDir [line 269]

string getDataDir(
)

Get PEAR data directory.

Return: PEAR data directory.
Access: public

[ Top ]

import [line 440]

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 464]

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 ]

isSupported [line 287]

bool isSupported(
string
$format)

Find the whether address book format is supported or not.

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

Parameters:

string $format — Address book format.

[ Top ]

set [line 216]

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):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_options = array(
        'def_dir'   => '',         // Definitions directory.
        'language'  => 'en'        // Language.
    )

Method Detail

Contact_AddressBook (Constructor) [line 191]

Parameters:

createBuilder [line 395]

Parameters:

createConverter [line 343]

Parameters:

createParser [line 303]

Parameters:

export [line 491]

Parameters:

exportToFile [line 519]

Parameters:

exportToPrint [line 553]

Parameters:

get [line 247]

Parameters:

getDataDir [line 269]

import [line 440]

Parameters:

importFromFile [line 464]

Parameters:

isSupported [line 287]

Parameters:

set [line 216]

Parameters:

Class: Contact_AddressBook

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_options = array( 'def_dir' => '', // Definitions directory. 'language' => 'en' // Language. )

Method Detail

Contact_AddressBook (Constructor) [line 191]

Parameters:

createBuilder [line 395]

Parameters:

createConverter [line 343]

Parameters:

createParser [line 303]

Parameters:

export [line 491]

Parameters:

exportToFile [line 519]

Parameters:

exportToPrint [line 553]

Parameters:

get [line 247]

Parameters:

getDataDir [line 269]

import [line 440]

Parameters:

importFromFile [line 464]

Parameters:

isSupported [line 287]

Parameters:

set [line 216]

Parameters:

$_options = array(
'def_dir' => '', // Definitions directory.
'language' => 'en' // Language.
)