Docs For Class Container

Description

Atstract class of container.

abstract:

Direct descendents

Class	Description
Cell	Class for creating cells of tables.
Footer	Class for creating footers of document.
Header	Class for creating headers of documents.
Section	Class for creating sections of document.

Variable Summary

mixed $elements

mixed $emptyPar

mixed $pard

mixed $rtf

Method Summary

Container Container ( &$rtf)

Image &addImage (string $fileName, &$parFormat, [float $width = 0], [float $height = 0], mix $parFormat)

Table &addTable ([string $alignment = 'left'])

void emptyParagraph ( &$font, &$parFormat, Fonf $font, ParFormat $parFormat)

string getContent ()

void writeHyperLink (string $hyperlink, string $text, &$font, &$parFormat, Font $font, mix $parFormat)

void writeRtfCode (string $text)

void writeText (string $text, &$font, &$parFormat, [bool $replaceTags = true], Font $font, mix $parFormat)

Variables

mixed $elements = array() (line 15)

Internal use.

access: public

Redefined in descendants as:

Cell::$elements : Internal use.

mixed $emptyPar = false (line 19)

Internal use.

access: public

mixed $pard = '\pard ' (line 17)

Internal use.

access: public

Redefined in descendants as:

Cell::$pard : Internal use.

mixed $rtf (line 13)

Internal use.

access: public

Methods

Constructor Container (line 22)

Container Container ( &$rtf)

&$rtf

addImage (line 162)

Adds image to element container.

access: public

Image &addImage (string $fileName, &$parFormat, float $width, float $height, mix $parFormat)

string $fileName: Name of image file.
mix $parFormat: Paragraph format or null object. If null object immage is in the same paragraph.
float $width: Default 0. If 0 image is displayed by it's height.
float $height: Default 0. If 0 image is displayed by it' width. If boths parameters are 0, image is displayed as is.
&$parFormat

addTable (line 146)

Adds table to element container.

access: public

Table &addTable ([string $alignment = 'left'])

string $alignment: Alingment of table. Possible values: 'left', 'center', 'right'

Redefined in descendants as:

Cell::addTable() : Overriden. Does nothing. Nesting cells are not suported in current version.

emptyParagraph (line 40)

Adds empty paragraph to container.

void emptyParagraph ( &$font, &$parFormat, Fonf $font, ParFormat $parFormat)

Fonf $font: Font of text.
ParFormat $parFormat: Paragraph format.
&$font
&$parFormat

getContent (line 174)

Gets rtf code of Container. Internal use.

access: public

string getContent ()

Redefined in descendants as:

Cell::getContent() : Gets rtf code of Cell object. Internal use.
Footer::getContent() : Gets rtf code of footer. Internal use.
Header::getContent() : Gets rtf code of header. Internal use.
Section::getContent() : Gets rtf code of section. Internal use.

writeHyperLink (line 128)

Writes hyperlink to container.

access: public

void writeHyperLink (string $hyperlink, string $text, &$font, &$parFormat, Font $font, mix $parFormat)

string $hyperlink: Hyperlink url (etc. "http://www.phprtf.com")
string $text: Hyperlinks text If false, hyperlink is writen in previous paragraph format.
Font $font: Font
mix $parFormat: Paragraph format or null object. If null object hyperlink is written in the same paragraph.
&$font
&$parFormat

writeRtfCode (line 31)

Writes rtf code to container.

access: public

void writeRtfCode (string $text)

string $text

writeText (line 74)

Writes text to container.

todo: Documentation
access: public

void writeText (string $text, &$font, &$parFormat, [bool $replaceTags = true], Font $font, mix $parFormat)

string $text: Text. Also you can use html style tags. Possible tags:
strong, b- bold;
em - ;
i - italic;
u - underline;
br - line break;
chdate - current date;
chdpl - current date in long format;
chdpa - current date in abbreviated format;
chtime - current time;
chpgn, pagenum - page number ;
tab - tab sectnum - section number;
line - line break;
page - page break;
sect - section break;
Font $font: Font of text.
mix $parFormat: Paragraph format. Use ParFormat object or null object. If null object, text is written in the same paragraph.
bool $replaceTags: If false, then html style tags are not replaced with rtf code.
&$font
&$parFormat