Class: Contact_AddressBook_Parser_CSV

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

Class Overview

Contact_AddressBook_Parser
   |
   --Contact_AddressBook_Parser_CSV

Class for parse CSV address book format.

Author(s):

Firman Wandayandi <firman at php.net>

Version:

Release: 0.5.1

Copyright:

Methods

Inherited Variables

Class: Contact_AddressBook_Parser

Contact_AddressBook_Parser::$file
Contact_AddressBook_Parser::$result

Inherited Methods

Class: Contact_AddressBook_Parser

Contact_AddressBook_Parser::getFileContents(): Read the input file to gets file contents.
Contact_AddressBook_Parser::getResult(): Get parse result data.
Contact_AddressBook_Parser::numRows(): Returns the number of rows in a result.
Contact_AddressBook_Parser::parse(): Parse input file to gets address book data.
Contact_AddressBook_Parser::reset(): Reset the parser.
Contact_AddressBook_Parser::setFile(): Set the input file to parse.

Class Details

[line 87]
Class for parse CSV address book format.

Author: Firman Wandayandi <firman@php.net>
Version: Release: 0.5.1
Copyright: Copyright (c) 2004-2005 Firman Wandayandi
See: File_CSV
License: BSD License

[ Top ]

Method Detail

finalizeHeader [line 261]

array() finalizeHeader(
array
$data)

Change the array of data from sequential array into associative array, using header elements as keys.

This function only called if configuration 'selectablefields' is TRUE.

Return: An associative array of result.
Access: public

Parameters:

array $data — The return value from Contact_AddressBook_Parser_CSV::parse() method.

[ Top ]

getResult [line 288]

array getResult(
)

Get the parse result.

Return: An array of address book parse result.
Access: public

Overrides Contact_AddressBook_Parser::getResult() (Get parse result data.)

[ Top ]

parse [line 189]

bool|PEAR_Error parse(
)

Parse input file to gets address book data.

Return: TRUE on succeed or PEAR_Error on failure.
See: Contact_AddressBook_Parser_CSV::finalizeHeader()
See: File_CSV::readQuoted()
See: Contact_AddressBook_Parser_CSV::_parseConfig()
See: Contact_AddressBook_CSV::getConfig()
See: File_CSV::discoverFormat()
Access: public

Overrides Contact_AddressBook_Parser::parse() (Parse input file to gets address book data.)

[ Top ]

setFormat [line 136]

void setFormat(
string
$format)

Set the address book format.

Access: public

Parameters:

string $format — CSV address book format. One of supported formats WAB, OutlookExpress, Outlook, Mozilla, Netscape, Thunderbird, Palm, Yahoo (case-insensitive and only alphanumeric letters).

[ Top ]