Add reading of the settings part

Author: troosan

src/PhpWord/TemplateProcessor.php

@@ -49,6 +49,13 @@ class TemplateProcessor
      */
     protected $tempDocumentMainPart;
 
+    /**
+     * Content of settings part (in XML format) of the temporary document
+     *
+     * @var string
+     */
+    protected $tempDocumentSettingsPart;
+
     /**
      * Content of headers (in XML format) of the temporary document
      *
@@ -120,6 +127,7 @@ public function __construct($documentTemplate)
         }
 
         $this->tempDocumentMainPart = $this->readPartWithRels($this->getMainPartName());
+        $this->tempDocumentSettingsPart = $this->readPartWithRels($this->getSettingsPartName());
         $this->tempDocumentContentTypes = $this->zipClass->getFromName($this->getDocumentContentTypesName());
     }
 
@@ -792,6 +800,22 @@ public function deleteBlock($blockname)
         $this->replaceBlock($blockname, '');
     }
 
+    /**
+     * Automatically Recalculate Fields on Open
+     *
+     * @param bool $update
+     */
+    public function setUpdateFields($update = true)
+    {
+        $string = $update ? 'true' : 'false';
+        $matches = array();
+        if (preg_match('/<w:updateFields w:val=\"(true|false|1|0|on|off)\"\/>/', $this->tempDocumentSettingsPart, $matches)) {
+            $this->tempDocumentSettingsPart = str_replace($matches[0], '<w:updateFields w:val="' . $string . '"/>', $this->tempDocumentSettingsPart);
+        } else {
+            $this->tempDocumentSettingsPart = str_replace('</w:settings>', '<w:updateFields w:val="' . $string . '"/></w:settings>', $this->tempDocumentSettingsPart);
+        }
+    }
+
     /**
      * Saves the result document.
      *
@@ -806,6 +830,7 @@ public function save()
         }
 
         $this->savePartWithRels($this->getMainPartName(), $this->tempDocumentMainPart);
+        $this->savePartWithRels($this->getSettingsPartName(), $this->tempDocumentSettingsPart);
 
         foreach ($this->tempDocumentFooters as $index => $xml) {
             $this->savePartWithRels($this->getFooterName($index), $xml);
@@ -943,6 +968,16 @@ protected function getMainPartName()
         return array_key_exists(1, $matches) ? $matches[1] : 'word/document.xml';
     }
 
+    /**
+     * The name of the file containing the Settings part
+     *
+     * @return string
+     */
+    protected function getSettingsPartName()
+    {
+        return 'word/settings.xml';
+    }
+
     /**
      * Get the name of the footer file for $index.
      *

tests/PhpWord/TemplateProcessorTest.php

@@ -830,4 +830,18 @@ public function testShouldReturnFalseIfXmlBlockNotFound()
         $result = $templateProcessor->findContainingXmlBlockForMacro('${macro}', 'w:rPr');
         $this->assertFalse($result);
     }
+
+    public function testShouldMakeFieldsUpdateOnOpen()
+    {
+        $settingsPart = '<w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+            <w:zoom w:percent="100"/>
+        </w:settings>';
+        $templateProcessor = new TestableTemplateProcesor(null, $settingsPart);
+
+        $templateProcessor->setUpdateFields(true);
+        $this->assertContains('<w:updateFields w:val="true"/>', $templateProcessor->getSettingsPart());
+
+        $templateProcessor->setUpdateFields(false);
+        $this->assertContains('<w:updateFields w:val="false"/>', $templateProcessor->getSettingsPart());
+    }
 }

tests/PhpWord/_includes/TestableTemplateProcesor.php

@@ -25,9 +25,10 @@
  */
 class TestableTemplateProcesor extends TemplateProcessor
 {
-    public function __construct($mainPart = null)
+    public function __construct($mainPart = null, $settingsPart = null)
     {
         $this->tempDocumentMainPart = $mainPart;
+        $this->tempDocumentSettingsPart = $settingsPart;
     }
 
     public function fixBrokenMacros($documentPart)
@@ -74,4 +75,12 @@ public function getMainPart()
     {
         return $this->tempDocumentMainPart;
     }
+
+    /**
+     * @return string
+     */
+    public function getSettingsPart()
+    {
+        return $this->tempDocumentSettingsPart;
+    }
 }