PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/Xlsx/Theme.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,8 +57,8 @@ 
     /**
      * Create a new Theme.
      *
-     * @param mixed $themeName
-     * @param mixed $colourSchemeName
+     * @param string $themeName
+     * @param string $colourSchemeName
      * @param mixed $colourMap
      */
     public function __construct($themeName, $colourSchemeName, $colourMap)
@@ -92,7 +92,7 @@ 
     /**
      * Get colour Map Value by Position.
      *
-     * @param mixed $index
+     * @param integer $index
      *
      * @return string
      */

docs/Examples/Reading WorkBook Data/exampleWorkBookReader03.php

Spacing +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 echo '<b>Custom Properties: </b><br />';
 /*  Loop through the list of custom properties  **/
 foreach ($customPropertyList as $customPropertyName) {
-    echo '<b>',$customPropertyName,': </b>';
+    echo '<b>', $customPropertyName, ': </b>';
     /*  Retrieve the property value  **/
     $propertyValue = $spreadsheet->getProperties()->getCustomPropertyValue($customPropertyName);
     /*  Retrieve the property type  **/

src/PhpSpreadsheet/Reader/Xlsx.php

Doc Comments +8 added lines

@@ -294,6 +294,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)
     {
         $cellDataType = 'f';
@@ -2159,6 +2164,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(["\r", "\n"], '', $style);

src/PhpSpreadsheet/Calculation.php

Doc Comments +19 added lines, -3 removed lines

@@ -2075,7 +2075,6 @@ 
     /**
      * Unset an instance of this class.
      *
-     * @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2329,6 +2328,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
     {
         $strlen = mb_strlen($formula);
@@ -2672,6 +2675,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2815,7 +2821,7 @@ 
      *
      * @param mixed &$matrix matrix operand
      *
-     * @return int[] An array comprising the number of rows, and number of columns
+     * @return integer[] An array comprising the number of rows, and number of columns
      */
     private static function getMatrixDimensions(&$matrix)
     {
@@ -3000,6 +3006,9 @@ 
         }
     }
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3088,6 +3097,10 @@ 
     ];
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3824,6 +3837,9 @@ 
         return true;
     }
 
+    /**
+     * @param string|null $cellID
+     */
     private function executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, &$stack, $recursingArrays = false)
     {
         //    If we're dealing with matrix operations, we want a matrix result
@@ -3964,7 +3980,7 @@ 
 
     /**
      * @param string $matrixFunction
-     * @param mixed $cellID
+     * @param string|null $cellID
      * @param mixed $operand1
      * @param mixed $operand2
      * @param mixed $operation

src/PhpSpreadsheet/Calculation/DateTime.php

Doc Comments +16 added lines, -16 removed lines

@@ -471,7 +471,7 @@ 
      *
      * @category Date/Time Functions
      *
-     * @param string $dateValue Text that represents a date in a Microsoft Excel date format.
+     * @param integer $dateValue Text that represents a date in a Microsoft Excel date format.
      *                                    For example, "1/30/2008" or "30-Jan-2008" are text strings within
      *                                    quotation marks that represent dates. Using the default date
      *                                    system in Excel for Windows, date_text must represent a date from
@@ -657,9 +657,9 @@ 
     /**
      * DATEDIF.
      *
-     * @param mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param integer $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
-     * @param mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param integer $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
      * @param string $unit
      *
@@ -783,9 +783,9 @@ 
      *
      * @category Date/Time Functions
      *
-     * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $startDate Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
-     * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $endDate Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param bool $method US or European Method
      *                                        FALSE or omitted: U.S. (NASD) method. If the starting date is
@@ -844,9 +844,9 @@ 
      *
      * @category Date/Time Functions
      *
-     * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $startDate Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
-     * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $endDate Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param int $method Method used for the calculation
      *                                        0 or omitted    US (NASD) 30/360
@@ -1135,7 +1135,7 @@ 
      * Excel Function:
      *        DAY(dateValue)
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      *
      * @return int Day of the month
@@ -1246,7 +1246,7 @@ 
      * Excel Function:
      *        WEEKNUM(dateValue[,style])
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param int $method Week begins on Sunday or Monday
      *                                        1 or omitted    Week begins on Sunday.
@@ -1299,7 +1299,7 @@ 
      * Excel Function:
      *        MONTH(dateValue)
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      *
      * @return int Month of the year
@@ -1332,7 +1332,7 @@ 
      * Excel Function:
      *        YEAR(dateValue)
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      *
      * @return int Year
@@ -1364,7 +1364,7 @@ 
      * Excel Function:
      *        HOUR(timeValue)
      *
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      *
      * @return int Hour
@@ -1405,7 +1405,7 @@ 
      * Excel Function:
      *        MINUTE(timeValue)
      *
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      *
      * @return int Minute
@@ -1446,7 +1446,7 @@ 
      * Excel Function:
      *        SECOND(timeValue)
      *
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      *
      * @return int Second
@@ -1489,7 +1489,7 @@ 
      * Excel Function:
      *        EDATE(dateValue,adjustmentMonths)
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param int $adjustmentMonths The number of months before or after start_date.
      *                                        A positive value for months yields a future date;
@@ -1535,7 +1535,7 @@ 
      * Excel Function:
      *        EOMONTH(dateValue,adjustmentMonths)
      *
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param int $adjustmentMonths The number of months before or after start_date.
      *                                        A positive value for months yields a future date;

src/PhpSpreadsheet/Calculation/TextData.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
      * This function converts a number to text using currency format, with the decimals rounded to the specified place.
      * The format used is $#,##0.00_);($#,##0.00)..
      *
-     * @param float $value The value to format
+     * @param integer $value The value to format
      * @param int $decimals The number of digits to display to the right of the decimal point.
      *                                    If decimals is negative, number is rounded to the left of the decimal point.
      *                                    If you omit decimals, it is assumed to be 2

src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +1 added lines, -1 removed lines

@@ -778,7 +778,7 @@
         }
     }
 
- // end hqr2
+    // end hqr2
 
     /**
      * Constructor: Check for symmetry, then construct the eigenvalue decomposition.

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -19 removed lines

@@ -149,10 +149,6 @@ 
      *
      *    Get a submatrix
      *
-     * @param int $i0 Initial row index
-     * @param int $iF Final row index
-     * @param int $j0 Initial column index
-     * @param int $jF Final column index
      *
      * @return Matrix Submatrix
      */
@@ -345,7 +341,7 @@ 
      *
      * @param int $m Row dimension
      * @param int $n Column dimension
-     * @param mixed $c Diagonal value
+     * @param integer $c Diagonal value
      *
      * @return Matrix Diagonal matrix
      */
@@ -429,7 +425,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     * @return float Sum of diagonal elements
+     * @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -458,7 +454,6 @@ 
      *
      *    A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -500,7 +495,6 @@ 
      *
      *    A = A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -556,7 +550,6 @@ 
      *
      *    A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -598,7 +591,6 @@ 
      *
      *    A = A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -655,7 +647,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Cij
      */
@@ -698,7 +689,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -755,7 +745,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -817,7 +806,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -860,7 +848,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -903,7 +890,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -945,7 +931,6 @@ 
      *
      *    Matrix multiplication
      *
-     * @param mixed $n Matrix/Array/Scalar
      *
      * @return Matrix Product
      */
@@ -1038,7 +1023,6 @@ 
      *
      *    A = A ^ B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -1094,7 +1078,6 @@ 
      *
      *    A = A & B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */

src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php

Doc Comments +3 added lines, -3 removed lines

@@ -441,7 +441,7 @@ 
     /**
      * Return the left singular vectors.
      *
-     * @return U
+     * @return Matrix
      */
     public function getU()
     {
@@ -451,7 +451,7 @@ 
     /**
      * Return the right singular vectors.
      *
-     * @return V
+     * @return Matrix
      */
     public function getV()
     {
@@ -471,7 +471,7 @@ 
     /**
      * Return the diagonal matrix of singular values.
      *
-     * @return S
+     * @return Matrix
      */
     public function getS()
     {

Indentation +1 added lines, -1 removed lines

@@ -436,7 +436,7 @@
         } // end while
     }
 
- // end constructor
+    // end constructor
 
     /**
      * Return the left singular vectors.