PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/NamedRange.php

Doc Comments +1 added lines, -1 removed lines

@@ -226,7 +226,7 @@
      * Resolve a named range to a regular cell range
      *
      * @param string $pNamedRange Named range
-     * @param Worksheet|null $pSheet Scope. Use null for global scope
+     * @param Worksheet $pSheet Scope. Use null for global scope
      * @return NamedRange
      */
     public static function resolveRange($pNamedRange, Worksheet $pSheet)

src/PhpSpreadsheet/Reader/BaseReader.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
      *
      * @param    boolean    $pValue
      *
-     * @return    PHPExcel_Reader_IReader
+     * @return    BaseReader
      */
     public function setReadEmptyCells($pValue = true)
     {

src/PhpSpreadsheet/Reader/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
     /**
      * Get Contiguous
      *
-     * @return boolean
+     * @return integer
      */
     public function getContiguous()
     {

src/PhpSpreadsheet/Reader/Excel2003XML.php

Doc Comments +6 added lines

@@ -231,6 +231,9 @@ 
         return $this->loadIntoExisting($pFilename, $objPHPExcel);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     protected static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -786,6 +789,9 @@ 
     }
 
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {

src/PhpSpreadsheet/Reader/Excel2007.php

Doc Comments +18 added lines, -1 removed lines

@@ -288,6 +288,11 @@ 
         return isset($c->v) ? (string) $c->v : null;
     }
 
+    /**
+     * @param string $r
+     * @param string $cellDataType
+     * @param string $castBaseType
+     */
     private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType)
     {
 //        echo 'Formula', PHP_EOL;
@@ -330,6 +335,9 @@ 
     }
 
 
+    /**
+     * @return string|null
+     */
     private function getFromZipArchive($archive, $fileName = '')
     {
         // Root-relative paths
@@ -359,7 +367,7 @@ 
      * Loads Spreadsheet from file
      *
      * @param     string         $pFilename
-     * @return    Spreadsheet
+     * @return    \PHPExcel\Spreadsheet
      * @throws    Exception
      */
     public function load($pFilename)
@@ -1924,6 +1932,9 @@ 
         return 'FF000000';
     }
 
+    /**
+     * @param \PHPExcel\Style $docStyle
+     */
     private static function readStyle($docStyle, $style)
     {
         // format code
@@ -2123,6 +2134,9 @@ 
         return $value;
     }
 
+    /**
+     * @param \PHPExcel\Spreadsheet $excel
+     */
     private function readRibbon($excel, $customUITarget, $zip)
     {
         $baseDir = dirname($customUITarget);
@@ -2175,6 +2189,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(array("\r","\n"), "", $style);

src/PhpSpreadsheet/Reader/Excel2007/Chart.php

Doc Comments +14 added lines

@@ -29,6 +29,10 @@ 
  */
 class Chart
 {
+    /**
+     * @param string $name
+     * @param string $format
+     */
     private static function getAttribute($component, $name, $format)
     {
         $attributes = $component->attributes();
@@ -56,6 +60,10 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $chartElements
+     * @param string $chartName
+     */
     public static function readChart($chartElements, $chartName)
     {
         $namespacesChartMeta = $chartElements->getNamespaces(true);
@@ -198,6 +206,9 @@ 
         return $chart;
     }
 
+    /**
+     * @param string $type
+     */
     private static function chartTitle($titleDetails, $namespacesChartMeta, $type)
     {
         $caption = array();
@@ -484,6 +495,9 @@ 
         return $plotAttributes;
     }
 
+    /**
+     * @param \PHPExcel\Chart\Layout $plotArea
+     */
     private static function setChartAttributes($plotArea, $plotAttributes)
     {
         foreach ($plotAttributes as $plotAttributeKey => $plotAttributeValue) {

src/PhpSpreadsheet/Reader/Excel5.php

Doc Comments +16 added lines, -7 removed lines

@@ -1211,7 +1211,7 @@ 
      *
      * @param string $data   Data stream to read from
      * @param int    $pos    Position to start reading from
-     * @param int    $length Record data length
+     * @param integer $len
      *
      * @return string Record data
      */
@@ -1754,6 +1754,7 @@ 
      * @var int    $block      Block for which to create decrypto
      * @var string $valContext MD5 context state
      *
+     * @param string $valContext
      * @return Excel5\RC4
      */
     private function makeKey($block, $valContext)
@@ -1788,6 +1789,11 @@ 
      * @var string $hashedsalt_data Hashed salt data
      * @var string &$valContext     Set to the MD5 context of the value
      *
+     * @param string $password
+     * @param string $docid
+     * @param string $salt_data
+     * @param string $hashedsalt_data
+     * @param string $valContext
      * @return bool Success
      */
     private function verifyPassword($password, $docid, $salt_data, $hashedsalt_data, &$valContext)
@@ -5227,7 +5233,7 @@ 
      * is in one piece.
      * Moves to next current position in data stream to start of next record different from a CONtINUE record
      *
-     * @return array
+     * @return integer|null
      */
     private function getSplicedRecordData()
     {
@@ -5331,8 +5337,7 @@ 
      * Take array of tokens together with additional data for formula and return human readable formula
      *
      * @param array $tokens
-     * @param array $additionalData Additional binary data going with the formula
-     * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
+     * @param string $additionalData Additional binary data going with the formula
      * @return string Human readable formula
      */
     private function createFormulaFromTokens($tokens, $additionalData)
@@ -5496,7 +5501,8 @@ 
      *
      * @param string Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
-     * @return array
+     * @param string $formulaData
+     * @return string
      * @throws Exception
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
@@ -7070,7 +7076,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7463,6 +7469,9 @@ 
     }
 
 
+    /**
+     * @param integer $rknum
+     */
     private static function getIEEE754($rknum)
     {
         if (($rknum & 0x02) != 0) {
@@ -7493,7 +7502,7 @@ 
      * Get UTF-8 string from (compressed or uncompressed) UTF-16 string
      *
      * @param string $string
-     * @param bool $compressed
+     * @param string|boolean $compressed
      * @return string
      */
     private static function encodeUTF16($string, $compressed = '')

src/PhpSpreadsheet/Reader/Excel5/Color.php

Doc Comments +1 added lines

@@ -9,6 +9,7 @@
      *
      * @param int $color Indexed color
      * @param array $palette Color palette
+     * @param integer $version
      * @return array RGB color value, example: array('rgb' => 'FF0000')
      */
     public static function map($color, $palette, $version)

src/PhpSpreadsheet/Reader/Excel5/MD5.php

Doc Comments +5 added lines

@@ -190,6 +190,11 @@
         return ($Y ^ ($X | (~ $Z))) ; // Y XOR (X OR NOT Z)
     }
 
+    /**
+     * @param string[] $func
+     * @param integer $s
+     * @param integer $t
+     */
     private static function step($func, &$A, $B, $C, $D, $M, $s, $t)
     {
         $A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff;