factory

[ ] [ ] [ ]

Class: Phpdocx_Phpdocx

Source Location: /Phpdocx_Phpdocx.inc

Class Overview

CreateDocument
   |
   --CreateDocx
      |
      --Phpdocx_Phpdocx

Abstract class used for creating documents

Author(s):

Version:

2.2

Copyright:

Copyright (c) 2009-2013 Narcea ProduCiones Multimedia S.L. (http://www.2mdc.com)

Inherited Constants

Class: CreateDocx

CreateDocx::NAMESPACEWORD
CreateDocx::SCHEMA_IMAGEDOCUMENT
CreateDocx::SCHEMA_OFFICEDOCUMENT

Inherited Variables

Class: CreateDocx

CreateDocx::$bidi
CreateDocx::$customLists
CreateDocx::$fileGraphicTemplate
CreateDocx::$graphicTemplate
CreateDocx::$intIdWord
CreateDocx::$log
CreateDocx::$numOL
CreateDocx::$numUL
CreateDocx::$orderedListStyle
CreateDocx::$PHPDOCXStyles
CreateDocx::$rtl
CreateDocx::$sectionProperties
CreateDocx::$settings
CreateDocx::$unorderedListStyle

Inherited Methods

Class: CreateDocx

CreateDocx::__construct(): Construct
CreateDocx::addBackgroundImage(): Adds a background image to the document
CreateDocx::addBasicHTML()
CreateDocx::addBookmark(): Adds a bookmart start or end tag
CreateDocx::addBreak(): Add a break
CreateDocx::addChart(): Add a chart
CreateDocx::addComment(): Adds a comment
CreateDocx::addDateAndHour(): Adds date and hour to the Word document
CreateDocx::addDOCX(): Embeds a DOCX.
CreateDocx::addElement(): Add an element to embedd in other elements
CreateDocx::addEndnote(): Adds an endnote
CreateDocx::addFont(): Add a new font
CreateDocx::addFooter(): Add a footer.
CreateDocx::addFootnote(): Adds a footnote
CreateDocx::addFormElement(): Add a Form element (text field, select or checkbox)
CreateDocx::addGraphic(): Add a graphic
CreateDocx::addGraphicImg(): Add a graphic image
CreateDocx::addGraphicTemplate(): Add a graphic template. Replace placeholder with a graphic
CreateDocx::addHeader(): Add a header.
CreateDocx::addHeading(): Adds a heading to the Word document
CreateDocx::addHTML(): Inserts HTML into a document as alternative content (altChunk).
CreateDocx::addImage(): Add an image
CreateDocx::addLineNumbering(): Adds line numbering
CreateDocx::addLink(): Add a link
CreateDocx::addList(): Add a list
CreateDocx::addMacroFromDoc(): Add a macro from a DOC
CreateDocx::addMathDocx(): Convert a math eq to DOCX
CreateDocx::addMathEq(): Add an existing math eq to DOCX
CreateDocx::addMathMML(): Convert a math MML eq to DOCX
CreateDocx::addMergeField(): Adds a merge field to the Word document
CreateDocx::addMHT(): Add a MHT file.
CreateDocx::addNewBaseTemplate(): Add a new base template into the templates folder.
CreateDocx::addObject(): Add an existing object (XLS or PPTX)
CreateDocx::addPageBorders(): Adds page borders
CreateDocx::addPageNumber(): Adds a page number to the document WARNING: if the page number is not added to a header or footer the user may need to press F9 in the MS Word interface to update its value to the current page
CreateDocx::addParagraph(): Adds a complex paragraph to a Word document
CreateDocx::addProperties(): Add properties to document
CreateDocx::addRawWordML(): Add a raw WordML
CreateDocx::addRTF(): Add a RTF file. Keep content and styles.
CreateDocx::addSection(): Adds a section
CreateDocx::addShape(): Add a shape
CreateDocx::addSimpleField(): Adds a simple field to the Word document WARNING: if the page number is not added to a header or footer the user may need to press F9 in the MS Word interface to update its value to the current page
CreateDocx::addStructuredDocumentTag(): Add a Structured Document Tag
CreateDocx::addSubDocument(): Add a subdocument to a master document. The document should be in the same folder as the final master document
CreateDocx::addTable(): Add a table.
CreateDocx::addTableContents(): Add a table of contents (TOC)
CreateDocx::addTemplate(): Add a DOCX file as a template
CreateDocx::addTemplateChart(): Replace a variable with a chart.
CreateDocx::addTemplateCheckBox(): Replace a variable with a checkbox.
CreateDocx::addTemplateImage(): Replace a variable image template with a new image.
CreateDocx::addTemplateVariable(): Replace a variable with a text, HTML, DOCX, RTF, MHT.
CreateDocx::addText(): Add a text
CreateDocx::addTextBox(): Add a textbox
CreateDocx::addWordML(): Adds WordML to the document.
CreateDocx::cleanTemplateVariable()
CreateDocx::cleanWordMLBlockElements(): Eliminates all block type elements from a WordML string
CreateDocx::clearBlocks(): Clear all BLOCK tags
CreateDocx::createDocx(): Generate a new DOCX file
CreateDocx::createDocxAndDownload(): Generate and download a new DOCX file
CreateDocx::createListStyle(): Create a new style to use in your Word document.
CreateDocx::createParagraphStyle(): Create a new paragraph style and linked char style to be used in your Word document.
CreateDocx::createWordMLFragment(): Creates a WordML fragment.
CreateDocx::deleteTemplateBlock(): Delete a block of content markep up between BLOCK tags
CreateDocx::disableDebug(): Disable debug mode
CreateDocx::docx2txt(): Transform a word document to a text file
CreateDocx::docxSettings(): Stablish the general docx settings in settings.xml
CreateDocx::embedHTML(): Embed HTML into the Word document by parsing the HTML code and converting it into WordML It preserves many CSS styles
CreateDocx::enableCompatibilityMode(): Enable compatibility mode for OpenOffice and MS Office 2003 CP. Avoid using unsupported methods
CreateDocx::enableDebug(): Enable debug mode
CreateDocx::generateBaseWordNumbering(): creates an empty word numbering base string
CreateDocx::getExtension(): Getter
CreateDocx::getTempDir(): To add support of sys_get_temp_dir for PHP versions under 5.2.1
CreateDocx::getTemplateVariables(): Return template variables (placeholders)
CreateDocx::getTemplateXML(): Return the XML of the given Template
CreateDocx::getTemporaryDirectory(): Getter
CreateDocx::getXmlContentTypes(): Getter
CreateDocx::getXmlDocPropsApp(): Getter
CreateDocx::getXmlDocPropsCore(): Getter
CreateDocx::getXmlDocPropsCustom(): Getter
CreateDocx::getXmlRelsRels(): Getter
CreateDocx::getXmlWordDocumentContent(): Getter
CreateDocx::getXmlWordDocumentStyles(): Getter
CreateDocx::getXmlWordEndnotes(): Getter
CreateDocx::getXmlWordFontTable(): Getter
CreateDocx::getXmlWordFooter1(): Getter
CreateDocx::getXmlWordHeader1(): Getter
CreateDocx::getXmlWordRelsDocumentRels(): Getter
CreateDocx::getXmlWordSettings(): Getter
CreateDocx::getXmlWordStyles(): Getter
CreateDocx::getXmlWordThemeTheme1(): Getter
CreateDocx::getXml_Word_WebSettings(): Setter
CreateDocx::importFontTableXML(): Imports an existing fontTable.xml file from an existing docx document.
CreateDocx::importHeadersAndFooters(): Inserts new headers and/or footers from a word file.
CreateDocx::importSettingsXML(): Imports an existing settings.xml file from an existing docx document.
CreateDocx::importSingleNumbering(): Inserts a new numbering style.
CreateDocx::importStyles(): Imports an existing style sheet from an existing docx document.
CreateDocx::importThemeXML(): Imports an existing theme from an existing docx document.
CreateDocx::importWebSettingsXML(): Imports an existing webSettings.xml file from an existing docx document.
CreateDocx::modifyInputFields(): Modify the value of a series of input fields.
CreateDocx::modifyPageLayout(): Modify page layout
CreateDocx::parseStyles(): Gets the Ids associated with the different styles in the current document or an external docx.
CreateDocx::readDOCX(): Parse DOCX file and extract content
CreateDocx::removeFooters(): Removes existing footers.
CreateDocx::removeHeaders(): Removes existing headers.
CreateDocx::removeHeadersAndFooters(): Removes headers and footers.
CreateDocx::replaceHeaderImage(): Replace a header image with a new image.
CreateDocx::replaceTemplateVariableByHTML(): Replace a template variable with WordML obtained from HTML via the embedHTML method.
CreateDocx::setBackgroundColor(): Changes the background color of the document
CreateDocx::setDecimalSymbol(): Change the default font
CreateDocx::setDefaultFont(): Change the default font
CreateDocx::setEncodeUTF8(): Transform to UTF-8 charset
CreateDocx::setExtension(): Setter
CreateDocx::setLanguage(): Change default language.
CreateDocx::setMarkAsFinal(): Mark the document as final
CreateDocx::setRTL(): sets global right to left options
CreateDocx::setRTLOptions(): sets global right to left options for the different methods
CreateDocx::setTemplateSymbol(): Set the symbol surrounding varibles (placeholders)
CreateDocx::setTemporaryDirectory(): Setter
CreateDocx::setXmlContentTypes(): Setter
CreateDocx::setXmlDocPropsApp(): Setter
CreateDocx::setXmlDocPropsCore(): Setter
CreateDocx::setXmlDocPropsCustom(): Setter
CreateDocx::setXmlRelsRels(): Setter
CreateDocx::setXmlWordDocument(): Setter
CreateDocx::setXmlWordDocumentStyles(): Setter
CreateDocx::setXmlWordEndnotes(): Setter
CreateDocx::setXmlWordFontTable(): Setter
CreateDocx::setXmlWordFooter1(): Setter
CreateDocx::setXmlWordHeader1(): Setter
CreateDocx::setXmlWordRelsDocumentRels(): Setter
CreateDocx::setXmlWordSettings(): Setter
CreateDocx::setXmlWordStyles(): Setter
CreateDocx::setXmlWordThemeTheme1(): Setter
CreateDocx::setXmlWordWebSettings(): Setter
CreateDocx::tickCheckbox(): Checks or unchecks a Word template checkbox.
CreateDocx::transformDocx(): Transform DOCX to PDF, ODT, SXW, RTF, DOC, TXT, HTML or WIKI
CreateDocx::transformDocxUsingMSWord(): If PHPDocX is installed in a server with a working copy of Word 2007 or newer you may use it to do format conversions.
CreateDocx::txt2docx(): Insert the content of a text file into a word document trying to hold the styles
CreateDocx::__destruct(): Destruct
CreateDocx::__toString(): Magic method, returns current word XML

Class Details

[line 18]
Abstract class used for creating documents

Tags:

version:	2.2
copyright:	Copyright (c) 2009-2013 Narcea ProduCiones Multimedia S.L. (http://www.2mdc.com)

[ Top ]

Documentation generated on Mon, 13 Jan 2014 13:44:24 +0100 by phpDocumentor 1.4.4