Documentation

Application

Table of Contents

Interfaces

EscaperInterface
ReaderInterface
Reader interface.
WriterInterface
Writer interface.

Classes

AbstractCollection
Collection abstract class.
Bookmarks
Bookmarks collection.
Charts
Charts collection.
Comments
Comments collection.
Endnotes
Endnotes collection.
Footnotes
Footnotes collection.
Titles
Titles collection.
FootnoteProperties
Footnote properties.
ProofState
Spelling and Grammatical Checking State.
TblWidth
TrackChangesView
Visibility of Annotation Types.
AbstractContainer
Container abstract class.
AbstractElement
Element abstract class.
Bookmark
Bookmark element.
Cell
Table cell element.
Chart
Chart element.
CheckBox
Check box element.
Comment
Comment element.
Endnote
Endnote element.
Field
Field element.
Footer
Footer element.
Footnote
Container abstract class.
FormField
Form field element.
Formula
Formula element.
Header
Header element.
Image
Image element.
Line
Line element.
Link
Link element.
ListItem
List item element.
ListItemRun
List item element.
OLEObject
OLEObject element.
PageBreak
Page break element.
PreserveText
Preserve text/field element.
Row
Table row element.
SDT
Structured document tag (SDT) element.
Section
Container abstract class.
Shape
Shape element.
Table
Table element.
Text
Text element.
TextBox
TextBox element.
TextBreak
Text break element.
TextRun
Textrun/paragraph element.
Title
Title element.
TOC
Table of contents.
TrackChange
TrackChange element.
AbstractEscaper
RegExp
Rtf
Xml
CopyFileException
General exception.
CreateTemporaryFileException
General exception.
Exception
General exception.
InvalidImageException
Exception used for when an image is not found.
InvalidObjectException
Exception used for when an image is not found.
InvalidStyleException
Exception used for when a style value is invalid.
UnsupportedImageTypeException
Exception used for when an image type is unsupported.
IOFactory
Media
Media collection.
Compatibility
Compatibility setting class.
DocInfo
Document information.
Protection
Document protection class.
Settings
Setting class.
PhpWord
PHPWord main class.
AbstractReader
Reader abstract class.
HTML
HTML Reader class.
MsDoc
Reader for Word97.
AbstractPart
Abstract part reader.
Content
Content reader.
Meta
Meta reader.
ODText
Reader for ODText.
Document
RTF document reader.
RTF
RTF Reader class.
AbstractPart
Abstract part reader.
Comments
Abstract part reader.
DocPropsApp
Extended properties reader.
DocPropsCore
Core properties reader.
DocPropsCustom
Custom properties reader.
Document
Document reader.
Endnotes
Endnotes reader.
Footnotes
Footnotes reader.
Numbering
Numbering reader.
Settings
Settings reader.
Styles
Styles reader.
Word2007
Reader for Word2007.
Settings
PHPWord settings class.
AbstractEnum
Converter
Common converter functions.
Css
Drawing
Drawing.
Html
Common Html functions.
PasswordEncoder
Password encoder for microsoft office applications.
OLERead
PclZip
Text
Text.
Validate
XMLReader
XML Reader wrapper.
XMLWriter
XMLWriter.
ZipArchive
ZipArchive wrapper.
Border
Border Styles.
DocProtect
Document Protection Types.
Jc
Horizontal Alignment Type.
JcTable
Table Alignment Type.
LineSpacingRule
Line Spacing Rule.
NumberFormat
Numbering Format.
TblWidth
Table Width Units.
TextAlignment
Magnification Preset Values.
VerticalJc
Vertical Alignment Type.
Zoom
Magnification Preset Values.
AbstractStyle
Abstract style class.
Border
Border style.
Cell
Table cell style.
Chart
Chart style.
Extrusion
3D extrusion style.
Fill
Fill style.
Font
Font style.
Frame
Frame defines the size and position of an object.
Image
Image and memory image style.
Indentation
Paragraph indentation style.
Language
Language A couple of predefined values are defined here, see the websites below for more values.
Line
Line style.
LineNumbering
Line numbering style.
ListItem
List item style.
Numbering
Numbering style.
NumberingLevel
Numbering level definition.
Outline
Outline defines the line/border of the object.
Paper
Paper size from ISO/IEC 29500-1:2012 pg. 1656-1657.
Paragraph
Paragraph style.
Row
Table row style.
Section
Section settings.
Shading
Shading style.
Shadow
Shadow style.
Shape
Shape style.
Spacing
Spacing between lines and above/below paragraph style.
Tab
Tab style.
Table
Border style.
TablePosition
TablePosition style.
TextBox
TextBox style.
TOC
TOC style.
Style
Style collection.
TemplateProcessor
AbstractWriter
Abstract writer class.
AbstractElement
Abstract HTML element writer.
Bookmark
Bookmark element HTML writer.
Container
Container element HTML writer.
Endnote
Endnote element HTML writer.
Footnote
Footnote element HTML writer.
Image
Image element HTML writer.
Link
Link element HTML writer.
ListItem
ListItem element HTML writer.
ListItemRun
ListItem element HTML writer.
PageBreak
PageBreak element HTML writer.
Table
Table element HTML writer.
Text
Text element HTML writer.
TextBreak
TextBreak element HTML writer.
TextRun
TextRun element HTML writer.
Title
TextRun element HTML writer.
AbstractPart
Body
RTF body part writer.
Head
RTF head part writer.
AbstractStyle
Style writer.
Font
Font style HTML writer.
Generic
Generic style writer.
Image
Paragraph style HTML writer.
Paragraph
Paragraph style HTML writer.
Table
Style writer.
HTML
HTML writer.
AbstractElement
Abstract element writer.
Container
Container element writer (section, textrun, header, footnote, cell, etc.).
Field
Field element writer.
Formula
Formula element writer.
Image
Image element writer.
Link
Text element writer.
PageBreak
PageBreak element writer.
Table
Table element writer.
Text
Text element writer.
TextBreak
TextBreak element writer.
TextRun
TextRun element writer.
Title
Title element writer.
AbstractPart
ODText writer part abstract.
Content
ODText content part writer: content.xml.
Manifest
ODText manifest part writer: META-INF/manifest.xml.
Meta
ODText meta part writer: meta.xml.
Mimetype
ODText mimetype part writer: mimetype.
Styles
ODText styles part writer: styles.xml.
AbstractStyle
Style writer.
Font
Font style writer.
Image
Image style writer.
Paragraph
Font style writer.
Section
Section style writer.
Table
Table style writer.
ODText
ODText writer.
AbstractRenderer
Abstract PDF renderer.
DomPDF
DomPDF writer.
MPDF
MPDF writer.
TCPDF
TCPDF writer.
PDF
PDF Writer.
AbstractElement
Abstract RTF element writer.
Container
Container element RTF writer.
Field
Field element writer.
Image
Image element RTF writer.
Link
Link element RTF writer.
ListItem
ListItem element RTF writer; extends from text.
PageBreak
PageBreak element RTF writer.
Table
Table element RTF writer.
Text
Text element RTF writer.
TextBreak
TextBreak element RTF writer.
TextRun
TextRun element RTF writer.
Title
Title element RTF writer; extends from text.
AbstractPart
Document
RTF document part writer.
Header
RTF header part writer.
AbstractStyle
Abstract RTF style writer.
Border
Border style writer.
Font
RTF font style writer.
Indentation
RTF indentation style writer.
Paragraph
RTF paragraph style writer.
Section
RTF section style writer.
Tab
Line numbering style writer.
RTF
RTF writer.
AbstractElement
Abstract element writer.
Bookmark
Bookmark element writer.
Chart
Chart element writer.
CheckBox
CheckBox element writer.
Container
Container element writer (section, textrun, header, footnote, cell, etc.).
Endnote
Endnote element writer.
Field
Field element writer.
Footnote
Footnote element writer.
FormField
FormField element writer.
Formula
Formula element writer.
Image
Image element writer.
Line
Line element writer.
Link
Link element writer.
ListItem
ListItem element writer.
ListItemRun
ListItemRun element writer.
OLEObject
OLEObject element writer.
PageBreak
PageBreak element writer.
ParagraphAlignment
PreserveText
PreserveText element writer.
SDT
Structured document tag element writer.
Shape
Shape element writer.
Table
Table element writer.
TableAlignment
Text
Text element writer.
TextBox
TextBox element writer.
TextBreak
TextBreak element writer.
TextRun
TextRun element writer.
Title
TextRun element writer.
TOC
TOC element writer.
AbstractPart
Word2007 writer part abstract class.
Chart
Word2007 chart part writer: word/charts/chartx.xml.
Comments
Word2007 comments part writer: word/comments.xml.
ContentTypes
Word2007 contenttypes part writer: [Content_Types].xml.
DocPropsApp
Word2007 extended document properties part writer: docProps/app.xml.
DocPropsCore
Word2007 core document properties part writer: docProps/core.xml.
DocPropsCustom
Word2007 custom document properties part writer: docProps/custom.xml.
Document
Word2007 document part writer: word/document.xml.
Endnotes
Word2007 endnotes part writer: word/endnotes.xml.
FontTable
Word2007 font table writer: word/fontTable.xml.
Footer
Word2007 footer part writer: word/footerx.xml.
Footnotes
Word2007 footnotes part writer: word/(footnotes|endnotes).xml.
Header
Word2007 header part writer: word/headerx.xml.
Numbering
Word2007 numbering part writer: word/numbering.xml.
Rels
Word2007 main relationship writer: _rels/.rels.
RelsDocument
Word2007 document relationship writer: word/_rels/document.xml.rels.
RelsPart
Word2007 part relationship writer: word/_rels/(header|footer|footnotes|endnotes)*.xml.rels.
Settings
Word2007 settings part writer: word/settings.xml.
Styles
Word2007 styles part writer: word/styles.xml.
Theme
Word2007 theme writer: word/theme/theme1.xml.
WebSettings
Word2007 web settings part writer: word/webSettings.xml.
AbstractStyle
Style writer.
Cell
Cell style writer.
Extrusion
3D extrusion style writer.
Fill
Fill style writer.
Font
Font style writer.
Frame
Frame style writer.
Image
Image style writer.
Indentation
Paragraph indentation style writer.
Line
Line style writer.
LineNumbering
Line numbering style writer.
MarginBorder
Margin border style writer.
Outline
Outline style writer.
Paragraph
Paragraph style writer.
Row
Row style writer.
Section
Section style writer.
Shading
Shading style writer.
Shadow
Shadow style writer.
Shape
Shape style writer.
Spacing
Spacing between lines and above/below paragraph style writer.
Tab
Line numbering style writer.
Table
Table style writer.
TablePosition
TablePosition style writer.
TextBox
TextBox style writer.
Word2007
Word2007 writer.

Constants

PCLZIP_ATT_FILE_COMMENT  = 79006
PCLZIP_ATT_FILE_CONTENT  = 79005
PCLZIP_ATT_FILE_MTIME  = 79004
PCLZIP_ATT_FILE_NAME  = 79001
PCLZIP_ATT_FILE_NEW_FULL_NAME  = 79003
PCLZIP_ATT_FILE_NEW_SHORT_NAME  = 79002
PCLZIP_CB_POST_ADD  = 78004
PCLZIP_CB_POST_EXTRACT  = 78002
PCLZIP_CB_PRE_ADD  = 78003
PCLZIP_CB_PRE_EXTRACT  = 78001
PCLZIP_ERR_ALREADY_A_DIRECTORY  = -17
PCLZIP_ERR_BAD_CHECKSUM  = -13
PCLZIP_ERR_BAD_EXTENSION  = -9
PCLZIP_ERR_BAD_EXTRACTED_FILE  = -7
PCLZIP_ERR_BAD_FORMAT  = -10
PCLZIP_ERR_DELETE_FILE_FAIL  = -11
PCLZIP_ERR_DIR_CREATE_FAIL  = -8
PCLZIP_ERR_DIRECTORY_RESTRICTION  = -21
PCLZIP_ERR_FILENAME_TOO_LONG  = -5
PCLZIP_ERR_INVALID_ARCHIVE_ZIP  = -14
PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE  = -20
PCLZIP_ERR_INVALID_OPTION_VALUE  = -16
PCLZIP_ERR_INVALID_PARAMETER  = -3
PCLZIP_ERR_INVALID_ZIP  = -6
PCLZIP_ERR_MISSING_FILE  = -4
PCLZIP_ERR_MISSING_OPTION_VALUE  = -15
PCLZIP_ERR_NO_ERROR  = 0
PCLZIP_ERR_READ_OPEN_FAIL  = -2
PCLZIP_ERR_RENAME_FILE_FAIL  = -12
PCLZIP_ERR_UNSUPPORTED_COMPRESSION  = -18
PCLZIP_ERR_UNSUPPORTED_ENCRYPTION  = -19
PCLZIP_ERR_USER_ABORTED  = 2
PCLZIP_ERR_WRITE_OPEN_FAIL  = -1
PCLZIP_ERROR_EXTERNAL  = 0
PCLZIP_OPT_ADD_COMMENT  = 77013
PCLZIP_OPT_ADD_PATH  = 77002
PCLZIP_OPT_ADD_TEMP_FILE_OFF  = 77022
PCLZIP_OPT_ADD_TEMP_FILE_ON  = 77021
PCLZIP_OPT_ADD_TEMP_FILE_THRESHOLD  = 77020
PCLZIP_OPT_BY_EREG  = 77010
PCLZIP_OPT_BY_INDEX  = 77009
PCLZIP_OPT_BY_NAME  = 77008
PCLZIP_OPT_BY_PREG  = 77011
PCLZIP_OPT_COMMENT  = 77012
PCLZIP_OPT_EXTRACT_AS_STRING  = 77006
PCLZIP_OPT_EXTRACT_DIR_RESTRICTION  = 77019
PCLZIP_OPT_EXTRACT_IN_OUTPUT  = 77015
PCLZIP_OPT_NO_COMPRESSION  = 77007
PCLZIP_OPT_PATH  = 77001
PCLZIP_OPT_PREPEND_COMMENT  = 77014
PCLZIP_OPT_REMOVE_ALL_PATH  = 77004
PCLZIP_OPT_REMOVE_PATH  = 77003
PCLZIP_OPT_REPLACE_NEWER  = 77016
PCLZIP_OPT_SET_CHMOD  = 77005
PCLZIP_OPT_STOP_ON_ERROR  = 77017
PCLZIP_OPT_TEMP_FILE_OFF  = 77022
PCLZIP_OPT_TEMP_FILE_ON  = 77021
PCLZIP_OPT_TEMP_FILE_THRESHOLD  = 77020
PCLZIP_READ_BLOCK_SIZE  = 2048
PCLZIP_SEPARATOR  = ','
PCLZIP_TEMPORARY_DIR  = ''
PCLZIP_TEMPORARY_DIR  = Settings::getTempDir() . '/'
PCLZIP_TEMPORARY_FILE_RATIO  = 0.47

Functions

PclZipUtilPathReduction()  : mixed
PclZipUtilPathInclusion()  : mixed
PclZipUtilCopyBlock()  : mixed
PclZipUtilRename()  : mixed
PclZipUtilOptionText()  : mixed
PclZipUtilTranslateWinPath()  : mixed

Constants

PCLZIP_ATT_FILE_COMMENT

public mixed PCLZIP_ATT_FILE_COMMENT = 79006

PCLZIP_ATT_FILE_CONTENT

public mixed PCLZIP_ATT_FILE_CONTENT = 79005

PCLZIP_ATT_FILE_MTIME

public mixed PCLZIP_ATT_FILE_MTIME = 79004

PCLZIP_ATT_FILE_NAME

public mixed PCLZIP_ATT_FILE_NAME = 79001

PCLZIP_ATT_FILE_NEW_FULL_NAME

public mixed PCLZIP_ATT_FILE_NEW_FULL_NAME = 79003

PCLZIP_ATT_FILE_NEW_SHORT_NAME

public mixed PCLZIP_ATT_FILE_NEW_SHORT_NAME = 79002

PCLZIP_CB_POST_ADD

public mixed PCLZIP_CB_POST_ADD = 78004

PCLZIP_CB_POST_EXTRACT

public mixed PCLZIP_CB_POST_EXTRACT = 78002

PCLZIP_CB_PRE_ADD

public mixed PCLZIP_CB_PRE_ADD = 78003

PCLZIP_CB_PRE_EXTRACT

public mixed PCLZIP_CB_PRE_EXTRACT = 78001

PCLZIP_ERR_ALREADY_A_DIRECTORY

public mixed PCLZIP_ERR_ALREADY_A_DIRECTORY = -17

PCLZIP_ERR_BAD_CHECKSUM

public mixed PCLZIP_ERR_BAD_CHECKSUM = -13

PCLZIP_ERR_BAD_EXTENSION

public mixed PCLZIP_ERR_BAD_EXTENSION = -9

PCLZIP_ERR_BAD_EXTRACTED_FILE

public mixed PCLZIP_ERR_BAD_EXTRACTED_FILE = -7

PCLZIP_ERR_BAD_FORMAT

public mixed PCLZIP_ERR_BAD_FORMAT = -10

PCLZIP_ERR_DELETE_FILE_FAIL

public mixed PCLZIP_ERR_DELETE_FILE_FAIL = -11

PCLZIP_ERR_DIR_CREATE_FAIL

public mixed PCLZIP_ERR_DIR_CREATE_FAIL = -8

PCLZIP_ERR_DIRECTORY_RESTRICTION

public mixed PCLZIP_ERR_DIRECTORY_RESTRICTION = -21

PCLZIP_ERR_FILENAME_TOO_LONG

public mixed PCLZIP_ERR_FILENAME_TOO_LONG = -5

PCLZIP_ERR_INVALID_ARCHIVE_ZIP

public mixed PCLZIP_ERR_INVALID_ARCHIVE_ZIP = -14

PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE

public mixed PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE = -20

PCLZIP_ERR_INVALID_OPTION_VALUE

public mixed PCLZIP_ERR_INVALID_OPTION_VALUE = -16

PCLZIP_ERR_INVALID_PARAMETER

public mixed PCLZIP_ERR_INVALID_PARAMETER = -3

PCLZIP_ERR_INVALID_ZIP

public mixed PCLZIP_ERR_INVALID_ZIP = -6

PCLZIP_ERR_MISSING_FILE

public mixed PCLZIP_ERR_MISSING_FILE = -4

PCLZIP_ERR_MISSING_OPTION_VALUE

public mixed PCLZIP_ERR_MISSING_OPTION_VALUE = -15

PCLZIP_ERR_NO_ERROR

public mixed PCLZIP_ERR_NO_ERROR = 0

PCLZIP_ERR_READ_OPEN_FAIL

public mixed PCLZIP_ERR_READ_OPEN_FAIL = -2

PCLZIP_ERR_RENAME_FILE_FAIL

public mixed PCLZIP_ERR_RENAME_FILE_FAIL = -12

PCLZIP_ERR_UNSUPPORTED_COMPRESSION

public mixed PCLZIP_ERR_UNSUPPORTED_COMPRESSION = -18

PCLZIP_ERR_UNSUPPORTED_ENCRYPTION

public mixed PCLZIP_ERR_UNSUPPORTED_ENCRYPTION = -19

PCLZIP_ERR_USER_ABORTED

public mixed PCLZIP_ERR_USER_ABORTED = 2

PCLZIP_ERR_WRITE_OPEN_FAIL

public mixed PCLZIP_ERR_WRITE_OPEN_FAIL = -1

PCLZIP_ERROR_EXTERNAL

public mixed PCLZIP_ERROR_EXTERNAL = 0

PCLZIP_OPT_ADD_COMMENT

public mixed PCLZIP_OPT_ADD_COMMENT = 77013

PCLZIP_OPT_ADD_PATH

public mixed PCLZIP_OPT_ADD_PATH = 77002

PCLZIP_OPT_ADD_TEMP_FILE_OFF

public mixed PCLZIP_OPT_ADD_TEMP_FILE_OFF = 77022

PCLZIP_OPT_ADD_TEMP_FILE_ON

public mixed PCLZIP_OPT_ADD_TEMP_FILE_ON = 77021

PCLZIP_OPT_ADD_TEMP_FILE_THRESHOLD

public mixed PCLZIP_OPT_ADD_TEMP_FILE_THRESHOLD = 77020

PCLZIP_OPT_BY_EREG

public mixed PCLZIP_OPT_BY_EREG = 77010

PCLZIP_OPT_BY_INDEX

public mixed PCLZIP_OPT_BY_INDEX = 77009

PCLZIP_OPT_BY_NAME

public mixed PCLZIP_OPT_BY_NAME = 77008

PCLZIP_OPT_BY_PREG

public mixed PCLZIP_OPT_BY_PREG = 77011

PCLZIP_OPT_COMMENT

public mixed PCLZIP_OPT_COMMENT = 77012

PCLZIP_OPT_EXTRACT_AS_STRING

public mixed PCLZIP_OPT_EXTRACT_AS_STRING = 77006

PCLZIP_OPT_EXTRACT_DIR_RESTRICTION

public mixed PCLZIP_OPT_EXTRACT_DIR_RESTRICTION = 77019

PCLZIP_OPT_EXTRACT_IN_OUTPUT

public mixed PCLZIP_OPT_EXTRACT_IN_OUTPUT = 77015

PCLZIP_OPT_NO_COMPRESSION

public mixed PCLZIP_OPT_NO_COMPRESSION = 77007

PCLZIP_OPT_PATH

public mixed PCLZIP_OPT_PATH = 77001

PCLZIP_OPT_PREPEND_COMMENT

public mixed PCLZIP_OPT_PREPEND_COMMENT = 77014

PCLZIP_OPT_REMOVE_ALL_PATH

public mixed PCLZIP_OPT_REMOVE_ALL_PATH = 77004

PCLZIP_OPT_REMOVE_PATH

public mixed PCLZIP_OPT_REMOVE_PATH = 77003

PCLZIP_OPT_REPLACE_NEWER

public mixed PCLZIP_OPT_REPLACE_NEWER = 77016

PCLZIP_OPT_SET_CHMOD

public mixed PCLZIP_OPT_SET_CHMOD = 77005

PCLZIP_OPT_STOP_ON_ERROR

public mixed PCLZIP_OPT_STOP_ON_ERROR = 77017

PCLZIP_OPT_TEMP_FILE_OFF

public mixed PCLZIP_OPT_TEMP_FILE_OFF = 77022

PCLZIP_OPT_TEMP_FILE_ON

public mixed PCLZIP_OPT_TEMP_FILE_ON = 77021

PCLZIP_OPT_TEMP_FILE_THRESHOLD

public mixed PCLZIP_OPT_TEMP_FILE_THRESHOLD = 77020

PCLZIP_READ_BLOCK_SIZE

public mixed PCLZIP_READ_BLOCK_SIZE = 2048

PCLZIP_SEPARATOR

public mixed PCLZIP_SEPARATOR = ','

PCLZIP_TEMPORARY_DIR

public mixed PCLZIP_TEMPORARY_DIR = ''

PCLZIP_TEMPORARY_DIR

public mixed PCLZIP_TEMPORARY_DIR = Settings::getTempDir() . '/'

PCLZIP_TEMPORARY_FILE_RATIO

public mixed PCLZIP_TEMPORARY_FILE_RATIO = 0.47

Functions

PclZipUtilPathReduction()

PclZipUtilPathReduction(mixed $p_dir) : mixed
Parameters
$p_dir : mixed

PclZipUtilPathInclusion()

PclZipUtilPathInclusion(mixed $p_dir, mixed $p_path) : mixed
Parameters
$p_dir : mixed
$p_path : mixed

PclZipUtilCopyBlock()

PclZipUtilCopyBlock(mixed $p_src, mixed $p_dest, mixed $p_size[, mixed $p_mode = 0 ]) : mixed
Parameters
$p_src : mixed
$p_dest : mixed
$p_size : mixed
$p_mode : mixed = 0

PclZipUtilRename()

PclZipUtilRename(mixed $p_src, mixed $p_dest) : mixed
Parameters
$p_src : mixed
$p_dest : mixed

PclZipUtilOptionText()

PclZipUtilOptionText(mixed $p_option) : mixed
Parameters
$p_option : mixed

PclZipUtilTranslateWinPath()

PclZipUtilTranslateWinPath(mixed $p_path[, mixed $p_remove_disk_letter = true ]) : mixed
Parameters
$p_path : mixed
$p_remove_disk_letter : mixed = true

        
On this page

Search results