PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Engineering.php

Doc Comments +5 added lines, -5 removed lines

@@ -1853,7 +1853,7 @@ 
      *
      * @param string $complexNumber the complex number for which you want the real coefficient
      *
-     * @return float
+     * @return string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2291,7 +2291,7 @@ 
      * Excel Function:
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumbers Series of complex numbers to add
+     * @param string[] $complexNumbers Series of complex numbers to add
      *
      * @return string
      */
@@ -2331,7 +2331,7 @@ 
      * Excel Function:
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumbers Series of complex numbers to multiply
+     * @param string[] $complexNumbers Series of complex numbers to multiply
      *
      * @return string
      */
@@ -2375,7 +2375,7 @@ 
      *        DELTA(a[,b])
      *
      * @param float $a the first number
-     * @param float $b The second number. If omitted, b is assumed to be zero.
+     * @param integer $b The second number. If omitted, b is assumed to be zero.
      *
      * @return int
      */
@@ -2398,7 +2398,7 @@ 
      * functions you calculate the count of values that exceed a threshold.
      *
      * @param float $number the value to test against step
-     * @param float $step The threshold value.
+     * @param integer $step The threshold value.
      *                                    If you omit a value for step, GESTEP uses zero.
      *
      * @return int

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +11 added lines, -11 removed lines

@@ -52,6 +52,10 @@ 
         return [(int) $value];
     }
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n)) / $n;
@@ -504,7 +508,7 @@ 
      * @category Mathematical and Trigonometric Functions
      *
      * @param float $number The positive real number for which you want the logarithm
-     * @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
+     * @param integer $base The base of the logarithm. If base is omitted, it is assumed to be 10.
      *
      * @return float
      */
@@ -822,8 +826,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param float $x
-     * @param float $y
+     * @param integer $x
+     * @param integer $y
      *
      * @return float
      */
@@ -897,7 +901,7 @@ 
      *
      * @param mixed $args Data values
      *
-     * @return float
+     * @return integer
      */
     public static function QUOTIENT(...$args)
     {
@@ -1035,9 +1039,6 @@ 
      *
      * Returns the sum of a power series
      *
-     * @param float $x Input value to the power series
-     * @param float $n Initial power to which you want to raise $x
-     * @param float $m Step by which to increase $n for each term in the series
      * @param array of mixed Data Series
      *
      * @return float
@@ -1215,7 +1216,7 @@ 
      * @param mixed $aArgs
      * @param mixed $sumArgs
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1255,9 +1256,8 @@ 
      *    @category Mathematical and Trigonometric Functions
      *
      * @param mixed $args Data values
-     * @param string $condition the criteria that defines which cells will be summed
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIFS(...$args)
     {
@@ -1446,7 +1446,7 @@ 
      *
      * Truncates value to the number of fractional digits by number_digits.
      *
-     * @param float $value
+     * @param integer $value
      * @param int $digits
      *
      * @return float Truncated value

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +9 added lines, -14 removed lines

@@ -133,7 +133,7 @@ 
      * @param mixed $p
      * @param mixed $q
      *
-     * @return 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
+     * @return double if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
      *
      * @author Jaco van Kooten
      */
@@ -159,8 +159,8 @@ 
      * @author Jaco van Kooten
      *
      * @param mixed $x
-     * @param mixed $p
-     * @param mixed $q
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -909,8 +909,8 @@ 
      * @param float $value Value at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param mixed $rMin
-     * @param mixed $rMax
+     * @param integer $rMin
+     * @param integer $rMax
      *
      * @return float
      */
@@ -948,8 +948,8 @@ 
      * @param float $probability Probability at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param float $rMin Minimum value
-     * @param float $rMax Maximum value
+     * @param integer $rMin Minimum value
+     * @param integer $rMax Maximum value
      *
      * @return float
      */
@@ -2015,7 +2015,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the largest) in the array or range of data to return
      *
      * @return float
      */
@@ -2745,7 +2744,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2796,7 +2794,7 @@ 
      * @param number the number of significant digits for the returned percentage value
      * @param mixed $valueSet
      * @param mixed $value
-     * @param mixed $significance
+     * @param integer $significance
      *
      * @return float
      */
@@ -2917,7 +2915,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2950,7 +2947,7 @@ 
      * @param mixed Order to sort the values in the value set
      * @param mixed $value
      * @param mixed $valueSet
-     * @param mixed $order
+     * @param integer $order
      *
      * @return float
      */
@@ -3092,7 +3089,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the smallest) in the array or range of data to return
      *
      * @return float
      */
@@ -3556,7 +3552,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */

src/PhpSpreadsheet/Reader/Xls.php

Doc Comments +5 added lines, -5 removed lines

@@ -5118,7 +5118,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()
     {
@@ -5368,7 +5368,7 @@ 
      *
      * @throws Exception
      *
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6945,7 +6945,7 @@ 
      *
      * @param string $subData
      *
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7060,7 +7060,7 @@ 
      *
      * @param string $arrayData
      *
-     * @return array
+     * @return string
      */
     private static function readBIFF8ConstantArray($arrayData)
     {
@@ -7099,7 +7099,7 @@ 
      *
      * @param string $valueData
      *
-     * @return array
+     * @return string
      */
     private static function readBIFF8Constant($valueData)
     {

src/PhpSpreadsheet/Reader/Xls/MD5.php

Doc Comments +5 added lines

@@ -187,6 +187,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;

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
     /**
      * Get parent. Only used for style supervisor.
      *
-     * @return Spreadsheet
+     * @return Style
      */
     public function getParent()
     {

src/PhpSpreadsheet/Writer/Xls/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -505,7 +505,7 @@ 
      *
      * @param mixed $token the token to convert
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -576,7 +576,7 @@ 
      *
      * @param string $string a string for conversion to its ptg value
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -654,7 +654,7 @@ 
      *
      * @param string $token an Excel range in the Sheet1!A1:A2 format
      *
-     * @return mixed the packed ptgArea3d token on success
+     * @return string the packed ptgArea3d token on success
      */
     private function convertRange3d($token)
     {
@@ -706,7 +706,7 @@ 
      *
      * @param string $cell An Excel cell reference
      *
-     * @return mixed the packed ptgRef3d token on success
+     * @return string the packed ptgRef3d token on success
      */
     private function convertRef3d($cell)
     {
@@ -805,7 +805,7 @@ 
      *
      * @param string $ext_ref The name of the external reference
      *
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -896,7 +896,7 @@ 
      *
      * @param string $cell The Excel cell reference to be packed
      *
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -925,7 +925,7 @@ 
      *
      * @param string $range The Excel range to be packed
      *
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1041,7 +1041,7 @@ 
     /**
      * Checks if it's a valid token.
      *
-     * @param mixed $token the token to check
+     * @param string $token the token to check
      *
      * @return mixed The checked token or false on failure
      */
@@ -1127,7 +1127,7 @@ 
      * @param string $formula the formula to parse, without the initial equal
      *                        sign (=)
      *
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {

docs/Examples/Reading WorkBook Data/exampleWorkBookReader01.php

Spacing +11 added lines, -11 removed lines

@@ -37,53 +37,53 @@
 
 /*  Read the document's creator property  **/
 $creator = $spreadsheet->getProperties()->getCreator();
-echo '<b>Document Creator: </b>',$creator,'<br />';
+echo '<b>Document Creator: </b>', $creator, '<br />';
 
 /*  Read the Date when the workbook was created (as a PHP timestamp value)  **/
 $creationDatestamp = $spreadsheet->getProperties()->getCreated();
 /*  Format the date and time using the standard PHP date() function  **/
 $creationDate = date('l, d<\s\up>S</\s\up> F Y', $creationDatestamp);
 $creationTime = date('g:i A', $creationDatestamp);
-echo '<b>Created On: </b>',$creationDate,' at ',$creationTime,'<br />';
+echo '<b>Created On: </b>', $creationDate, ' at ', $creationTime, '<br />';
 
 /*  Read the name of the last person to modify this workbook  **/
 $modifiedBy = $spreadsheet->getProperties()->getLastModifiedBy();
-echo '<b>Last Modified By: </b>',$modifiedBy,'<br />';
+echo '<b>Last Modified By: </b>', $modifiedBy, '<br />';
 
 /*  Read the Date when the workbook was last modified (as a PHP timestamp value)  **/
 $modifiedDatestamp = $spreadsheet->getProperties()->getModified();
 /*  Format the date and time using the standard PHP date() function  **/
 $modifiedDate = date('l, d<\s\up>S</\s\up> F Y', $modifiedDatestamp);
 $modifiedTime = date('g:i A', $modifiedDatestamp);
-echo '<b>Last Modified On: </b>',$modifiedDate,' at ',$modifiedTime,'<br />';
+echo '<b>Last Modified On: </b>', $modifiedDate, ' at ', $modifiedTime, '<br />';
 
 /*  Read the workbook title property  **/
 $workbookTitle = $spreadsheet->getProperties()->getTitle();
-echo '<b>Title: </b>',$workbookTitle,'<br />';
+echo '<b>Title: </b>', $workbookTitle, '<br />';
 
 /*  Read the workbook description property  **/
 $description = $spreadsheet->getProperties()->getDescription();
-echo '<b>Description: </b>',$description,'<br />';
+echo '<b>Description: </b>', $description, '<br />';
 
 /*  Read the workbook subject property  **/
 $subject = $spreadsheet->getProperties()->getSubject();
-echo '<b>Subject: </b>',$subject,'<br />';
+echo '<b>Subject: </b>', $subject, '<br />';
 
 /*  Read the workbook keywords property  **/
 $keywords = $spreadsheet->getProperties()->getKeywords();
-echo '<b>Keywords: </b>',$keywords,'<br />';
+echo '<b>Keywords: </b>', $keywords, '<br />';
 
 /*  Read the workbook category property  **/
 $category = $spreadsheet->getProperties()->getCategory();
-echo '<b>Category: </b>',$category,'<br />';
+echo '<b>Category: </b>', $category, '<br />';
 
 /*  Read the workbook company property  **/
 $company = $spreadsheet->getProperties()->getCompany();
-echo '<b>Company: </b>',$company,'<br />';
+echo '<b>Company: </b>', $company, '<br />';
 
 /*  Read the workbook manager property  **/
 $manager = $spreadsheet->getProperties()->getManager();
-echo '<b>Manager: </b>',$manager,'<br />';
+echo '<b>Manager: </b>', $manager, '<br />';
 
 ?>
 <body>

docs/Examples/Calculations/Database/DAVERAGE.php

Indentation +10 added lines, -10 removed lines

@@ -31,17 +31,17 @@
 
 // Add some data
 $database = [['Tree',  'Height', 'Age', 'Yield', 'Profit'],
-                   ['Apple',  18,       20,    14,      105.00],
-                   ['Pear',   12,       12,    10,       96.00],
-                   ['Cherry', 13,       14,     9,      105.00],
-                   ['Apple',  14,       15,    10,       75.00],
-                   ['Pear',    9,        8,     8,       76.80],
-                   ['Apple',   8,        9,     6,       45.00],
-                 ];
+                    ['Apple',  18,       20,    14,      105.00],
+                    ['Pear',   12,       12,    10,       96.00],
+                    ['Cherry', 13,       14,     9,      105.00],
+                    ['Apple',  14,       15,    10,       75.00],
+                    ['Pear',    9,        8,     8,       76.80],
+                    ['Apple',   8,        9,     6,       45.00],
+                    ];
 $criteria = [['Tree',      'Height', 'Age', 'Yield', 'Profit', 'Height'],
-                   ['="=Apple"', '>10',    null,  null,    null,     '<16'],
-                   ['="=Pear"',  null,     null,  null,    null,     null],
-                 ];
+                    ['="=Apple"', '>10',    null,  null,    null,     '<16'],
+                    ['="=Pear"',  null,     null,  null,    null,     null],
+                    ];
 
 $worksheet->fromArray($criteria, null, 'A1');
 $worksheet->fromArray($database, null, 'A4');

Spacing +10 added lines, -10 removed lines

@@ -30,17 +30,17 @@
 $worksheet = $spreadsheet->getActiveSheet();
 
 // Add some data
-$database = [['Tree',  'Height', 'Age', 'Yield', 'Profit'],
-                   ['Apple',  18,       20,    14,      105.00],
-                   ['Pear',   12,       12,    10,       96.00],
-                   ['Cherry', 13,       14,     9,      105.00],
-                   ['Apple',  14,       15,    10,       75.00],
-                   ['Pear',    9,        8,     8,       76.80],
-                   ['Apple',   8,        9,     6,       45.00],
+$database = [['Tree', 'Height', 'Age', 'Yield', 'Profit'],
+                   ['Apple', 18, 20, 14, 105.00],
+                   ['Pear', 12, 12, 10, 96.00],
+                   ['Cherry', 13, 14, 9, 105.00],
+                   ['Apple', 14, 15, 10, 75.00],
+                   ['Pear', 9, 8, 8, 76.80],
+                   ['Apple', 8, 9, 6, 45.00],
                  ];
-$criteria = [['Tree',      'Height', 'Age', 'Yield', 'Profit', 'Height'],
-                   ['="=Apple"', '>10',    null,  null,    null,     '<16'],
-                   ['="=Pear"',  null,     null,  null,    null,     null],
+$criteria = [['Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height'],
+                   ['="=Apple"', '>10', null, null, null, '<16'],
+                   ['="=Pear"', null, null, null, null, null],
                  ];
 
 $worksheet->fromArray($criteria, null, 'A1');