wrklst / docxmustache

src/WrkLst/DocxMustache/DocImage.php

Doc Comments +7 added lines

@@ -14,6 +14,9 @@ 
         ];
     }
 
+    /**
+     * @param string $manipulation
+     */
     public function GetImageFromUrl($url, $manipulation)
     {
         $allowed_imgs = $this->AllowedContentTypeImages();
@@ -38,6 +41,10 @@ 
         return false;
     }
 
+    /**
+     * @param DocxMustache $parent
+     * @param string $data
+     */
     public function ResampleImage($parent, $imgs, $k, $data, $dpi = 72)
     {
         \Storage::disk($parent->storageDisk)->put($parent->local_path.'word/media/'.$imgs[$k]['img_file_src'], $data);

Spacing +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
 
         //rework img to new size and jpg format
         $img_rework = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
-        if($dpi!=72) $img_rework2 = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
+        if ($dpi != 72) $img_rework2 = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
 
         $imgWidth = $img_rework->width();
         $imgHeight = $img_rework->height();
@@ -73,17 +73,17 @@ 
         //for getting non high dpi measurements, as the document is on 72 dpi.
         //TODO: this should be improved. it does not really need the resampling to identify the new sizes.
         //instead this should just be calculated, as resampling the image is too process instensive.
-        $img_rework->resize($w, $h, function ($constraint) {
+        $img_rework->resize($w, $h, function($constraint) {
             $constraint->aspectRatio();
             $constraint->upsize();
         });
         $new_height = $img_rework->height();
         $new_width = $img_rework->width();
 
-        if($dpi!=72)
+        if ($dpi != 72)
         {
             //for storing the image in high dpi, so it has good quality on high dpi screens
-            $img_rework2->resize(((int)$w*($dpi/72)), $h, function ($constraint) { // make high dpi version for actual storage
+            $img_rework2->resize(((int) $w * ($dpi / 72)), $h, function($constraint) { // make high dpi version for actual storage
                 $constraint->aspectRatio();
                 $constraint->upsize();
             });

Braces +4 added lines, -3 removed lines

@@ -44,7 +44,9 @@ 
 
         //rework img to new size and jpg format
         $img_rework = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
-        if($dpi!=72) $img_rework2 = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
+        if($dpi!=72) {
+            $img_rework2 = \Image::make($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_src']));
+        }
 
         $imgWidth = $img_rework->width();
         $imgHeight = $img_rework->height();
@@ -97,8 +99,7 @@ 
             $im->clear();
             $im->destroy();
             */
-        }
-        else {
+        } else {
             $img_rework->save($parent->StoragePath($parent->local_path.'word/media/'.$imgs[$k]['img_file_dest']));
         }
 

src/WrkLst/DocxMustache/DocxMustache.php

Doc Comments +13 added lines

@@ -101,6 +101,9 @@ 
             ->extractTo($this->StoragePath($this->local_path), [$file], \Chumper\Zipper\Zipper::WHITELIST);
     }
 
+    /**
+     * @param string $file
+     */
     protected function ReadOpenXmlFile($file, $type = 'file')
     {
         $this->exctractOpenXmlFile($file);
@@ -133,6 +136,10 @@ 
         }
     }
 
+    /**
+     * @param string $file
+     * @param false|string $folder
+     */
     protected function SaveOpenXmlObjectToFile($xmlObject, $file, $folder)
     {
         if ($xmlString = $xmlObject->asXML()) {
@@ -142,6 +149,9 @@ 
         }
     }
 
+    /**
+     * @param integer $dpi
+     */
     public function ReadTeamplate($dpi)
     {
         $this->Log('Analyze Template');
@@ -190,6 +200,9 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $main_file
+     */
     protected function FetchReplaceableImages(&$main_file, $ns)
     {
         //set up basic arrays to keep track of imgs

Spacing +11 added lines, -11 removed lines

@@ -39,7 +39,7 @@ 
         $this->verbose = false;
     }
 
-    public function Execute($dpi=72)
+    public function Execute($dpi = 72)
     {
         $this->CopyTmplate();
         $this->ReadTeamplate($dpi);
@@ -166,7 +166,7 @@ 
     {
         $ct_file = $this->ReadOpenXmlFile('[Content_Types].xml', 'object');
 
-        if (! ($ct_file instanceof \Traversable)) {
+        if (!($ct_file instanceof \Traversable)) {
             throw new Exception('Cannot traverse through [Content_Types].xml.');
         }
 
@@ -182,7 +182,7 @@ 
 
         //if content type for jpg has not been set, add it to xml
         // and save xml to file and add it to the archive
-        if (! $ct_already_set) {
+        if (!$ct_already_set) {
             $sxe = $ct_file->addChild('Default');
             $sxe->addAttribute('Extension', $imageCt);
             $sxe->addAttribute('ContentType', 'image/'.$imageCt);
@@ -313,7 +313,7 @@ 
         libxml_use_internal_errors(true);
         $main_file = simplexml_load_string($this->word_doc);
 
-        if(gettype($main_file) == "object")
+        if (gettype($main_file) == "object")
         {
             $this->Log('Merge Images into Template');
 
@@ -362,8 +362,8 @@ 
     */
     protected function display_xml_error($error, $xml)
     {
-        $return  = $xml[$error->line - 1] . "\n";
-        $return .= str_repeat('-', $error->column) . "^\n";
+        $return  = $xml[$error->line - 1]."\n";
+        $return .= str_repeat('-', $error->column)."^\n";
 
         switch ($error->level) {
             case LIBXML_ERR_WARNING:
@@ -377,8 +377,8 @@ 
                 break;
         }
 
-        $return .= trim($error->message) .
-                   "\n  Line: $error->line" .
+        $return .= trim($error->message).
+                   "\n  Line: $error->line".
                    "\n  Column: $error->column";
 
         if ($error->file) {
@@ -421,7 +421,7 @@ 
             $valid = true;
 
             //TODO: create a better url validity check
-            if (! trim(str_replace(['http', 'https', ':', ' '], '', $url)) || $url == str_replace('http', '', $url)) {
+            if (!trim(str_replace(['http', 'https', ':', ' '], '', $url)) || $url == str_replace('http', '', $url)) {
                 $valid = false;
             }
             $mode = 'url';
@@ -444,7 +444,7 @@ 
             $valid = true;
 
             //check if path starts with storage path
-            if (! starts_with($path, storage_path())) {
+            if (!starts_with($path, storage_path())) {
                 $valid = false;
             }
             $mode = 'path';
@@ -482,7 +482,7 @@ 
             //wait until process is ready
         }
         // executes after the command finishes
-        if (! $process->isSuccessful()) {
+        if (!$process->isSuccessful()) {
             throw new \Symfony\Component\Process\Exception\ProcessFailedException($process);
         } else {
             $path_parts = pathinfo($this->StoragePath($this->local_path.$this->template_file_name));