_debug = Debug::getInstance();
Logger::configure(dirname(__FILE__) . '/conf/log4php.properties');
self::$log = Logger::getLogger('phpdocx_logger');
$this->_background = '';
$this->_backgroundColor = 'FFFFFF';
$this->_baseTemplateFilesPath;
if($baseTemplatePath == 'docm'){
$this->_baseTemplatePath = PHPDOCX_BASE_FOLDER.'phpdocxBaseTemplate.docm';
$this->_docm = true;
$this->_defaultTemplate = true;
$this->_extension = 'docm';
}else if($baseTemplatePath == 'docx'){
$this->_baseTemplatePath = PHPDOCX_BASE_FOLDER.'phpdocxBaseTemplate.docx';
$this->_docm = false;
$this->_defaultTemplate = true;
$this->_extension = 'docx';
}else{
if($baseTemplatePath == PHPDOCX_BASE_TEMPLATE){
$this->_defaultTemplate = true;
}else{
$this->_defaultTemplate = false;
}
$this->_baseTemplatePath = $baseTemplatePath;
$extensionArray = explode('.', $this->_baseTemplatePath);
$extension = array_pop($extensionArray);
$this->_extension = $extension;
if($extension == 'docm'){
$this->_docm = true;
}else if($extension == 'docx'){
$this->_docm = false;
}else{
self::$log->fatal('Invalid base template extension');
exit();
}
}
$this->_baseTemplateZip = new ZipArchive();
$this->_bookmarksIds = array();
$this->_idRels = array();
$this->_idWords = array();
$this->_idImgHeader = 1;
$this->_idRels = 1;
self::$intIdWord = rand(9999999,99999999);
self::$_encodeUTF = 0;
$this->_language = 'en-US';
$this->_markAsFinal = 0;
$this->graphicTemplate = array();
$this->fileGraphicTemplate = array();
$this->_zipDocx = new ZipArchive();
if ($tempDir) {
$this->_tempDir = $tempDir;
} else {
$this->_tempDir = self::getTempDir();
}
$this->_tempFile = tempnam($this->_tempDir, 'document');
$this->_templateNumberings;
$this->_zipDocx->open($this->_tempFile, ZipArchive::OVERWRITE);
$this->_compatibilityMode = false;
self::$log->info(
'Create a temp file to use as initial ZIP file. ' .
'DOCX is a ZIP file.'
);
// sign is set false as default
$this->_sign = false;
$this->_relsRelsC = '';
$this->_relsRelsT = '';
$this->_contentTypeC = '';
$this->_contentTypeT = NULL;
$this->_defaultFont = '';
$this->_docPropsAppC = '';
$this->_docPropsAppT = '';
$this->_docPropsCoreC = '';
$this->_docPropsCoreT = '';
$this->_docPropsCustomC = '';
$this->_docPropsCustomT = '';
$this->_macro = 0;
$this->_relsHeader = array();
$this->_relsFooter = array();
$this->_parsedStyles = array();
$this->_relsHeaderFooterImage = array();
$this->_relsHeaderFooterImageExternal = array();
$this->_relsHeaderFooterLink = array();
$this->_sectPr = NULL;
$this->_tempFileXLSX = array();
$this->_uniqid = 'phpdocx_'.uniqid();
$this->_wordDocumentT = '';
$this->_wordDocumentC = '';
$this->_wordDocumentStyles = '';
$this->_wordEndnotesC = '';
$this->_wordEndnotesT = '';
$this->_wordFontTableT = '';
$this->_wordFontTableC = '';
$this->_wordFooterC = array();
$this->_wordFooterT = array();
$this->_wordFootnotesC = '';
$this->_wordFootnotesT = '';
$this->_wordHeaderC = array();
$this->_wordHeaderT = array();
$this->_wordNumberingC;
$this->_wordNumberingT;
$this->_wordRelsDocumentRelsC = '';
$this->_wordRelsDocumentRelsT = NULL;
$this->_wordRelsHeaderRelsC = array();
$this->_wordRelsHeaderRelsT = array();
$this->_wordRelsFooterRelsC = array();
$this->_wordRelsFooterRelsT = array();
$this->_wordSettingsT = '';
$this->_wordSettingsC = '';
$this->_wordStylesT = '';
$this->_wordStylesC = '';
$this->_wordThemeThemeT = '';
$this->_wordThemeThemeC = '';
$this->_wordWebSettingsT = '';
$this->_wordWebSettingsC = '';
$this->_defaultPHPDOCXStyles = array('Default Paragraph Font PHPDOCX', //This is the default paragraph font style used in multiple places
'List Paragraph PHPDOCX', //This is the style used for the defolt ordered and unorderd lists
'Title PHPDOCX', //This style is used by the addTitle method
'Subtitle PHPDOCX', //This style is used by the addTitle method
'Normal Table PHPDOCX', //This style is used for the basic table
'Table Grid PHPDOCX', //This style is for basic tables and is also used to embed HTML tables with border="1"
'footnote text PHPDOCX', //This style is used for default footnotes
'footnote text Car PHPDOCX', //The character style for footnotes
'footnote reference PHPDOCX', // The style for the footnote
'endnote text PHPDOCX', //This style is used for default endnotes
'endnote text Car PHPDOCX', //The character style for endnotes
'endnote reference PHPDOCX'); // The style for the endnote
//Some variables to control that some v2.4 keep working
$this->footerAdded = false;
$this->headerAdded = false;
self::$PHPDOCXStyles = '
';
self::$unorderedListStyle = '
';
self::$orderedListStyle ='
';
try {
GenerateDocx::beginDocx();
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We now try to open the zip file defined as base template
try {
$openBaseTemplate = $this->_baseTemplateZip->open($this->_baseTemplatePath);
if ($openBaseTemplate !== true){
throw new Exception('Error while opening the Base Template: please, check the path');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We now extract the contents of the base template into a temp dir for further manipulation
try {
$this->_baseTemplateFilesPath = $this->_tempDir.'/'.uniqid(true);
$extractBaseTemplate =$this->_baseTemplateZip->extractTo($this->_baseTemplateFilesPath);
if ($extractBaseTemplate !== true) {
throw new Exception('Error while extracting the Base Template: there may be problems writing in the default tmp folder');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We should now check if there is any structured content as front page to include it in the resulting document
try{
$baseTemplateDocumentT = $this->_baseTemplateZip->getFromName('word/document.xml');
if ($baseTemplateDocumentT == '') {
throw new Exception('Error while extracting the document.xml file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$baseDocument = new DOMDocument();
$baseDocument->loadXML($baseTemplateDocumentT);
$docXpath = new DOMXPath($baseDocument);
$docXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$queryDoc = '//w:body/w:sdt';
$docNodes = $docXpath->query($queryDoc);
if ($docNodes->length > 0){
if($docNodes->item(0)->nodeName == 'w:sdt'){
$tempDoc = new DomDocument();
$sdt =$tempDoc->importNode($docNodes->item(0), true);
$newNode = $tempDoc->appendChild($sdt);
$frontPage = $tempDoc->saveXML($newNode);
$this->_wordDocumentC .= $frontPage;
}
}
//Let us extract now the section information to include it at the end of the document.xml file
$sectPr = $baseDocument->getElementsByTagName('sectPr')->item(0);
$this->_sectPr = new DOMDocument();
$sectNode = $this->_sectPr->importNode($sectPr, true);
$this->_sectPr->appendChild($sectNode);
//Let us extract the contents of the [Content_Types].xml file for further manipulation
try{
$baseTemplateContentTypeT = $this->_baseTemplateZip->getFromName('[Content_Types].xml');
if ($baseTemplateContentTypeT == '') {
throw new Exception('Error while extracting the [Content_Types].xml file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_contentTypeT = new DOMDocument();
$this->_contentTypeT->loadXML($baseTemplateContentTypeT);
//We are going to include the standard image defaults
$this->generateDEFAULT('gif', 'image/gif');
$this->generateDEFAULT('jpg', 'image/jpg');
$this->generateDEFAULT('png', 'image/png');
$this->generateDEFAULT('jpeg', 'image/jpeg');
$this->generateDEFAULT('bmp', 'image/bmp');
//Let us extract the document.xml.rels for further manipulation
try{
$baseTemplateDocumentRelsT = $this->_baseTemplateZip->getFromName('word/_rels/document.xml.rels');
if ($baseTemplateDocumentRelsT == '') {
throw new Exception('Error while extracting the document.xml.rels file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordRelsDocumentRelsT = new DOMDocument();
$this->_wordRelsDocumentRelsT->loadXML($baseTemplateDocumentRelsT);
$relationships = $this->_wordRelsDocumentRelsT->getElementsByTagName('Relationship');
//Now we have to take care of the case that the template used is not one of the default preprocessed tempaltes
if($this->_defaultTemplate){
self::$numUL = 1;
self::$numOL = rand(9999, 999999999);
//Let's get the original template numbering.xml file as a DOMdocument
try{
$this->_wordNumberingT = $this->_baseTemplateZip->getFromName('word/numbering.xml');
if ($this->_wordNumberingT == '') {
throw new Exception('Error while extracting the numbering file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}else{
//We should do now some cleaning of the files from the base template zip
//Let us first look at the document.xml.rels file to analyze the contents
//Let us analyze its structure
//In order to do that we should parse word/_rels/document.xml.rels
$counter = $relationships->length -1;
for ($j=$counter; $j > -1; $j--){
$completeType = $relationships->item($j)->getAttribute('Type');
$target = $relationships->item($j)->getAttribute('Target');
$tempArray = explode('/', $completeType);
$type = array_pop($tempArray);
//This array holds the data that has to be changed in settings.xml
$arrayCleaner = array();
switch($type){
case 'header':
//TODO: this should be changed if we use default templates with headers
array_push($this->_relsHeader,$target);
break;
case 'footer':
//TODO: this should be changed if we use default templates with footers
array_push($this->_relsFooter,$target);
break;
case 'chart':
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/charts');
$this->_wordRelsDocumentRelsT->documentElement->removeChild($relationships->item($j));
break;
case 'embeddings':
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/embeddings');
$this->_wordRelsDocumentRelsT->documentElement->removeChild($relationships->item($j));
break;
}
}
//Let us now manage the numbering.xml and style.xml files
// We are going to use some default styles, for example, in the creation of lists, footnotes, titles, ...
// So we should make sure that it is included in the styles.xml document
$this->importStyles(PHPDOCX_BASE_TEMPLATE, 'merge', $this->_defaultPHPDOCXStyles);
//Let us first check if the base template file has a numbering.xml file
$numRef = rand(9999999, 99999999);
self::$numUL = $numRef;
self::$numOL = $numRef +1;
if(file_exists($this->_baseTemplateFilesPath.'/word/numbering.xml')) {
//Let's get the original template numbering.xml file as a DOMdocument
try {
$this->_wordNumberingT = $this->_baseTemplateZip->getFromName('word/numbering.xml');
if ($this->_wordNumberingT == '') {
throw new Exception('Error while extracting the numbering file from the base template');
}
} catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$unorderedListStyle, self::$numUL);
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$orderedListStyle, self::$numOL);
}else{
$this->_wordNumberingT = $this->generateBaseWordNumbering();
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$unorderedListStyle, self::$numUL);
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$orderedListStyle, self::$numOL);
//Now we should include the corresponding relationshipand Override
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . rand(99999999, 999999999), 'numbering', 'numbering.xml'
);
$this->generateOVERRIDE('/word/numbering.xml','application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml');
}
//Let us now make sure that there are the corresponding xmls, with all their relationships for endnotes and footnotes
if(!file_exists($this->_baseTemplateFilesPath.'/word/endnotes.xml') || !file_exists($this->_baseTemplateFilesPath.'/word/footnotes.xml')){
$notesZip = new ZipArchive();
try {
$openNotesZip = $notesZip->open(PHPDOCX_BASE_TEMPLATE);
if ($openNotesZip !== true){
throw new Exception('Error while opening the standard base template to extract the word/footnotes.xml and word/endnotes.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$arraySettings = array();
if(!file_exists($this->_baseTemplateFilesPath.'/word/footnotes.xml')){
$notesZip->extractTo($this->_baseTemplateFilesPath, 'word/footnotes.xml');
//Now we should include the corresponding relationshipand Override
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . rand(99999999, 999999999), 'footnotes', 'footnotes.xml'
);
$this->generateOVERRIDE('/word/footnotes.xml','application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml');
array_push($arraySettings, '');
}
if(!file_exists($this->_baseTemplateFilesPath.'/word/endnotes.xml')){
$notesZip->extractTo($this->_baseTemplateFilesPath, 'word/endnotes.xml');
//Now we should include the corresponding relationshipand Override
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . rand(99999999, 999999999), 'endnotes', 'endnotes.xml'
);
$this->generateOVERRIDE('/word/endnotes.xml','application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml');
array_push($arraySettings,'');
}
//$this->includeSettings($arraySettings)
}
}
//To finish we make sure that we are using the default paper size and the default language
$this->modifyPageLayout($paperType = DEFAULT_PAPER_SIZE);
$this->setLanguage(DEFAULT_LANGUAGE);
}
/**
* Destruct
*
* @access public
*/
public function __destruct()
{
}
/**
* Magic method, returns current word XML
*
* @access public
* @return string Return current word
*/
public function __toString()
{
$this->generateTemplateWordDocument();
self::$log->debug('Get document template content.');
return $this->_wordDocumentT;
}
/**
* Setter
*
* @access public
*/
public function setExtension($extension)
{
$this->_extension = $extension;
}
/**
* Getter
*
* @access public
*/
public function getExtension()
{
return $this->_extension;
}
/**
* Setter
*
* @access public
*/
public function setTemporaryDirectory($tempDir)
{
$this->_tempDir = $tempDir;
}
/**
* Getter
*
* @access public
*/
public function getTemporaryDirectory()
{
return $this->_tempDir;
}
/**
* Setter
*
* @access public
*/
public function setXmlContentTypes($xmlContentTypes)
{
$this->_contentTypeC = $xmlContentTypes;
}
/**
* Getter
*
* @access public
*/
public function getXmlContentTypes()
{
return $this->_contentTypeC;
}
/**
* Setter
*
* @access public
*/
public function setXmlRelsRels($xmlRelsRels)
{
$this->_relsRelsC = $xmlRelsRels;
}
/**
* Getter
*
* @access public
*/
public function getXmlRelsRels()
{
return $this->_relsRelsC;
}
/**
* Setter
*
* @access public
*/
public function setXmlDocPropsApp($xmlDocPropsApp)
{
$this->_docPropsAppC = $xmlDocPropsApp;
}
/**
* Getter
*
* @access public
*/
public function getXmlDocPropsApp()
{
return $this->_docPropsAppC;
}
/**
* Setter
*
* @access public
*/
public function setXmlDocPropsCore($xmlDocPropsCore)
{
$this->_docPropsCoreC = $xmlDocPropsCore;
}
/**
* Getter
*
* @access public
*/
public function getXmlDocPropsCore()
{
return $this->_docPropsCoreC;
}
/**
* Setter
*
* @access public
*/
public function setXmlDocPropsCustom($xmlDocPropsCustom)
{
$this->_docPropsCustomC = $xmlDocPropsCustom;
}
/**
* Getter
*
* @access public
*/
public function getXmlDocPropsCustom()
{
return $this->_docPropsCustomC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordDocument($xmlWordDocument)
{
$this->_wordDocumentC = $xmlWordDocument;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordDocumentContent()
{
return $this->_wordDocumentC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordDocumentStyles($xmlWordDocumentStyles)
{
$this->_wordDocumentStyles = $xmlWordDocumentStyles;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordDocumentStyles()
{
return $this->_wordDocumentStyles;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordEndnotes($xmlWordEndnotes)
{
$this->_wordEndnotesC = $xmlWordEndnotes;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordEndnotes()
{
return $this->_wordEndnotesC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordFontTable($xmlWordFontTable)
{
$this->_wordFontTableC = $xmlWordFontTable;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordFontTable()
{
return $this->_wordFontTableC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordFooter1($xmlWordFooter)
{
$this->_wordFooterC = $xmlWordFooter;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordFooter1()
{
return $this->_wordFooterC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordHeader1($xmlWordHeader)
{
$this->_wordHeaderC = $xmlWordHeader;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordHeader1()
{
return $this->_wordHeaderC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordRelsDocumentRels($xmlWordRelsDocumentRels)
{
$this->_wordRelsDocumentRelsC = $xmlWordRelsDocumentRels;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordRelsDocumentRels()
{
return $this->_wordRelsDocumentRelsC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordSettings($xmlWordSettings)
{
$this->_wordSettingsC = $xmlWordSettings;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordSettings()
{
return $this->_wordSettingsC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordStyles($xmlWordStyles)
{
$this->_wordStylesC = $xmlWordStyles;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordStyles()
{
return $this->_wordStylesC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordThemeTheme1($xmlWordThemeTheme)
{
$this->_wordThemeThemeC = $xmlWordThemeTheme;
}
/**
* Getter
*
* @access public
*/
public function getXmlWordThemeTheme1()
{
return $this->_wordThemeThemeC;
}
/**
* Setter
*
* @access public
*/
public function setXmlWordWebSettings($xmlWordWebSettings)
{
$this->_wordWebSettingsC = $xmlWordWebSettings;
}
/**
* Setter
*
* @access public
*/
public function getXml_Word_WebSettings()
{
return $this->_wordWebSettingsC;
}
/**
* Adds a background image to the document
*
* @access public
* @example ../examples/easy/BackgroundImage.php
* @param string $path
*/
public function addBackgroundImage($path)
{
//Let us extract some basic info about the background image
$image = pathinfo($path);
$extension = $image['extension'];
$imageName = $image['filename'];
//We define an unique identifier
$tempId = uniqid(true);
$identifier = 'rId'. $tempId;
//We construct the background WordML code
$this->_background ='
';
//We make sure that there exists the corresponding content type
$this->generateDEFAULT($extension, 'image/'.$extension);
//We copy the image in the media folder
$backgroundImage = file_get_contents($path);
if(!is_dir($this->_baseTemplateFilesPath.'/word/media')){
mkdir($this->_baseTemplateFilesPath.'/word/media');
}
$backgroundImageHandle = fopen($this->_baseTemplateFilesPath.'/word/media/img'.$tempId.'.'.$extension, "w+");
$contents = fwrite($backgroundImageHandle, $backgroundImage);
fclose($backgroundImageHandle);
//We insert the relationship
$relsImage = '';
$relsNodeImage = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$relsNodeImage->appendXML($relsImage);
$this->_wordRelsDocumentRelsT->documentElement->appendChild($relsNodeImage);
//Now we have to modify the settings to display the background image
try{
$settings = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "r");
$baseTemplateSettingsT = fread($settings, 1000000);
fclose($settings);
if ($baseTemplateSettingsT == '') {
throw new Exception('Error while extracting settings.xml file from the base template to insert the background image');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordSettingsT = new DOMDocument();
$this->_wordSettingsT->loadXML($baseTemplateSettingsT);
$settingsImage = $this->_wordSettingsT->createDocumentFragment();
$settingsImage->appendXML('');
$this->_wordSettingsT->documentElement->appendChild($settingsImage);
$newSettings = $this->_wordSettingsT->saveXML();
$settingsHandle = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "w+");
$contents = fwrite($settingsHandle, $newSettings);
fclose($settingsHandle);
}
/**
*
* @param string $html
* @param array $options
* @deprecated
*/
public function addBasicHTML($html = '', $options = array())
{
$this->embedHTML($html, $options);
}
/**
* Adds a bookmart start or end tag
*
* @access public
* @example ../examples/easy/Bookmarks.php
* @param array $options
* Values:
* 'type' (start, end)
* 'name' (string)
* 'rawWordML' (boolean)
*/
public function addBookmark($options = array('type' => null, 'name' => null, 'rawWordML' => false))
{
$type = $options['type'];
$name = $options['name'];
//First we check for the requested parameters
if (empty($type) || empty($name)) {
self::$log->fatal('Error: the addBookmark method is lacking at least one required parameter');
exit();
}
if($type == 'start'){
$bookmarkId = rand(9999999, 999999999);
$bookmark = '';
$this->_bookmarksIds[$name] = $bookmarkId;
}else if($type == 'end'){
if(empty($this->_bookmarksIds[$name])){
self::$log->fatal('You are trying to end a nonexisting bookmark');
exit('');
}
$bookmark = '';
unset($this->_bookmarksIds[$name]);
}else{
self::$log->fatal('The addBookmark type is incorrect');
exit();
}
self::$log->info('Adds a bookmark' . $type . ' to the Word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $bookmark;
}else{
$this->_wordDocumentC .= (string) $bookmark;
}
}
/**
* Add a break
*
* @access public
* @example ../examples/easy/PageBreak.php
* @example ../examples/intermediate/Chart_footnote.php
* @example ../examples/intermediate/FooterPager.php
* @example ../examples/intermediate/Multidocument.php
* @example ../examples/advanced/Report.php
* @param string $options
* Values:
* 'type' (line, page, column)
* 'rawWordML' (boolean)
*/
public function addBreak($options = array('type' => 'line', 'rawWordML' => false))
{
$break = CreatePage::getInstance();
$break->generatePageBreak($options['type']);
self::$log->info('Add break to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $break;
}else{
$this->_wordDocumentC .= (string) $break;
}
}
/**
* Add a chart
*
* @access public
* @example ../examples/easy/Chart.php
* @example ../examples/easy/Chart_area3D.php
* @example ../examples/easy/Chart_bar.php
* @example ../examples/easy/Chart_barStacked.php
* @example ../examples/easy/Chart_bubble.php
* @example ../examples/easy/Chart_col.php
* @example ../examples/easy/Chart_doughnut.php
* @example ../examples/easy/Chart_line.php
* @example ../examples/easy/Chart_ofPieChart_bar.php
* @example ../examples/easy/Chart_ofPieChart_pie.php
* @example ../examples/easy/Chart_percentstaked.php
* @example ../examples/easy/Chart_radar.php
* @example ../examples/easy/Chart_scatter.php
* @example ../examples/easy/Chart_surface.php
* @example ../examples/intermediate/Chart.php
* @example ../examples/intermediate/Chart_cylinder.php
* @example ../examples/intermediate/Chart_footnote.php
* @example ../examples/intermediate/Multidocument.php
* @example ../examples/advanced/Report.php
* @param array $options
* Values: 'color' (1, 2, 3...), 'cornerP' (20, 30...),
* 'cornerX' (20, 30...),
* 'cornerY' (20, 30...),
* 'data' (array of values),
* 'font' (Arial, Times New Roman...),
* 'groupBar' (clustered, stacked),
* 'jc' (center, left, right),
* 'showPercent' (0, 1),
* 'sizeX' (10, 11, 12...),
* 'sizeY' (10, 11, 12...),
* 'textWrap' (0 (inline), 1 (square), 2 (front), 3 (back), 4 (up and bottom), 5 (clear)),
* 'title',
* 'type' (barChart, bar3DChart, bar3DChartCylinder, bar3DChartCone, bar3DChartPyramid, colChart, col3DChart,
* col3DChartCylinder, col3DChartCone, bar3DChartPyramid, pieChart, pie3DChart, lineChart, line3DChart,
* areaChart, area3DChart, radar, scatterChart, surfaceChart,ofpiechar, doughnut, bublechart)
* 'legendpos' (r, l, t, b, none),
* 'legendoverlay' (0, 1),
* 'border' (0, 1),
* 'haxlabel' horizontal axis label,
* 'vaxlabel' vertical axis label,
* 'showtable' (0, 1) show the table of values,
* 'vaxlabel_display' (rotated, vertical, horizontal),
* 'haxlabel_display' (rotated, vertical, horizontal),
* 'hgrid' (0, 1, 2, 3),
* 'vgrid' (0, 1, 2, 3),
* 'style' this work only in radar charts.
* 'gapWidth' distance between the pie and the second chart(ofpiechart)
* 'secondPieSize' : size of the second chart(ofpiechart)
* 'splitType' how decide to split the values :auto(Default Split), cust(Custom Split), percent(Split by Percentage), pos(Split by Position), val(Split by Value)
* 'splitPos' split position , integer or float
* 'custSplit' array of index to split
* 'subtype' type of the second chart pie or bar
* 'explosion' distance between the diferents values
* 'holeSize' size of the hole in doughnut type
* 'symbol' array of symbols(scatter chart)
* 'symbolSize' the size of the simbols
* 'smooth' smooth the line (scatter chart)
* 'wireframe' boolean(surface chart)to remove content color and only leave the border colors
* 'showValue' show the values inside the chart
* 'showCategory' show the category inside the chart
* 'rawWordML' (boolean)
*/
public function addChart($options = array('rawWordML' => false))
{
self::$log->debug('Create chart.');
try {
if (isset($options['data']) && isset($options['type'])) {
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Chart.');
$type = $options['type'];
if(strpos($type, 'Chart') === false)
$type .= 'Chart';
$graphic = CreateChartFactory::createObject($type);
if ($graphic->createGraphic(self::$intIdWord, $options) != false) {
self::$log->info(
'Add chart word/charts/chart' . self::$intIdWord .
'.xml to DOCX.'
);
$this->_zipDocx->addFromString(
'word/charts/chart' . self::$intIdWord . '.xml',
$graphic->getXmlChart()
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'chart',
'charts/chart' . self::$intIdWord . '.xml'
);
$this->generateDEFAULT('xlsx', 'application/octet-stream');
$this->generateOVERRIDE(
'/word/charts/chart' . self::$intIdWord . '.xml',
'application/vnd.openxmlformats-officedocument.' .
'drawingml.chart+xml'
);
} else {
throw new Exception(
'There was an error related to the chart.'
);
}
$excel = $graphic->getXlsxType();
$this->_tempFileXLSX[self::$intIdWord] =
tempnam($this->_tempDir, 'documentxlsx');
if (
$excel->createXlsx(
$this->_tempFileXLSX[self::$intIdWord],
$options['data']
) != false
) {
$this->_zipDocx->addFile(
$this->_tempFileXLSX[self::$intIdWord],
'word/embeddings/datos' . self::$intIdWord . '.xlsx'
);
$chartRels = CreateChartRels::getInstance();
$chartRels->createRelationship(self::$intIdWord);
$this->_zipDocx->addFromString(
'word/charts/_rels/chart' . self::$intIdWord .
'.xml.rels',
(string) $chartRels
);
}
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $graphic;
}else{
$this->_wordDocumentC .= (string) $graphic;
}
} else {
throw new Exception(
'Images must have "data" and "type" values.'
);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Adds date and hour to the Word document
*
* @access public
* @example ../examples/easy/DateAndHour.php
* @param array $options Style options to apply to the date
* Values:
* 'b' (on, off)
* 'color' (ffffff, ff0000...)
* 'font' (Arial, Times New Roman...)
* 'i' (on, off)
* 'jc' (both, center, distribute, left, right)
* 'pageBreakBefore' (on, off)
* 'sz' (1, 2, 3...)
* 'u' (dash, dotted, double, single, wave, words)
* 'widowControl' (on, off)
* 'wordWrap' (on, off)
* 'lineSpacing' 120, 240 (standard), 480...
* 'indent_left' 100...
* 'indent_right' 100...
* 'rawWordML' (boolean)
* 'dateFormat (string) dd/MM/yyyy H:mm:ss (default value) One may define a
* customised format like dd' of 'MMMM' of 'yyyy' at 'H:mm (resulting in 20 of December of 2012 at 9:30)
*
*/
public function addDateAndHour($options = array( 'dateFormat' => 'dd/MM/yyyy H:mm:ss', 'rawWordML' => false))
{
if(!isset($options['dateFormat'])){
$options['dateFormat'] = 'dd/MM/yyyy H:mm:ss';
}
$textOptions = $options;
$textOptions['rawWordML'] = true;
$date = $this->addText('date', $textOptions);
$date = preg_replace('/__[A-Z]+__/','',$date);
$dateRef = ''.$date;
$dateRef = str_replace('', '', $dateRef);
$dateDOM = new DOMDocument();
$dateDOM->loadXML($dateRef);
$pPrNodes = $dateDOM->getElementsByTagName('pPr');
if($pPrNodes->length > 0){
$pPrContent = $dateDOM->saveXML($pPrNodes->item(0));
}else{
$pPrContent = '';
}
$rPrNodes = $dateDOM->getElementsByTagName('rPr');
if($rPrNodes->length > 0){
$rPrContent = $dateDOM->saveXML($rPrNodes->item(0));
}else{
$rPrContent = '';
}
if($pPrContent != ''){
$pPrContent = str_replace('', $rPrContent . '', $pPrContent);
}else{
$pPrContent = '' . $rPrContent . '';
}
$runs = '' . $rPrContent . '';
$runs .= '' . $rPrContent . 'TIME \@ "'. $options['dateFormat'] .'"';
$runs .= '' . $rPrContent . '';
$runs .= '' . $rPrContent . 'date';
$runs .= '' . $rPrContent . '';
$date = '' . $pPrContent . $runs . '';
self::$log->info('Add a date to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $date;
}else{
$this->_wordDocumentC .= (string) $date;
}
}
/**
* Merge DOCX. Keep content and styles.
*
* @access public
* @example ../examples/easy/DOCX.php
* @param array $options
* Values:
* 'pathDOCX' (string) path to DOCX
* 'rawWordML' (boolean)
*/
public function addDOCX($options = array('rawWordML' => false))
{
try {
if ($this->_compatibilityMode) {
throw new Exception('Running in compatibility mode. Unsupported method.');
}
if (file_exists($options['pathDOCX'])) {
$wordDOCX = EmbedDOCX::getInstance();
$wordDOCX->embed();
self::$log->info('Add DOCX file to word document.');
$this->_zipDocx->addFile($options['pathDOCX'], 'word/docx' . $wordDOCX->getId() .
'.zip');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rDOCXId' . $wordDOCX->getId(), 'aFChunk', 'docx' .
$wordDOCX->getId() . '.zip', 'TargetMode="Internal"');
$this->generateDEFAULT('zip', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml');
if (isset($options['rawWordML']) && $options['rawWordML']) {
return (string) $wordDOCX . '';
} else {
$this->_wordDocumentC .= (string) $wordDOCX;
}
} else {
throw new Exception('File does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception($e->getMessage());
}
}
/**
* Add an element to embedd in other elements
*
* @access public
* @deprecated
* @example ../examples/easy/Chart_areaEmbeddedIntoList.php
* @example ../examples/intermediate/List.php
* @example ../examples/intermediate/TableStyled.php
* @param string $type Element type.
* Values: 'addImage', 'addGraphic', 'addLink', 'addTextBox', 'addText'
* @param array $parrams Set of parameters.
* Values: same as elements
* @return Element object
*/
public function addElement($type, $params = '')
{
$type = str_replace('Chart', 'Graphic', $type);
$type = str_replace('add', 'Create', $type);
if($type == 'CreateGraphic'){
if(strpos($params['type'], 'Chart') === false)
$params['type'] .= 'Chart';
//we use the factory to create the object
$element = CreateChartFactory::createObject($params['type']);
}else{
$element = CreateFactory::createObject($type);
}
$type = str_replace('Create', 'init', $type);
$element->$type($params);
if ($type == 'initImage') {
self::$log->debug('Create embedded image.');
try {
if (isset($params['name']) && file_exists($params['name'])) {
$attrImages = getimagesize($params['name']);
try {
if ($attrImages['mime'] == 'image/jpg' ||
$attrImages['mime'] == 'image/jpeg' ||
$attrImages['mime'] == 'image/png' ||
$attrImages['mime'] == 'image/gif'
) {
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord .
' . Embedded image.'
);
$type = str_replace('add', 'Create', $type);
$dir = $this->parsePath($params['name']);
$element->setRId(self::$intIdWord);
self::$log->info(
'Add image ' . $params['name']
. ' to DOCX.'
);
$this->_zipDocx->addFile(
$params['name'],
'word/media/image' . self::$intIdWord . '.'
. $dir['extension']
);
$this->generateDEFAULT(
$dir['extension'], $attrImages['mime']
);
self::$log->debug(
'Add a new relationship related to image '
. $params['name'] . ' .'
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP(
'rId'
. self::$intIdWord, 'image', 'media/image'
. self::$intIdWord . '.'
. $dir['extension']
);
} else {
throw new Exception(
'Image format is not supported.'
);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
} else {
throw new Exception('Image does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
} elseif ($type == 'initGraphic' || $type == 'initChart') {
self::$log->debug('Create embedded chart.');
try {
if (isset($params['data']) && isset($params['type'])) {
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord . ' . Embedded chart.'
);
$element->setRId(self::$intIdWord);
self::$log->info(
'Add chart ' . 'word/charts/chart' . self::$intIdWord
. '.xml to DOCX.'
);
$this->_zipDocx->addFromString(
'word/charts/chart' . self::$intIdWord . '.xml',
$element->createEmbeddedXmlChart()
);
self::$log->debug(
'Add a new relationship related to chart.'
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'chart', 'charts/chart' .
self::$intIdWord . '.xml'
);
$this->generateDEFAULT('xlsx', 'application/octet-stream');
$this->generateOVERRIDE(
'/word/charts/chart' . self::$intIdWord .
'.xml',
'application/vnd.openxmlformats-officedocument' .
'.drawingml.chart+xml'
);
$excel = $element->getXlsxType();
$this->_tempFileXLSX[self::$intIdWord] = tempnam($this->_tempDir, 'documentxlsx');
if (
$excel->createXlsx(
$this->_tempFileXLSX[self::$intIdWord], $params['data'],
$params['type']
) != false
) {
$this->_zipDocx->addFile(
$this->_tempFileXLSX[self::$intIdWord],
'word/embeddings/datos' . self::$intIdWord . '.xlsx'
);
$chartRels = CreateChartRels::getInstance();
$chartRels->createRelationship(self::$intIdWord);
self::$log->info(
'Add chart ' . 'word/charts/_rels/chart'
. self::$intIdWord . '.xml.rels to DOCX.'
);
$this->_zipDocx->addFromString(
'word/charts/_rels/chart' . self::$intIdWord
. '.xml.rels', (string) $chartRels
);
}
} else {
throw new Exception(
'Charts must have "data" and "type" values.'
);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
return $element;
}
/**
* Add an endnote
*
* @access public
* @example ../examples/easy/Endnote.php
* @example ../examples/intermediate/EndnoteAndFootnote.php
* @param array $options.
* Values:
* 'font' (string) font family //TODO: include font family in wordML
* 'textDocument' (string)text to appear in the body of the document
* 'textEndnote' (string) text to appear in the endnote
* 'rawWordML' (boolean)
*/
public function addEndnote($options = array('rawWordML' => false))
{
$id = rand(9999,32766);//this number can not be bigger than 32767
$endnoteBase ='
'.$options['textEndnote'].'
';
$endnoteDocument =''.$options['textDocument'].'
';
//We now try to open the zip file defined as base template
$filename = $this->_baseTemplateFilesPath.'/word/endnotes.xml';
$handle = fopen($filename, "r");
$contents = fread($handle, 999999);
fclose($handle);
$this->_wordEndnotesT = new DOMDocument();
$this->_wordEndnotesT->loadXML($contents);
$tempNode = $this->_wordEndnotesT->createDocumentFragment();
$tempNode->appendXML($endnoteBase);
$this->_wordEndnotesT->documentElement->appendChild($tempNode);
//We copy the content into the respective file
$endnoteHandler = fopen($this->_baseTemplateFilesPath.'/word/endnotes.xml', "w+");
fwrite($endnoteHandler, $this->_wordEndnotesT->saveXML());
fclose($endnoteHandler);
self::$log->info('Add endnote to endnote document.');
self::$log->info('Add endnote to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $endnoteDocument;
}else{
$this->_wordDocumentC .= (string) $endnoteDocument;
}
}
/**
* Add a new font
*
* @access public
* @param array $fonts Fonts to add
*/
public function addFont($fonts)
{
$font = CreateFontTable::getInstance();
$font->createFont($fonts);
self::$log->info('Add font to fontable document.');
$this->_wordFontTableC .= (string) $font;
}
/**
* Add a footer.
*
* @access public
* @example ../examples/easy/Footer.php
* @example ../examples/intermediate/HeaderAndFooter.php
* @example ../examples/advanced/Report.php
* @param array $footer
* @param array
* Values:
* 'default'(object) WordMLFragment
* 'even' (object) WordMLFragment
* 'first' (object) WordMLFragment
*/
public function addFooter($footers)
{
$this->footerAdded = true;
$this->removeFooters();
foreach($footers as $key => $value){
if ($value instanceof WordMLFragment){
$this->_wordFooterT[$key] ='
';
$this->_wordFooterT[$key] .= (string) $value;
$this->_wordFooterT[$key] .= '';
$this->_wordFooterT[$key] = preg_replace('/__[A-Z]+__/', '', $this->_wordFooterT[$key]);
//1.Insert image Rels
//2.Insert external images rels
//3.Insert Link rels
$relationships = '';
if(isset($this->_relsHeaderFooterImage[$key . 'Footer'])){
foreach($this->_relsHeaderFooterImage[$key . 'Footer'] as $key2 => $value2){
$relationships .= '';
}
}
if(isset($this->_relsHeaderFooterExternalImage[$key . 'Footer'])){
foreach($this->_relsHeaderFooterExternalImage[$key . 'Footer'] as $key2 => $value2){
$relationships .= '';
}
}
if(isset($this->_relsHeaderFooterLink[$key . 'Footer'])){
foreach($this->_relsHeaderFooterLink[$key . 'Footer'] as $key2 => $value2){
$relationships .= '';
}
}
//Now we create the complete rels file relative to that footer
if($relationships != ''){
$rels = '';
$rels .= $relationships;
$rels .= '';
}
//4.Include the footer xml files
$footerHandler = fopen($this->_baseTemplateFilesPath.'/word/'. $key . 'Footer.xml', 'w+');
fwrite($footerHandler, $this->_wordFooterT[$key]);
fclose($footerHandler);
//5.Include the footer rels files
if(isset($rels)){
$footerRelsHandler = fopen($this->_baseTemplateFilesPath.'/word/_rels/'. $key . 'Footer.xml.rels', 'w+');
fwrite($footerRelsHandler, $rels);
fclose($footerRelsHandler);
}
//6. modify the document.xml.rels file
$newId = uniqid(true);
$newFooterNode = '';
$newNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$newNode->appendXML($newFooterNode);
$baseNode =$this->_wordRelsDocumentRelsT->documentElement;
$baseNode->appendChild($newNode);
//7. modify accordingly the sectPr node
$newSectNode = '';
$sectNode = $this->_sectPr->createDocumentFragment();
$sectNode->appendXML($newSectNode);
$refNode =$this->_sectPr->documentElement->childNodes->item(0);
$refNode->parentNode->insertBefore($sectNode, $refNode);
if($key == 'first'){
$this->generateTitlePg();
}else if($key == 'even'){
$this->generateSetting('w:evenAndOddHeaders');
}
//6.generate the corresponding Override element in [Content_Types].xml
$this->generateOVERRIDE(
'/word/' . $key . 'Footer.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml.' .
'footer+xml'
);
//7.Refresh the _relsFooter array
$this->_relsFooter[] = $key . 'Footer.xml';
//8.Refresh the arrays used to hold the image and link data
$this->_relsHeaderFooterImage[$key . 'Footer'] = array();
$this->_relsHeaderFooterExternalImage[$key . 'Footer'] = array();
$this->_relsHeaderFooterLink[$key . 'Footer'] = array();
}else{
self::$log->fatal('The footer contents must be WordML fragments');
exit();
}
}
}
/**
* Add a footnote
*
* @access public
* @example ../examples/easy/Footnote.php
* @example ../examples/intermediate/Chart_footnote.php
* @example ../examples/intermediate/EndnoteAndFootnote.php
* @param array $options
* Values:
* 'font' (string) font family //TODO
* 'textDocument'(string) text to appear in the document body
* 'textFootnote' (string) text to appear in the footnote
* 'rawWordML' (boolean)
*/
public function addFootnote($options = array('rawWordML' => false))
{
$id = rand(9999,32766);//this number can not be bigger than 32767
$footnoteBase ='
'.$options['textFootnote'].'
';
$footnoteDocument =''.$options['textDocument'].'
';
//We now try to open the zip file defined as base template
$filename = $this->_baseTemplateFilesPath.'/word/footnotes.xml';
$handle = fopen($filename, "r");
$contents = fread($handle, 999999);
fclose($handle);
$this->_wordFootnotesT = new DOMDocument();
$this->_wordFootnotesT->loadXML($contents);
$tempNode = $this->_wordFootnotesT->createDocumentFragment();
$tempNode->appendXML($footnoteBase);
$this->_wordFootnotesT->documentElement->appendChild($tempNode);
//We copy the content into the respective file
$footnoteHandler = fopen($this->_baseTemplateFilesPath.'/word/footnotes.xml', "w+");
fwrite($footnoteHandler, $this->_wordFootnotesT->saveXML());
fclose($footnoteHandler);
self::$log->info('Add footnote to footnote document.');
self::$log->info('Add footnote to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $footnoteDocument;
}else{
$this->_wordDocumentC .= (string) $footnoteDocument;
}
}
/**
* Add a graphic
*
* @access public
* @example ../examples/easy/Chart.php
* @example ../examples/easy/Chart_bar.php
* @example ../examples/intermediate/Chart.php
* @example ../examples/intermediate/Chart_footnote.php
* @example ../examples/intermediate/Multidocument.php
* @example ../examples/advanced/Report.php
* @param array $dats Parameters of graphic
* Values: 'color' (1, 2, 3...), 'cornerP' (20, 30...),
* 'cornerX' (20, 30...), 'cornerY' (20, 30...), 'data' (array of values),
* 'font' (Arial, Times New Roman...), 'groupBar' (clustered, stacked),
* 'jc' (center, left, right), 'showPercent' (0, 1), 'sizeX' (10, 11,
* 12...), 'sizeY' (10, 11, 12...), 'textWrap' (0 (inline), 1 (square),
* 2 (front), 3 (back), 4 (up and bottom), 5 (clear)), 'title', 'type'
* (barChart, bar3DChart, colChart, col3DChart, pieChart, pie3DChart)
* @deprecated Use addChart method
* @see addChart
*/
public function addGraphic($dats)
{
self::$log->debug('Create chart.');
try {
if (isset($dats['data']) && isset($dats['type'])) {
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Chart.');
$graphic = CreateGraphic::getInstance();
if ($graphic->createGraphic(self::$intIdWord, $dats) != false) {
self::$log->info(
'Add chart word/charts/chart' . self::$intIdWord .
'.xml to DOCX.'
);
$this->_zipDocx->addFromString(
'word/charts/chart' . self::$intIdWord . '.xml',
$graphic->getXmlChart()
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'chart',
'charts/chart' . self::$intIdWord . '.xml'
);
$this->_wordDocumentC .= (string) $graphic;
$this->generateDEFAULT('xlsx', 'application/octet-stream');
$this->generateOVERRIDE(
'/word/charts/chart' . self::$intIdWord . '.xml',
'application/vnd.openxmlformats-officedocument.' .
'drawingml.chart+xml'
);
} else {
throw new Exception(
'There was an error related to the chart.'
);
}
$excel = CreateXlsx::getInstance();
$this->_tempFileXLSX[self::$intIdWord] =
tempnam($this->_tempDir, 'documentxlsx');
if (
$excel->createXlsx(
$this->_tempFileXLSX[self::$intIdWord],
$dats['data'], $dats['type']
) != false
) {
$this->_zipDocx->addFile(
$this->_tempFileXLSX[self::$intIdWord],
'word/embeddings/datos' . self::$intIdWord . '.xlsx'
);
$chartRels = CreateChartRels::getInstance();
$chartRels->createRelationship(self::$intIdWord);
$this->_zipDocx->addFromString(
'word/charts/_rels/chart' . self::$intIdWord .
'.xml.rels',
(string) $chartRels
);
}
} else {
throw new Exception(
'Images must have "data" and "type" values.'
);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add a graphic image
*
* @access public
* @param array $options
* Values:
* 'color' (1, 2, 3, 4, 5),
* 'cornerX' (20, 30...),
* 'data' (array of values),
* 'sizeX' (10, 11, 12...),
* 'sizeY' (10, 11, 12...),
* 'title',
* 'type' (barChart, bar3DChart,colChart, col3DChart, pieChart, pie3DChart)
* 'rawWordML' (boolean)
*/
public function addGraphicImg($options = array('rawWordML' => false))
{
self::$log->debug('Create image chart.');
try {
if (isset($options['data']) && isset($options['type'])) {
$graphic = CreateGraphicImg::getInstance();
if ($graphic->createGraphicImg($options)) {
}
else {
throw new Exception(
'Unsupported chart type.'
);
}
} else {
throw new Exception(
'Images must have "data" and "type" values.'
);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add a graphic template. Replace placeholder with a graphic
*
* @access public
* @param array $options
* Values: same as charts
*/
public function addGraphicTemplate($options)
{
try {
if (isset($options['data']) && isset($options['type'])) {
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord . ' . Image template.'
);
$type = $options['type'];
if(strpos($type, 'Chart') === false)
$type .= 'Chart';
$graphic = CreateChartFactory::createObject($type);
if ($graphic->createGraphic(self::$intIdWord, $options) != false) {
$this->graphicTemplate['arrChartXML'][self::$intIdWord] =
$graphic->getXmlChart();
$this->graphicTemplate['arrRelationships'][self::$intIdWord] =
$this->generateRELATIONSHIPTemplate(
'rId' . self::$intIdWord, 'chart',
'charts/chart' . self::$intIdWord . '.xml'
);
$this->graphicTemplate['arrGraphics'][self::$intIdWord] =
(string) $graphic;
$this->graphicTemplate['arrGenerateDEFAULT'][self::$intIdWord] =
' ';
$this->graphicTemplate['arrGenerateOVERRIDE'][self::$intIdWord] =
' ';
} else {
throw new Exception(
'There was an error related to the chart.'
);
}
$excel = $graphic->getXlsxType();
$this->_tempFileXLSX[self::$intIdWord] = tempnam($this->_tempDir, 'documentxlsx');
if (
$excel->createXlsx(
$this->_tempFileXLSX[self::$intIdWord], $options['data'],
$options['type']
) != false
) {
$this->fileGraphicTemplate['datos' . self::$intIdWord . '.xlsx'] =
'word/embeddings/datos' . self::$intIdWord . '.xlsx';
$objChartRels = CreateChartRels::getInstance();
$objChartRels->createRelationship(self::$intIdWord);
$this->fileGraphicTemplate['word/charts/_rels/chart' . self::$intIdWord . '.xml.rels'] =
(string) $objChartRels;
}
} else {
throw new Exception(
'Charts must have "data" and "type" values.
');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add a header.
*
* @access public
* @example ../examples/easy/Header.php
* @example ../examples/intermediate/HeaderAndFooter.php
* @example ../examples/advanced/Report.php
* @param array $headers
* Values:
* 'default'(object) WordMLFragment
* 'even' (object) WordMLFragment
* 'first' (object) WordMLFragment
*/
public function addHeader($headers)
{
$this->headerAdded = true;
$this->removeHeaders();
foreach($headers as $key => $value){
if ($value instanceof WordMLFragment){
$this->_wordHeaderT[$key] ='
';
$this->_wordHeaderT[$key] .= (string) $value;
$this->_wordHeaderT[$key] .= '';
$this->_wordHeaderT[$key] = preg_replace('/__[A-Z]+__/', '', $this->_wordHeaderT[$key]);
//1.Insert image Rels
//2.Insert external images rels
//3.Insert Link rels
$relationships = '';
if(isset($this->_relsHeaderFooterImage[$key . 'Header'])){
foreach($this->_relsHeaderFooterImage[$key . 'Header'] as $key2 => $value2){
$relationships .= '';
}
}
if(isset($this->_relsHeaderFooterExternalImage[$key . 'Header'])){
foreach($this->_relsHeaderFooterExternalImage[$key . 'Header'] as $key2 => $value2){
$relationships .= '';
}
}
if(isset($this->_relsHeaderFooterLink[$key . 'Header'])){
foreach($this->_relsHeaderFooterLink[$key . 'Header'] as $key2 => $value2){
$relationships .= '';
}
}
//Now we create the complete rels file relative to that header
if($relationships != ''){
$rels = '';
$rels .= $relationships;
$rels .= '';
}
//4.Include the header xml files
$headerHandler = fopen($this->_baseTemplateFilesPath.'/word/'. $key . 'Header.xml', 'w+');
fwrite($headerHandler, $this->_wordHeaderT[$key]);
fclose($headerHandler);
//5.Include the header rels files
if(isset($rels)){
$headerRelsHandler = fopen($this->_baseTemplateFilesPath.'/word/_rels/'. $key . 'Header.xml.rels', 'w+');
fwrite($headerRelsHandler, $rels);
fclose($headerRelsHandler);
}
//6. modify the document.xml.rels file
$newId = uniqid(true);
$newHeaderNode = '';
$newNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$newNode->appendXML($newHeaderNode);
$baseNode =$this->_wordRelsDocumentRelsT->documentElement;
$baseNode->appendChild($newNode);
//7. modify accordingly the sectPr node
$newSectNode = '';
$sectNode = $this->_sectPr->createDocumentFragment();
$sectNode->appendXML($newSectNode);
$refNode =$this->_sectPr->documentElement->childNodes->item(0);
$refNode->parentNode->insertBefore($sectNode, $refNode);
if($key == 'first'){
$this->generateTitlePg();
}else if($key == 'even'){
$this->generateSetting('w:evenAndOddHeaders');
}
//6.generate the corresponding Override element in [Content_Types].xml
$this->generateOVERRIDE(
'/word/' . $key . 'Header.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml.' .
'header+xml'
);
//7.Refresh the _relsHeader array
$this->_relsHeader[] = $key . 'Header.xml';
//8.Refresh the arrays used to hold the image and link data
$this->_relsHeaderFooterImage[$key . 'Header'] = array();
$this->_relsHeaderFooterExternalImage[$key . 'Header'] = array();
$this->_relsHeaderFooterLink[$key . 'Header'] = array();
}else{
self::$log->fatal('The header contents must be WordML fragments');
exit();
}
}
}
/**
* Inserts HTML into a document as alternative content (altChunk).
* This method IS NOT compatible with PDF conversion or Open Office (use embedHTML instead).
*
* @access public
* @example ../examples/easy/HTML.php
* @example ../examples/intermediate/BasicHTML.php
* @example ../examples/intermediate/HTML.php
* @param array $options
* Values:
* 'html' (string)
* 'rawWordML' (boolean)
*/
public function addHTML($options = array('html' => '', 'rawWordML' => false))
{
try {
if ($this->_compatibilityMode) {
throw new Exception('Running in compatibility mode. Unsupported method.');
}
$wordHTML = EmbedHTML::getInstance();
$wordHTML->embed();
self::$log->info('Embed HTML to word document.');
$this->_zipDocx->addFromString('word/html' . $wordHTML->getId() .
'.htm', '' . $options['html'] . '');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rHTMLId' . $wordHTML->getId(), 'aFChunk', 'html' .
$wordHTML->getId() . '.htm', 'TargetMode="Internal"');
$this->generateDEFAULT('htm', 'application/xhtml+xml');
if (isset($options['rawWordML']) && $options['rawWordML']) {
return (string)$wordHTML . '';
} else {
$this->_wordDocumentC .= (string)$wordHTML;
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception($e->getMessage());
}
}
/**
* Add an image
*
* @access public
* @example ../examples/easy/Image.php
* @example ../examples/intermediate/Chart_footnote.php
* @param array $data
* Values:
* 'border'(int) 1, 2, 3...
* 'borderDiscontinuous' (0, 1)
* 'font' (string) Arial, Times New Roman...
* 'jc' (center, left, right)
* 'name' (string)
* 'scaling' (int) 50, 100, ..
* 'sizeX' (int) 10, 11, 12...
* 'sizeY' (int) 10, 11, 12...
* 'dpi' (int) dots per inch
* 'spacingTop' (int) 10, 11...
* 'spacingBottom' (int) 10, 11...
* 'spacingLeft' (int) 10, 11...
* 'spacingRight' (int) 10, 11...
* 'textWrap' 0 (inline), 1 (square), 2 (front), 3 (back), 4 (up and bottom), 5 (clear))
* 'target' (string): document (default value), defaultHeader, firstHeader, evenHeader, defaultFooter, firstFooter, evenFooter
* 'rawWordML' (boolean)
*/
public function addImage($data = '')
{
if(!isset($data['target'])){
$data['target'] = 'document';
}
self::$log->debug('Create image.');
try {
if (isset($data['name']) && file_exists($data['name']) == 'true') {
$attrImage = getimagesize($data['name']);
try {
if ($attrImage['mime'] == 'image/jpg' ||
$attrImage['mime'] == 'image/jpeg' ||
$attrImage['mime'] == 'image/png' ||
$attrImage['mime'] == 'image/gif'
) {
self::$intIdWord++;
self::$log->debug(
'New ID rId' . self::$intIdWord . ' . Image.'
);
$image = CreateImage::getInstance();
$data['rId'] = self::$intIdWord;
$image->createImage($data);
$dir = $this->parsePath($data['name']);
self::$log->info(
'Add image word/media/imgrId' .
self::$intIdWord . '.' . $dir['extension'] .
'.xml to DOCX.'
);
$this->_zipDocx->addFile(
$data['name'], 'word/media/imgrId' .
self::$intIdWord . '.' .
$dir['extension']
);
$this->generateDEFAULT(
$dir['extension'], $attrImage['mime']
);
if ((string) $image != ''){
//Here we consider the case where the image will be included in a header or footer
if($data['target'] == 'defaultHeader' ||
$data['target'] == 'firstHeader' ||
$data['target'] == 'evenHeader' ||
$data['target'] == 'defaultFooter' ||
$data['target'] == 'firstFooter' ||
$data['target'] == 'evenFooter'){
$this->_relsHeaderFooterImage[$data['target']][] =
array('rId' => 'rId' . self::$intIdWord, 'extension' => $dir['extension']);
}else{
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'image',
'media/imgrId' . self::$intIdWord . '.'
. $dir['extension']
);
}
}
if(isset($data['rawWordML']) && $data['rawWordML']){
return (string) $image;
}else{
$this->_wordDocumentC .= (string) $image;
}
} else {
throw new Exception('Image format is not supported.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
} else {
throw new Exception('Image does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add a link
*
* @access public
* @example ../examples/easy/Link.php
* @example ../examples/advanced/Report.php
* @param array $options
* @see addText
* additional parameter:
* 'url' (string) URL
*
*/
public function addLink($text, $options = array('url' => '',
'font' => '',
'sz' => '',
'color' => '0000ff',
'u' => 'single',
'rawWordML' => false))
{
if($text == ''){
self::$log->fatal('The linked text is missing');
}else if($options['url'] == ''){
self::$log->fatal('The URL is missing');
}
if(isset($options['color'])){
$color = $options['color'];
}else{
$color = '0000ff';
}
if(isset($options['u'])){
$u = $options['u'];
}else{
$u = 'single';
}
$textOptions = $options;
$textOptions['rawWordML'] = true;
$link = $this->addText($text, $textOptions);
$link = preg_replace('/__[A-Z]+__/', '', $link);
$startNodes ='
HYPERLINK "'.$options['url'].'"
';
if(strstr($link, '')){
$link = preg_replace('/<\/w:pPr>/', ''.$startNodes, $link);
}else{
$link = preg_replace('//', ''.$startNodes, $link);
}
$endNode = '';
$link = preg_replace('/<\/w:p>/', $endNode . '', $link);
self::$log->info('Add link to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $link;
}else{
$this->_wordDocumentC .= (string) $link;
}
}
/**
* Add a list
*
* @access public
* @example ../examples/easy/List.php
* @example ../examples/intermediate/List.php
* @example ../examples/intermediate/List_nested.php
* @example ../examples/intermediate/Multidocument.php
* @param array $data Values of the list
* @param array $options
* Values:
* 'font' (string), Arial, Times New Roman, ...
* 'val' (int), 0 (clear), 1 (inordinate), 2(numerical)
* 'bullets' (array) 1 (), 2 (o), 3 ()
* 'rawWordML' (boolean)
*/
public function addList($data, $options = array('rawWordML' => false))
{
$list = CreateList::getInstance();
if ($options['val'] == 2){
self::$numOL++;
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$orderedListStyle, self::$numOL);
}
$list->createList($data, $options);
self::$log->info('Add list to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $list;
}else{
$this->_wordDocumentC .= (string) $list;
}
if (!empty($options['bullets'])
&& is_array($options['bullets'])
&& $options['val'] == 1
) {
for ($i = 0; $i <= CreateList::MAXDEPTH; $i++) {
$bullets = $options['bullets'];
if (isset($bullets[$i])) {
$styleId = $bullets[$i];
} else {
$styleId = $i;
}
$list->createListStyles($i, $styleId);
self::$log->info('Add list styles to word document.');
$this->_wordDocumentStyles .= (string) $list;
}
}
}
/**
* Add a macro from a DOC
*
* @access public
* @param string $path Path to a file with macro
*/
public function addMacroFromDoc($path)
{
if(!$this->_docm){
self::$log->fatal('The base template should be a docm to include a macro in your document');
exit();
}else if(!file_exists($this->_baseTemplateFilesPath.'/word/vbaData.xml')){
self::$log->fatal('The base template should be a docm and it should include at list a macro');
exit();
}
$package = new ZipArchive();
self::$log->info('Open document with a macro.');
$package->open($path);
self::$log->info('Add macro files to DOCX file.');
//We copy the contents of vbaData
$vbaDataHandler = fopen($this->_baseTemplateFilesPath.'/word/vbaData.xml', "w+");
fwrite($vbaDataHandler, $package->getFromName('word/vbaData.xml'));
fclose($vbaDataHandler);
//We copy the contents of vbaProject
$vbaProjectHandler = fopen($this->_baseTemplateFilesPath.'/word/vbaProject.bin', "w+");
fwrite($vbaProjectHandler, $package->getFromName('word/vbaProject.bin'));
fclose($vbaProjectHandler);
$package->close();
}
/**
* Convert a math eq to DOCX
*
* @access public
* @example ../examples/easy/Math.php
* @param string $path Path to a file with math eq
*/
public function addMathDocx($path)
{
$package = new ZipArchive();
self::$log->info('Open document with an existing math eq.');
$package->open($path);
$document = $package->getFromName('word/document.xml');
$eqs = preg_split('/<[\/]*m:oMathPara>/', $document);
self::$log->info('Add math eq to word document.');
$this->addMathEq('' . $eqs[1] . '');
$package->close();
}
/**
* Add an existing math eq to DOCX
*
* @access public
* @example ../examples/easy/Math.php
* @param string $eq Math eq
*/
public function addMathEq($eq)
{
self::$log->info('Add existing math eq to word document.');
$this->_wordDocumentC .= '<' . CreateDocx::NAMESPACEWORD . ':p>' .
(string) $eq . '';
}
/**
* Convert a math MML eq to DOCX
*
* @access public
* @param string $eq Math eq
*/
public function addMathMML($eq)
{
$math = CreateMath::getInstance();
self::$log->debug('Convert MathMML eq.');
$math->createMath($eq);
self::$log->info('Add converted MathMML eq to word document.');
$this->addMathEq('' . (string) $math . '');
}
/**
* Add a MHT file.
*
* @access public
* @example ../examples/easy/MHT.php
* @param array $options
* Values:
* 'pathMHT' (string) path to the MHT file
* 'rawWordML' (boolean)
*/
public function addMHT($options = array('rawWordML' => false))
{
try {
if (file_exists($options['pathMHT'])) {
$wordMHT = EmbedMHT::getInstance();
$wordMHT->embed();
self::$log->info('Add MHT file to word document.');
$this->_zipDocx->addFile($options['pathMHT'], 'word/mht' . $wordMHT->getId() .
'.mht');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rMHTId' . $wordMHT->getId() , 'aFChunk', 'mht' .
$wordMHT->getId() . '.mht', 'TargetMode="Internal"');
$this->generateDEFAULT('mht', 'message/rfc822');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $wordMHT . '';
}else{
$this->_wordDocumentC .= (string) $wordMHT;
}
} else {
throw new Exception('File does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception($e->getMessage());
}
}
/**
* Add a new base template into the templates folder.
*
* @access public
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
* @param string $name. Must be a valid name for the new base template. It should include the extension
* @param boolean $overwrite. Optional. If true overwrites any existing template with the given name
*
*/
public function addNewBaseTemplate($path, $name, $overwrite=false)
{
if(!$overwrite){
try{
$exists= file_exists(PHPDOCX_BASE_FOLDER.'/'.$name);
if ($exists == true) {
throw new Exception('There is a base template by that name. If you want to overwrite it set the overwrite parameter to true');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
try{
$newTemplate= copy($path, PHPDOCX_BASE_FOLDER.'/'.$name);
if ($newTemplate !== true) {
throw new Exception('Error while trying to copy the new template: please, check the path or the permission rights of the template folder');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add an existing object (XLS or PPTX)
*
* @access public
* @todo Not finished method
* @param array $options
* Values:
* 'path' (string) path to the object
* 'type' (string) object type: xlsx, pptx
* 'rawWordML' (boolean)
*/
public function addObject($options = array('rawWordML' => false))
{
try {
if (file_exists($options['path']) &&
($options['type'] == 'xls' || $options['type'] == 'pptx')) {
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Object.');
if ($options['type'] == 'xls') {
$this->generateDEFAULT(
'xls', 'application/vnd.ms-excel'
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP('rId' . self::$intIdWord,
'oleObject',
'embeddings/Microsoft_Office_Excel_97-2003_'
+ 'Worksheet' + self::$intIdWord + '.xls'
);
} elseif ($options['type'] == 'pptx') {
$this->generateDEFAULT(
'pptx', 'application/vnd.openxmlformats-officedocument'
+ '.presentationml.presentation'
);
$this->_wordRelsDocumentRelsC .=
$this->generateRELATIONSHIP('rId' . self::$intIdWord,
'package',
'embeddings/Microsoft_Office_PowerPoint_'
+ 'PresentationWorksheet' + self::$intIdWord
+ '.pptx'
);
}
$this->generateDEFAULT(
'emf', 'image/x-emf'
);
$object = CreateObject::getInstance();
$object->createObject($options['path'], $options['type']);
self::$log->info('Add object to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $object;
}else{
$this->_wordDocumentC .= (string) $object;
}
} else {
throw new Exception('File does not exist or format is not
supported.');
}
}
catch (Exception $e) {
self::$log->warn($e->getMessage());
throw new Exception('File does not exist or format is not supported.');
}
}
/**
* 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
*
* @access public
* @example ../examples/easy/PageNumber.php
* @example ../examples/intermediate/FooterPager.php
* @param mixed $type (String): numerical, alphabetical.
* @param array $options Style options to apply to the numbering
* Values:
* 'b' (on, off)
* 'color' (ffffff, ff0000...)
* 'font' (Arial, Times New Roman...)
* 'i' (on, off)
* 'jc' (both, center, distribute, left, right)
* 'pageBreakBefore' (on, off)
* 'sz' (1, 2, 3...)
* 'u' (dash, dotted, double, single, wave, words)
* 'widowControl' (on, off)
* 'wordWrap' (on, off)
* 'lineSpacing' 120, 240 (standard), 480...,
* 'indent_left' 100...,
* 'indent_right' 100...
* 'defaultValue' (int)
* 'rawWordML' (boolean)
*
*/
public function addPageNumber($type = 'numerical', $options = array('defaultValue' => 1, 'rawWordML' => false))
{
if(!isset($options['defaultValue'])){
if($type == 'numerical'){
$options['defaultValue'] = '1';
}else if($type == 'alphabetical'){
$options['defaultValue'] = 'a';
}
}
$textOptions = $options;
$textOptions['rawWordML'] = true;
$pageNumber = $this->addText($options['defaultValue'], $textOptions);
if($type == 'alphabetical'){
$beguin = '';
}else{
$beguin = '';
}
$end = '';
$pageNumber = str_replace('', $beguin . '', $pageNumber);
$pageNumber = str_replace('', '' . $end, $pageNumber);
self::$log->info('Add page number to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $pageNumber;
}else{
$this->_wordDocumentC .= (string) $pageNumber;
}
}
/**
* Adds a complex paragraph to a Word document
*
* @access public
* @example ../examples/intermediate/ComplexParagraph.php
* @example ../examples/intermediate/EmbeddedShapes.php
* @param array $options
* @see CreateDocx->addText()
* 'spacingBottom' (int) bottom margin in points
* 'spacingTop'(int) top margin in points
* 'target' (string) document (default value), defaultHeader, firstHeader, evenHeader, defaultFooter, firstFooter, evenFooter.
* 'rawWordML' (boolean)
* @param array $parameters :
* values: 'type' (text, lineBreak, link, bookmark, image, footnote, endnote, arc, curve, line, polyline, rect, roundrect, shape, oval)
* @see CreateDocx->addText()
* Extra options
* type link: 'URL' (http://... or #anchor)
* type bookmark: 'markerName' (string)
* type image: @see CreateDocx->addImage()
* 'position' (inline, left, right)
* types arc, curve, line, polyline, rect, roundrect, shape, oval: @see CreateDocx->addShape()
*/
public function addParagraph($parameters, $options)
{
if(!isset($options['target'])){
$options['target'] = 'document';
}
$rawParagraph = '';
try {
$customHTML = CustomHTML::getInstance();
$pHTML = $customHTML->paragraphHTML($parameters, $options);
if(isset($options['rawWordML']) && $options['rawWordML'] === true){
$rawParagraph = $this->embedHTML($pHTML[0], array('target' => $options['target'], 'downloadImages' => true, 'parseAnchors' => true, 'rawWordML' => true));
}else{
$this->embedHTML($pHTML[0], array('downloadImages' => true, 'parseAnchors' => true));
}
if(count($pHTML[1]) > 0){
foreach($pHTML[1] as $key => $value){
$footnoteWordML = new HTML2WordML($this->_baseTemplateFilesPath);
$dataML = $footnoteWordML->render($value, array());
$footnoteML = (string) $dataML[0];
$footnoteBase =''.$footnoteML.'';
//Let us get the font color and family to modify accordingly the superscript
$tempSubstring = explode('', $footnoteBase);
$content = explode('', $tempSubstring[1]);
$rStyle = str_replace('','',$content[0]);
$aux = '' .$rStyle. '';
//We now insert the superscript into the footnote
$footnoteBase = str_replace('', ''.$aux.'', $footnoteBase);
//Let us open the footnotes.xml file to insert the new footnote
$filename = $this->_baseTemplateFilesPath.'/word/footnotes.xml';
$handle = fopen($filename, "r");
$contents = fread($handle, 999999);
fclose($handle);
$this->_wordFootnotesT = new DOMDocument();
$this->_wordFootnotesT->loadXML($contents);
$tempNode = $this->_wordFootnotesT->createDocumentFragment();
$tempNode->appendXML($footnoteBase);
$this->_wordFootnotesT->documentElement->appendChild($tempNode);
//We copy the content into the respective file
$footnoteHandler = fopen($this->_baseTemplateFilesPath.'/word/footnotes.xml', "w+");
fwrite($footnoteHandler, $this->_wordFootnotesT->saveXML());
fclose($footnoteHandler);
}
}
if(count($pHTML[2]) > 0){
foreach($pHTML[2] as $key => $value){
$endnoteWordML = new HTML2WordML($this->_baseTemplateFilesPath);
$dataML = $endnoteWordML->render($value, array());
$endnoteML = (string) $dataML[0];
$endnoteBase =''.$endnoteML.'';
//Let us get the font color and family to modify accordingly the superscript
$tempSubstring = explode('', $endnoteBase);
$content = explode('', $tempSubstring[1]);
$rStyle = str_replace('','',$content[0]);
$aux = '' .$rStyle. '';
//We now insert the superscript into the endnote
$endnoteBase = str_replace('', ''.$aux.'', $endnoteBase);
//Let us open the endnotes.xml file to insert the new endnote
$filename = $this->_baseTemplateFilesPath.'/word/endnotes.xml';
$handle = fopen($filename, "r");
$contents = fread($handle, 999999);
fclose($handle);
$this->_wordEndnotesT = new DOMDocument();
$this->_wordEndnotesT->loadXML($contents);
$tempNode = $this->_wordEndnotesT->createDocumentFragment();
$tempNode->appendXML($endnoteBase);
$this->_wordEndnotesT->documentElement->appendChild($tempNode);
//We copy the content into the respective file
$endnoteHandler = fopen($this->_baseTemplateFilesPath.'/word/endnotes.xml', "w+");
fwrite($endnoteHandler, $this->_wordEndnotesT->saveXML());
fclose($endnoteHandler);
}
}
//Now we are going to check if there are any shapes to be included
if(count($pHTML[3]) > 0){
for($j = 0; $j < count($pHTML[3]); $j++){
$type = $pHTML[3][$j]['type'];
$pHTML[3][$j]['rawWordML'] = true;
$shapeData = $this->addShape($type, $pHTML[3][$j]);
//Now we have to substitute in the document PHPDOCX_shape_2
//by the corresponding
if(isset($options['rawWordML']) && $options['rawWordML'] === true){
$rawParagraph = str_replace('PHPDOCX_shape_'.$j.'', $shapeData, $rawParagraph);
}else{
$this->_wordDocumentC = str_replace('PHPDOCX_shape_'.$j.'', $shapeData, $this->_wordDocumentC);
}
}
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception($e->getMessage());
}
if(isset($options['rawWordML']) && $options['rawWordML'] === true){
$paragraphObj = new WordML();
$paragraphObj->createRawWordML($rawParagraph);
return $paragraphObj;
}
}
/**
* Add properties to document
*
* @access public
* @example ../examples/easy/Properties.php
* @param array $values Parameters to use
* Values: 'title', 'subject', 'creator', 'keywords', 'description',
* 'category', 'contentStatus', 'Manager','Company', 'custom' ('name' => array('type' => 'value'))
*/
public function addProperties($values)
{
$prop = CreateProperties::getInstance();
if (!empty($values['title'])
|| !empty($values['subject'])
|| !empty($values['creator'])
|| !empty($values['keywords'])
|| !empty($values['description'])
|| !empty($values['category'])
|| !empty($values['contentStatus'])) {
$prop->createProperties($values, $this->_baseTemplateFilesPath);
}
if($values['contentStatus'] == 'Final'){
$prop->createPropertiesCustom(array('_MarkAsFinal' => array('boolean' => 'true')), $this->_baseTemplateFilesPath);
//We now write the new Override node associated to the new custon.xml file en [Content_Types].xml
$this->generateOVERRIDE(
'/docProps/custom.xml',
'application/vnd.openxmlformats-officedocument.' .
'custom-properties+xml'
);
}
if (!empty($values['Manager']) || !empty($values['Company'])) {
$prop->createPropertiesApp($values, $this->_baseTemplateFilesPath);
}
if (!empty($values['custom']) && is_array($values['custom'])) {
$prop->createPropertiesCustom($values['custom'], $this->_baseTemplateFilesPath);
//We now write the new Override node associated to the new custon.xml file en [Content_Types].xml
$this->generateOVERRIDE(
'/docProps/custom.xml',
'application/vnd.openxmlformats-officedocument.' .
'custom-properties+xml'
);
}
self::$log->info('Adding properties to word document.');
}
/**
* Add a raw WordML
*
* @access public
* @param string $wml WordML to add
* @deprecated See addWordML
*/
public function addRawWordML($wml)
{
self::$log->info('Add raw WordML');
$this->_wordDocumentC .= $wml;
}
/**
* Add a RTF file. Keep content and styles.
*
* @access public
* @example ../examples/easy/RTF.php
* @param array $options
* Values:
* 'pathRTF' (string) path to the RTF file
* 'rawWordML' (boolean)
*/
public function addRTF($options = array('rawWordML' => false))
{
try {
if ($this->_compatibilityMode) {
throw new Exception('Running in compatibility mode. Unsupported method.');
}
if (file_exists($options['pathRTF'])) {
$wordRTF = EmbedRTF::getInstance();
$wordRTF->embed();
self::$log->info('Add RTF file to word document.');
$this->_zipDocx->addFile($options['pathRTF'], 'word/rtf' . $wordRTF->getId() .
'.rtf');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rRTFId' . $wordRTF->getId() , 'aFChunk', 'rtf' .
$wordRTF->getId() . '.rtf', 'TargetMode="Internal"');
$this->generateDEFAULT('rtf', 'application/rtf');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $wordRTF . '';
}else{
$this->_wordDocumentC .= (string) $wordRTF;
}
} else {
throw new Exception('File does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception($e->getMessage());
}
}
/**
* Adds a section
*
* @access public
* @example ../examples/easy/Section.php
* @param string sectionType (string): nextPage, nextColumn, continuous, evenPage, oddPage
* @param array paperType (string): A4, A3, letter, legal, A4-landscape, A3-landscape, letter-landscape, legal-landscape, custom
* @param array options
* Values:
* width (int): measurement in twips (twentieths of a point)
* height (int): measurement in twips (twentieths of a point)
* numberCols (int): number of columns
* orient (string): portrait, landscape
* marginTop (int): measurement in twips (twentieths of a point)
* marginRight (int): measurement in twips (twentieths of a point)
* marginBottom (int): measurement in twips (twentieths of a point)
* marginLeft (int): measurement in twips (twentieths of a point)
* marginHeader (int): measurement in twips (twentieths of a point)
* marginFooter (int): measurement in twips (twentieths of a point)
* gutter (int): measurement in twips (twentieths of a point)
*/
public function addSection($sectionType ='nextPage', $paperType ='A4', $options = array())
{
$previousSectionPr = ''.$this->_sectPr->saveXML().'';
$previousSectionPr = str_replace('', '', $previousSectionPr);
$this->_wordDocumentC .= (string) $previousSectionPr;
$this->modifyPageLayout($paperType, $options);
$nodeSz = $this->_sectPr->getElementsByTagName('pgSz')->item(0);
$typeNode = $this->_sectPr->createDocumentFragment();
$typeNode->appendXML('');
$nodeSz->parentNode->insertBefore($typeNode, $nodeSz);
}
/**
* Add a shape
*
* @access public
* @example ../examples/intermediate/Shapes.php
* @param string $type Type of shape to draw
* Values:arc, curve, line, polyline, rect, roundrect, shape, oval
* @param array $options
* General options:
* 'width' in points
* 'height' in points
* 'position' (absolute, relative)
* 'margin-top' in points
* 'margin-left' in points
* 'z-index' integer
* 'strokecolor' (#ff0000, #00ffff, ...)
* 'strokeweight' (1.0pt, 3.5pt, ...)
* 'fillcolor' (#ff0000, #00ffff, ...)
* 'rawWordML' (boolean)
* Options for especific type:
* arc: 'startAngle' (0, 45, 90, ...), 'endAngle' (0, 45, 90, ...)
* line and curve: 'from' and 'to' (initial and final points in x,y format)
* curve: 'control1' (x,y), 'control2' (x,y)
* polyline: 'points' (x1,y1 x2,y2 ....)
* roundrect: 'arcsize' (0.5, 1.8, ...)
* shape: 'path' (VML path), 'coordsize' (x,y)
*/
public function addShape($type, $options = array('rawWordML' => false))
{
$shape = new CreateShape();
$shapeData = $shape->createShape($type, $options);
self::$log->info('Adds a' . $type . 'to the Word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return ''. $shapeData . '';
}else{
$paragraphShape = ''. $shapeData . '';
$this->_wordDocumentC .= $paragraphShape;
}
}
/**
* Add a subdocument to a master document. The document should be in the
* same folder as the final master document
*
* @param string $path path to the subdocument
* @param string $destination path to where the subdocument should be stored
* if empty is assumed to remain in its original folder
* @access public
*/
public function addSubDocument($originalPath, $destination = '')
{
$rId = 'rId'.uniqid(true);
$this->_wordDocumentC .= '';
$this->generateRELATIONSHIP($rId, 'subDocument', $originalPath, 'TargetMode="External"');
}
/**
* Add a table.
*
* @access public
* @example ../examples/easy/Table.php
* @example ../examples/easy/Table_size_cols.php
* @example ../examples/intermediate/Table.php
* @example ../examples/intermediate/TableStyled.php
* @example ../examples/advanced/Report.php
* @param array $data Values to add
* @param array $options Parameters to use
* Values:
* 'border' (none, single, double);
* 'border_color' (ffffff, ff0000);
* 'border_spacing' (0, 1, 2...);
* 'border_sz' (10, 11...);
* 'font' (Arial, Times New Roman...);
* 'jc' (center, left, right);
* 'decimalTab'
* 'size_col': column width fix (1200, 1300...),
* column width variable (array);
* 'TBLSTYLEval' (string) Word table style;
* 'cantSplitRows' (boolean)
* 'rawWordML' (boolean)
*/
public function addTable($data, $options= array('rawWordML' => false))
{
$table = CreateTable::getInstance();
$table->createTable($data, $options);
self::$log->info('Add table to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $table;
}else{
$this->_wordDocumentC .= (string) $table;
}
}
/**
* Add a table of contents (TOC)
*
* @access public
* @example ../examples/easy/TableContents.php
* @param string $font Set font type
* Values: 'Arial', 'Times New Roman'...
*/
public function addTableContents($font = '')
{
$tableContents = CreateTableContents::getInstance();
$tableContents->createTableContents($font);
self::$log->info('Add table of contents to word document.');
$this->_wordDocumentC .= (string) $tableContents;
}
/**
* Add a DOCX file as a template
*
* @access public
* @example ../examples/easy/Template.php
* @example ../examples/easy/Template_docx.php
* @example ../examples/easy/Template_html.php
* @example ../examples/easy/Template_image.php
* @example ../examples/easy/Template_mht.php
* @example ../examples/easy/Template_rtf.php
* @example ../examples/easy/Template_text.php
* @example ../examples/intermediate/Template.php
* @example ../examples/intermediate/Template_image.php
* @example ../examples/intermediate/Template_multitext.php
* @param string $path Path to the template file
*/
public function addTemplate($path)
{
$numRef = rand(9999999, 99999999);
CreateDocx::$numUL = $numRef;
CreateDocx::$numOL = $numRef +1;
$template = CreateTemplate::getInstance();
try {
if (file_exists($path)) {
self::$log->info('Open template ' . $path . '.');
$template->openTemplate($path);
} else {
throw new Exception('File ' . $path . ' not exists');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//we regenerate the numberings for ordered and unordered lists
}
/**
* Replace a variable with a chart.
*
* @access public
* @example ../examples/easy/Template_chart.php
* @param string $var Value of the variable
* @param string $chart Chart to add
* Values: same as charts.
*/
public function addTemplateChart($var, $chart)
{
$template = CreateTemplate::getInstance();
self::$log->info('Assign as chart variable ' . $var . ' in template.');
$this->addGraphicTemplate($chart);
self::$log->info('Replace chart variable ' . $var . ' in template.');
$template->replaceChart($var);
}
/**
* Replace a variable with a checkbox.
*
* @access public
* @example ../examples/easy/Template_checkbox.php
* @param string $var Value of the variable. String
* @param string $value
*/
public function addTemplateCheckBox($var, $value = false)
{
$template = CreateTemplate::getInstance();
self::$log->info(
'Replace text variable ' . $var . ' with a checkbox.'
);
$template->replaceCheckBox($var, $value);
}
/**
* Replace a variable image template with a new image.
*
* @access public
* @example ../examples/easy/Template_imageSimple.php
* @example ../examples/intermediate/Template_image.php
* @param string $var Value of the variable
* @param string $pathImage Path of the new image
*/
public function addTemplateImage($var, $pathImage)
{
$template = CreateTemplate::getInstance();
self::$log->info(
'Assign and replace image variable ' . $var . ' in template.'
);
$template->replaceImage($var, $pathImage);
}
/**
* Replace a variable with a text, HTML, DOCX, RTF, MHT.
*
* @access public
* @example ../examples/easy/Template.php
* @example ../examples/intermediate/Template.php
* @param mixed $var Value of the variable. String, html or array of values
* @param string $value Text value, type of value, CSS or text array
* Values type of template: list, table,
* @param mixed $settings Template settings or content type
* Content types: html, rtf, docx, mht
*/
public function addTemplateVariable($var, $value = '', $settings = '')
{
$template = CreateTemplate::getInstance();
self::$log->info(
'Assign and replace text variable ' . $var . ' in template.'
);
$template->replaceVariable($var, $value, $settings);
}
/**
* Add a text
*
* @access public
* @example ../examples/easy/Text.php
* @example ../examples/easy/Text_columns.php
* @example ../examples/easy/Text_cursive.php
* @example ../examples/easy/Text_linespacing.php
* @example ../examples/intermediate/FooterPager.php
* @example ../examples/intermediate/Multidocument.php
* @example ../examples/intermediate/Text.php
* @example ../examples/advanced/Report.php
* @param mixed $textParams if a string just the text to be included, if an
* array is an array of arrays with each element containing
* the text to be inserted and their formatting properties
* Values:
* 'text' (string) the run of text to be inserted
* 'b' (on, off)
* 'color' (ffffff, ff0000...)
* 'font' (Arial, Times New Roman...)
* 'i' (on, off)
* 'lineBreak' (before, after, both) inserts a line break before, after or both, a run of text
* 'sz' (1, 2, 3...)
* 'u' (none, dash, dotted, double, single, wave, words)
* @param array $paragraphParams Style options to apply to the whole paragraph
* Values:
* 'pStyle' (string) Word style to be used. Run parseStyles() to check all available paragraph styles
* 'b' (on, off)
* 'color' (ffffff, ff0000...)
* 'font' (Arial, Times New Roman...)
* 'i' (on, off)
* 'jc' (both, center, distribute, left, right)
* 'lineBreak' (before, after, both) inserts a line break before, after or both, a run of text
* 'pageBreakBefore' (on, off)
* 'sz' (1, 2, 3...)
* 'u' (none, dash, dotted, double, single, wave, words)
* 'widowControl' (on, off)
* 'wordWrap' (on, off)
* 'lineSpacing' 120, 240 (standard), 480...,
* 'indent_left' 100...,
* 'indent_right' 100...
* 'rawWordML' (boolean)
*/
public function addText($textParams, $paragraphParams = array('rawWordML' => false))
{
$text = CreateText::getInstance();
$text->createText($textParams, $paragraphParams);
self::$log->info('Add text to word document.');
if(isset($paragraphParams['rawWordML']) && $paragraphParams['rawWordML']){
return (string) $text;
}else{
$this->_wordDocumentC .= (string) $text;
}
}
/**
* Add a textbox
*
* @access public
* @example ../examples/easy/TextBox.php
* @example ../examples/intermediate/TextBox.php
* @param array $text these are the same parameters used in the addText method
* The first array entry is the text to be included in the text box, the second one
* is itself another array with all the standard text formatting options
* @param array $options includes the specific textbox options
* Values:
* 'border' (int)
* 'border_color (string) color (black, red,...) or hexadecimal value (#ff0000, #0000ff, ...)
* 'align' (center, left, right)
* 'fillcolor' (string) color (black, red,...) or hexadecimal value (#ff0000, #0000ff, ...)
* 'width' (float) width in cm
* 'height' (float) height in cm
* 'textWrap' (tight, square, through, none)
* 'margin_left' (float) distance in cm
* 'margin_top' (float) distance in cm
* 'padding_bottom' (float) distance in cm
* 'padding_left' (float) distance in cm
* 'padding_right' (float) distance in cm
* 'padding_top' (float) distance in cm
* 'rawWordML' (boolean)
*/
public function addTextBox($text, $options = array('rawWordML' => false))
{
$textBox = CreateTextBox::getInstance();
$textBox->createTextBox($text, $options);
self::$log->info('Add textbox to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $textBox;
}else{
$this->_wordDocumentC .= (string) $textBox;
}
}
/**
* Add a title
*
* @access public
* @example ../examples/easy/Title.php
* @example ../examples/intermediate/Multidocument.php
* @example ../examples/advanced/Report.php
* @param string $text Text to add
* @param array $options
* Values:
* 'type' (title, subtitle)
* 'b' (on, off)
* 'color' (ffffff, ff0000...)
* 'font' (Arial, Times New Roman...)
* 'i' (on, off)
* 'jc' (both, center, distribute, left, right)
* 'pageBreakBefore' (on, off), 'sz' (1, 2, 3...)
* 'u' (dash, dotted, double, single, wave, words)
* 'widowControl' (on, off)
* 'wordWrap' (on, off)
* 'rawWordML' (boolean)
*/
public function addTitle($text, $options = array('rawWordML' => false))
{
$title = CreateText::getInstance();
$title->createTitle($text, $options);
self::$log->info('Add title to word document.');
if(isset($options['rawWordML']) && $options['rawWordML']){
return (string) $title;
}else{
$this->_wordDocumentC .= (string) $title;
}
}
/**
* Adds WordML to the document.
*
* @access public
* @param array $options
* Values:
* 'wordML' (string) WordML to add
* 'rawWordML' (boolean)
*/
public function addWordML($options = array('rawWordML' => false))
{
if(isset($options['rawWordML']) && $options['rawWordML']){
$wordXML = new WordML();
$wordXML->CreateRawWordML($options['wordML']);
return $wordXML;
}else{
$this->_wordDocumentC .= (String) $options['wordML'];
}
}
/**
* Eliminates all block type elements from a WordML string
*
* @access public
*/
public function cleanWordMLBlockElements($wordML)
{
$wordMLChunk = new DOMDocument();
$namespaces = 'xmlns:ve="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" ';
$wordML = ''.$wordML;
$wordML = $wordML.'';
$wordMLChunk->loadXML($wordML);
$wordMLXpath = new DOMXPath($wordMLChunk);
$wordMLXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$query= '//w:r';
$wrNodes = $wordMLXpath->query($query);
$blockCleaned = '';
foreach ($wrNodes as $node){
$nodeR = $node->ownerDocument->saveXML($node);
$blockCleaned .= $nodeR;
}
return $blockCleaned;
}
/**
* Clear all blocks
*
* @access public
*/
public function clearBlocks()
{
self::$log->info('Clear all blocks.');
CreateTemplate::deleteAllBlocks();
}
/**
* Generate a new DOCX file
*
* @access public
* @example ../examples/easy/Text.php
* @example ../examples/advanced/Report.php
* @param string $args[0] File name
* @param string $args[1] Page style
* Values: 'bottom' (4000, 4001...), 'columns' (1, 2, 3), 'left' (4000, 4001...),
* 'orient' (landscape), 'right' (4000, 4001), 'titlePage' (1),
* 'top' (4000, 4001)
*/
public function createDocx()
{
$args = func_get_args();
if (!empty($args[0])) {
$fileName = $args[0];
} else {
$fileName = 'document';
}
self::$log->info('Set DOCX name to: ' . $fileName . '.');
if (!CreateTemplate::getBlnTemplate()) {
self::$log->debug('DOCX is a new file, not a template.');
try {
GenerateDocx::beginDocx();
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We copy the rels content into the respective file
$relsHandler = fopen($this->_baseTemplateFilesPath.'/word/_rels/document.xml.rels', "w+");
fwrite($relsHandler, $this->_wordRelsDocumentRelsT->saveXML());
fclose($relsHandler);
//We also copy the contents of the [Content_types].xml file
$contentTypesHandler = fopen($this->_baseTemplateFilesPath.'/[Content_Types].xml', "w+");
fwrite($contentTypesHandler, $this->_contentTypeT->saveXML());
fclose($contentTypesHandler);
$arrArgsPage = array();
if (isset($args[1])) {
self::$log->debug('Modify page layout.');
$this->modifyPageLayout('custom', $args[1]);
}
$this->generateTemplateWordDocument($arrArgsPage);
if ($this->_debug->getActive() == 1) {
self::$log->debug('Debug is active, add messages to objDebug.');
libxml_use_internal_errors(true);
simplexml_load_string(
$this->_wordDocumentT, 'SimpleXMLElement', LIBXML_NOWARNING
);
$xmlErrors = libxml_get_errors();
if (is_array($xmlErrors)) {
$this->_debug->addMessage($xmlErrors);
libxml_clear_errors();
}
}
self::$log->info('Add word/document.xml content to DOCX file.');
$documentHandler = fopen($this->_baseTemplateFilesPath.'/word/document.xml', "w+");
if (self::$_encodeUTF) {
$contentDocumentXML = utf8_encode($this->_wordDocumentT);
//TODO: sot out encoding problems
fwrite($documentHandler, utf8_encode($this->_wordDocumentT));
} else {
$contentDocumentXML = $this->_wordDocumentT;
fwrite($documentHandler, $this->_wordDocumentT);
}
fclose($documentHandler);
// repair document.xml
$repair = Repair::getInstance();
$repair->setXML($contentDocumentXML);
$repair->addParapraphEmptyTablesTags();
$documentHandler = fopen($this->_baseTemplateFilesPath.'/word/document.xml', "w+");
fwrite($documentHandler, (string)$repair);
fclose($documentHandler);
if($this->_wordFootnotesC != ''){
self::$log->info('Add word/footnote.xml content to DOCX file.');
$footnoteHandler = fopen($this->_baseTemplateFilesPath.'/word/footnote.xml', "w+");
if (self::$_encodeUTF) {
//TODO: sot out encoding problems
fwrite($footnoteHandler, utf8_encode($this->_wordFootnotesT));
} else {
fwrite($footnoteHandler, $this->_wordFootnotesT);
}
fclose($documentHandler);
}
$numberingHandler = fopen($this->_baseTemplateFilesPath.'/word/numbering.xml', "w+");
fwrite($numberingHandler, $this->_wordNumberingT);
fclose($numberingHandler);
self::$log->info('Close the zip.');
$this->recursiveInsert($this->_zipDocx, $this->_baseTemplateFilesPath, $this->_baseTemplateFilesPath);
//Lets now insert the photos inserted by the embedHTML method
if (is_dir($this->_baseTemplateFilesPath.'/word/mediaTemplate')){
$contentsDir = scandir($this->_baseTemplateFilesPath.'/word/mediaTemplate');
$predefinedExtensions = explode(',', ALLOWED_IMAGE_EXT);
foreach($contentsDir as $element){
$arrayExtension = explode('.', $element);
$extension = strtolower(array_pop($arrayExtension));
if (in_array($extension, $predefinedExtensions)){
$this->_zipDocx->addFile($this->_baseTemplateFilesPath.'/word/mediaTemplate/'.$element, 'word/media/'.$element);
}
//Now we remove the image from the mediaTemplate folder
$this->_zipDocx->deleteName('word/mediaTemplate/'.$element);
}
//And now we delete the mediaTemplate folder
$deleteMediaTemplate = $this->_zipDocx->deleteName('word/mediaTemplate/');
}
//Check if there are openbookmars and if so throw an error
if(count($this->_bookmarksIds) > 0) {
self::$log->fatal('There are unclosed bookmarks. Please, check that all open bookmarks tags are properly closed.');
exit('');
}
$this->_zipDocx->close();
$arrpathFile = pathinfo($fileName);
self::$log->info('Copy DOCX file using a new name.');
copy(
$this->_tempFile,
$fileName . '.' . $this->_extension
);
if ($this->_debug->getActive() == 1) {
self::$log->debug('Debug is active, show messages.');
echo $this->_debug;
}
} else {
self::$log->debug('DOCX is a template.');
self::$log->info(
'Create a temp copy of the file, to generate a new DOCX.'
);
$finalFileName = $fileName . '.' . $this->_extension;
$fileName = tempnam($this->_tempDir, $fileName);
copy(CreateTemplate::$path, $fileName);
$zipDocxTemplate = new ZipArchive();
try {
if ($zipDocxTemplate->open($fileName)) {
if (count(CreateTemplate::getFooter()) > 0) {
$footers = CreateTemplate::getFooter();
$i = 1;
foreach ($footers as $footer) {
self::$log->info('Footer exists, replace word/footer' . $i . '.xml with a new footer.');
$zipDocxTemplate->addFromString('word/footer' . $i . '.xml', $footer);
$i++;
}
}
if (count(CreateTemplate::getHeader()) > 0) {
$headers = CreateTemplate::getHeader();
$i = 1;
foreach ($headers as $header) {
self::$log->info('Footer exists, replace word/header' . $i . '.xml with a new header.');
$zipDocxTemplate->addFromString('word/header' . $i . '.xml', $header);
$i++;
}
}
if (CreateTemplate::getRelsDocumentXMLRels() != '') {
self::$log->info(
'Document.xml.rels exists, replace word/_rels/' .
'document.xml.rels with a new document.'
);
$zipDocxTemplate->addFromString(
'word/_rels/document.xml.rels',
CreateTemplate::getRelsDocumentXMLRels()
);
}
if (count(CreateTemplate::$placeholderImages) > 0) {
self::$log->info(
'There is one or more images as placeholders, . ' .
'replace them.'
);
CreateTemplate::replaceImages($zipDocxTemplate);
}
if (count(CreateTemplate::$placeholderHeaderImages) > 0) {
self::$log->info(
'There is one or more images in the header as placeholders, . ' .
'replace them.'
);
CreateTemplate::replaceHeaderMediaImages($zipDocxTemplate);
}
if (CreateTemplate::$totalTemplateCharts > 0) {
self::$log->info(
'There is one or more charts as placeholders, . ' .
'replace them.'
);
for ($i = CreateTemplate::$ridInitTemplateCharts + 1;
$i <= self::$intIdWord; $i++
) {
$zipDocxTemplate->addFromString(
'word/charts/chart' . $i . '.xml',
$this->graphicTemplate['arrChartXML'][$i]
);
CreateTemplate::replaceVariableChart(
$this->graphicTemplate['arrGraphics'][$i],
$i
);
$zipDocxTemplate->addFile(
$this->_tempFileXLSX[$i],
$this->fileGraphicTemplate['datos' . $i . '.xlsx']
);
$zipDocxTemplate->addFromString(
'word/charts/_rels/chart' . $i . '.xml.rels',
$this->fileGraphicTemplate['word/charts/_rels/chart' . $i . '.xml.rels']
);
CreateTemplate::addContentTypes(
$this->graphicTemplate['arrGenerateOVERRIDE'][$i]
);
CreateTemplate::addContentTypes(
$this->graphicTemplate['arrGenerateDEFAULT'][$i]
);
CreateTemplate::addRelationship(
$this->graphicTemplate['arrRelationships'][$i]
);
}
}
self::$log->info(
'Replace [Content_Types].xml with a new document.'
);
$zipDocxTemplate->addFromString(
'[Content_Types].xml',
CreateTemplate::getContentTypes()
);
self::$log->info(
'Replace word/_rels/document.xml.rels with a new ' .
'document.'
);
$zipDocxTemplate->addFromString(
'word/_rels/document.xml.rels',
CreateTemplate::getRelsDocumentXMLRels()
);
$this->_wordNumberingT = CreateTemplate::getNumbering();
if($this->_wordNumberingT == ''){
$this->_wordNumberingT = $this->generateBaseWordNumbering();
}
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$unorderedListStyle, self::$numUL);
if(is_array($this->_templateNumberings)){
foreach($this->_templateNumberings as $value){
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$orderedListStyle, $value);
}
}
$zipDocxTemplate->addFromString(
'word/numbering.xml',
$this->_wordNumberingT
);
$this->_wordStylesT = CreateTemplate::getStyles();
$importingStyles = new DOMDocument();
$importingStyles->loadXML(self::$PHPDOCXStyles);
$this->_wordStylesT = $this->addStylesTemplate($this->_wordStylesT, $importingStyles);
$zipDocxTemplate->addFromString(
'word/styles.xml',
$this->_wordStylesT
);
self::$log->info(
'Replace word/document.xml with a new document.'
);
if (self::$_encodeUTF) {
$contentDocumentXML = utf8_encode(CreateTemplate::getDocument());
$zipDocxTemplate->addFromString(
'word/document.xml',
utf8_encode(CreateTemplate::getDocument())
);
} else {
$contentDocumentXML = CreateTemplate::getDocument();
$zipDocxTemplate->addFromString(
'word/document.xml', CreateTemplate::getDocument()
);
}
self::$log->info(
'Add embedded files.'
);
foreach (CreateTemplate::$embedFiles as $files) {
if (isset($files['src_string'])) {
$zipDocxTemplate->addFromString(
'word/' . $files['dest_file'], $files['src_string']
);
} elseif (isset($files['src_file'])) {
$zipDocxTemplate->addFile($files['src_file'], 'word/' . $files['dest_file']);
}
}
//Lets now insert the photos inserted by the replaceTemplateVariableByHTML
if(is_dir($this->_baseTemplateFilesPath.'/word/mediaTemplate')){
$contentsDir = scandir($this->_baseTemplateFilesPath.'/word/mediaTemplate');
$predefinedExtensions = array('gif', 'png', 'jpg', 'jpeg', 'bmp');
foreach($contentsDir as $element){
$arrayExtension = explode('.', $element);
$extension = strtolower(array_pop($arrayExtension));
if (in_array($extension, $predefinedExtensions)){
$zipDocxTemplate->addFile($this->_baseTemplateFilesPath.'/word/mediaTemplate/'.$element, 'word/media/'.$element);
}
}
}
self::$log->info('End of file, close it.');
// repair document.xml
$repair = Repair::getInstance();
$repair->setXML($contentDocumentXML);
$repair->addParapraphEmptyTablesTags();
$zipDocxTemplate->addFromString(
'word/document.xml', (string)$repair
);
$zipDocxTemplate->close();
copy($fileName, $finalFileName);
// delete temp file
if (is_file($fileName) && is_writable($fileName)) {
unlink($fileName);
}
} else {
throw new Exception('Unable to create DOCX file.');
}
CreateTemplate::reset();
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
// delete temp file
if (is_file($this->_tempFile) && is_writable($this->_tempFile)) {
unlink($this->_tempFile);
}
}
/**
* Generate and download a new DOCX file
*
* @access public
* @param string $args[0] Name of file
* @param string $args[1] Page style
* Values: 'bottom' (4000, 4001...), 'left' (4000, 4001...),
* 'orient' (landscape), 'right' (4000, 4001), 'titlePage' (1),
* 'top' (4000, 4001)
*/
public function createDocxAndDownload()
{
$args = func_get_args();
try {
if (isset($args[1])) {
$this->createDocx($args[0], $args[1]);
} else {
$this->createDocx($args[0]);
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
if (!empty($args[0])) {
$fileName = $args[0];
$completeName = explode("/",$args[0]);
$fileNameDownload = array_pop($completeName);
} else {
$fileName = 'document';
$fileNameDownload = 'document';
}
self::$log->info(
'Download file ' . $fileNameDownload . '.' . $this->_extension . '.'
);
header(
'Content-Type: application/vnd.openxmlformats-officedocument.' .
'wordprocessingml.document'
);
header(
'Content-Disposition: attachment; filename="' . $fileNameDownload .
'.' . $this->_extension . '"'
);
header('Content-Transfer-Encoding: binary');
header('Content-Length: ' . filesize($fileName));
readfile($fileName . '.' . $this->_extension);
}
/**
* Delete a block
*
* @access public
* @param string $blockName Block to remove
*/
public function deleteTemplateBlock($blockName)
{
self::$log->info('Delete block ' . $blockName . '.');
CreateTemplate::deleteBlock($blockName);
}
/**
* Disable debug mode
*
* @access public
* @deprecated
*/
public function disableDebug()
{
self::$log->info('Disable debug.');
$this->_debug->disableDebug();
}
/**
*
* Transform a word document to a text file
*
* @example ../examples/easy/Docx2Text.php
* @param string $path. Path to the docx from which we wish to import the content
* @param string $path. Path to the text file output
* @param array styles. Declares if we want to change the default styles of phpdocx
* keys: table => true/false,list => true/false, paragraph => true/false, footnote => true/false, endnote => true/false, chart => (0=false,1=array,2=table)
*/
public static function docx2txt($from, $to, $options = array()) {
$text = new Docx2Text($options);
$text->setDocx($from);
$text->extract($to);
}
/**
* Embed HTML into the Word document by parsing the HTML code and converting it into WordML
* It preserves many CSS styles
*
* @access public
* @example ../examples/easy/EmbedSimpleHTML.php
* @example ../examples/intermediate/EmbedExternalHTML.php
* @example ../examples/intermediate/EmbedHTMLinTable.php
* @param string $html HTML to add. Must be a valid XHTML
* @param array $options:
* isFile (boolean),
* baseURL (string),
* downloadImages (boolean),
* filter (string) could be an string denoting the id, class or tag to be filtered.
* If you want only a class introduce .classname, #idName for an id or for a particular tag. One can also use
* standard XPath expresions supported by PHP.
* 'parseAnchors' (boolean),
* 'parseDivs' (paragraph, table): parses divs as paragraphs or tables,
* 'parseFloats' (boolean),
* 'strictWordStyles' (boolean) if true ignores all CSS styles and uses the styles set via the wordStyles option (see next)
* 'wordStyles' (array) associates a particular class, id or HTML tag to a Word style
* 'target' (string) document (default value), defaultHeader, firstHeader, evenHeader, defaultFooter, firstFooter, evenFooter.
* 'rawWordML' (boolean)
*/
public function embedHTML($html = '', $options = array())
{
if(!isset($options['target'])){
$options['target'] = 'document';
}
$htmlDOCX = new HTML2WordML($this->_baseTemplateFilesPath);
$sFinalDocX = $htmlDOCX->render($html, $options);
self::$log->info('Add converted HTML to word document.');
$this->HTMLRels($sFinalDocX, $options);
//We should also take care of the ordered lsit if they exist
if(is_array($sFinalDocX[3])){
foreach($sFinalDocX[3] as $value){
$this->_wordNumberingT = $this->importSingleNumbering($this->_wordNumberingT, self::$orderedListStyle, $value);
}
}
if(isset($options['rawWordML']) && $options['rawWordML'] === true){
return (string) $sFinalDocX[0];
}else{
$this->_wordDocumentC .= (string) $sFinalDocX[0];
}
}
/**
* Enable compatibility mode for OpenOffice and MS Office 2003 CP. Avoid using unsupported methods
*
* @access public
*/
public function enableCompatibilityMode()
{
self::$log->info('Enable compatibility mode.');
$this->_compatibilityMode = true;
}
/**
* Enable debug mode
*
* @access public
* @deprecated
*/
public function enableDebug()
{
self::$log->info('Enable debug.');
$this->_debug->enableDebug();
}
/**
* Return template variables (placeholders)
*
* @access public
* @example ../examples/easy/Template_variables.php
* @return array
*/
public function getTemplateVariables()
{
$template = CreateTemplate::getInstance();
self::$log->info(
'Return template variables.'
);
return $template->returnAllVariables();
}
/**
* Return the XML of the given Template
*
* @access public
* @return array
*/
public function getTemplateXML()
{
$templateXML = CreateXML::getInstance();
self::$log->info(
'Return the XML of the given Template.'
);
self::getTemplateVariables();
$templateXML->XML();
return $templateXML->getXML();
}
/**
* Imports an existing style sheet from an existing docx document.
*
* @access public
* @example ../examples/easy/ImportWordStyles.php
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
* @param string $type. You may choose 'replace' (overwrites the current styles) or 'merge' (adds the selected styles)
* @param array $myStyles. A list of specific styles to be merged. If it is empty or the choosen type is 'replace' it will be ignored.
*/
public function importStyles($path, $type= 'replace', $myStyles= array())
{
$zipStyles = new ZipArchive();
try {
$openStyle = $zipStyles->open($path);
if ($openStyle !== true) {
throw new Exception('Error while opening the Style Template: please, check the path');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
if($type == 'replace'){
//Now we overwrite the original styles file
try{
$extractingStyleFile = $zipStyles->extractTo($this->_baseTemplateFilesPath.'/','word/styles.xml');
if (!$extractingStyleFile){
throw new Exception('Error while trying to overwrite the styles.xml of the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//In order not to loose certain styles needed for certain PHPDOCX methods we should merge them
$this->importStyles(PHPDOCX_BASE_TEMPLATE, 'merge', $this->_defaultPHPDOCXStyles);
}else{
//We will first extract the new styles from the external docx
try{
$newStyles = $zipStyles->getFromName('word/styles.xml');
if ($newStyles == '') {
throw new Exception('Error while extracting the styles from the external docx');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//let's parse the different styles via XPath
$newStylesDoc = new DOMDocument();
$newStylesDoc->loadXML($newStyles);
$stylesXpath = new DOMXPath($newStylesDoc);
$stylesXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$queryStyle = '//w:style';
$styleNodes = $stylesXpath->query($queryStyle);
//Let's get the original styles as a DOMdocument
try{
$styleHandler = fopen($this->_baseTemplateFilesPath.'/word/styles.xml', 'r');
$styleXML = fread($styleHandler, filesize($this->_baseTemplateFilesPath.'/word/styles.xml'));
fclose($styleHandler);
$this->_wordStylesT = $styleXML;
if ($styleXML == '') {
throw new Exception('Error while extracting the style file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$stylesDocument = new DomDocument();
$stylesDocument->loadXML($this->_wordStylesT);
$baseNode = $stylesDocument->documentElement;
$stylesDocumentXPath = new DOMXPath($stylesDocument);
$stylesDocumentXPath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$query = '//w:style';
$originalNodes = $stylesDocumentXPath->query($query);
//Now we start to insert the new styles at the end of the styles.xml
foreach($styleNodes as $node){
// in order to avoid duplicated Ids we first remove from the
// original styles.xml any duplicity with the new ones
// TODO: check performance
foreach($originalNodes as $oldNode){
$oldName = $oldNode->getElementsByTagName('w:name');
if($oldNode->getAttribute('w:styleId') == $node->getAttribute('w:styleId')
&& in_array($oldName, $myStyles)){
$oldNode->parentNode->removeChild($oldNode);
}
}
if(count($myStyles)>0){
//Lets remove the unwanted styles in case there is a list of styles to insert
$nodeChilds = $node->childNodes;
foreach($nodeChilds as $child){
if ($child->nodeName == 'w:name'){
$styleName = $child->getAttribute('w:val');
if(in_array($styleName, $myStyles)){
$insertNode = $stylesDocument->importNode($node, true);
$baseNode->appendChild($insertNode);
}
}
}
}else{
$insertNode = $stylesDocument->importNode($node, true);
$baseNode->appendChild($insertNode);
}
}
$this->_wordStylesT = $stylesDocument->saveXML();
try{
$stylesFile=fopen($this->_baseTemplateFilesPath.'/word/styles.xml', 'w');
if ($stylesFile == false) {
throw new Exception('Error while opening the base template styles.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$writeStyles = fwrite($stylesFile,$this->_wordStylesT );
if ($writeStyles == 0) {
throw new Exception('There were no new styles written');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
//echo $this->_wordStylesT;
//readfile($this->_baseTemplateFilesPath.'/word/styles.xml');
self::$log->info('Importing styles from an external docx.');
}
/**
* Imports an existing theme from an existing docx document.
*
* @access public
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
*/
public function importThemeXML($path){
try{
$zipTheme = new ZipArchive();
$extractingThemeFile = $zipTheme->extractTo($this->_baseTemplateFilesPath.'/','word/theme/theme1.xml');
if (!$extractingThemeFile){
throw new Exception('Error while trying to overwrite the theme1.xml of the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Imports an existing webSettings.xml file from an existing docx document.
*
* @access public
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
*/
public function importWebSettingsXML($path){
try{
$zipWebSettings = new ZipArchive();
$extractingWebSettingsFile = $zipTheme->extractTo($this->_baseTemplateFilesPath.'/','word/webSettings.xml');
if (!$extractingWebSettingsFile){
throw new Exception('Error while trying to overwrite the webSettings.xml of the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Imports an existing settings.xml file from an existing docx document.
*
* @access public
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
*/
public function importSettingsXML($path){
try{
$zipSettings = new ZipArchive();
$extractingSettingsFile = $zipTheme->extractTo($this->_baseTemplateFilesPath.'/','word/settings.xml');
if (!$extractingSettingsFile){
throw new Exception('Error while trying to overwrite the settings.xml of the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Imports an existing fontTable.xml file from an existing docx document.
*
* @access public
* @param string $path. Must be a valid path to an existing .docx, .dotx o .docm document
*/
public function importFontTableXML($path){
try{
$zipFontTable = new ZipArchive();
$extractingFontTableFile = $zipTheme->extractTo($this->_baseTemplateFilesPath.'/','word/fontTable.xml');
if (!$extractingFontTableFile){
throw new Exception('Error while trying to overwrite the fontTable.xml of the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Merge WordML into a DOCX. WordML is added at the end of the document
*
* @access public
* @example ../examples/easy/MergeDocx.php
* @param string $path Path to DOCX file
* @param string $newXML WordML to add
*/
public function mergeDOCX($path, $newXML)
{
$template = CreateTemplate::getInstance();
self::$log->info('Merge DOCX file.');
$template->mergeFiles($path, $newXML);
}
/**
* Modify page layout
*
* @access public
* @example ../examples/intermediate/modifyPageLayout.php
* @param array paperType (string): A4, A3, letter, legal, A4-landscape, A3-landscape, letter-landscape, legal-landscape, custom
* @param array options
* Values:
* width (int): measuremt in twips (twentieths of a point)
* height (int): measuremt in twips (twentieths of a point)
* numberCols (int): measuremt in twips (twentieths of a point)
* orient (string): portrait, landscape
* marginTop (int): measuremt in twips (twentieths of a point)
* marginRight (int): measuremt in twips (twentieths of a point)
* marginBottom (int): measuremt in twips (twentieths of a point)
* marginLeft (int): measuremt in twips (twentieths of a point)
* marginHeader (int): measuremt in twips (twentieths of a point)
* marginFooter (int): measuremt in twips (twentieths of a point)
* gutter (int): measuremt in twips (twentieths of a point)
*/
public function modifyPageLayout($paperType = 'letter', $options = array())
{
$paperTypes = array('A4',
'A3',
'letter',
'legal',
'A4-landscape',
'A3-landscape',
'letter-landscape',
'legal-landscape',
'custom');
$layoutOptions = array( 'width',
'height',
'numberCols',
'orient',
'code',
'marginTop',
'marginRight',
'marginBottom',
'marginLeft',
'marginHeader',
'marginFooter',
'gutter');
$referenceSizes = array(
'A4' => array(
'width' => '11906',
'height' => '16838',
'numberCols' => '1',
'orient' => 'portrait',
'code' => '9',
'marginTop' => '1417',
'marginRight' => '1701',
'marginBottom' => '1417',
'marginLeft' => '1701',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'A4-landscape' => array(
'width' => '16838',
'height' => '11906',
'numberCols' => '1',
'orient' => 'landscape',
'code' => '9',
'marginTop' => '1701',
'marginRight' => '1417',
'marginBottom' => '1701',
'marginLeft' => '1417',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'A3' => array(
'width' => '16839',
'height' => '23814',
'numberCols' => '1',
'orient' => 'portrait',
'code' => '8',
'marginTop' => '1417',
'marginRight' => '1701',
'marginBottom' => '1417',
'marginLeft' => '1701',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'A3-landscape' => array(
'width' => '23814',
'height' => '16839',
'numberCols' => '1',
'orient' => 'landscape',
'code' => '8',
'marginTop' => '1701',
'marginRight' => '1417',
'marginBottom' => '1701',
'marginLeft' => '1417',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'letter' => array(
'width' => '12240',
'height' => '15840',
'numberCols' => '1',
'orient' => 'portrait',
'code' => '1',
'marginTop' => '1417',
'marginRight' => '1701',
'marginBottom' => '1417',
'marginLeft' => '1701',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'letter-landscape' => array(
'width' => '15840',
'height' => '12240',
'numberCols' => '1',
'orient' => 'landscape',
'code' => '1',
'marginTop' => '1701',
'marginRight' => '1417',
'marginBottom' => '1701',
'marginLeft' => '1417',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'legal' => array(
'width' => '12240',
'height' => '20160',
'numberCols' => '1',
'orient' => 'portrait',
'code' => '5',
'marginTop' => '1417',
'marginRight' => '1701',
'marginBottom' => '1417',
'marginLeft' => '1701',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
'legal-landscape' => array(
'width' => '20160',
'height' => '12240',
'numberCols' => '1',
'orient' => 'landscape',
'code' => '5',
'marginTop' => '1701',
'marginRight' => '1417',
'marginBottom' => '1701',
'marginLeft' => '1417',
'marginHeader' => '708',
'marginFooter' => '708',
'gutter' => '0'
),
);
try{
if(!in_array($paperType, $paperTypes)){
throw new Exception('You have used an invalid paper size');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception('You have used an invalid paper size');
}
$layout = array();
foreach($layoutOptions as $opt){
if (isset($options[$opt])){
$layout[$opt] = $options[$opt];
}else if (isset($referenceSizes[$paperType][$opt])){
$layout[$opt] = $referenceSizes[$paperType][$opt];
}
}
if (isset($layout['width'])){
$this->_sectPr->getElementsByTagName('pgSz')->item(0)->setAttribute('w:w', $layout['width']);
}
if (isset($layout['height'])){
$this->_sectPr->getElementsByTagName('pgSz')->item(0)->setAttribute('w:h', $layout['height']);
}
if (isset($layout['orient'])){
$this->_sectPr->getElementsByTagName('pgSz')->item(0)->setAttribute('w:orient', $layout['orient']);
}
if (isset($layout['code'])){
$this->_sectPr->getElementsByTagName('pgSz')->item(0)->setAttribute('w:code', $layout['code']);
}
if (isset($layout['marginTop'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:top', $layout['marginTop']);
}
if (isset($layout['marginRight'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:right', $layout['marginRight']);
}
if (isset($layout['marginBottom'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:bottom', $layout['marginBottom']);
}
if (isset($layout['marginLeft'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:left', $layout['marginLeft']);
}
if (isset($layout['marginHeader'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:header', $layout['marginHeader']);
}
if (isset($layout[$paperType]['marginFooter'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:footer', $layout['marginFooter']);
}
if (isset($layout['gutter'])){
$this->_sectPr->getElementsByTagName('pgMar')->item(0)->setAttribute('w:gutter', $layout['gutter']);
}
//Now we look at the case of numberCols
if (isset($layout['numberCols'])){
if ($this->_sectPr->getElementsByTagName('cols')->length > 0){
$this->_sectPr->getElementsByTagName('cols')->item(0)->setAttribute('w:num', $layout['numberCols']);
}else{
$colsNode = $this->_sectPr->createDocumentFragment();
$colsNode->appendXML('');
$this->_sectPr->documentElement->appendChild($colsNode);
}
}
}
/**
* Gets the Ids associated with the different styles in the current document or an external docx.
* It returns a docx with all the avalaible paragraph, list and table styles.
*
* @access public
* @example ../examples/easy/ParseStyles.php
* @param string $path. Optional, if empty lists de Ids of the current style sheet
*/
public function parseStyles($path='')
{
if($path != ''){
$tempTitle = explode('/',$path);
$title = array_pop($tempTitle);
$parseStyles = new ZipArchive();
try {
$openParseStyle = $parseStyles->open($path);
if ($openParseStyle !== true) {
throw new Exception('Error while opening the Style sheet to be tested: please, check the path');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$parsedStyles = $parseStyles->getFromName('word/styles.xml');
if ($parsedStyles == '') {
throw new Exception('Error while extracting the styles to be parsed from the external docx');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$parsedNumberings = $parseStyles->getFromName('word/numbering.xml');
if ($parsedNumberings == '') {
throw new Exception('Error while extracting the numberings to be parsed from the external docx');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}else{
$tempTitle = explode('/',PHPDOCX_BASE_TEMPLATE);
$title = array_pop($tempTitle);
$parsedStyles = $this->_baseTemplateZip->getFromName('word/styles.xml');
$parsedNumberings = $this->_baseTemplateZip->getFromName('word/numbering.xml');
}
//We now include certain sample content to create the resulting style docx
$myParagraph = 'This is some sample paragraph test';
$myList = array('item 1', 'item 2', array('subitem 2_1', 'subitem 2_2'), 'item 3', array('subitem 3_1', 'subitem 3_2', array('sub_subitem 3_2_1', 'sub_subitem 3_2_1')), 'item 4');
$myTable = array(
array(
'Title A',
'Title B',
'Title C'
),
array(
'First row A',
'First row B',
'First row C'
),
array(
'Second row A',
'Second row B',
'Second row C'
)
);
//let's parse the different list numberings from
$this->addText('List styles: '.$title, array('jc' => 'center', 'color' => 'b90000', 'b' => 'single', 'sz' => '18', 'u' => 'double'));
$wordListChunk ='
SAMPLE CODE:
$
myList
= array(\'item 1\',
\'item 2\',
array(\'subitem
2_1\',
\'
subitem
2_2\'),
\'item 3\',
array(\'subitem
3_1\',
\'subitem
3_2\',
array(\'sub_subitem
3_2_1\',
\'sub_subitem
3_2_1\')),
\'item 4\');
addList($
myList, array(\'
val
\' => NUMID
))
SAMPLE RESULT:
';
$NumberingsDoc = new DOMDocument();
$NumberingsDoc->loadXML($parsedNumberings);
$numberXpath = new DOMXPath($NumberingsDoc);
$numberXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$queryNumber = '//w:num';
$numberingsNodes = $numberXpath->query($queryNumber);
foreach($numberingsNodes as $node){
$wordListChunkTemp = str_replace('NUMID',$node->getAttribute('w:numId'), $wordListChunk);
$this->_wordDocumentC .= $wordListChunkTemp;
$this->addList($myList, array('val' => $node->getAttribute('w:numId')));
$this->addBreak(array('type' => 'page'));
}
$this->addText('Paragraph and Table styles: '.$title, array('jc' => 'center', 'color' => 'b90000', 'b' => 'single', 'sz' => '18', 'u' => 'double'));
//let's parse the different styles via XPath
$StylesDoc = new DOMDocument();
$StylesDoc->loadXML($parsedStyles);
$parseStylesXpath = new DOMXPath($StylesDoc);
$parseStylesXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$query = '//w:style';
$parsedNodes = $parseStylesXpath->query($query);
//Lets list the present styles and their respective Ids
$count=1;
foreach($parsedNodes as $node){
$styleId = $node->getAttribute('w:styleId');
$styleType= $node->getAttribute('w:type');
$styleDefault = $node->getAttribute('w:default');
$styleCustom= $node->getAttribute('w:custom');
$nodeChilds = $node->childNodes;
foreach($nodeChilds as $child){
if ($child->nodeName == 'w:name'){
$styleName = $child->getAttribute('w:val');
}
}
$this->parsedStyles[$count]= array('id'=>$styleId, 'name'=>$styleName, 'type'=>$styleType,'default'=>$styleDefault, 'custom'=>$styleCustom);
$default = ($styleDefault == 1)?'true':'false';
$custom = ($styleCustom == 1)?'true':'false';
$wordMLChunk = '
NAME:
'.$styleName.'
Type
:
'.$styleType.'
ID:
'.$styleId.'
Default:
'.$default.'
Custom
:
'.$custom.'
SAMPLE CODE:
CODEX
SAMPLE RESULT:
';
switch($styleType){
case 'table':
$wordMLChunk = str_replace('CODEX',"addTable(array(array('Title A','Title B','Title C'),array('First row A','First row B','First row C'),array('Second row A','Second row B','Second row C')), array('TBLSTYLEval'=> '$styleId'))", $wordMLChunk);
$this->_wordDocumentC .= $wordMLChunk;
$params = array('TBLSTYLEval'=> $styleId);
$this->addTable($myTable, $params);
if($count%2 == 0){
$this->_wordDocumentC .= '';
}else{
$this->_wordDocumentC .= '';
}
$count++;
break;
case 'paragraph':
$myPCode = "addText('This is some sample paragraph test', array('pStyle' => '".$styleId."'))";
$wordMLChunk = str_replace('CODEX',$myPCode, $wordMLChunk);
$this->_wordDocumentC .= $wordMLChunk;
$params = array('pStyle'=> $styleId);
$this->addText($myParagraph, $params);
if($count%2 == 0){
$this->_wordDocumentC .= '';
}else{
$this->_wordDocumentC .= '';
}
$count++;
break;
}
}
}
/**
* Parse DOCX file and extract content
*
* @access public
* @example ../examples/easy/Parser.php
* @param string $path Path to DOCX file
*/
public function readDOCX($path)
{
$parser = Parser::getInstance();
try {
$parser->readFile($path);
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
throw new Exception('File does not exist');
}
self::$log->info('Read DOCX file.');
}
/**
* Replace a header image with a new image.
*
* @access public
* @example ../examples/intermediate/ReplaceHeaderImage.php
* @param string $var Value of the variable
* @param string $pathImage Path of the new image
*/
public function replaceHeaderImage($var, $pathImage)
{
$template = CreateTemplate::getInstance();
self::$log->info(
'Assign and replace image variable ' . $var . ' in header.'
);
$template->replaceHeaderImage($var, $pathImage);
}
/**
* Replace a template variable with WordML obtained from HTML via the
* embedHTML method.
*
* @access public
* @example ../examples/easy/ReplaceTemplateVariableByHTML.php
* @param string $var Value of the variable.
* @param type inline or block
* @param string $html HTML source
* @param array $options:
* isFile (boolean),
* baseURL (string),
* downloadImages (boolean),
* filter (string) could be an string denoting the id, class or tag to be filtered.
* If you want only a class introduce .classname, #idName for an id or for a particular tag. One can also use
* standard XPath expresions supported by PHP.
* 'parseAnchors' (boolean),
* 'parseDivs' (paragraph, table): parses divs as paragraphs or tables,
* 'parseFloats' (boolean),
* 'strictWordStyles' (boolean) if true ignores all CSS styles and uses the styles set via the wordStyles option (see next)
* 'wordStyles' (array) associates a particular class, id or HTML tag to a Word style
*
*/
public function replaceTemplateVariableByHTML($var, $type, $html = '', $options = array())
{
$htmlDOCX = new HTML2WordML($this->_baseTemplateFilesPath);
$wordHTML = $htmlDOCX->render($html, $options);
$template = CreateTemplate::getInstance();
self::$log->info(
'Assign and replace variable ' . $var . ' in template by HTML.'
);
//We now clean the wordML to take into account the case where we want an 'inline' replace
if($type == 'block'){
$wordHTMLString = $wordHTML[0];
}else{
$wordHTMLString = $this->cleanWordMLBlockElements($wordHTML[0]);
}
$template->replaceVariableByHTML($var, $type, $wordHTMLString);
$template->TemplateHTMLRels($wordHTML, $options, $this->_baseTemplateFilesPath);
$this->_templateNumberings = $wordHTML[3];
}
/**
* Changes the background color of the document
*
* @access public
* @example ../examples/easy/BackgroundColor.php
* @param string $color
* Values: hexadecimal color value without # (ffff00, 0000ff, ...)
*/
public function setBackgroundColor($color)
{
$this->_backgroundColor = $color;
//We construct the background WordML code
if ($this->_background == ''){
$this->_background ='';
//We have to modify the settings.xml file
try{
$settings = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "r");
$baseTemplateSettingsT = fread($settings, 1000000);
fclose($settings);
if ($baseTemplateSettingsT == '') {
throw new Exception('Error while extracting settings.xml file from the base template to insert the background image');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordSettingsT = new DOMDocument();
$this->_wordSettingsT->loadXML($baseTemplateSettingsT);
$settingsImage = $this->_wordSettingsT->createDocumentFragment();
$settingsImage->appendXML('');
$this->_wordSettingsT->documentElement->appendChild($settingsImage);
$newSettings = $this->_wordSettingsT->saveXML();
$settingsHandle = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "w+");
$contents = fwrite($settingsHandle, $newSettings);
fclose($settingsHandle);
}else{
$this->_background = str_replace('w:color="FFFFFF"', 'w:color="' . $color . '"', $this->_background);
}
}
/**
* Change the default font
*
* @access public
* @param string $symbol
* Values: '.', ',',...
*/
public function setDecimalSymbol($symbol)
{
//Let's get the original settings.xml as a DOMdocument
try{
$settingsHandler = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', 'r');
$settingsXML = fread($settingsHandler, filesize($this->_baseTemplateFilesPath.'/word/settings.xml'));
fclose($settingsHandler);
if ($settingsXML == '') {
throw new Exception('Error while extracting the settings file from the base template to stablish default decimal symbol');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$settingsDocument = new DomDocument();
$settingsDocument->loadXML($settingsXML);
$decimalNodes = $settingsDocument->getElementsByTagName('decimalSymbol');
$decimalNode = $decimalNodes->item(0);
$newDecimalNode = $settingsDocument->createElement('w:decimalSymbol', '');
$newDecimalNode->setAttribute('w:val', $symbol);
$decimalNode->parentNode->replaceChild($newDecimalNode, $decimalNode);
$settingsXML = $settingsDocument->saveXML();
try{
$settingsFile=fopen($this->_baseTemplateFilesPath.'/word/settings.xml', 'w');
if ($settingsFile == false) {
throw new Exception('Error while opening the base template settings.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$writeSettings = fwrite($settingsFile, $settingsXML);
if ($writeSettings == 0) {
throw new Exception('There was an error while trying to set the decimal Symbol');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
self::$log->info('Change decimal symbol.');
}
/**
* Change the default font
*
* @access public
* @example ../examples/easy/SetDefaultFont.php
* @param string $font The new font
* Values: 'Arial', 'Times New Roman'...
*/
public function setDefaultFont($font)
{
$this->_defaultFont = $font;
//Let's get the original theme as a DOMdocument
try{
$themeHandler = fopen($this->_baseTemplateFilesPath.'/word/theme/theme1.xml', 'r');
$themeXML = fread($themeHandler, filesize($this->_baseTemplateFilesPath.'/word/theme/theme1.xml'));
fclose($themeHandler);
if ($themeXML == '') {
throw new Exception('Error while extracting the theme file from the base template to stablish default font');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$themeDocument = new DomDocument();
$themeDocument->loadXML($themeXML);
$latinNode = $themeDocument->getElementsByTagName('latin');
$latinNode->item(0)->setAttribute('typeface', $font);
$latinNode->item(1)->setAttribute('typeface', $font);
$themeXML = $themeDocument->saveXML();
try{
$themeFile=fopen($this->_baseTemplateFilesPath.'/word/theme/theme1.xml', 'w');
if ($themeFile == false) {
throw new Exception('Error while opening the base template theme1.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$writeTheme = fwrite($themeFile, $themeXML);
if ($writeTheme == 0) {
throw new Exception('There was an error while trying to set the default font');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
self::$log->info('Change default font.');
}
/**
* Transform to UTF-8 charset
*
* @access public
*/
public function setEncodeUTF8()
{
self::$_encodeUTF = 1;
}
/**
* Change default language.
* @example ../examples/easy/Language.php
* @param $lang Locale: en-US, es-ES...
* @access public
*/
public function setLanguage($lang = DEFAULT_LANGUAGE)
{
//Let's get the original styles as a DOMdocument
try{
$styleHandler = fopen($this->_baseTemplateFilesPath.'/word/styles.xml', 'r');
$styleXML = fread($styleHandler, 10000000);
fclose($styleHandler);
$this->_wordStylesT = $styleXML;
if ($styleXML == '') {
throw new Exception('Error while extracting the style file from the base template to stablish default language');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$stylesDocument = new DomDocument();
$stylesDocument->loadXML($this->_wordStylesT);
$langNode = $stylesDocument->getElementsByTagName('lang');
$langNode->item(0)->setAttribute('w:val', $lang);
$langNode->item(0)->setAttribute('w:eastAsia', $lang);
$this->_wordStylesT = $stylesDocument->saveXML();
try{
$stylesFile=fopen($this->_baseTemplateFilesPath.'/word/styles.xml', 'w');
if ($stylesFile == false) {
throw new Exception('Error while opening the base template styles.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
try{
$writeStyles = fwrite($stylesFile,$this->_wordStylesT );
if ($writeStyles == 0) {
throw new Exception('There was an error while trying to set the default language');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
self::$log->info('The language has been set.');
}
/**
* Mark the document as final
*
* @access public
* @example ../examples/easy/MarkAsFinal.php
*
*/
public function setMarkAsFinal()
{
$this->_markAsFinal = 1;
$this->addProperties(array('contentStatus' => 'Final'));
$this->generateOVERRIDE(
'/docProps/custom.xml',
'application/vnd.openxmlformats-officedocument.' .
'custom-properties+xml'
);
}
/**
* Set the symbol surrounding varibles (placeholders)
*
* @access public
* @param string $symbol The new symbol. Optional, $ as default
*/
public function setTemplateSymbol($symbol = '$')
{
self::$log->info('Change template symbol.');
CreateTemplate::setTemplateSymbol($symbol);
}
/**
* Transform DOCX to PDF, ODT, SXW, RTF, DOC, TXT, HTML or WIKI
*
* @access public
* @example ../examples/advanced/Transform.php
* @param string $docSource
* @param string $docDestination
* @param string $tempDir
* @return void
*/
public function transformDocx($docSource, $docDestination, $tempDir = null) {
try {
if (!$this->_compatibilityMode) {
throw new Exception('Running in compatibility mode. Unsupported method.');
}
$convert = new TransformDocAdv();
$convert->transformDocument($docSource, $docDestination, $tempDir);
} catch (Exception $e) {
self::$log->fatal($e->getMessage());
}
}
/**
* If PHPDocX is installed in a server with a working copy of Word 2007 or newer you may
* use it to do format conversions.
* Supported formats, DOCX and DOC to PDF, RTF, HTML and DOC
* @access public
* @param $docSource You should use the full Windows path to the docx (remember to escape backslashes)
* @param $docDestination ou should use the full Windows path to the docx (remember to escape backslashes)
* @return void
*/
public function transformDocxUsingMSWord($docSource, $docDestination) {
$convert = new MSWordInterface();
$convert->transformFormat($docSource, $docDestination);
}
/**
*
* Insert the content of a text file into a word document trying to hold the styles
*
* @example ../examples/easy/Text2Docx.php
* @param string $path. Path to the text file from which we insert into docx document
* @param array of style values
* keys: styleTbl, styleLst, styleP
*/
public function txt2docx($text_filename, $options = array()) {
$text = new Text2Docx($text_filename, $options);
self::$log->info('Add text from text file.');
$this->_wordDocumentC .= (string) $text;
}
/**
* Creates a WordML freagment.
*
* @access public
* @example ../examples/easy/WordMLFragment.php
* @example ../examples/intermediate/EmbedHTMLinTable.php
* @param mixed $data, string or array
*/
public function createWordMLFragment($data)
{
$wordMLFragment = new WordMLFragment();
if(!empty($data) && !is_array($data)){
$wordMLFragment->addRawWordML($data);
}else if(!empty($data) && is_array($data)){
foreach($data as $key => $value){
$wordMLFragment->addRawWordML($value);
}
}
return $wordMLFragment;
}
/*** End old API ***/
/**
* Add default endnote
*
* @access private
*/
private function addDefaultEndnote()
{
$endnote = CreateEndnote::getInstance();
$endnote->createInitEndnote(array('type' => 'separator'));
$this->_wordEndnotesC .= (string) $endnote;
$endnote = CreateEndnote::getInstance();
$endnote->createInitEndnote(array('type' => 'continuationSeparator'));
$this->_wordEndnotesC .= (string) $endnote;
}
/**
* Add default footnote
*
* @access private
*/
private function addDefaultFootnote()
{
$footnote = CreateFootnote::getInstance();
$footnote->createInitFootnote(array('type' => 'separator'));
$this->_wordFootnotesC .= (string) $footnote;
$footnote = CreateFootnote::getInstance();
$footnote->createInitFootnote(
array('type' => 'continuationSeparator')
);
$this->_wordFootnotesC .= (string) $footnote;
}
/**
* Add an image in the footer
*
* @param array $dats Image to add and paramaters to use
* @return string
*/
private function addImageFooter($dats = '')
{
try {
if (isset($dats['name']) && file_exists($dats['name'])) {
$arrAtributos = getimagesize($dats['name']);
try {
if (
$arrAtributos['mime'] == 'image/jpg' ||
$arrAtributos['mime'] == 'image/jpeg' ||
$arrAtributos['mime'] == 'image/png' ||
$arrAtributos['mime'] == 'image/gif'
) {
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord . ' . Image footer.'
);
$img = CreateImage::getInstance();
$dats['rId'] = self::$intIdWord;
$img->createImage($dats);
$xmlHeaderImg = (string) $img;
$dir = $this->parsePath($dats['name']);
self::$log->info(
'Add image header word/media/image' .
self::$intIdWord . '.' . $dir['extension'] .
'.xml to DOCX.'
);
$this->_zipDocx->addFile(
$dats['name'], 'word/media/image' .
self::$intIdWord . '.' . $dir['extension']
);
$this->generateDEFAULT(
$dir['extension'], $arrAtributos['mime']
);
if ((string) $img != '') {
$this->_wordRelsFooterRelsC .=
$this->generateRELATIONSHIPTemplate(
'rId' . self::$intIdWord, 'image',
'media/image' . self::$intIdWord .
'.' . $dir['extension']
);
return $xmlHeaderImg;
} else {
throw new Exception(
'Image format is not supported.'
);
}
} else {
throw new Exception('Image does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add an image in the header
*
* @param array $dats Image to add and paramaters to use
* @return string
*/
private function addImageHeader($dats = '')
{
try {
if (isset($dats['name']) && file_exists($dats['name'])) {
$attrImage = getimagesize($dats['name']);
try {
if (
$attrImage['mime'] == 'image/jpg' ||
$attrImage['mime'] == 'image/jpeg' ||
$attrImage['mime'] == 'image/png' ||
$attrImage['mime'] == 'image/gif'
) {
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord . ' . Image header.'
);
$img = CreateImage::getInstance();
$dats['rId'] = self::$intIdWord;
$img->createImage($dats);
$xmlHeaderImg = (string) $img;
$dir = $this->parsePath($dats['name']);
self::$log->info(
'Add image header word/media/image' .
self::$intIdWord . '.' .
$dir['extension'] . '.xml to DOCX.'
);
$this->_zipDocx->addFile(
$dats['name'],
'word/media/image' . self::$intIdWord . '.' .
$dir['extension']
);
$this->generateDEFAULT(
$dir['extension'], $attrImage['mime']
);
if ((string) $img != '') {
$this->_wordRelsHeaderRelsC .=
$this->generateRELATIONSHIPTemplate(
'rId' . self::$intIdWord, 'image',
'media/image' . self::$intIdWord . '.' .
$dir['extension']
);
return $xmlHeaderImg;
} else {
throw new Exception(
'Image format is not supported.'
);
}
} else {
throw new Exception('Image does not exist.');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
}
/**
* Add settings
*
* @access private
*/
private function addSettings()
{
$settings = CreateSettings::getInstance();
$settings->generateSettings();
self::$log->info('Add settings to settings document.');
$this->_wordSettingsC .= (string) $settings;
}
/**
* Add style
*
* @param string lang Language
* @access private
*/
private function addStyle($lang = 'en-US')
{
$style = CreateStyle::getInstance();
$style->createStyle($lang);
self::$log->info('Add styles to styles document.');
$this->_wordStylesC .= (string) $style;
}
/**
* Imports styles into the template stylesheet.
*
* @access private
* @param string $templateStyles
* @param DOMDocument $importedStylesheet
*/
private function addStylesTemplate($templateStyles, $importedStylesheet)
{
$templateStylesheet = new DomDocument();
$templateStylesheet->loadXML($templateStyles);
//let's parse the different styles via XPath
$stylesXpath = new DOMXPath($importedStylesheet);
$stylesXpath->registerNamespace('w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main');
$queryStyle = '//w:style';
$styleNodes = $stylesXpath->query($queryStyle);
//Let's get the original styles as a DOMNode
$stylesDocument = new DomDocument();
$stylesDocument->loadXML($templateStyles);
$baseNode = $stylesDocument->documentElement;
//Now we start to insert the new styles at the end of the styles.xml
foreach($styleNodes as $node){
// in order to avoid duplicated Ids we first remove from the
// original styles any duplicity with the new ones
$originalNodes = $stylesDocument->childNodes;
foreach($originalNodes as $oldNode){
if($oldNode->getAttribute('w:styleId') == $node->getAttribute('w:styleId')){
$oldNode->parent->removeChild($oldNode);
}
}
$insertNode = $stylesDocument->importNode($node, true);
$baseNode->appendChild($insertNode);
}
return $stylesDocument->saveXML();
self::$log->info('Importing styles into the template stylesheet.');
}
/**
* Add websettings
*
* @access private
*/
private function addWebSettings()
{
$webSettings = CreateWebSettings::getInstance();
$webSettings->generateWebSettings();
self::$log->info('Add web settings to web settings document.');
$this->_wordWebSettingsC .= (string) $webSettings;
}
/**
* Clean template
*
* @access private
*/
private function cleanTemplate()
{
self::$log->debug('Remove existing template tags.');
$this->_wordDocumentT = preg_replace(
'/__[A-Z]+__/',
'',
$this->_wordDocumentT
);
}
/**
* Generate content type
*
* @access private
*/
private function generateContentType()
{
try {
GenerateDocx::beginDocx();
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->generateDEFAULT(
'rels', 'application/vnd.openxmlformats-package.relationships+xml'
);
$this->generateDEFAULT('xml', 'application/xml');
$this->generateDEFAULT('htm', 'application/xhtml+xml');
$this->generateDEFAULT('rtf', 'application/rtf');
$this->generateDEFAULT('zip', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml');
$this->generateDEFAULT('mht', 'message/rfc822');
$this->generateDEFAULT('wml', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml');
$this->generateOVERRIDE(
'/word/numbering.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml.' .
'numbering+xml'
);
$this->generateOVERRIDE(
'/word/styles.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml' .
'.styles+xml'
);
$this->generateOVERRIDE(
'/docProps/app.xml',
'application/vnd.openxmlformats-officedocument.extended-' .
'properties+xml'
);
$this->generateOVERRIDE(
'/docProps/custom.xml',
'application/vnd.openxmlformats-officedocument.' .
'custom-properties+xml'
);
$this->generateOVERRIDE(
'/word/settings.xml', 'application/' .
'vnd.openxmlformats-officedocument.wordprocessingml.settings+xml'
);
$this->generateOVERRIDE(
'/word/theme/theme1.xml',
'application/vnd.openxmlformats-officedocument.theme+xml'
);
$this->generateOVERRIDE(
'/word/fontTable.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml.' .
'fontTable+xml'
);
$this->generateOVERRIDE(
'/word/webSettings.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml' .
'.webSettings+xml'
);
if ($this->_wordFooterC != '' || $this->_wordHeaderC != '') {
$this->generateOVERRIDE(
'/word/header.xml',
'application/vnd.openxmlformats-officedocument.' .
'wordprocessingml.header+xml'
);
$this->generateOVERRIDE(
'/word/footer.xml',
'application/vnd.openxmlformats-officedocument.' .
'wordprocessingml.footer+xml'
);
$this->generateOVERRIDE(
'/word/footnotes.xml',
'application/vnd.openxmlformats-officedocument.' .
'wordprocessingml.footnotes+xml'
);
$this->generateOVERRIDE(
'/word/endnotes.xml',
'application/vnd.openxmlformats-officedocument.' .
'wordprocessingml.endnotes+xml'
);
}
$this->generateOVERRIDE(
'/docProps/core.xml',
'application/vnd.openxmlformats-package.core-properties+xml'
);
}
/**
* Generate DEFAULT
*
* @access private
*/
private function generateDEFAULT($extension, $contentType)
{
$strContent = $this->_contentTypeT->saveXML();
if (
strpos($strContent, 'Extension="' . $extension)
=== false
) {
$strContentTypes = ' ';
$tempNode = $this->_contentTypeT->createDocumentFragment();
$tempNode->appendXML($strContentTypes);
$this->_contentTypeT->documentElement->appendChild($tempNode);
}
}
/**
*
*
* @access private
*/
private function generateDefaultFonts()
{
$font = array(
'name' => 'Calibri', 'pitch' => 'variable', 'usb0' => 'A00002EF',
'usb1' => '4000207B', 'usb2' => '00000000', 'usb3' => '00000000',
'csb0' => '0000009F', 'csb1' => '00000000', 'family' => 'swiss',
'charset' => '00', 'panose1' => '020F0502020204030204'
);
$this->addFont($font);
$font = array(
'name' => 'Times New Roman', 'pitch' => 'variable',
'usb0' => 'E0002AEF', 'usb1' => 'C0007841', 'usb2' => '00000009',
'usb3' => '00000000', 'csb0' => '000001FF', 'csb1' => '00000000',
'family' => 'roman', 'charset' => '00',
'panose1' => '02020603050405020304'
);
$this->addFont($font);
$font = array(
'name' => 'Cambria', 'pitch' => 'variable', 'usb0' => 'A00002EF',
'usb1' => '4000004B', 'usb2' => '00000000', 'usb3' => '00000000',
'csb0' => '0000009F', 'csb1' => '00000000', 'family' => 'roman',
'charset' => '00', 'panose1' => '02040503050406030204'
);
$this->addFont($font);
}
/**
* Generate DefaultWordRels
*
* @access private
*/
private function generateDefaultWordRels()
{
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . numbering.xml.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'numbering', 'numbering.xml'
);
self::$intIdWord++;
self::$log->debug(
'New ID ' . self::$intIdWord . ' . theme/theme1.xml.'
);
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'theme', 'theme/theme1.xml'
);
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . numbering.xml.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'webSettings', 'webSettings.xml'
);
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . webSettings.xml.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'fontTable', 'fontTable.xml'
);
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . fontTable.xml.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'settings', 'settings.xml'
);
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . settings.xml.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'styles', 'styles.xml'
);
}
/**
* Generate OVERRIDE
*
* @access private
* @param string $partName
* @param string $contentType
*/
private function generateOVERRIDE($partName, $contentType)
{
$strContent = $this->_contentTypeT->saveXML();
if (
strpos($strContent, 'PartName="' . $partName . '"')
=== false
) {
$strContentTypes = '';
$tempNode = $this->_contentTypeT->createDocumentFragment();
$tempNode->appendXML($strContentTypes);
$this->_contentTypeT->documentElement->appendChild($tempNode);
}
}
/**
* Generate RELATIONSHIP
*
* @access private
*/
private function generateRELATIONSHIP()
{
$arrArgs = func_get_args();
if ($arrArgs[1] == 'vbaProject') {
$type =
'http://schemas.microsoft.com/office/2006/relationships/vbaProject';
} else {
$type =
'http://schemas.openxmlformats.org/officeDocument/2006/' .
'relationships/' . $arrArgs[1];
}
if (!isset($arrArgs[3])) {
$nodeWML = '';
} else {
$nodeWML = '';
}
$relsNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$relsNode->appendXML($nodeWML);
$this->_wordRelsDocumentRelsT->documentElement->appendChild($relsNode);
}
/**
* Gnerate RELATIONSHIP
*
* @access private
*/
private function generateRELATIONSHIPTemplate()
{
$arrArgs = func_get_args();
if ($arrArgs[1] == 'vbaProject') {
$type =
'http://schemas.microsoft.com/office/2006/relationships/vbaProject';
} else {
$type =
'http://schemas.openxmlformats.org/officeDocument/2006/' .
'relationships/' . $arrArgs[1];
}
if (!isset($arrArgs[3])) {
$nodeWML = '';
} else {
$nodeWML = '';
}
/*$relsNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$relsNode->appendXML($nodeWML);
$this->_wordRelsDocumentRelsT->documentElement->appendChild($relsNode);*/
return $nodeWML;
}
/**
* Generate SECTPR
*
* @access private
* @param array $args Section style
*/
private function generateSECTPR($args = '')
{
$page = CreatePage::getInstance();
$page->createSECTPR($args);
$this->_wordDocumentC .= (string) $page;
}
/**
* Generates an element in settings.xml
*
* @access private
*/
private function generateSetting($tag)
{
$settingChilds = array( 'w:writeProtection',
'w:view',
'w:zoom',
'w:removePersonalInformation',
'w:removeDateAndTime',
'w:doNotDisplayPageBoundaries',
'w:displayBackgroundShape',
'w:printPostScriptOverText',
'w:printFractionalCharacterWidth',
'w:printFormsData',
'w:embedTrueTypeFonts',
'w:embedSystemFonts',
'w:saveSubsetFonts',
'w:saveFormsData',
'w:mirrorMargins',
'w:alignBordersAndEdges',
'w:bordersDoNotSurroundHeader',
'w:bordersDoNotSurroundFooter',
'w:gutterAtTop',
'w:hideSpellingErrors',
'w:hideGrammaticalErrors',
'w:activeWritingStyle',
'w:proofState',
'w:formsDesign',
'w:attachedTemplate',
'w:linkStyles',
'w:stylePaneFormatFilter',
'w:stylePaneSortMethod',
'w:documentType',
'w:mailMerge',
'w:revisionView',
'w:trackRevisions',
'w:doNotTrackMoves',
'w:doNotTrackFormatting',
'w:documentProtection',
'w:autoFormatOverride',
'w:styleLockTheme',
'w:styleLockQFSet',
'w:defaultTabStop',
'w:autoHyphenation',
'w:consecutiveHyphenLimit',
'w:hyphenationZone',
'w:doNotHyphenateCaps',
'w:showEnvelope',
'w:summaryLength',
'w:clickAndTypeStyle',
'w:defaultTableStyle',
'w:evenAndOddHeaders',
'w:bookFoldRevPrinting',
'w:bookFoldPrinting',
'w:bookFoldPrintingSheets',
'w:drawingGridHorizontalSpacing',
'w:drawingGridVerticalSpacing',
'w:displayHorizontalDrawingGridEvery',
'w:displayVerticalDrawingGridEvery',
'w:doNotUseMarginsForDrawingGridOrigin',
'w:drawingGridHorizontalOrigin',
'w:drawingGridVerticalOrigin',
'w:doNotShadeFormData',
'w:noPunctuationKerning',
'w:characterSpacingControl',
'w:printTwoOnOne',
'w:strictFirstAndLastChars',
'w:noLineBreaksAfter',
'w:noLineBreaksBefore',
'w:savePreviewPicture',
'w:doNotValidateAgainstSchema',
'w:saveInvalidXml',
'w:ignoreMixedContent',
'w:alwaysShowPlaceholderText',
'w:doNotDemarcateInvalidXml',
'w:saveXmlDataOnly',
'w:useXSLTWhenSaving',
'w:saveThroughXslt',
'w:showXMLTags',
'w:alwaysMergeEmptyNamespace',
'w:updateFields',
'w:hdrShapeDefaults',
'w:footnotePr',
'w:endnotePr',
'w:compat',
'w:docVars',
'w:rsids',
'm:mathPr',
'w:uiCompat97To2003',
'w:attachedSchema',
'w:themeFontLang',
'w:clrSchemeMapping',
'w:doNotIncludeSubdocsInStats',
'w:doNotAutoCompressPictures',
'w:forceUpgrade',
'w:captions',
'w:readModeInkLockDown',
'w:smartTagType',
'sl:schemaLibrary',
'w:shapeDefaults',
'w:doNotEmbedSmartTags',
'w:decimalSymbol',
'w:listSeparator'
);
if((!in_array($tag, $settingChilds))){
self::$log->fatal('Incorrect setting tag');
}
$settingIndex = array_search($tag, $settingChilds);
try{
$settings = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "r");
$baseTemplateSettingsT = fread($settings, 1000000);
fclose($settings);
if ($baseTemplateSettingsT == '') {
throw new Exception('Error while extracting settings.xml file from the base template to insert the selected element');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordSettingsT = new DOMDocument();
$this->_wordSettingsT->loadXML($baseTemplateSettingsT);
$selectedElements = $this->_wordSettingsT->documentElement->getElementsByTagName($tag);
if($selectedElements->length == 0){
$settingsElement = $this->_wordSettingsT->createDocumentFragment();
$settingsElement->appendXML('<' . $tag . ' xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" />');
$childNodes = $this->_wordSettingsT->documentElement->childNodes;
$index = false;
foreach($childNodes as $node){
$name = $node->nodeName;
$index = array_search($node->nodeName, $settingChilds);
if($index > $settingIndex){
$node->parentNode->insertBefore($settingsElement, $node);
break;
}
}
//in case no node was found (pretty unlikely)we should append the protectionFragment
if (!$index) {
$this->_wordSettingsT->documentElement->appendChild($settingsElement);
}
$newSettings = $this->_wordSettingsT->saveXML();
$settingsHandle = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "w+");
$contents = fwrite($settingsHandle, $newSettings);
fclose($settingsHandle);
}
}
/**
* Generate ContentType XML template
*
* @access private
*/
private function generateTemplateContentType()
{
$this->_wordContentTypeT =
'' .
'' . $this->_contentTypeC . '';
}
/**
* Generate DocPropsApp XML template
*
* @access private
*/
private function generateTemplateDocPropsApp()
{
$this->_docPropsAppT =
'' .
'Normal.dotm' .
'0111'
. 'Microsoft Office Word' .
'411' .
'false';
if ($this->_docPropsAppC) {
$this->_docPropsAppT .= $this->_docPropsAppC;
} else {
$this->_docPropsAppT .= 'Company';
}
$this->_docPropsAppT .= 'false' .
'1' .
'falsefalse' .
'12.0000';
}
/**
* Generate DocPropsCore XML template
*
* @access private
*/
private function generateTemplateDocPropsCore()
{
date_default_timezone_set('UTC');
if ($this->_markAsFinal) {
$this->_docPropsCoreT =
'' .
'Title' .
'Subject2mdc' .
'Description' .
'user1' .
'' .
date('c') . '' . date('c') .
'Final' .
'';
} else {
$this->_docPropsCoreT =
' ' .
'' .
'TitleSubject' .
'2mdcDescription' .
'user' .
'1' .
'' . date('c') .
'' . date('c') . '';
}
}
/**
* Generate DocPropsCustom XML template
*
* @access private
*/
private function generateTemplateDocPropsCustom()
{
$this->_docPropsCustomT =
'' .
'' .
'true' .
'';
}
/**
* Generate RelsRels XML template
*
* @access private
*/
private function generateTemplateRelsRels()
{
$this->_relsRelsT =
'' .
'' .
$this->generateRELATIONSHIP(
'rId3', 'extended-properties', 'docProps/app.xml'
) .
'' .
$this->generateRELATIONSHIP(
'rId1', 'officeDocument', 'word/document.xml'
);
if ($this->_markAsFinal) {
$this->_relsRelsT .=
'';
}
$this->_relsRelsT .= '';
}
/**
* Generate WordDocument XML template
*
* @access private
*/
private function generateTemplateWordDocument()
{
$arrArgs = func_get_args();
//$this->generateSECTPR($arrArgs[0]);
$this->_wordDocumentC .= $this->_sectPr->saveXML($this->_sectPr->documentElement);//FIXME: I am insertying by hand the sections of the base template
if (!empty($this->_wordHeaderC)) {
$this->_wordDocumentC = str_replace(
'__GENERATEHEADERREFERENCE__',
'<' . CreateDocx::NAMESPACEWORD . ':headerReference ' .
CreateDocx::NAMESPACEWORD . ':type="default" r:id="rId' .
$this->_idWords['header'] . '">',
$this->_wordDocumentC
);
}
if (!empty($this->_wordFooterC)) {
$this->_wordDocumentC = str_replace(
'__GENERATEFOOTERREFERENCE__',
'<' . CreateDocx::NAMESPACEWORD . ':footerReference ' .
CreateDocx::NAMESPACEWORD . ':type="default" r:id="rId' .
$this->_idWords['footer'] . '">',
$this->_wordDocumentC
);
}
$this->_wordDocumentT =
'' .
'<' . CreateDocx::NAMESPACEWORD . ':document xmlns:ve=' .
'"http://schemas.openxmlformats.org/markup-compatibility/2006" ' .
'xmlns:o="urn:schemas-microsoft-com:office:office"' .
' xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006' .
'/relationships" xmlns:m="http://schemas.openxmlformats.org/' .
'officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml"'.
' xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/' .
'wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:' .
'office:word" xmlns:w="http://schemas.openxmlformats.org/' .
'wordprocessingml/2006/main" xmlns:wne="http://schemas' .
'.microsoft.com/office/word/2006/wordml">' .
$this->_background.
'<' . CreateDocx::NAMESPACEWORD . ':body>' .
$this->_wordDocumentC .
'' .
'';
$this->cleanTemplate();
}
/**
* Generate WordEndnotes XML template
*
* @access private
*/
private function generateTemplateWordEndnotes()
{
$this->_wordEndnotesT =
'' .
'<' . CreateDocx::NAMESPACEWORD . ':endnotes xmlns:ve' .
'="http://schemas.openxmlformats.org/markup-compatibility/2006" ' .
'xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="' .
'http://schemas.openxmlformats.org/officeDocument/2006/' .
'relationships" xmlns:m="http://schemas.openxmlformats.org/' .
'officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:' .
'vml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006' .
'/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:' .
'office:word" xmlns:w="http://schemas.openxmlformats.org/' .
'wordprocessingml/2006/main" xmlns:wne="http://schemas' .
'.microsoft.com/office/word/2006/wordml">' .
$this->_wordEndnotesC .
'';
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Endnotes.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'endnotes', 'endnotes.xml'
);
$this->generateOVERRIDE(
'/word/endnotes.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml' .
'.endnotes+xml'
);
}
/**
* Generate WordFontTable XML template
*
* @access private
*/
private function generateTemplateWordFontTable()
{
$this->_wordFontTableT =
'' .
'<' . CreateDocx::NAMESPACEWORD . ':fonts xmlns:r="http://' .
'schemas.openxmlformats.org/officeDocument/2006/' .
'relationships" xmlns:w="http://schemas.openxmlformats.org/' .
'wordprocessingml/2006/main">' . $this->_wordFontTableC .
'';
}
/**
* Generate WordFooter XML template
*
* @access private
*/
private function generateTemplateWordFooter()
{
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Footer.');
$this->_idWords['footer'] = self::$intIdWord;
$this->_wordFooterT =
'
<' . CreateDocx::NAMESPACEWORD . ':ftr xmlns:ve' .
'="http://schemas.openxmlformats.org/markup-compatibility/' .
'2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns' .
':r="http://schemas.openxmlformats.org/officeDocument/2006/' .
'relationships" xmlns:m="http://schemas.openxmlformats.org/' .
'officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml' .
'" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/' .
'wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:' .
'office:word" xmlns:w="http://schemas.openxmlformats.org/' .
'wordprocessingml/2006/main" xmlns:wne="http://schemas' .
'.microsoft.com/office/word/2006/wordml">' . $this->_wordFooterC .
'';
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'footer', 'footer.xml'
);
return 'rId' . self::$intIdWord;
}
/**
* Generate WordFootnotes XML template
*
* @access private
*/
private function generateTemplateWordFootnotes()
{
$this->_wordFootnotesT =
'' .
'<' . CreateDocx::NAMESPACEWORD . ':footnotes xmlns:ve="' .
'http://schemas.openxmlformats.org/markup-compatibility/2006" ' .
'xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="' .
'http://schemas.openxmlformats.org/officeDocument/2006/' .
'relationships" xmlns:m="http://schemas.openxmlformats.org/' .
'officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:' .
'vml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006' .
'/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:' .
'office:word" xmlns:w="http://schemas.openxmlformats.org/' .
'wordprocessingml/2006/main" xmlns:wne="http://schemas.microsoft' .
'.com/office/word/2006/wordml">' . $this->_wordFootnotesC .
'';
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Footnotes.');
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'footnotes', 'footnotes.xml'
);
$this->generateOVERRIDE(
'/word/footnotes.xml',
'application/vnd.openxmlformats-officedocument.wordprocessingml' .
'.footnotes+xml'
);
}
/**
* Generate WordHeader XML template
*
* @access private
*/
private function generateTemplateWordHeader()
{
self::$intIdWord++;
self::$log->debug('New ID ' . self::$intIdWord . ' . Header.');
$this->_idWords['header'] = self::$intIdWord;
$this->_wordHeaderT = '' .
'<' . CreateDocx::NAMESPACEWORD .
':hdr xmlns:ve="http://schemas.openxmlformats.org/markup' .
'-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:' .
'office:office" xmlns:r="http://schemas.openxmlformats.org/' .
'officeDocument/2006/relationships" xmlns:m="http://schemas' .
'.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:' .
'schemas-microsoft-com:vml" xmlns:wp="http://schemas' .
'.openxmlformats.org/drawingml/2006/wordprocessingDrawing" ' .
'xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="' .
'http://schemas.openxmlformats.org/wordprocessingml/2006/' .
'main" xmlns:wne="http://schemas.microsoft.com/office/word/' .
'2006/wordml"> ' . $this->_wordHeaderC .
'';
$this->_wordRelsDocumentRelsC .= $this->generateRELATIONSHIP(
'rId' . self::$intIdWord, 'header', 'header.xml'
);
return 'rId' . self::$intIdWord;
}
/**
* Generate WordNumbering XML template
*
* @access private
*/
private function generateTemplateWordNumbering()
{
$this->_wordNumberingT =
'' .
'' .
'' .
'' .
'' .
'' . '
' .
'' .
'' .
'' .
'' .
'' .
'' .
'' .
'' .
'' .
'' .
'' .
'';
}
/**
* Generate WordNumbering XML template
*
* @access private
*/
private function generateTemplateWordNumberingStyles()
{
$this->_wordNumberingT =
'' .
'' .
$this->_wordDocumentStyles . '' .
'';
}
/**
* Generate WordRelsDocumentRels XML template
*
* @access private
*/
private function generateTemplateWordRelsDocumentRels()
{
$this->_wordRelsDocumentRelsT =
'' .
'' . $this->_wordRelsDocumentRelsC .
'';
}
/**
* Generate WordRelsFooterRels XML template
*
* @access private
*/
private function generateTemplateWordRelsFooterRels()
{
$this->_wordRelsFooterRelsT =
'' .
'' . $this->_wordRelsFooterRelsC .
'';
}
/**
* Generate WordRelsHeaderRels XML template
*
* @access private
*/
private function generateTemplateWordRelsHeaderRels()
{
$this->_wordRelsHeaderRelsT =
'' .
'' . $this->_wordRelsHeaderRelsC .
'';
}
/**
* Generate WordSettings XML template
*
* @access private
*/
private function generateTemplateWordSettings()
{
$this->_wordSettingsT = $this->_wordSettingsC;
}
/**
* Generate WordStyles XML template
*
* @access private
*/
private function generateTemplateWordStyles()
{
$this->_wordStylesT =
'<' .
CreateDocx::NAMESPACEWORD . ':styles xmlns:r="http://' .
'schemas.openxmlformats.org/officeDocument/2006/relationships' .
'" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/' .
'2006/main">' . $this->_wordStylesC .
'';
}
/**
* Generate WordThemeTheme1 XML template
*
* @access private
*/
private function generateTemplateWordThemeTheme1()
{
$this->addTheme($this->_defaultFont);
$this->_wordThemeThemeT =
'<' .
CreateTheme1::NAMESPACEWORD . ':theme xmlns:a="http://' .
'schemas.openxmlformats.org/drawingml/2006/main" name="' .
'Tema de Office">' . $this->_wordThemeThemeC .
'';
}
/**
* Generate WordWebSettings XML template
*
* @access private
*/
private function generateTemplateWordWebSettings()
{
$this->_wordWebSettingsT = $this->_wordWebSettingsC;
}
/**
* Generates a TitlePg element in SectPr
*
* @access private
*/
private function generateTitlePg()
{
$foundNodes = $this->_sectPr->documentElement->getElementsByTagName('w:TitlePg');
if($foundNodes->length == 0){
$newSectNode = '';
$sectNode = $this->_sectPr->createDocumentFragment();
$sectNode->appendXML($newSectNode);
$refNode =$this->_sectPr->documentElement->appendChild($sectNode);
}
}
/**
* To add support of sys_get_temp_dir for PHP versions under 5.2.1
*
* @access private
* @return string
*/
public static function getTempDir() {
if ( !function_exists('sys_get_temp_dir')) {
function sys_get_temp_dir() {
if ($temp = getenv('TMP')) {
return $temp;
}
if ($temp = getenv('TEMP')) {
return $temp;
}
if ($temp = getenv('TMPDIR')) {
return $temp;
}
$temp = tempnam(__FILE__,'');
if (file_exists($temp)) {
unlink($temp);
return dirname($temp);
}
return null;
}
} else {
return sys_get_temp_dir();
}
}
/**
* Takes care of the links and images asociated with an HTML chunck processed
* by the embedHTML method
*
* @access private
* @param array $sFinalDocX an arry with the required link and image data
*/
private function HTMLRels($sFinalDocX, $options)
{
$relsLinks = '';
if ($options['target'] == 'defaultHeader' ||
$options['target'] == 'firstHeader' ||
$options['target'] == 'evenHeader' ||
$options['target'] == 'defaultFooter' ||
$options['target'] == 'firstFooter' ||
$options['target'] == 'evenFooter') {
foreach ($sFinalDocX[1] as $key => $value) {
$this->_relsHeaderFooterLink[$options['target']][] =
array('rId' => $key, 'url' => $value);
}
} else {
foreach ($sFinalDocX[1] as $key => $value) {
$relsLinks .= '';
}
if ($relsLinks != '') {
$relsNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$relsNode->appendXML($relsLinks);
$this->_wordRelsDocumentRelsT->documentElement->appendChild($relsNode);
}
}
$relsImages = '';
if($options['target'] == 'defaultHeader' ||
$options['target'] == 'firstHeader' ||
$options['target'] == 'evenHeader' ||
$options['target'] == 'defaultFooter' ||
$options['target'] == 'firstFooter' ||
$options['target'] == 'evenFooter'){
foreach ($sFinalDocX[2] as $key => $value) {
//We should remove the first three 'rId' characters in this case
$value = array_shift(explode('?', $value));
if (isset($options['downloadImages']) && $options['downloadImages']) {
$arrayExtension = explode('.', $value);
$extension = strtolower(array_pop($arrayExtension));
$predefinedExtensions = array('gif', 'png', 'jpg', 'jpeg', 'bmp');
if (!in_array($extension, $predefinedExtensions)) {
$this->generateDEFAULT($extension, 'image/'.$extension);
}
$this->_relsHeaderFooterImage[$options['target']][] = array('rId' => $key, 'extension' => $extension);
} else {
$this->_relsHeaderFooterExternalImage[$options['target']][] = array('rId' => $key, 'url' => $value);
}
}
} else {
foreach ($sFinalDocX[2] as $key => $value) {
$valueArray = explode('?', $value);
$value = array_shift($valueArray);
if (isset($options['downloadImages']) && $options['downloadImages']) {
$arrayExtension = explode('.', $value);
$extension = strtolower(array_pop($arrayExtension));
$predefinedExtensions = array('gif', 'png', 'jpg', 'jpeg', 'bmp');
if (! in_array($extension, $predefinedExtensions)) {
$this->generateDEFAULT($extension, 'image/'.$extension);
}
$relsImages .= '';
} else {
$relsImages .= '';
}
}
if ($relsImages != '') {
$relsNodeImages = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$relsNodeImages->appendXML($relsImages);
$this->_wordRelsDocumentRelsT->documentElement->appendChild($relsNodeImages);
}
}
}
/**
* Parse path dir
*
* @access private
* @param string $dir Directory path
*/
private function parsePath($dir)
{
$slash = 0;
$path = '';
if (($slash = strrpos($dir, '/')) !== false) {
$slash += 1;
$path = substr($dir, 0, $slash);
}
$punto = strpos(substr($dir, $slash), '.');
$nombre = substr($dir, $slash, $punto);
$extension = substr($dir, $punto + $slash + 1);
return array(
'path' => $path, 'nombre' => $nombre, 'extension' => $extension
);
}
/**
* Delete a file or recursively delete a directory
*
* @param string $str path to file or directory
*/
private function recursiveDelete($str){
if(is_file($str)){
return @unlink($str);
}
elseif(is_dir($str)){
$scan = glob(rtrim($str,'/').'/*');
foreach($scan as $index=>$path){
$this->recursiveDelete($path);
}
return @rmdir($str);
}
}
/**
*
* Adds directory contents recursively into a zip.
*
* @param string $fileName. The path to the dir to add.
*
* @param string $myZip. The zip where the contents of the dir should be added.
*
*/
private function recursiveInsert($myZip, $fileName, $basePath){
$length = strlen($basePath);
if(is_dir($fileName)){
$contentsDir = scandir($fileName);
foreach($contentsDir as $element){
if($element != "." && $element !=".."){
$this->recursiveInsert($myZip, $fileName."/".$element, $basePath);
}
}
}else{
$newName = substr($fileName, $length + 1);
$myZip->addFile($fileName, $newName);
}
}
/**
*
* Includes data in the setting.xml file.
*
* @param array $settings. The string with the nodes that should be included in the settings.xml file.
*
*/
private function includeSettings($data){
try{
$baseSettings = $this->_baseTemplateZip->getFromName('word/settings.xml');
if ($baseSettings == '') {
throw new Exception('Error while extracting the settings.xml file from the base template');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$settingsDoc = new DOMDocument();
$settingsDoc->loadXML($baseSettings);
$settings = $settingsDoc->documentElement;
foreach($data as $key => $value){
$newNode = $settingsDoc->createDocumentFragment();
$newNode->appendXML($value);
$settings->appendChild($newNode);
}
$settingsHandler = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "w+");
fwrite($settingsHandler, $settingsDoc->saveXML());
fclose($documentHandler);
}
/**
*
* Removes headers and footers.
*
*/
public function removeHeadersAndFooters(){
$this->removeHeaders();
$this->removeFooters();
}
/**
*
* Removes existing headers.
*
*/
public function removeHeaders(){
foreach($this->_relsHeader as $key => $value){
//Let us first remove the actual header files
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/'.$value);
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/_rels/'.$value.'.rels');
//Now we should modify the rels file
$relationships = $this->_wordRelsDocumentRelsT->getElementsByTagName('Relationship');
$counter = $relationships->length -1;
for($j=$counter; $j > -1; $j--){
$target = $relationships->item($j)->getAttribute('Target');
if($target == $value){
$this->_wordRelsDocumentRelsT->documentElement->removeChild($relationships->item($j));
}
}
//We should also remove the corresponding override tags from [Content_Types].xml
$overrides = $this->_contentTypeT->getElementsByTagName('Override');
$counter = $overrides->length -1;
for($j=$counter; $j > -1; $j--){
$target = $overrides->item($j)->getAttribute('PartName');
if($target == '/word/'.$value){
$this->_contentTypeT->documentElement->removeChild($overrides->item($j));
}
}
}
//We should change the section properties
$headers = $this->_sectPr->getElementsByTagName('headerReference');
$counter = $headers->length -1;
for($j=$counter; $j > -1; $j--){
$this->_sectPr->documentElement->removeChild($headers->item($j));
}
$titlePage = $this->_sectPr->getElementsByTagName('titlePg');
$counter = $titlePage->length -1;
for($j=$counter; $j > -1; $j--){
$this->_sectPr->documentElement->removeChild($titlePage->item($j));
}
//Finally, we remove, if it exists, the evenAndOddHeader element from settings
$this->removeSetting('w:evenAndOddHeaders');
}
/**
*
* Removes existing footers.
*
*/
public function removeFooters(){
foreach($this->_relsFooter as $key => $value){
//Let us first remove the actual header files
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/'.$value);
$this->recursiveDelete($this->_baseTemplateFilesPath.'/word/_rels/'.$value.'.rels');
//Now we should modify the rels file
$relationships = $this->_wordRelsDocumentRelsT->getElementsByTagName('Relationship');
$counter = $relationships->length -1;
for($j=$counter; $j > -1; $j--){
$target = $relationships->item($j)->getAttribute('Target');
if($target == $value){
$this->_wordRelsDocumentRelsT->documentElement->removeChild($relationships->item($j));
}
}
//We should also remove the corresponding override tags from [Content_Types].xml
$overrides = $this->_contentTypeT->getElementsByTagName('Override');
$counter = $overrides->length -1;
for($j=$counter; $j > -1; $j--){
$target = $overrides->item($j)->getAttribute('PartName');
if($target == '/word/'.$value){
$this->_contentTypeT->documentElement->removeChild($overrides->item($j));
}
}
}
//We should change the section properties
$footers = $this->_sectPr->getElementsByTagName('footerReference');
$counter = $footers->length -1;
for($j=$counter; $j > -1; $j--){
$this->_sectPr->documentElement->removeChild($footers->item($j));
}
$titlePage = $this->_sectPr->getElementsByTagName('titlePg');
$counter = $titlePage->length -1;
for($j=$counter; $j > -1; $j--){
$this->_sectPr->documentElement->removeChild($titlePage->item($j));
}
//Finally, we remove, if it exists, the evenAndOddHeader element from settings
$this->removeSetting('w:evenAndOddHeaders');
}
/**
* Removes an element from settings.xml
*
* @access private
*/
private function removeSetting($tag)
{
try{
$settings = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "r");
$baseTemplateSettingsT = fread($settings, 1000000);
fclose($settings);
if ($baseTemplateSettingsT == '') {
throw new Exception('Error while extracting settings.xml file from the base template to remove the tag element');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$this->_wordSettingsT = new DOMDocument();
$this->_wordSettingsT->loadXML($baseTemplateSettingsT);
$settingsHeader = $this->_wordSettingsT->documentElement->getElementsByTagName($tag);
if($settingsHeader->length > 0){
$this->_wordSettingsT->documentElement->removeChild($settingsHeader->item(0));
$newSettings = $this->_wordSettingsT->saveXML();
$settingsHandle = fopen($this->_baseTemplateFilesPath.'/word/settings.xml', "w+");
$contents = fwrite($settingsHandle, $newSettings);
fclose($settingsHandle);
}
}
/**
*
* Inserts a new numbering style.
*
* @param string $numberingsXML the numberings.xml that we wish to modify
* @param string $newNumbering the new numbering style we wish to add.
* @param string $numberId a unique integer tha determines the numbering id
* and the abstract numbering id
*/
public function importSingleNumbering($numberingsXML, $newNumbering, $numberId, $originalAbstractNumId=''){
//First we insert the $newNumbering into $numberingsXML
$myNumbering = new DOMDocument();
$myNumbering->loadXML($numberingsXML);
//Let us now modify the w:abstractNumId atribute
$newNumbering = str_replace('createDocumentFragment();
$new->appendXML($newNumbering);
$base = $myNumbering->documentElement->firstChild;
$base->parentNode->insertBefore($new, $base);
$numberingsXML = $myNumbering->saveXML();
//Now we include the relationshiop
$newNum = '';
$numberingsXML = str_replace('', $newNum.'', $numberingsXML);
return $numberingsXML;
}
/**
*
* creates an empty word numbering base string
*/
public function generateBaseWordNumbering(){
//We copy the numbering.xml file from the standard PHPDocX template into the new base template
$numZip = new ZipArchive();
try {
$openNumZip = $numZip->open(PHPDOCX_BASE_TEMPLATE);
if ($openNumZip !== true){
throw new Exception('Error while opening the standard base template to extract the word/numbering.xml file');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$baseWordNumbering = $numZip->getFromName('word/numbering.xml');
return $baseWordNumbering;
}
/**
*
* Inserts new headers and/or footers from a word file.
*
* @example ../examples/easy/ImportHeaderAndFooter.php
* @param string $path. Path to the docx from which we wish to import the header and/or footer
* @param string $type. Declares if we want to import only the header, only the footer or both.
* Values: header, footer, headerAndFooter (default value)
* @param array $options
* Values:
* 'first' (boolean) defaults to false
*/
public function importHeadersAndFooters($path, $type='headerAndFooter'){
switch ($type){
case 'headerAndFooter':
$this->removeHeadersAndFooters();
break;
case 'header':
$this->removeHeaders();
break;
case 'footer':
$this->removeFooters();
break;
}
//Let us first get parse and extract the relevant files from the docx with the new headers/footers
try {
$baseHeadersFooters = new ZipArchive();
$openHeadersFooters = $baseHeadersFooters->open($path);
if ($openHeadersFooters !== true){
throw new Exception('Error while opening the docx to extract the header and/or footer');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We now extract its contents into a temp dir for further manipulation
try {
$baseHeadersFootersFilesPath = $this->_tempDir.'/'.uniqid(true);
$extractHeadersFooters =$baseHeadersFooters->extractTo($baseHeadersFootersFilesPath);
if ($extractHeadersFooters !== true) {
throw new Exception('Error while extracting the contents of the docx file that containes the header and/or footer: there may be problems writing in the default tmp folder');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//We need to extract the different roles: default, even or first played by the different headers and footers
//In order to do that we should first parse the node sectPr from the document.xml file
try{
$docHeadersFooters = $baseHeadersFooters->getFromName('word/document.xml');
if ($docHeadersFooters == '') {
throw new Exception('Error while extracting the document.xml file from the docx from which we want to get the feaders and/or footers');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$docHeadersFootersContent = new DOMDocument();
$docHeadersFootersContent ->loadXML($docHeadersFooters);
//We now extract the first sectPr element in the document
$docSectPr = $docHeadersFootersContent->getElementsByTagName('sectPr')->item(0);
$headerTypes = array();
$footerTypes = array();
$titlePg = false;
foreach($docSectPr->childNodes as $value){
if($value->nodeName == 'w:headerReference'){
$headerTypes[$value->getAttribute('r:id')] = $value->getAttribute('w:type');
}else if($value->nodeName == 'w:footerReference'){
$footerTypes[$value->getAttribute('r:id')] = $value->getAttribute('w:type');
}
}
//We now should chek if the first and even headers and footers are shown in the original Word document
$titlePg = false;
if($docHeadersFootersContent->getElementsByTagName('titlePg')->length > 0){
$titlePg = true;
}
try{
$settingsHeadersFooters = $baseHeadersFooters->getFromName('word/settings.xml');
if ($settingsHeadersFooters == '') {
throw new Exception('Error while extracting the settings.xml file from the docx from which we want to get the headers and/or footers');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
$settingsHeadersFootersContent = new DOMDocument();
$settingsHeadersFootersContent ->loadXML($settingsHeadersFooters);
if($settingsHeadersFootersContent->getElementsByTagName('evenAndOddHeaders')->length > 0){
$this->generateSetting('w:evenAndOddHeaders');
}
//Let us read the _rels/document.xml.rels to see which footers and headers we do have to get
try{
$baseHeadersFootersRelsT = $baseHeadersFooters->getFromName('word/_rels/document.xml.rels');
if ($baseHeadersFootersRelsT == '') {
throw new Exception('Error while extracting the document.xml.rels file from the docx from which we want to get the feaders and/or footers');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//Let us analyze its structure
//In order to do that we should parse word/_rels/document.xml.rels
$wordHeadersFootersRelsT = new DOMDocument();
$wordHeadersFootersRelsT->loadXML($baseHeadersFootersRelsT);
$relationships = $wordHeadersFootersRelsT->getElementsByTagName('Relationship');
$counter = $relationships->length -1;
for($j=$counter; $j > -1; $j--){
$rId = $relationships->item($j)->getAttribute('Id');
$completeType = $relationships->item($j)->getAttribute('Type');
$target = $relationships->item($j)->getAttribute('Target');
$myType = array_pop(explode('/', $completeType));
switch($myType){
case 'header':
$relsHeader[$rId]= $target;
break;
case 'footer':
$relsFooter[$rId]= $target;
break;
}
}
//Let start the looping over the $relsHeader and/or $relsFooter arrays
if($type == 'headerAndFooter' || $type == 'header'){
foreach ($relsHeader as $key => $value){
//First we check if there is a rels file for each header
if(file_exists($baseHeadersFootersFilesPath.'/word/_rels/'.$value.'.rels')){
try{
$headersRelsT = $baseHeadersFooters->getFromName('word/_rels/'.$value.'.rels');
if ($headersRelsT == '') {
throw new Exception('Error while extracting the rels file for the header');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//Now we should parse the corresponding rels file to copy and rename the images included in the header
$wordHeadersRelsT = new DOMDocument();
$wordHeadersRelsT->loadXML($headersRelsT);
$relations = $wordHeadersRelsT->getElementsByTagName('Relationship');
$countrels = $relations->length -1;
for($j=$countrels; $j > -1; $j--){
$completeType = $relations->item($j)->getAttribute('Type');
$target = $relations->item($j)->getAttribute('Target');
$myType = array_pop(explode('/', $completeType));
switch($myType){
case 'image':
$refExtension = array_pop(explode('.', $target));
$refImage = 'media/image'.uniqid(true).'.'.$refExtension;
//We change the attibute to the new name
$relations->item($j)->setAttribute('Target', $refImage);
//We copy the image in the base template with the new name
if(!file_exists($this->_baseTemplateFilesPath.'/word/media')){
$test2 = mkdir($this->_baseTemplateFilesPath.'/word/media');
}
copy($baseHeadersFootersFilesPath.'/word/'.$target, $this->_baseTemplateFilesPath.'/word/'.$refImage);
//We copy the associated rels file
$newRels = fopen($this->_baseTemplateFilesPath.'/word/_rels/'.$value.'.rels', 'w+');
fwrite($newRels, $wordHeadersRelsT->saveXML());
//We should make sure that the corresponding image types are included in [Content_Types].xml
$imageTypeFound = false;
foreach($this->_contentTypeT->documentElement->childNodes as $node){
if ($node->nodeName == 'Default' && $node->getAttribute('Extension') == $refExtension){
$imageTypeFound = true;
}
}
if(!$imageTypeFound){
$newDefaultNode = '';
$newDefault = $this->_contentTypeT->createDocumentFragment();
$newDefault->appendXML($newDefaultNode);
$baseDefaultNode =$this->_contentTypeT->documentElement;
$baseDefaultNode->appendChild($newDefault);
}
break;
}
}
}
//Now we copy the corresponding header xml files
copy($baseHeadersFootersFilesPath.'/word/'.$value, $this->_baseTemplateFilesPath.'/word/'.$value);
//We should now modify the /_rels/document.xml.rels of the base template to include the new element
$newId = uniqid(true);
$newHeaderNode = '';
$newNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$newNode->appendXML($newHeaderNode);
$baseNode =$this->_wordRelsDocumentRelsT->documentElement;
$baseNode->appendChild($newNode);
//As well as the section DOMNode
$newSectNode = '';
$sectNode = $this->_sectPr->createDocumentFragment();
$sectNode->appendXML($newSectNode);
$refNode =$this->_sectPr->documentElement->childNodes->item(0);
$refNode->parentNode->insertBefore($sectNode, $refNode);
//And we have to include the corresponding in [Content_Types].xml
$newOverrideNode = '';
$newOverride = $this->_contentTypeT->createDocumentFragment();
$newOverride->appendXML($newOverrideNode);
$baseOverrideNode =$this->_contentTypeT->documentElement;
$baseOverrideNode->appendChild($newOverride);
}
}
if($type == 'headerAndFooter' || $type == 'footer'){
foreach ($relsFooter as $key => $value){
//First we check if there is a rels file for each header
if(file_exists($baseHeadersFootersFilesPath.'/word/_rels/'.$value.'.rels')){
try{
$footersRelsT = $baseHeadersFooters->getFromName('word/_rels/'.$value.'.rels');
if ($footersRelsT == '') {
throw new Exception('Error while extracting the rels file for the footer');
}
}
catch (Exception $e) {
self::$log->fatal($e->getMessage());
exit();
}
//Now we should parse the corresponding rels file to copy and rename the images included in the header
$wordFootersRelsT = new DOMDocument();
$wordFootersRelsT->loadXML($footersRelsT);
$relations = $wordFootersRelsT->getElementsByTagName('Relationship');
$countrels = $relations->length -1;
for($j=$countrels; $j > -1; $j--){
$completeType = $relations->item($j)->getAttribute('Type');
$target = $relations->item($j)->getAttribute('Target');
$myType = array_pop(explode('/', $completeType));
switch($myType){
case 'image':
$refExtension = array_pop(explode('.', $target));
$refImage = 'media/image'.uniqid(true).'.'.$refExtension;
//We change the attibute to the new name
$relations->item($j)->setAttribute('Target', $refImage);
//We copy the image in the base template with the new name
if(!file_exists($this->_baseTemplateFilesPath.'/word/media')){
$test2 = mkdir($this->_baseTemplateFilesPath.'/word/media');
}
copy($baseHeadersFootersFilesPath.'/word/'.$target, $this->_baseTemplateFilesPath.'/word/'.$refImage);
//We copy the associated rels file
$newRels = fopen($this->_baseTemplateFilesPath.'/word/_rels/'.$value.'.rels', 'w+');
fwrite($newRels, $wordFootersRelsT->saveXML());
//We should make sure that the corresponding image types are included in [Content_Types].xml
$imageTypeFound = false;
foreach($this->_contentTypeT->documentElement->childNodes as $node){
if ($node->nodeName == 'Default' && $node->getAttribute('Extension') == $refExtension){
$imageTypeFound = true;
}
}
if(!$imageTypeFound){
$newDefaultNode = '';
$newDefault = $this->_contentTypeT->createDocumentFragment();
$newDefault->appendXML($newDefaultNode);
$baseDefaultNode =$this->_contentTypeT->documentElement;
$baseDefaultNode->appendChild($newDefault);
}
break;
}
}
}
//Now we copy the corresponding header xml files
copy($baseHeadersFootersFilesPath.'/word/'.$value, $this->_baseTemplateFilesPath.'/word/'.$value);
//We should now modify the /_rels/document.xml.rels of the base template to include the new element
$newId = uniqid(true);
$newFooterNode = '';
$newNode = $this->_wordRelsDocumentRelsT->createDocumentFragment();
$newNode->appendXML($newFooterNode);
$baseNode =$this->_wordRelsDocumentRelsT->documentElement;
$baseNode->appendChild($newNode);
//As well as the section DOMNode
$newSectNode = '';
$sectNode = $this->_sectPr->createDocumentFragment();
$sectNode->appendXML($newSectNode);
$refNode =$this->_sectPr->documentElement->childNodes->item(0);
$refNode->parentNode->insertBefore($sectNode, $refNode);
//And we have to include the corresponding in [Content_Types].xml
$newOverrideNode = '';
$newOverride = $this->_contentTypeT->createDocumentFragment();
$newOverride->appendXML($newOverrideNode);
$baseOverrideNode =$this->_contentTypeT->documentElement;
$baseOverrideNode->appendChild($newOverride);
}
}
if($titlePg){
$this->generateTitlePg();
}
}
}