wrklst / docxmustache

src/WrkLst/DocxMustache/DocxMustache.php

Doc Comments +10 added lines

@@ -101,6 +101,9 @@ 
             ->extractTo($this->storagePath($this->local_path), array($file), \Chumper\Zipper\Zipper::WHITELIST);
     }
 
+    /**
+     * @param string $file
+     */
     protected function ReadOpenXmlFile($file, $type="file")
     {
         $this->exctractOpenXmlFile($file);
@@ -126,6 +129,10 @@ 
         }
     }
 
+    /**
+     * @param string $file
+     * @param string|false $folder
+     */
     protected function saveOpenXmlFile($file, $folder, $content)
     {
         \Storage::disk($this->storageDisk)
@@ -193,6 +200,9 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $main_file
+     */
     protected function FetchReplaceableImages(&$main_file, $ns)
     {
         //set up basic arrays to keep track of imgs

Spacing +5 added lines, -5 removed lines

@@ -101,11 +101,11 @@ 
             ->extractTo($this->storagePath($this->local_path), array($file), \Chumper\Zipper\Zipper::WHITELIST);
     }
 
-    protected function ReadOpenXmlFile($file, $type="file")
+    protected function ReadOpenXmlFile($file, $type = "file")
     {
         $this->exctractOpenXmlFile($file);
 
-        if($type=="file")
+        if ($type == "file")
         {
             if ($file_contents = \Storage::disk($this->storageDisk)->get($this->local_path.$file))
             {
@@ -139,7 +139,7 @@ 
     {
         $this->log('Analyze Template');
         //get the main document out of the docx archive
-        $this->word_doc = ReadOpenXmlFile('word/document.xml','file');
+        $this->word_doc = ReadOpenXmlFile('word/document.xml', 'file');
 
         $this->log('Merge Data into Template');
 
@@ -157,7 +157,7 @@ 
 
     protected function AddContentType($imageCt = "jpeg")
     {
-        $ct_file = $this->ReadOpenXmlFile('[Content_Types].xml','object');
+        $ct_file = $this->ReadOpenXmlFile('[Content_Types].xml', 'object');
 
         if (!($ct_file instanceof \Traversable)) {
             throw new Exception('Cannot traverse through [Content_Types].xml.');
@@ -330,7 +330,7 @@ 
         $imgs = $replaceableImage['imgs'];
         $imgs_replaced = $replaceableImage['imgs_replaced'];
 
-        $rels_file = $this->ReadOpenXmlFile('word/_rels/document.xml.rels','object');
+        $rels_file = $this->ReadOpenXmlFile('word/_rels/document.xml.rels', 'object');
 
         $this->RemoveReplaceImages($imgs_replaced, $rels_file);