PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Engineering.php

Doc Comments +3 added lines, -5 removed lines

@@ -1826,7 +1826,7 @@ 
      * @access    public
      * @category Engineering Functions
      * @param    string $complexNumber The complex number for which you want the real coefficient.
-     * @return    float
+     * @return    string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2260,7 +2260,6 @@ 
      * Excel Function:
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
-     * @param    string $complexNumber,... Series of complex numbers to add
      * @return    string
      */
     public static function IMSUM()
@@ -2299,7 +2298,6 @@ 
      * Excel Function:
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
-     * @param    string $complexNumber,... Series of complex numbers to multiply
      * @return    string
      */
     public static function IMPRODUCT()
@@ -2342,7 +2340,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
      */
     public static function DELTA($a, $b = 0)
@@ -2365,7 +2363,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/LookupRef.php

Doc Comments +4 added lines, -4 removed lines

@@ -39,7 +39,7 @@ 
      *
      * @param    row                Row number to use in the cell reference
      * @param    column            Column number to use in the cell reference
-     * @param    relativity        Flag indicating the type of reference to return
+     * @param    relativity        integer indicating the type of reference to return
      *                                1 or omitted    Absolute
      *                                2                Absolute row; relative column
      *                                3                Relative row; absolute column
@@ -352,7 +352,7 @@ 
      *
      * @param    cellAddress        The reference from which you want to base the offset. Reference must refer to a cell or
      *                                range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
-     * @param    rows            The number of rows, up or down, that you want the upper-left cell to refer to.
+     * @param    rows            integer number of rows, up or down, that you want the upper-left cell to refer to.
      *                                Using 5 as the rows argument specifies that the upper-left cell in the reference is
      *                                five rows below reference. Rows can be positive (which means below the starting reference)
      *                                or negative (which means above the starting reference).
@@ -490,7 +490,7 @@ 
      *
      * @param    lookup_value    The value that you want to match in lookup_array
      * @param    lookup_array    The range of cells being searched
-     * @param    match_type        The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
+     * @param    match_type        integer number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
      * @return    integer            The relative position of the found item
      */
     public static function MATCH($lookup_value, $lookup_array, $match_type = 1)
@@ -680,7 +680,7 @@ 
      * The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number.
      * @param    lookup_value    The value that you want to match in lookup_array
      * @param    lookup_array    The range of cells being searched
-     * @param    index_number    The column number in table_array from which the matching value must be returned. The first column is 1.
+     * @param    index_number    integer column number in table_array from which the matching value must be returned. The first column is 1.
      * @param    not_exact_match    Determines if you are looking for an exact match based on lookup_value.
      * @return    mixed            The value of the found cell
      */

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +11 added lines, -20 removed lines

@@ -55,6 +55,10 @@ 
     }
 
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n ) ) / $n;
@@ -337,7 +341,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed    $arg,...        Data values
      * @return    integer                    Greatest Common Divisor
      */
     public static function GCD()
@@ -444,7 +447,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed    $arg,...        Data values
      * @return    int        Lowest Common Multiplier
      */
     public static function LCM()
@@ -495,7 +497,7 @@ 
      * @access    public
      * @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
      */
     public static function logBase($number = null, $base = 10)
@@ -805,8 +807,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param    float        $x
-     * @param    float        $y
+     * @param    integer        $x
+     * @param    integer        $y
      * @return    float
      */
     public static function POWER($x = 0, $y = 2)
@@ -837,7 +839,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function PRODUCT()
@@ -876,8 +877,7 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
-     * @return    float
+     * @return    integer
      */
     public static function QUOTIENT()
     {
@@ -1015,9 +1015,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
      */
@@ -1154,7 +1151,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function SUM()
@@ -1183,9 +1179,8 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be summed.
-     * @return    float
+     * @return    integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = array())
     {
@@ -1224,9 +1219,7 @@ 
      *
      *    @access    public
      *    @category Mathematical and Trigonometric Functions
-     *    @param    mixed        $arg,...        Data values
-     *    @param    string        $condition        The criteria that defines which cells will be summed.
-     *    @return    float
+     * @return integer
      */
     public static function SUMIFS()
     {
@@ -1271,7 +1264,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function SUMPRODUCT()
@@ -1316,7 +1308,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function SUMSQ()
@@ -1415,7 +1406,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/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/Shared/JAMA/EigenvalueDecomposition.php

Doc Comments +2 added lines, -2 removed lines

@@ -816,7 +816,7 @@ 
      *    Return the eigenvector matrix
      *
      *    @access public
-     *    @return V
+     *    @return Matrix
      */
     public function getV()
     {
@@ -849,7 +849,7 @@ 
      *    Return the block diagonal eigenvalue matrix
      *
      *    @access public
-     *    @return D
+     *    @return Matrix
      */
     public function getD()
     {

src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php

Doc Comments +3 added lines, -3 removed lines

@@ -436,7 +436,7 @@ 
      *    Return the left singular vectors
      *
      *    @access public
-     *    @return U
+     *    @return Matrix
      */
     public function getU()
     {
@@ -448,7 +448,7 @@ 
      *    Return the right singular vectors
      *
      *    @access public
-     *    @return V
+     *    @return Matrix
      */
     public function getV()
     {
@@ -472,7 +472,7 @@ 
      *    Return the diagonal matrix of singular values
      *
      *    @access public
-     *    @return S
+     *    @return Matrix
      */
     public function getS()
     {

src/PhpSpreadsheet/Shared/TimeZone.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     /**
      *    Return the Timezone transition for the specified timezone and timestamp
      *
-     *    @param        DateTimeZone         $objTimezone    The timezone for finding the transitions
+     *    @param        \DateTimeZone         $objTimezone    The timezone for finding the transitions
      *    @param        integer                 $timestamp        PHP date/time value for finding the current transition
      *    @return         array                The current transition details
      */

Documentation/Examples/Calculations/DateTime/DATEVALUE.php

Indentation +18 added lines, -18 removed lines

@@ -33,21 +33,21 @@ 
 
 // Add some data
 $testDates = array(	'26 March 2012',	'29 Feb 2012',	'April 1, 2012',	'25/12/2012',
-					'2012-Oct-31',		'5th November',	'January 1st',		'April 2012',
-					'17-03',			'03-2012',		'29 Feb 2011',		'03-05-07',
-					'03-MAY-07',		'03-13-07',
-				  );
+                    '2012-Oct-31',		'5th November',	'January 1st',		'April 2012',
+                    '17-03',			'03-2012',		'29 Feb 2011',		'03-05-07',
+                    '03-MAY-07',		'03-13-07',
+                    );
 $testDateCount = count($testDates);
 
 for($row = 1; $row <= $testDateCount; ++$row) {
-	$worksheet->setCellValue('A'.$row, $testDates[$row-1]);
-	$worksheet->setCellValue('B'.$row, '=DATEVALUE(A'.$row.')');
-	$worksheet->setCellValue('C'.$row, '=B'.$row);
+    $worksheet->setCellValue('A'.$row, $testDates[$row-1]);
+    $worksheet->setCellValue('B'.$row, '=DATEVALUE(A'.$row.')');
+    $worksheet->setCellValue('C'.$row, '=B'.$row);
 }
 
 $worksheet->getStyle('C1:C'.$testDateCount)
-          ->getNumberFormat()
-          ->setFormatCode('yyyy-mmm-dd');
+            ->getNumberFormat()
+            ->setFormatCode('yyyy-mmm-dd');
 
 
 echo '<hr />';
@@ -64,13 +64,13 @@ 
 		<th>Formatted DateStamp</th>
 	</tr>
 	<?php
-	for ($row = 1; $row <= $testDateCount; ++$row) {
-		echo '<tr>';
-		    echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
-		echo '</tr>';
-	}
-	?>
+    for ($row = 1; $row <= $testDateCount; ++$row) {
+        echo '<tr>';
+            echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('B'.$row)->getValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
+        echo '</tr>';
+    }
+    ?>
 </table>
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

@@ -32,20 +32,20 @@ 
 $worksheet = $objPHPExcel->getActiveSheet();
 
 // Add some data
-$testDates = array(	'26 March 2012',	'29 Feb 2012',	'April 1, 2012',	'25/12/2012',
-					'2012-Oct-31',		'5th November',	'January 1st',		'April 2012',
-					'17-03',			'03-2012',		'29 Feb 2011',		'03-05-07',
-					'03-MAY-07',		'03-13-07',
+$testDates = array('26 March 2012', '29 Feb 2012', 'April 1, 2012', '25/12/2012',
+					'2012-Oct-31', '5th November', 'January 1st', 'April 2012',
+					'17-03', '03-2012', '29 Feb 2011', '03-05-07',
+					'03-MAY-07', '03-13-07',
 				  );
 $testDateCount = count($testDates);
 
-for($row = 1; $row <= $testDateCount; ++$row) {
-	$worksheet->setCellValue('A'.$row, $testDates[$row-1]);
-	$worksheet->setCellValue('B'.$row, '=DATEVALUE(A'.$row.')');
-	$worksheet->setCellValue('C'.$row, '=B'.$row);
+for ($row = 1; $row <= $testDateCount; ++$row) {
+	$worksheet->setCellValue('A' . $row, $testDates[$row - 1]);
+	$worksheet->setCellValue('B' . $row, '=DATEVALUE(A' . $row . ')');
+	$worksheet->setCellValue('C' . $row, '=B' . $row);
 }
 
-$worksheet->getStyle('C1:C'.$testDateCount)
+$worksheet->getStyle('C1:C' . $testDateCount)
           ->getNumberFormat()
           ->setFormatCode('yyyy-mmm-dd');
 
@@ -66,10 +66,10 @@ 
 	<?php
 	for ($row = 1; $row <= $testDateCount; ++$row) {
 		echo '<tr>';
-		    echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
+		    echo '<td>', $worksheet->getCell('A' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('B' . $row)->getValue(), '</td>';
+			echo '<td>', $worksheet->getCell('B' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('C' . $row)->getFormattedValue(), '</td>';
 		echo '</tr>';
 	}
 	?>

Documentation/Examples/Calculations/DateTime/DATE.php

Indentation +20 added lines, -20 removed lines

@@ -33,22 +33,22 @@ 
 
 // Add some data
 $testDates = array(	array(2012,3,26),	array(2012,2,29),	array(2012,4,1),	array(2012,12,25),
-					array(2012,10,31),	array(2012,11,5),	array(2012,1,1),	array(2012,3,17),
-					array(2011,2,29),	array(7,5,3),		array(2012,13,1),	array(2012,11,45),
-					array(2012,0,0),	array(2012,1,0),	array(2012,0,1),
-					array(2012,-2,2),	array(2012,2,-2),	array(2012,-2,-2),
-				  );
+                    array(2012,10,31),	array(2012,11,5),	array(2012,1,1),	array(2012,3,17),
+                    array(2011,2,29),	array(7,5,3),		array(2012,13,1),	array(2012,11,45),
+                    array(2012,0,0),	array(2012,1,0),	array(2012,0,1),
+                    array(2012,-2,2),	array(2012,2,-2),	array(2012,-2,-2),
+                    );
 $testDateCount = count($testDates);
 
 $worksheet->fromArray($testDates,NULL,'A1',true);
 
 for ($row = 1; $row <= $testDateCount; ++$row) {
-	$worksheet->setCellValue('D'.$row, '=DATE(A'.$row.',B'.$row.',C'.$row.')');
-	$worksheet->setCellValue('E'.$row, '=D'.$row);
+    $worksheet->setCellValue('D'.$row, '=DATE(A'.$row.',B'.$row.',C'.$row.')');
+    $worksheet->setCellValue('E'.$row, '=D'.$row);
 }
 $worksheet->getStyle('E1:E'.$testDateCount)
-          ->getNumberFormat()
-          ->setFormatCode('yyyy-mmm-dd');
+            ->getNumberFormat()
+            ->setFormatCode('yyyy-mmm-dd');
 
 
 echo '<hr />';
@@ -69,15 +69,15 @@ 
 		<th>Day</th>
 	<tr>
 	<?php
-	for ($row = 1; $row <= $testDateCount; ++$row) {
-		echo '<tr>';
-		    echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('D'.$row)->getValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('D'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('E'.$row)->getFormattedValue() , '</td>';
-		echo '</tr>';
-	}
-	?>
+    for ($row = 1; $row <= $testDateCount; ++$row) {
+        echo '<tr>';
+            echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('D'.$row)->getValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('D'.$row)->getFormattedValue() , '</td>';
+            echo '<td>' , $worksheet->getCell('E'.$row)->getFormattedValue() , '</td>';
+        echo '</tr>';
+    }
+    ?>
 </table>
\ No newline at end of file

Spacing +15 added lines, -15 removed lines

@@ -32,21 +32,21 @@ 
 $worksheet = $objPHPExcel->getActiveSheet();
 
 // Add some data
-$testDates = array(	array(2012,3,26),	array(2012,2,29),	array(2012,4,1),	array(2012,12,25),
-					array(2012,10,31),	array(2012,11,5),	array(2012,1,1),	array(2012,3,17),
-					array(2011,2,29),	array(7,5,3),		array(2012,13,1),	array(2012,11,45),
-					array(2012,0,0),	array(2012,1,0),	array(2012,0,1),
-					array(2012,-2,2),	array(2012,2,-2),	array(2012,-2,-2),
+$testDates = array(array(2012, 3, 26), array(2012, 2, 29), array(2012, 4, 1), array(2012, 12, 25),
+					array(2012, 10, 31), array(2012, 11, 5), array(2012, 1, 1), array(2012, 3, 17),
+					array(2011, 2, 29), array(7, 5, 3), array(2012, 13, 1), array(2012, 11, 45),
+					array(2012, 0, 0), array(2012, 1, 0), array(2012, 0, 1),
+					array(2012, -2, 2), array(2012, 2, -2), array(2012, -2, -2),
 				  );
 $testDateCount = count($testDates);
 
-$worksheet->fromArray($testDates,NULL,'A1',true);
+$worksheet->fromArray($testDates, NULL, 'A1', true);
 
 for ($row = 1; $row <= $testDateCount; ++$row) {
-	$worksheet->setCellValue('D'.$row, '=DATE(A'.$row.',B'.$row.',C'.$row.')');
-	$worksheet->setCellValue('E'.$row, '=D'.$row);
+	$worksheet->setCellValue('D' . $row, '=DATE(A' . $row . ',B' . $row . ',C' . $row . ')');
+	$worksheet->setCellValue('E' . $row, '=D' . $row);
 }
-$worksheet->getStyle('E1:E'.$testDateCount)
+$worksheet->getStyle('E1:E' . $testDateCount)
           ->getNumberFormat()
           ->setFormatCode('yyyy-mmm-dd');
 
@@ -71,12 +71,12 @@ 
 	<?php
 	for ($row = 1; $row <= $testDateCount; ++$row) {
 		echo '<tr>';
-		    echo '<td>' , $worksheet->getCell('A'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('B'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('C'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('D'.$row)->getValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('D'.$row)->getFormattedValue() , '</td>';
-			echo '<td>' , $worksheet->getCell('E'.$row)->getFormattedValue() , '</td>';
+		    echo '<td>', $worksheet->getCell('A' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('B' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('C' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('D' . $row)->getValue(), '</td>';
+			echo '<td>', $worksheet->getCell('D' . $row)->getFormattedValue(), '</td>';
+			echo '<td>', $worksheet->getCell('E' . $row)->getFormattedValue(), '</td>';
 		echo '</tr>';
 	}
 	?>