Docs For Class File_Archive_Writer

Class: File_Archive_Writer_Mail

Inherited Variables

Inherited Methods

Class: File_Archive_Writer

File_Archive_Writer::close(): Close the writer, eventually flush the data, write the footer...
File_Archive_Writer::newFile(): Create a new file in the writer
File_Archive_Writer::newFileNeedsMIME(): Returns whether the writer newFile function needs the $mime parameter
File_Archive_Writer::newFromTempFile(): Create a new file in the writer with the content of the physical file $filename and then unlink $filename.
File_Archive_Writer::writeData(): Append the specified data to the writer
File_Archive_Writer::writeFile(): Append the content of the physical file $filename to the writer writeFile($filename) must be equivalent to writeData(file_get_contents($filename)) but can be more efficient

Class Details

[line 39]
Send the files attached to a mail.

Method Detail

File_Archive_Writer_Mail (Constructor) [line 91]

File_Archive_Writer_Mail File_Archive_Writer_Mail(

$to, array
$headers, string
$message, 
&$mail, Mail
$mail)

Parameters:

Mail	`$mail`	—	Object used to send mail (see Mail::factory)
array	`$headers`	—	or string $to An array or a string with comma separated recipients
string	`$message`	—	Text body of the mail
	`$to`	—
	`&$mail`	—

[ Top ]

addCurrentData [line 138]

void addCurrentData(
)

Called when a file is finished and must be added as attachment to the mail

[ Top ]

addHTMLImage [line 118]

void addHTMLImage(

$file, [
$c_type = 'application/octet-stream'], [
$name = ''], [
$isfile = true])

See: Mail_Mime::addHTMLImage()

Parameters:

	`$file`	—
	`$c_type`	—
	`$name`	—
	`$isfile`	—

[ Top ]

close [line 180]

void close(
)

See: File_Archive_Writer::close()

Overrides File_Archive_Writer::close() (Close the writer, eventually flush the data, write the footer...)

[ Top ]

newFile [line 155]

void newFile(

$filename, 
$stat, [
$mime = "application/octet-stream"])

See: File_Archive_Writer::newFile()

Overrides File_Archive_Writer::newFile() (Create a new file in the writer)

Parameters:

	`$filename`	—
	`$stat`	—
	`$mime`	—

[ Top ]

newFileNeedsMIME [line 172]

void newFileNeedsMIME(
)

See: File_Archive_Writer::newFileNeedsMIME()

Overrides File_Archive_Writer::newFileNeedsMIME() (Returns whether the writer newFile function needs the $mime parameter)

[ Top ]

setHTMLBody [line 111]

void setHTMLBody(

$data, [
$isfile = false])

See: Mail_Mime::setHTMLBody()

Parameters:

	`$data`	—
	`$isfile`	—

[ Top ]

writeData [line 131]

void writeData(

$data)

See: File_Archive_Writer::writeData() This function just put the data in $currentData until the end of file At that time, addCurrentData is called to attach $currentData to the mail and to clear $currentData for a new file

Overrides File_Archive_Writer::writeData() (Append the specified data to the writer)

Parameters:

$data —

[ Top ]

Class: File_Archive_Writer_Mail

Class Overview

Methods

Inherited Variables

Inherited Methods

Class: File_Archive_Writer

Class Details

Method Detail

File_Archive_Writer_Mail (Constructor) [line 91]

Parameters:

addCurrentData [line 138]

addHTMLImage [line 118]

Parameters:

close [line 180]

newFile [line 155]

Parameters:

newFileNeedsMIME [line 172]

setHTMLBody [line 111]

Parameters:

writeData [line 131]

Parameters: