프로퍼티 | 타입 | 설명 | |
---|---|---|---|
$_borderSurroundsFooter | boolean | ||
$_borderSurroundsHeader | boolean | ||
$_colorTable | PHPRtfLite_DocHead_ColorTable | color table instance | |
$_defaultFont | PHPRtfLite_Font | default font | |
$_fontTable | PHPRtfLite_DocHead_FontTable | font table instance | |
$_footers | PHPRtfLite_Container_Footer[] | rtf footers | |
$_headers | PHPRtfLite_Container_Header[] | rtf headers | |
$_properties | array | rtf properties | |
$_sections | PHPRtfLite_Container_Section[] | rtf sections |
메소드 | 설명 | |
---|---|---|
__construct ( ) | ||
addFooter ( string $type = PHPRtfLite_Container_Footer::TYPE_ALL, PHPRtfLite_Container_Footer $footer = null ) : PHPRtfLite_Container_Footer | creates footer for the document | |
addHeader ( string $type = PHPRtfLite_Container_Header::TYPE_ALL, PHPRtfLite_Container_Header $header = null ) : PHPRtfLite_Container_Header | creates header for the document | |
addSection ( PHPRtfLite_Container_Section $section = null ) : PHPRtfLite_Container_Section | adds section to rtf document | |
borderSurroundsFooter ( ) : boolean | checks, if border surrounds footer | |
borderSurroundsHeader ( ) : boolean | checks, if border surrounds header | |
convertNewlinesToRtfCode ( string $text ) : string | convert new lines to rtf line breaks | |
free ( ) | ||
getBorder ( ) : PHPRtfLite_Border | gets border of document | |
getCharset ( ) : string | gets charset for rtf text inputs | |
getColorTable ( ) : PHPRtfLite_DocHead_ColorTable | gets color table | |
getContent ( boolean $free = true ) : string | gets rtf document code | |
getDefaultFont ( ) : PHPRtfLite_Font | gets default font | |
getDefaultFontForNotes ( ) : PHPRtfLite_Font | gets default font for notes | |
getDefaultTabWidth ( ) : float | sets default tab width of the document | |
getEndnoteNumberingType ( ) : integer | gets endnote numbering type | |
getEndnoteStartNumber ( ) : integer | gets endnote start number | |
getFontTable ( ) : PHPRtfLite_DocHead_FontTable | gets font table | |
getFooters ( ) : array | gets defined footers for document pages | |
getFootnoteNumberingType ( ) : integer | gets footnote numbering type | |
getFootnoteStartNumber ( ) : integer | gets footnote start number | |
getGutter ( ) : float | gets the gutter width | |
getHeaders ( ) : array | gets defined headers for document pages | |
getMarginBottom ( ) : float | gets the bottom margin of document pages | |
getMarginLeft ( ) : float | gets the left margin of document pages | |
getMarginRight ( ) : float | gets the right margin of document pages | |
getMarginTop ( ) : float | gets the top margin of document pages | |
getNoteDocHead ( ) : PHPRtfLite_DocHead_Note | gets document head definition for notes | |
getPageNumberStart ( ) : integer | gets the beginning page number | |
getPaperHeight ( ) : float | gets the paper height of document | |
getPaperWidth ( ) : float | gets the paper width of document | |
getProperty ( string $name ) : string | gets rtf property | |
getSections ( ) : array | gets sections | |
getViewMode ( ) : integer | gets the view mode of the document | |
getWriter ( ) : PHPRtfLite_Writer_Interface | gets writer | |
getZoomLevel ( ) : integer | gets the zoom level (in percents) of the document | |
getZoomMode ( ) : integer | gets the zoom mode of the document | |
hasSpecialLayoutForFirstPage ( ) : boolean | returns true, if first page has special layout | |
isLandscape ( ) : boolean | returns true, if landscape layout should be used | |
isMirrorMargins ( ) : boolean | returns true, if use mirror margins should be used | |
isOddEvenDifferent ( ) : boolean | gets if odd and even headers/footers are different | |
isRestartEndnoteNumberEachPage ( ) : boolean | checks, if endnote numbering shall be started on each page | |
isRestartFootnoteNumberEachPage ( ) : boolean | sets restart endnote number on each page | |
quoteRtfCode ( string $text, boolean $convertNewlines = true ) : string | quotes rtf code | |
registerAutoloader ( ) : boolean | registers autoloader for PHPRtfLite classes | |
registerFont ( PHPRtfLite_Font $font ) | registers the font in color table and font table | |
registerParFormat ( PHPRtfLite_ParFormat $parFormat ) | registers the par format in color table | |
save ( string $file, boolean $free = true ) | saves rtf document to file | |
sendRtf ( string $filename = 'simple', $free = true ) | sends rtf content as file attachment | |
setBorder ( PHPRtfLite_Border $border ) | Sets border to rtf document. Sections may override this border. | |
setBorderSurroundsFooter ( boolean $borderSurroundsFooter = true ) : PHPRtfLite | ||
setBorderSurroundsHeader ( boolean $borderSurroundsHeader = true ) : PHPRtfLite | sets border surrounds header | |
setBorders ( PHPRtfLite_Border_Format $borderFormat, boolean $left = true, boolean $top = true, boolean $right = true, boolean $bottom = true ) | Sets borders to rtf document. Sections may override this border. | |
setCharset ( string $charset ) | sets charset for rtf text inputs | |
setDefaultFont ( PHPRtfLite_Font $font ) | sets default font | |
setDefaultFontForNotes ( PHPRtfLite_Font $font ) | sets default font for notes | |
setDefaultTabWidth ( float $defaultTabWidth ) | sets default tab width of the document | |
setEndnoteNumberingType ( integer $numberingType ) | sets endnote numbering type | |
setEndnoteStartNumber ( integer $startNumber ) | sets endnote start number | |
setFootnoteNumberingType ( integer $numberingType ) | sets footnote numbering type | |
setFootnoteStartNumber ( integer $startNumber ) | sets footnote start number | |
setGutter ( float $gutter ) |
sets the gutter width. NOTICE: Does not work with OpenOffice. |
|
setHyphenation ( ) | sets using hyphenation | |
setLandscape ( ) | sets landscape orientation for the document | |
setMarginBottom ( float $margin ) | sets the bottom margin of document pages | |
setMarginLeft ( float $margin ) | sets the left margin of document pages | |
setMarginRight ( float $margin ) | sets the right margin of document pages | |
setMarginTop ( float $margin ) | sets the top margin of document pages | |
setMargins ( float $marginLeft, float $marginTop, float $marginRight, float $marginBottom ) | sets the margins of document pages | |
setMirrorMargins ( ) |
sets the margin definitions on left and right pages. NOTICE: Does not work with OpenOffice. |
|
setOddEvenDifferent ( boolean $different = true ) | sets if odd and even headers/footers are different | |
setPageNumberStart ( integer $pageNumber ) | sets the beginning page number | |
setPaperFormat ( string $paperFormat ) | Sets the paper format. | |
setPaperHeight ( float $height ) | sets the paper height of document | |
setPaperWidth ( float $width ) | sets the paper width of document | |
setProperty ( string $name, mixed $value ) | sets document information properties | |
setRestartEndnoteNumberEachPage ( ) : boolean | checks, if footnote numbering shall be started on each page | |
setRestartFootnoteNumberEachPage ( ) | sets restart footnote number on each page | |
setSpecialLayoutForFirstPage ( boolean $specialLayout = true ) | sets that first page has a special layout | |
setUseTemporaryFile ( boolean $flag = true ) | set that a temporary file should be used for creating the output NOTE: is slowing down the rendering because of the io operations, but uses less memory | |
setViewMode ( integer $viewMode ) | sets the view mode of the document | |
setWriter ( PHPRtfLite_Writer_Interface $writer ) | sets writer | |
setZoomLevel ( integer $zoom ) |
sets the zoom level (in percents) of the document. By default word uses 100%. NOTICE: if zoom mode is defined, zoom level is not used. |
|
setZoomMode ( integer $zoomMode ) | sets the zoom mode of the document | |
unregisterAutoloader ( ) : boolean | unregisters autoloader for PHPRtfLite classes |
메소드 | 설명 | |
---|---|---|
getInfoPart ( ) : string | gets rtf info part | |
render ( ) | prepares rtf contents |
메소드 | 설명 | |
---|---|---|
createWriter ( string $file = null ) | creates writer |
public addHeader ( string $type = PHPRtfLite_Container_Header::TYPE_ALL, PHPRtfLite_Container_Header $header = null ) : PHPRtfLite_Container_Header | ||
$type | string | Represented by class constants PHPRtfLite_Container_Header::TYPE_* Possible values: PHPRtfLite_Container_Header::TYPE_ALL all pages (different odd and even headers/footers must be not set) PHPRtfLite_Container_Header::TYPE_LEFT left pages (different odd and even headers/footers must be set) PHPRtfLite_Container_Header::TYPE_RIGHT right pages (different odd and even headers/footers must be set PHPRtfLite_Container_Header::TYPE_FIRST first page |
$header | PHPRtfLite_Container_Header | |
리턴 | PHPRtfLite_Container_Header |
public addSection ( PHPRtfLite_Container_Section $section = null ) : PHPRtfLite_Container_Section | ||
$section | PHPRtfLite_Container_Section | |
리턴 | PHPRtfLite_Container_Section |
public borderSurroundsHeader ( ) : boolean | ||
리턴 | boolean |
public static convertNewlinesToRtfCode ( string $text ) : string | ||
$text | string | |
리턴 | string |
public getBorder ( ) : PHPRtfLite_Border | ||
리턴 | PHPRtfLite_Border |
public getColorTable ( ) : PHPRtfLite_DocHead_ColorTable | ||
리턴 | PHPRtfLite_DocHead_ColorTable |
public getContent ( boolean $free = true ) : string | ||
$free | boolean | |
리턴 | string |
public getDefaultFont ( ) : PHPRtfLite_Font | ||
리턴 | PHPRtfLite_Font |
public getDefaultFontForNotes ( ) : PHPRtfLite_Font | ||
리턴 | PHPRtfLite_Font |
public getDefaultTabWidth ( ) : float | ||
리턴 | float | $defaultTabWidth Default tab width |
public getEndnoteNumberingType ( ) : integer | ||
리턴 | integer |
public getEndnoteStartNumber ( ) : integer | ||
리턴 | integer |
public getFontTable ( ) : PHPRtfLite_DocHead_FontTable | ||
리턴 | PHPRtfLite_DocHead_FontTable |
public getFootnoteNumberingType ( ) : integer | ||
리턴 | integer |
public getFootnoteStartNumber ( ) : integer | ||
리턴 | integer |
public getHeaders ( ) : array | ||
리턴 | array | contains PHPRtfLite_Container_Header objects |
public getMarginBottom ( ) : float | ||
리턴 | float | $margin |
public getMarginLeft ( ) : float | ||
리턴 | float | $margin |
public getMarginRight ( ) : float | ||
리턴 | float | $margin |
public getMarginTop ( ) : float | ||
리턴 | float | $margin |
public getNoteDocHead ( ) : PHPRtfLite_DocHead_Note | ||
리턴 | PHPRtfLite_DocHead_Note |
public getPageNumberStart ( ) : integer | ||
리턴 | integer |
public getPaperHeight ( ) : float | ||
리턴 | float | $paperHeight paper height |
public getPaperWidth ( ) : float | ||
리턴 | float | $paperWidth paper width |
public getProperty ( string $name ) : string | ||
$name | string | |
리턴 | string |
public getViewMode ( ) : integer | ||
리턴 | integer | view mode represented as class constants VIEW_MODE_* |
public getWriter ( ) : PHPRtfLite_Writer_Interface | ||
리턴 | PHPRtfLite_Writer_Interface |
public getZoomLevel ( ) : integer | ||
리턴 | integer | $zoom zoom level |
public hasSpecialLayoutForFirstPage ( ) : boolean | ||
리턴 | boolean |
public isLandscape ( ) : boolean | ||
리턴 | boolean |
public isMirrorMargins ( ) : boolean | ||
리턴 | boolean |
public isOddEvenDifferent ( ) : boolean | ||
리턴 | boolean |
public isRestartEndnoteNumberEachPage ( ) : boolean | ||
리턴 | boolean |
public isRestartFootnoteNumberEachPage ( ) : boolean | ||
리턴 | boolean |
public static registerAutoloader ( ) : boolean | ||
리턴 | boolean |
public registerFont ( PHPRtfLite_Font $font ) | ||
$font | PHPRtfLite_Font |
public registerParFormat ( PHPRtfLite_ParFormat $parFormat ) | ||
$parFormat | PHPRtfLite_ParFormat |
public setBorder ( PHPRtfLite_Border $border ) | ||
$border | PHPRtfLite_Border |
public setBorderSurroundsHeader ( boolean $borderSurroundsHeader = true ) : PHPRtfLite | ||
$borderSurroundsHeader | boolean | |
리턴 | PHPRtfLite |
public setCharset ( string $charset ) | ||
$charset | string |
public setDefaultFont ( PHPRtfLite_Font $font ) | ||
$font | PHPRtfLite_Font |
public setDefaultFontForNotes ( PHPRtfLite_Font $font ) | ||
$font | PHPRtfLite_Font |
public setDefaultTabWidth ( float $defaultTabWidth ) | ||
$defaultTabWidth | float | Default tab width |
public setEndnoteNumberingType ( integer $numberingType ) | ||
$numberingType | integer |
public setEndnoteStartNumber ( integer $startNumber ) | ||
$startNumber | integer |
public setFootnoteNumberingType ( integer $numberingType ) | ||
$numberingType | integer |
public setFootnoteStartNumber ( integer $startNumber ) | ||
$startNumber | integer |
public setMarginBottom ( float $margin ) | ||
$margin | float |
public setMarginLeft ( float $margin ) | ||
$margin | float |
public setMarginRight ( float $margin ) | ||
$margin | float |
public setMarginTop ( float $margin ) | ||
$margin | float |
public setMirrorMargins ( ) |
public setOddEvenDifferent ( boolean $different = true ) | ||
$different | boolean |
public setPageNumberStart ( integer $pageNumber ) | ||
$pageNumber | integer | Beginning page number (if not defined, Word uses 1) |
public setPaperFormat ( string $paperFormat ) | ||
$paperFormat | string |
public setPaperHeight ( float $height ) | ||
$height | float | paper height |
public setPaperWidth ( float $width ) | ||
$width | float | pager width |
public setProperty ( string $name, mixed $value ) | ||
$name | string | Property of document. Possible properties: 'title' => title of the document (value string) 'subject' => subject of the document (value string) 'author' => author of the document (value string) 'manager' => manager of the document (value string) 'company' => company of author (value string) 'operator' => operator of document. Operator is a person who last made changes to the document. (value string) 'category' => category of document (value string) 'keywords' => keywords of document (value string) 'doccomm' => comments of document (value string) 'creatim' => creation time (value int) 'revtim' => last revision time (value int) 'buptim' => last backup time (value int) 'printim' => last print time (value int) |
$value | mixed | Value |
public setRestartEndnoteNumberEachPage ( ) : boolean | ||
리턴 | boolean |
public setRestartFootnoteNumberEachPage ( ) |
public setSpecialLayoutForFirstPage ( boolean $specialLayout = true ) | ||
$specialLayout | boolean |
public setUseTemporaryFile ( boolean $flag = true ) | ||
$flag | boolean | default is true |
public setViewMode ( integer $viewMode ) | ||
$viewMode | integer | View Mode. Represented as class constants VIEW_MODE_* Possible values: VIEW_MODE_NONE => 0 - None VIEW_MODE_PAGE_LAYOUT => 1 - Page Layout view VIEW_MODE_OUTLINE => 2 - Outline view VIEW_MODE_MASTER => 3 - Master Document view VIEW_MODE_NORMAL => 4 - Normal view VIEW_MODE_ONLINE_LAYOUT => 5 - Online Layout view |
public setWriter ( PHPRtfLite_Writer_Interface $writer ) | ||
$writer | PHPRtfLite_Writer_Interface |
public setZoomLevel ( integer $zoom ) | ||
$zoom | integer | zoom level |
public setZoomMode ( integer $zoomMode ) | ||
$zoomMode | integer | zoom mode. Represented as class constants.
Possible values: ZOOM_MODE_NONE => 0 - None ZOOM_MODE_FULL_PAGE => 1 - Full Page ZOOM_MODE_BEST_FIT => 2 - Best Fit |
public static unregisterAutoloader ( ) : boolean | ||
리턴 | boolean |
protected PHPRtfLite_DocHead_ColorTable $_colorTable | ||
리턴 | PHPRtfLite_DocHead_ColorTable |
protected PHPRtfLite_DocHead_FontTable $_fontTable | ||
리턴 | PHPRtfLite_DocHead_FontTable |
protected PHPRtfLite_Container_Header[] $_headers | ||
리턴 | PHPRtfLite_Container_Header[] |