wrklst / docxmustache

src/WrkLst/DocxMustache/DocxMustache.php

Doc Comments +13 added lines

@@ -100,6 +100,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);
@@ -127,6 +130,10 @@ 
 
     }
 
+    /**
+     * @param string $file
+     * @param string|false $folder
+     */
     protected function SaveOpenXmlFile($file,$folder,$content)
     {
         \Storage::disk($this->storageDisk)
@@ -214,6 +221,9 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $main_file
+     */
     protected function FetchReplaceableImages(&$main_file, $ns)
     {
         //set up basic arrays to keep track of imgs
@@ -317,6 +327,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $data
+     */
     protected function ResampleImage($imgs, $k, $data)
     {
         \Storage::disk($this->storageDisk)->put($this->local_path.'word/media/'.$imgs[$k]['img_file_src'], $data);

Spacing +12 added lines, -12 removed lines

@@ -100,11 +100,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))
             {
@@ -115,7 +115,7 @@ 
             }
         } else
         {
-            if($xml_object = simplexml_load_file($this->storagePath($this->local_path.$file)))
+            if ($xml_object = simplexml_load_file($this->storagePath($this->local_path.$file)))
             {
                 return $xml_object;
             }
@@ -127,7 +127,7 @@ 
 
     }
 
-    protected function SaveOpenXmlFile($file,$folder,$content)
+    protected function SaveOpenXmlFile($file, $folder, $content)
     {
         \Storage::disk($this->storageDisk)
             ->put($this->local_path.$file, $content);
@@ -140,7 +140,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');
         $this->word_doc = $this->MustacheRender($this->items, $this->word_doc);
@@ -150,7 +150,7 @@ 
 
         $this->log('Compact Template with Data');
 
-        $this->SaveOpenXmlFile('word/document.xml','word',$this->word_doc);
+        $this->SaveOpenXmlFile('word/document.xml', 'word', $this->word_doc);
         $this->zipper->close();
     }
 
@@ -169,7 +169,7 @@ 
 
     protected function MustacheRender($items, $mustache_template, $clean_tags = true)
     {
-        if($clean_tags)
+        if ($clean_tags)
             $mustache_template = $this->MustacheTagCleaner($mustache_template);
 
         $m = new \Mustache_Engine(array('escape' => function($value) {
@@ -183,7 +183,7 @@ 
 
     protected function AddContentType($imageCt = "jpeg")
     {
-        $ct_file = $this->ReadOpenXmlFile('[Content_Types].xml','object');
+        $ct_file = $this->ReadOpenXmlFile('[Content_Types].xml', 'object');
 
         //check if content type for jpg has been set
         $i = 0;
@@ -206,7 +206,7 @@ 
 
             if ($ct_file_xml = $ct_file->asXML())
             {
-                $this->SaveOpenXmlFile('[Content_Types].xml',false,$ct_file_xml);
+                $this->SaveOpenXmlFile('[Content_Types].xml', false, $ct_file_xml);
             } else
             {
                 throw new Exception('Cannot generate xml for [Content_Types].xml.');
@@ -361,7 +361,7 @@ 
         foreach ($imgs as $k=>$img)
         {
             //get file type of img and test it against supported imgs
-            if($imgageData = $this->GetImageFromUrl($img['url']))
+            if ($imgageData = $this->GetImageFromUrl($img['url']))
             {
                 $imgs[$k]['img_file_src'] = str_replace("wrklstId", "wrklst_image", $img['id']).$allowed_imgs[$imgageData['mime']];
                 $imgs[$k]['img_file_dest'] = str_replace("wrklstId", "wrklst_image", $img['id']).'.jpeg';
@@ -417,7 +417,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);
 
@@ -428,7 +428,7 @@ 
 
         if ($rels_file_xml = $rels_file->asXML())
         {
-            $this->SaveOpenXmlFile('word/_rels/document.xml.rels','word/_rels',$rels_file_xml);
+            $this->SaveOpenXmlFile('word/_rels/document.xml.rels', 'word/_rels', $rels_file_xml);
         } else
         {
             throw new Exception('Cannot generate xml for word/_rels/document.xml.rels.');

Braces +7 added lines, -6 removed lines

@@ -60,8 +60,9 @@ 
     {
         //introduce logging method here to keep track of process
         // can be overwritten in extended class to log with custom preocess logger
-        if ($this->verbose)
-            Log::error($msg);
+        if ($this->verbose) {
+                    Log::error($msg);
+        }
     }
 
     public function cleanUpTmpDirs()
@@ -118,8 +119,7 @@ 
             if($xml_object = simplexml_load_file($this->storagePath($this->local_path.$file)))
             {
                 return $xml_object;
-            }
-            else
+            } else
             {
                 throw new Exception('Cannot load XML Object from file '.$file);
             }
@@ -169,8 +169,9 @@ 
 
     protected function MustacheRender($items, $mustache_template, $clean_tags = true)
     {
-        if($clean_tags)
-            $mustache_template = $this->MustacheTagCleaner($mustache_template);
+        if($clean_tags) {
+                    $mustache_template = $this->MustacheTagCleaner($mustache_template);
+        }
 
         $m = new \Mustache_Engine(array('escape' => function($value) {
             if (str_replace('*[[DONOTESCAPE]]*', '', $value) != $value) {