Class: Contact_AddressBook_Builder

Source Location: /Contact_AddressBook-0.5.1/Contact/AddressBook/Builder.php

Class Overview

Abstract class for building address book.

Author(s):

Firman Wandayandi <firman at php.net>

Version:

Release: 0.5.1

Copyright:

Variables

Methods

Child classes:

Contact_AddressBook_Builder_CSV: Class for building CSV address book format.

Contact_AddressBook_Builder_Eudora: Class for building the Eudora address book.

Inherited Variables

Inherited Methods

Class Details

[line 82]
Abstract class for building address book.

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

[ Top ]

Class Variables

$data = array()

[line 92]

Cache for data.

Access: protected

Type:

array

[ Top ]

$extension = 'txt'

[line 116]

File extension.

Access: protected

Type:

string

[ Top ]

$mime = 'text/plain'

[line 108]

MIME Type when send the output to the browser.

Access: protected

Type:

string

[ Top ]

$result = ''

[line 100]

Cache for result.

Access: protected

Type:

string

[ Top ]

Method Detail

Contact_AddressBook_Builder (Constructor) [line 121]

Contact_AddressBook_Builder Contact_AddressBook_Builder(
[
$data = null])

Parameters:

$data —

[ Top ]

build [line 158]

bool|PEAR_Error build(
)

Build the structure format.

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

Overridden in child classes as:

Contact_AddressBook_Builder_CSV::build(): Build the structure format.

Contact_AddressBook_Builder_Eudora::build(): Build the structure format.

[ Top ]

download [line 203]

void download(
string
$filename)

Download the result via browser.

Access: public

Parameters:

string $filename — Filename.

[ Top ]

save [line 187]

bool|PEAR_Error save(
string
$filename)

Save the result into file.

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

Parameters:

string $filename — Filename.

[ Top ]

setData [line 139]

bool|PEAR_Error setData(
array
$data)

Set data to build.

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

Parameters:

array $data — Data.

[ Top ]

show [line 171]

void show(
)

Print out the result.

Access: public

[ Top ]

stripLineBreak [line 240]

string stripLineBreak(
string
$str)

Strip any line break characters then replace it with space.

Return: Result string.
Access: public

Parameters:

string $str — Value.

[ Top ]