Docs For Class Section

Description

Class for creating sections of document.

todo: Exception, then columns widths override paper width.

Located in /Section.php (line 7)

Container
   |
   --Section

Variable Summary

mixed $alignment

mixed $bordered

mixed $first

mixed $oddEvenDifferent

Method Summary

Footer &addFooter ([$type $type = 'all'])

Header &addHeader ([$type $type = 'all'])

string getContent ()

float getLayoutWidth ()

void insertPageBreak ()

void setBorders (BorderFormat &$borderFormat, [boolean $left = true], [boolean $top = true], [boolean $right = true], [boolean $bottom = true])

void setColumns (array $columnsWidths)

void setColumnsCount (integer $columnsCount)

void setGutter (float $gutter)

void setLineBetweenColumns ()

void setMargins (float $marginLeft, float $marginTop, float $marginRight, float $marginBottom)

void setMirrorMargins ()

void setNoBreak ()

void setPaperHeight (float $paperHeight)

void setPaperWidth (float $paperWidth)

void setSpaceBetweenColumns (float $spaceBetweenColumns)

void setVerticalAlignment (string $alignment)

Variables

mixed $alignment (line 17)

Internal use.

access: public

mixed $bordered (line 13)

Internal use.

access: public

mixed $first = false (line 15)

Internal use.

access: public

mixed $oddEvenDifferent (line 19)

Internal use.

access: public

Inherited Variables

Inherited from Container

Container::$elements
Container::$emptyPar
Container::$pard
Container::$rtf

Methods

addFooter (line 251)

Creates footer for section pages.

access: public

Footer &addFooter ([$type $type = 'all'])

$type $type: Possible values:
'all' => all pages (different odd and even headers/footers must be not set)
'left' => left pages (different odd and even headers/footers must be set)
'right' => right pages (different odd and even headers/footers must be set)
'first' => first page

addHeader (line 224)

Creates header for section pages.

access: public

Header &addHeader ([$type $type = 'all'])

$type $type: Possible values:
'all' => all pages (different odd and even headers/footers must be not set)
'left' => left pages (different odd and even headers/footers must be set)
'right' => right pages (different odd and even headers/footers must be set)
'first' => first page

getContent (line 282)

Gets rtf code of section. Internal use.

access: public

string getContent ()

Redefinition of:

Container::getContent(): Gets rtf code of Container. Internal use.

getLayoutWidth (line 109)

Gets width of page layout.

access: public

float getLayoutWidth ()

insertPageBreak (line 273)

Breaks page.

since: 0.2.0/ This method is used instead of using "page" tag in Container::writeText method.

void insertPageBreak ()

setBorders (line 126)

Sets borders of section pages.

access: public

void setBorders (BorderFormat &$borderFormat, [boolean $left = true], [boolean $top = true], [boolean $right = true], [boolean $bottom = true])

BorderFormat &$borderFormat
boolean $left: If false, left border is not set (default true)
boolean $top: If false, top border is not set (default true)
boolean $right: If false, right border is not set (default true)
boolean $bottom: If false, bottom border is not set (default true)

setColumns (line 160)

Sets section columns with different widths.
If you use this function, you shouldn't use {@see SetColumnsNumber}.

todo: Check if columns width sum doesn't overload paper width.
access: public

void setColumns (array $columnsWidths)

array $columnsWidths: Array with columns widths

setColumnsCount (line 139)

Sets number of columns in section.

access: public

void setColumnsCount (integer $columnsCount)

integer $columnsCount: Number of columns

setGutter (line 91)

Sets the gutter width.
NOTICE: OpenOficce doesn't understant.

access: public

void setGutter (float $gutter)

float $gutter: Gutter width

setLineBetweenColumns (line 180)

Sets line between columns.

access: public

void setLineBetweenColumns ()

setMargins (line 78)

Sets the margins of pages in section.

access: public

void setMargins (float $marginLeft, float $marginTop, float $marginRight, float $marginBottom)

float $marginLeft: Margin left
float $marginTop: Margin top
float $marginRight: Margin right
float $marginBottom: Margin bottom

setMirrorMargins (line 100)

Sets the margin definitions on left and right pages.

Notice: OpenOficce doesn't Understant.

access: public

void setMirrorMargins ()

setNoBreak (line 172)

Sets no section break.

If footnotes are use in different sections, Word always will break sections.

access: public

void setNoBreak ()

setPaperHeight (line 66)

Sets the paper height of pages in section.

access: public

void setPaperHeight (float $paperHeight)

float $paperHeight: Paper height

setPaperWidth (line 57)

Sets the paper width of pages in section.

access: public

void setPaperWidth (float $paperWidth)

float $paperWidth: Paper width

setSpaceBetweenColumns (line 149)

Sets space (width) between columns.

access: public

void setSpaceBetweenColumns (float $spaceBetweenColumns)

float $spaceBetweenColumns: Space between columns

setVerticalAlignment (line 194)

Sets vertical alignment of text of section.

todo: bottom justify don't work

void setVerticalAlignment (string $alignment)

string $alignment: Possible values:
'top' => top (default)
'center' => center
'bottom' => bottom
'justify' => justify

Inherited Methods

Inherited From Container

Container::Container()
Container::addImage()
Container::addTable()
Container::emptyParagraph()
Container::getContent()
Container::writeHyperLink()
Container::writeRtfCode()
Container::writeText()