dompdf / dompdf

lib/Cpdf.php

Doc Comments +57 added lines, -57 removed lines

@@ -375,8 +375,8 @@ 
     /**
      * Destination object, used to specify the location for the user to jump to, presently on opening
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return string|null
      */
@@ -421,7 +421,7 @@ 
      * set the viewer preferences
      *
      * @param $id
-     * @param $action
+     * @param string $action
      * @param string|array $options
      * @return string|null
      */
@@ -529,8 +529,8 @@ 
     /**
      * define the document catalog, the overall controller for the document
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string|array $options
      * @return string|null
      */
@@ -603,8 +603,8 @@ 
     /**
      * object which is a parent to the pages in the document
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return string|null
      */
@@ -751,8 +751,8 @@ 
     /**
      * define the outlines in the doc, empty for now
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return string|null
      */
@@ -793,8 +793,8 @@ 
     /**
      * an object to hold the font description
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string|array $options
      * @return string|null
      */
@@ -954,8 +954,8 @@ 
     /**
      * A toUnicode section, needed for unicode fonts
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @return null|string
      */
     protected function o_toUnicode($id, $action)
@@ -1014,8 +1014,8 @@ 
     /**
      * a font descriptor, needed for including additional fonts
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1079,8 +1079,8 @@ 
     /**
      * the font encoding
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1133,7 +1133,7 @@ 
      * a descendent cid font, needed for unicode fonts
      *
      * @param $id
-     * @param $action
+     * @param string $action
      * @param string|array $options
      * @return null|string
      */
@@ -1223,8 +1223,8 @@ 
     /**
      * CID system info section, needed for unicode fonts
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @return null|string
      */
     protected function o_cidSystemInfo($id, $action)
@@ -1267,7 +1267,7 @@ 
      * a font glyph to character map, needed for unicode fonts
      *
      * @param $id
-     * @param $action
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1323,8 +1323,8 @@ 
     /**
      * the document procset, solves some problems with printing to old PS printers
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1369,7 +1369,7 @@ 
     /**
      * define the document information
      *
-     * @param $id
+     * @param integer $id
      * @param $action
      * @param string $options
      * @return null|string
@@ -1435,8 +1435,8 @@ 
     /**
      * an action object, used to link to URLS initially
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1496,8 +1496,8 @@ 
      * an annotation object, this will add an annotation to the current page.
      * initially will support just link annotations
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1563,7 +1563,7 @@ 
      * a page object, it also creates a contents object to hold its contents
      *
      * @param $id
-     * @param $action
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1673,8 +1673,8 @@ 
     /**
      * the contents objects hold all of the content which appears on pages
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string|array $options
      * @return null|string
      */
@@ -1739,8 +1739,8 @@ 
     }
 
     /**
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @return string|null
      */
     protected function o_embedjs($id, $action)
@@ -1770,8 +1770,8 @@ 
     }
 
     /**
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $code
      * @return null|string
      */
@@ -1806,8 +1806,8 @@ 
     /**
      * an image object, will be an XObject in the document, includes description and data
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -1948,8 +1948,8 @@ 
     /**
      * graphics state object
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return null|string
      */
@@ -2015,8 +2015,8 @@ 
     /**
      * encryption object.
      *
-     * @param $id
-     * @param $action
+     * @param integer $id
+     * @param string $action
      * @param string $options
      * @return string|null
      */
@@ -2650,7 +2650,7 @@ 
      * note that encoding='none' will need to be used for symbolic fonts
      * and 'differences' => an array of mappings between numbers 0->255 and character names.
      *
-     * @param $fontName
+     * @param string $fontName
      * @param string $encoding
      * @param bool $set
      * @return int
@@ -4139,11 +4139,11 @@ 
      *
      * @param $x
      * @param $y
-     * @param $angle
+     * @param integer $angle
      * @param $size
-     * @param $wa
+     * @param integer $wa
      * @param $text
-     * @return array
+     * @return double[]
      */
     private function getTextPosition($x, $y, $angle, $size, $wa, $text)
     {
@@ -4638,7 +4638,7 @@ 
     /**
      * add content to the documents info object
      *
-     * @param $label
+     * @param string $label
      * @param int $value
      */
     function addInfo($label, $value = 0)
@@ -4678,8 +4678,8 @@ 
      * extract an integer from a position in a byte stream
      *
      * @param $data
-     * @param $pos
-     * @param $num
+     * @param integer $pos
+     * @param integer $num
      * @return int
      */
     private function getBytes(&$data, $pos, $num)
@@ -4779,8 +4779,8 @@ 
      * @param $file
      * @param $x
      * @param $y
-     * @param $w
-     * @param $h
+     * @param integer $w
+     * @param integer $h
      * @param $byte
      */
     protected function addImagePngAlpha($file, $x, $y, $w, $h, $byte)
@@ -5046,14 +5046,14 @@ 
     /**
      * add a PNG image into the document, from a memory buffer of the file
      *
-     * @param $file
-     * @param $x
-     * @param $y
+     * @param string $file
+     * @param double $x
+     * @param double $y
      * @param float $w
      * @param float $h
-     * @param $data
+     * @param null|string $data
      * @param bool $is_mask
-     * @param null $mask
+     * @param boolean|null $mask
      */
     function addPngFromBuf($file, $x, $y, $w = 0.0, $h = 0.0, &$data, $is_mask = false, $mask = null)
     {
@@ -5389,7 +5389,7 @@ 
 
     /**
      * common code used by the two JPEG adding functions
-     * @param $data
+     * @param null|string $data
      * @param $x
      * @param $y
      * @param int $w
@@ -5523,7 +5523,7 @@ 
      * and for the user to add new ones for their fonts. The default bahavious can be overridden should
      * that be desired.
      *
-     * @param $family
+     * @param string $family
      * @param string $options
      */
     function setFontFamily($family, $options = '')

Spacing +7 added lines, -7 removed lines

@@ -343,7 +343,7 @@ 
     function __construct($pageSize = array(0, 0, 612, 792), $isUnicode = false, $fontcache = '', $tmp = '')
     {
         $this->isUnicode = $isUnicode;
-        $this->fontcache = rtrim($fontcache, DIRECTORY_SEPARATOR."/\\");
+        $this->fontcache = rtrim($fontcache, DIRECTORY_SEPARATOR . "/\\");
         $this->tmp = ($tmp !== '' ? $tmp : sys_get_temp_dir());
         $this->newDocument($pageSize);
 
@@ -510,7 +510,7 @@ 
                     if (is_string($v)) {
                         $v = '/' . $v;
                     } elseif (is_int($v)) {
-                        $v = (string) $v;
+                        $v = (string)$v;
                     } elseif (is_bool($v)) {
                         $v = ($v ? 'true' : 'false');
                     } elseif (is_array($v)) {
@@ -1003,7 +1003,7 @@ 
 
                 $res = "\n$id 0 obj\n";
                 $res .= "<</Length " . mb_strlen($stream, '8bit') . " >>\n";
-                $res .= "stream\n" . $stream . "\nendstream" . "\nendobj";;
+                $res .= "stream\n" . $stream . "\nendstream" . "\nendobj"; ;
 
                 return $res;
         }
@@ -1255,7 +1255,7 @@ 
                 $res .= "/Supplement 0\n"; // The supplement number of the character collection.
                 $res .= ">>";
 
-                $res .= "\nendobj";;
+                $res .= "\nendobj"; ;
 
                 return $res;
         }
@@ -1818,7 +1818,7 @@ 
                 // make the new object
                 $this->objects[$id] = array('t' => 'image', 'data' => &$options['data'], 'info' => array());
 
-                $info =& $this->objects[$id]['info'];
+                $info = & $this->objects[$id]['info'];
 
                 $info['Type'] = '/XObject';
                 $info['Subtype'] = '/Image';
@@ -2311,7 +2311,7 @@ 
         }
 
         if ($this->fileIdentifier === '') {
-            $tmp = implode('',  $this->objects[$this->infoObject]['info']);
+            $tmp = implode('', $this->objects[$this->infoObject]['info']);
             $this->fileIdentifier = md5('DOMPDF' . __FILE__ . $tmp . microtime() . mt_rand());
         }
 
@@ -2416,7 +2416,7 @@ 
 
         $fontcache = $this->fontcache;
         if ($fontcache == '') {
-            $fontcache = rtrim($dir, DIRECTORY_SEPARATOR."/\\");
+            $fontcache = rtrim($dir, DIRECTORY_SEPARATOR . "/\\");
         }
 
         //$name       filename without folder and extension of font metrics