PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/CachedObjectStorageFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
     /**
      * Return the current cache storage class
      *
-     * @return \CachedObjectStorage\ICache|null
+     * @return string
      **/
     public static function getCacheStorageClass()
     {

src/PhpSpreadsheet/Calculation.php

Doc Comments +26 added lines, -3 removed lines

@@ -2110,7 +2110,6 @@ 
      * Unset an instance of this class
      *
      * @access    public
-     * @param   Spreadsheet $spreadsheet  Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2401,6 +2400,10 @@ 
         return $formula;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     private static function translateFormula($from, $to, $formula, $fromSeparator, $toSeparator)
     {
         //    Convert any Excel function names to the required language
@@ -2718,6 +2721,9 @@ 
     }
 
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2732,6 +2738,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function saveValueToCache($cellReference, $cellValue)
     {
         if ($this->calculationCacheEnabled) {
@@ -2851,7 +2860,7 @@ 
      * Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0
      *
      * @param    mixed        &$matrix        matrix operand
-     * @return    array        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)
     {
@@ -3002,7 +3011,7 @@ 
      * Format type and details of an operand for display in the log (based on operand type)
      *
      * @param    mixed        $value    First matrix operand
-     * @return    mixed
+     * @return    string|null
      */
     private function showTypeDetails($value)
     {
@@ -3036,6 +3045,9 @@ 
     }
 
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = array('{', ';', '}');
@@ -3126,6 +3138,10 @@ 
     );
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3493,6 +3509,10 @@ 
     }
 
     // evaluate postfix notation
+
+    /**
+     * @param string $cellID
+     */
     private function processTokenStack($tokens, $cellID = null, Cell $pCell = null)
     {
         if ($tokens == false) {
@@ -4077,6 +4097,9 @@ 
         return strcmp($inversedStr1, $inversedStr2);
     }
 
+    /**
+     * @param string $matrixFunction
+     */
     private function executeNumericBinaryOperation($cellID, $operand1, $operand2, $operation, $matrixFunction, &$stack)
     {
         //    Validate the two operands

Indentation +8 added lines, -8 removed lines

@@ -232,7 +232,7 @@ 
         'NULL' => null,
     ];
 
-     //    PhpSpreadsheet functions
+        //    PhpSpreadsheet functions
     private static $phpSpreadsheetFunctions = [
         'ABS' => [
             'category' => Calculation\Categories::CATEGORY_MATH_AND_TRIG,
@@ -3073,13 +3073,13 @@ 
         $pCellParent = ($pCell !== null) ? $pCell->getWorksheet() : null;
 
         $regexpMatchString = '/^(' . self::CALCULATION_REGEXP_FUNCTION .
-                               '|' . self::CALCULATION_REGEXP_CELLREF .
-                               '|' . self::CALCULATION_REGEXP_NUMBER .
-                               '|' . self::CALCULATION_REGEXP_STRING .
-                               '|' . self::CALCULATION_REGEXP_OPENBRACE .
-                               '|' . self::CALCULATION_REGEXP_NAMEDRANGE .
-                               '|' . self::CALCULATION_REGEXP_ERROR .
-                             ')/si';
+                                '|' . self::CALCULATION_REGEXP_CELLREF .
+                                '|' . self::CALCULATION_REGEXP_NUMBER .
+                                '|' . self::CALCULATION_REGEXP_STRING .
+                                '|' . self::CALCULATION_REGEXP_OPENBRACE .
+                                '|' . self::CALCULATION_REGEXP_NAMEDRANGE .
+                                '|' . self::CALCULATION_REGEXP_ERROR .
+                                ')/si';
 
         //    Start with initialisation
         $index = 0;

Spacing +48 added lines, -48 removed lines

@@ -109,10 +109,10 @@ 
      * @var array
      */
     private static $operators = [
-        '+' => true,    '-' => true,    '*' => true,    '/' => true,
-        '^' => true,    '&' => true,    '%' => false,    '~' => false,
-        '>' => true,    '<' => true,    '=' => true,    '>=' => true,
-        '<=' => true,    '<>' => true,    '|' => true,    ':' => true,
+        '+' => true, '-' => true, '*' => true, '/' => true,
+        '^' => true, '&' => true, '%' => false, '~' => false,
+        '>' => true, '<' => true, '=' => true, '>=' => true,
+        '<=' => true, '<>' => true, '|' => true, ':' => true,
     ];
 
     /**
@@ -121,10 +121,10 @@ 
      * @var array
      */
     private static $binaryOperators = [
-        '+' => true,    '-' => true,    '*' => true,    '/' => true,
-        '^' => true,    '&' => true,    '>' => true,    '<' => true,
-        '=' => true,    '>=' => true,    '<=' => true,    '<>' => true,
-        '|' => true,    ':' => true,
+        '+' => true, '-' => true, '*' => true, '/' => true,
+        '^' => true, '&' => true, '>' => true, '<' => true,
+        '=' => true, '>=' => true, '<=' => true, '<>' => true,
+        '|' => true, ':' => true,
     ];
 
     /**
@@ -189,7 +189,7 @@ 
      *
      * @var string
      */
-    private static $localeLanguage = 'en_us';                    //    US English    (default locale)
+    private static $localeLanguage = 'en_us'; //    US English    (default locale)
 
     /**
      * List of available locale settings
@@ -198,7 +198,7 @@ 
      * @var string[]
      */
     private static $validLocaleLanguages = [
-        'en',        //    English        (default language)
+        'en', //    English        (default language)
     ];
 
     /**
@@ -2279,7 +2279,7 @@ 
                 //    Retrieve the list of locale or language specific function names
                 $localeFunctions = file($functionNamesFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
                 foreach ($localeFunctions as $localeFunction) {
-                    list($localeFunction) = explode('##', $localeFunction);    //    Strip out comments
+                    list($localeFunction) = explode('##', $localeFunction); //    Strip out comments
                     if (strpos($localeFunction, '=') !== false) {
                         list($fName, $lfName) = explode('=', $localeFunction);
                         $fName = trim($fName);
@@ -2304,7 +2304,7 @@ 
                 if (file_exists($configFile)) {
                     $localeSettings = file($configFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
                     foreach ($localeSettings as $localeSetting) {
-                        list($localeSetting) = explode('##', $localeSetting);    //    Strip out comments
+                        list($localeSetting) = explode('##', $localeSetting); //    Strip out comments
                         if (strpos($localeSetting, '=') !== false) {
                             list($settingName, $settingValue) = explode('=', $localeSetting);
                             $settingName = strtoupper(trim($settingName));
@@ -3034,12 +3034,12 @@ 
     //    These operators always work on two values
     //    Array key is the operator, the value indicates whether this is a left or right associative operator
     private static $operatorAssociativity = [
-        '^' => 0,                                                            //    Exponentiation
-        '*' => 0, '/' => 0,                                                 //    Multiplication and Division
-        '+' => 0, '-' => 0,                                                    //    Addition and Subtraction
-        '&' => 0,                                                            //    Concatenation
-        '|' => 0, ':' => 0,                                                    //    Intersect and Range
-        '>' => 0, '<' => 0, '=' => 0, '>=' => 0, '<=' => 0, '<>' => 0,        //    Comparison
+        '^' => 0, //    Exponentiation
+        '*' => 0, '/' => 0, //    Multiplication and Division
+        '+' => 0, '-' => 0, //    Addition and Subtraction
+        '&' => 0, //    Concatenation
+        '|' => 0, ':' => 0, //    Intersect and Range
+        '>' => 0, '<' => 0, '=' => 0, '>=' => 0, '<=' => 0, '<>' => 0, //    Comparison
     ];
 
     //    Comparison (Boolean) Operators
@@ -3050,15 +3050,15 @@ 
     //    This list includes all valid operators, whether binary (including boolean) or unary (such as %)
     //    Array key is the operator, the value is its precedence
     private static $operatorPrecedence = [
-        ':' => 8,                                                                //    Range
-        '|' => 7,                                                                //    Intersect
-        '~' => 6,                                                                //    Negation
-        '%' => 5,                                                                //    Percentage
-        '^' => 4,                                                                //    Exponentiation
-        '*' => 3, '/' => 3,                                                     //    Multiplication and Division
-        '+' => 2, '-' => 2,                                                        //    Addition and Subtraction
-        '&' => 1,                                                                //    Concatenation
-        '>' => 0, '<' => 0, '=' => 0, '>=' => 0, '<=' => 0, '<>' => 0,            //    Comparison
+        ':' => 8, //    Range
+        '|' => 7, //    Intersect
+        '~' => 6, //    Negation
+        '%' => 5, //    Percentage
+        '^' => 4, //    Exponentiation
+        '*' => 3, '/' => 3, //    Multiplication and Division
+        '+' => 2, '-' => 2, //    Addition and Subtraction
+        '&' => 1, //    Concatenation
+        '>' => 0, '<' => 0, '=' => 0, '>=' => 0, '<=' => 0, '<>' => 0, //    Comparison
     ];
 
     // Convert infix to postfix notation
@@ -3085,9 +3085,9 @@ 
         $index = 0;
         $stack = new Calculation\Token\Stack();
         $output = [];
-        $expectingOperator = false;                    //    We use this test in syntax-checking the expression to determine when a
+        $expectingOperator = false; //    We use this test in syntax-checking the expression to determine when a
                                                     //        - is a negation or + is a positive operator rather than an operation
-        $expectingOperand = false;                    //    We use this test in syntax-checking the expression to determine whether an operand
+        $expectingOperand = false; //    We use this test in syntax-checking the expression to determine whether an operand
                                                     //        should be null in a function call
         //    The guts of the lexical parser
         //    Loop through the formula extracting each operator and operand in turn
@@ -3107,26 +3107,26 @@ 
 
             if ($opCharacter == '-' && !$expectingOperator) {                //    Is it a negation instead of a minus?
 //echo 'Element is a Negation operator', PHP_EOL;
-                $stack->push('Unary Operator', '~');                            //    Put a negation on the stack
-                ++$index;                                                    //        and drop the negation symbol
+                $stack->push('Unary Operator', '~'); //    Put a negation on the stack
+                ++$index; //        and drop the negation symbol
             } elseif ($opCharacter == '%' && $expectingOperator) {
                 //echo 'Element is a Percentage operator', PHP_EOL;
-                $stack->push('Unary Operator', '%');                            //    Put a percentage on the stack
+                $stack->push('Unary Operator', '%'); //    Put a percentage on the stack
                 ++$index;
             } elseif ($opCharacter == '+' && !$expectingOperator) {            //    Positive (unary plus rather than binary operator plus) can be discarded?
 //echo 'Element is a Positive number, not Plus operator', PHP_EOL;
-                ++$index;                                                    //    Drop the redundant plus symbol
+                ++$index; //    Drop the redundant plus symbol
             } elseif ((($opCharacter == '~') || ($opCharacter == '|')) && (!$isOperandOrFunction)) {    //    We have to explicitly deny a tilde or pipe, because they are legal
-                return $this->raiseFormulaError("Formula Error: Illegal character '~'");                //        on the stack but not in the input expression
+                return $this->raiseFormulaError("Formula Error: Illegal character '~'"); //        on the stack but not in the input expression
             } elseif ((isset(self::$operators[$opCharacter]) or $isOperandOrFunction) && $expectingOperator) {    //    Are we putting an operator on the stack?
 //echo 'Element with value '.$opCharacter.' is an Operator', PHP_EOL;
                 while ($stack->count() > 0 &&
                     ($o2 = $stack->last()) &&
                     isset(self::$operators[$o2['value']]) &&
                     @(self::$operatorAssociativity[$opCharacter] ? self::$operatorPrecedence[$opCharacter] < self::$operatorPrecedence[$o2['value']] : self::$operatorPrecedence[$opCharacter] <= self::$operatorPrecedence[$o2['value']])) {
-                    $output[] = $stack->pop();                                //    Swap operands and higher precedence operators from the stack to the output
+                    $output[] = $stack->pop(); //    Swap operands and higher precedence operators from the stack to the output
                 }
-                $stack->push('Binary Operator', $opCharacter);    //    Finally put our current operator onto the stack
+                $stack->push('Binary Operator', $opCharacter); //    Finally put our current operator onto the stack
                 ++$index;
                 $expectingOperator = false;
             } elseif ($opCharacter == ')' && $expectingOperator) {            //    Are we expecting to close a parenthesis?
@@ -3141,10 +3141,10 @@ 
                 }
                 $d = $stack->last(2);
                 if (preg_match('/^' . self::CALCULATION_REGEXP_FUNCTION . '$/i', $d['value'], $matches)) {    //    Did this parenthesis just close a function?
-                    $functionName = $matches[1];                                        //    Get the function name
+                    $functionName = $matches[1]; //    Get the function name
 //echo 'Closed Function is '.$functionName, PHP_EOL;
                     $d = $stack->pop();
-                    $argumentCount = $d['value'];        //    See how many arguments there were (argument count is the next value stored on the stack)
+                    $argumentCount = $d['value']; //    See how many arguments there were (argument count is the next value stored on the stack)
 //if ($argumentCount == 0) {
 //    echo 'With no arguments', PHP_EOL;
 //} elseif ($argumentCount == 1) {
@@ -3152,8 +3152,8 @@ 
 //} else {
 //    echo 'With '.$argumentCount.' arguments', PHP_EOL;
 //}
-                    $output[] = $d;                        //    Dump the argument count on the output
-                    $output[] = $stack->pop();            //    Pop the function and push onto the output
+                    $output[] = $d; //    Dump the argument count on the output
+                    $output[] = $stack->pop(); //    Pop the function and push onto the output
                     if (isset(self::$controlFunctions[$functionName])) {
                         //echo 'Built-in function '.$functionName, PHP_EOL;
                         $expectedArgumentCount = self::$controlFunctions[$functionName]['argumentCount'];
@@ -3217,7 +3217,7 @@ 
                     if ($o2 === null) {
                         return $this->raiseFormulaError('Formula Error: Unexpected ,');
                     } else {
-                        $output[] = $o2;    // pop the argument expression stuff and push onto the output
+                        $output[] = $o2; // pop the argument expression stuff and push onto the output
                     }
                 }
                 //    If we've a comma when we're expecting an operand, then what we actually have is a null operand;
@@ -3231,8 +3231,8 @@ 
                     return $this->raiseFormulaError('Formula Error: Unexpected ,');
                 }
                 $d = $stack->pop();
-                $stack->push($d['type'], ++$d['value'], $d['reference']);    // increment the argument count
-                $stack->push('Brace', '(');    // put the ( back on, we'll need to pop back to it again
+                $stack->push($d['type'], ++$d['value'], $d['reference']); // increment the argument count
+                $stack->push('Brace', '('); // put the ( back on, we'll need to pop back to it again
                 $expectingOperator = false;
                 $expectingOperand = true;
                 ++$index;
@@ -3311,13 +3311,13 @@ 
                         if ((is_integer($startRowColRef)) && (ctype_digit($val)) &&
                             ($startRowColRef <= 1048576) && ($val <= 1048576)) {
                             //    Row range
-                            $endRowColRef = ($pCellParent !== null) ? $pCellParent->getHighestColumn() : 'XFD';    //    Max 16,384 columns for Excel2007
+                            $endRowColRef = ($pCellParent !== null) ? $pCellParent->getHighestColumn() : 'XFD'; //    Max 16,384 columns for Excel2007
                             $output[count($output) - 1]['value'] = $rangeWS1 . 'A' . $startRowColRef;
                             $val = $rangeWS2 . $endRowColRef . $val;
                         } elseif ((ctype_alpha($startRowColRef)) && (ctype_alpha($val)) &&
                             (strlen($startRowColRef) <= 3) && (strlen($val) <= 3)) {
                             //    Column range
-                            $endRowColRef = ($pCellParent !== null) ? $pCellParent->getHighestRow() : 1048576;        //    Max 1,048,576 rows for Excel2007
+                            $endRowColRef = ($pCellParent !== null) ? $pCellParent->getHighestRow() : 1048576; //    Max 1,048,576 rows for Excel2007
                             $output[count($output) - 1]['value'] = $rangeWS1 . strtoupper($startRowColRef) . '1';
                             $val = $rangeWS2 . $val . $endRowColRef;
                         }
@@ -3395,9 +3395,9 @@ 
                         ($o2 = $stack->last()) &&
                         isset(self::$operators[$o2['value']]) &&
                         @(self::$operatorAssociativity[$opCharacter] ? self::$operatorPrecedence[$opCharacter] < self::$operatorPrecedence[$o2['value']] : self::$operatorPrecedence[$opCharacter] <= self::$operatorPrecedence[$o2['value']])) {
-                        $output[] = $stack->pop();                                //    Swap operands and higher precedence operators from the stack to the output
+                        $output[] = $stack->pop(); //    Swap operands and higher precedence operators from the stack to the output
                     }
-                    $stack->push('Binary Operator', '|');    //    Put an Intersect Operator on the stack
+                    $stack->push('Binary Operator', '|'); //    Put an Intersect Operator on the stack
                     $expectingOperator = false;
                 }
             }
@@ -3405,7 +3405,7 @@ 
 
         while (($op = $stack->pop()) !== null) {    // pop everything off the stack and push onto output
             if ((is_array($op) && $op['value'] == '(') || ($op === '(')) {
-                return $this->raiseFormulaError("Formula Error: Expecting ')'");    // if there are any opening braces on the stack, then braces were unbalanced
+                return $this->raiseFormulaError("Formula Error: Expecting ')'"); // if there are any opening braces on the stack, then braces were unbalanced
             }
             $output[] = $op;
         }

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/Financial.php

Doc Comments +28 added lines, -17 removed lines

@@ -63,6 +63,10 @@ 
     }
 
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -85,6 +89,9 @@ 
     }
 
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -162,7 +169,7 @@ 
      *                                    The security settlement date is the date after the issue date
      *                                    when the security is traded to the buyer.
      * @param    float    $rate            The security's annual coupon rate.
-     * @param    float    $par            The security's par value.
+     * @param    integer    $par            The security's par value.
      *                                    If you omit par, ACCRINT uses $1,000.
      * @param    integer    $frequency        the number of coupon payments per year.
      *                                    Valid frequency values are:
@@ -432,6 +439,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    float
      */
     public static function COUPDAYBS($settlement, $maturity, $frequency, $basis = 0)
@@ -491,6 +499,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    float
      */
     public static function COUPDAYS($settlement, $maturity, $frequency, $basis = 0)
@@ -564,6 +573,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    float
      */
     public static function COUPDAYSNC($settlement, $maturity, $frequency, $basis = 0)
@@ -681,6 +691,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    integer
      */
     public static function COUPNUM($settlement, $maturity, $frequency, $basis = 0)
@@ -1144,7 +1155,7 @@ 
      *
      * @access    public
      * @category Financial Functions
-     * @param    float    $nominal_rate        Nominal interest rate
+     * @param    integer    $nominal_rate        Nominal interest rate
      * @param    integer    $npery                Number of compounding payments per year
      * @return    float
      */
@@ -1172,12 +1183,12 @@ 
      *
      * @access    public
      * @category Financial Functions
-     * @param    float    $rate    The interest rate per period
+     * @param    integer    $rate    The interest rate per period
      * @param    int        $nper    Total number of payment periods in an annuity
-     * @param    float    $pmt    The payment made each period: it cannot change over the
+     * @param    integer    $pmt    The payment made each period: it cannot change over the
      *                            life of the annuity. Typically, pmt contains principal
      *                            and interest but no other fees or taxes.
-     * @param    float    $pv        Present Value, or the lump-sum amount that a series of
+     * @param    integer    $pv        Present Value, or the lump-sum amount that a series of
      *                            future payments is worth right now.
      * @param    integer    $type    A number 0 or 1 and indicates when payments are due:
      *                                0 or omitted    At the end of the period.
@@ -1293,7 +1304,7 @@ 
      * @param    int        $per    Period for which we want to find the interest
      * @param    int        $nper    Number of periods
      * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1485,7 +1496,7 @@ 
      *
      * Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
      *
-     * @param    float    $effect_rate    Effective interest rate
+     * @param    integer    $effect_rate    Effective interest rate
      * @param    int        $npery            Number of compounding payments per year
      * @return    float
      */
@@ -1509,10 +1520,10 @@ 
      *
      * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $pmt    Periodic payment (annuity)
-     * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $pv        Present Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1575,10 +1586,10 @@ 
      *
      * Returns the constant payment (annuity) for a cash flow with a constant interest rate.
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $nper    Number of periods
-     * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $pv        Present Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1612,7 +1623,7 @@ 
      * @param    int        $per    Period for which we want to find the interest
      * @param    int        $nper    Number of periods
      * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1795,10 +1806,10 @@ 
      *
      * Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $nper    Number of periods
-     * @param    float    $pmt    Periodic payment (annuity)
-     * @param    float    $fv        Future Value
+     * @param    integer    $pmt    Periodic payment (annuity)
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */

Spacing +13 added lines, -13 removed lines

@@ -180,9 +180,9 @@ 
         $firstinterest = Functions::flattenSingleValue($firstinterest);
         $settlement = Functions::flattenSingleValue($settlement);
         $rate = Functions::flattenSingleValue($rate);
-        $par = (is_null($par))        ? 1000 :    Functions::flattenSingleValue($par);
-        $frequency = (is_null($frequency))    ? 1    :         Functions::flattenSingleValue($frequency);
-        $basis = (is_null($basis))        ? 0    :        Functions::flattenSingleValue($basis);
+        $par = (is_null($par)) ? 1000 : Functions::flattenSingleValue($par);
+        $frequency = (is_null($frequency)) ? 1 : Functions::flattenSingleValue($frequency);
+        $basis = (is_null($basis)) ? 0 : Functions::flattenSingleValue($basis);
 
         //    Validate
         if ((is_numeric($rate)) && (is_numeric($par))) {
@@ -230,8 +230,8 @@ 
         $issue = Functions::flattenSingleValue($issue);
         $settlement = Functions::flattenSingleValue($settlement);
         $rate = Functions::flattenSingleValue($rate);
-        $par = (is_null($par))    ? 1000 :    Functions::flattenSingleValue($par);
-        $basis = (is_null($basis))    ? 0 :        Functions::flattenSingleValue($basis);
+        $par = (is_null($par)) ? 1000 : Functions::flattenSingleValue($par);
+        $basis = (is_null($basis)) ? 0 : Functions::flattenSingleValue($basis);
 
         //    Validate
         if ((is_numeric($rate)) && (is_numeric($par))) {
@@ -290,7 +290,7 @@ 
         $salvage = Functions::flattenSingleValue($salvage);
         $period = floor(Functions::flattenSingleValue($period));
         $rate = Functions::flattenSingleValue($rate);
-        $basis = (is_null($basis))    ? 0 :    (int) Functions::flattenSingleValue($basis);
+        $basis = (is_null($basis)) ? 0 : (int) Functions::flattenSingleValue($basis);
 
         //    The depreciation coefficients are:
         //    Life of assets (1/rate)        Depreciation coefficient
@@ -617,7 +617,7 @@ 
         $settlement = Functions::flattenSingleValue($settlement);
         $maturity = Functions::flattenSingleValue($maturity);
         $frequency = (int) Functions::flattenSingleValue($frequency);
-        $basis = (is_null($basis))    ? 0 :    (int) Functions::flattenSingleValue($basis);
+        $basis = (is_null($basis)) ? 0 : (int) Functions::flattenSingleValue($basis);
 
         if (is_string($settlement = DateTime::getDateValue($settlement))) {
             return Functions::VALUE();
@@ -672,7 +672,7 @@ 
         $settlement = Functions::flattenSingleValue($settlement);
         $maturity = Functions::flattenSingleValue($maturity);
         $frequency = (int) Functions::flattenSingleValue($frequency);
-        $basis = (is_null($basis))    ? 0 :    (int) Functions::flattenSingleValue($basis);
+        $basis = (is_null($basis)) ? 0 : (int) Functions::flattenSingleValue($basis);
 
         if (is_string($settlement = DateTime::getDateValue($settlement))) {
             return Functions::VALUE();
@@ -743,7 +743,7 @@ 
         $settlement = Functions::flattenSingleValue($settlement);
         $maturity = Functions::flattenSingleValue($maturity);
         $frequency = (int) Functions::flattenSingleValue($frequency);
-        $basis = (is_null($basis))    ? 0 :    (int) Functions::flattenSingleValue($basis);
+        $basis = (is_null($basis)) ? 0 : (int) Functions::flattenSingleValue($basis);
 
         if (is_string($settlement = DateTime::getDateValue($settlement))) {
             return Functions::VALUE();
@@ -1619,7 +1619,7 @@ 
         $yield = (float) Functions::flattenSingleValue($yield);
         $redemption = (float) Functions::flattenSingleValue($redemption);
         $frequency = (int) Functions::flattenSingleValue($frequency);
-        $basis = (is_null($basis))    ? 0 :    (int) Functions::flattenSingleValue($basis);
+        $basis = (is_null($basis)) ? 0 : (int) Functions::flattenSingleValue($basis);
 
         if (is_string($settlement = DateTime::getDateValue($settlement))) {
             return Functions::VALUE();
@@ -1828,9 +1828,9 @@ 
         $nper = (int) Functions::flattenSingleValue($nper);
         $pmt = Functions::flattenSingleValue($pmt);
         $pv = Functions::flattenSingleValue($pv);
-        $fv = (is_null($fv))    ? 0.0    :    Functions::flattenSingleValue($fv);
-        $type = (is_null($type))    ? 0        :    (int) Functions::flattenSingleValue($type);
-        $guess = (is_null($guess))    ? 0.1    :    Functions::flattenSingleValue($guess);
+        $fv = (is_null($fv)) ? 0.0 : Functions::flattenSingleValue($fv);
+        $type = (is_null($type)) ? 0 : (int) Functions::flattenSingleValue($type);
+        $guess = (is_null($guess)) ? 0.1 : Functions::flattenSingleValue($guess);
 
         $rate = $guess;
         if (abs($rate) < FINANCIAL_PRECISION) {

src/PhpSpreadsheet/Calculation/FormulaParser.php

Doc Comments +2 added lines, -2 removed lines

@@ -116,7 +116,7 @@ 
      * Get Token
      *
      * @param     int        $pId    Token id
-     * @return    string
+     * @return    FormulaToken
      * @throws  Exception
      */
     public function getToken($pId = 0)
@@ -131,7 +131,7 @@ 
     /**
      * Get Token count
      *
-     * @return string
+     * @return integer
      */
     public function getTokenCount()
     {

Indentation +2 added lines, -2 removed lines

@@ -497,7 +497,7 @@ 
                     (($previousToken->getTokenType() == FormulaToken::TOKEN_TYPE_FUNCTION) && ($previousToken->getTokenSubType() == FormulaToken::TOKEN_SUBTYPE_STOP)) ||
                     (($previousToken->getTokenType() == FormulaToken::TOKEN_TYPE_SUBEXPRESSION) && ($previousToken->getTokenSubType() == FormulaToken::TOKEN_SUBTYPE_STOP)) ||
                     ($previousToken->getTokenType() == FormulaToken::TOKEN_TYPE_OPERAND)
-                  )) {
+                    )) {
                 continue;
             }
 
@@ -509,7 +509,7 @@ 
                     (($nextToken->getTokenType() == FormulaToken::TOKEN_TYPE_FUNCTION) && ($nextToken->getTokenSubType() == FormulaToken::TOKEN_SUBTYPE_START)) ||
                     (($nextToken->getTokenType() == FormulaToken::TOKEN_TYPE_SUBEXPRESSION) && ($nextToken->getTokenSubType() == FormulaToken::TOKEN_SUBTYPE_START)) ||
                     ($nextToken->getTokenType() == FormulaToken::TOKEN_TYPE_OPERAND)
-                  )) {
+                    )) {
                 continue;
             }
 

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
      */

Spacing +1 added lines, -1 removed lines

@@ -260,7 +260,7 @@
         $args = func_get_args();
         $pCell = array_pop($args);
 
-        $linkURL = (is_null($linkURL))     ? '' : Functions::flattenSingleValue($linkURL);
+        $linkURL = (is_null($linkURL)) ? '' : Functions::flattenSingleValue($linkURL);
         $displayName = (is_null($displayName)) ? '' : Functions::flattenSingleValue($displayName);
 
         if ((!is_object($pCell)) || (trim($linkURL) == '')) {

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
      */

Spacing +1 added lines, -1 removed lines

@@ -913,7 +913,7 @@
     public static function ROMAN($aValue, $style = 0)
     {
         $aValue = Functions::flattenSingleValue($aValue);
-        $style = (is_null($style))    ? 0 :    (integer) Functions::flattenSingleValue($style);
+        $style = (is_null($style)) ? 0 : (integer) Functions::flattenSingleValue($style);
         if ((!is_numeric($aValue)) || ($aValue < 0) || ($aValue >= 4000)) {
             return Functions::VALUE();
         }

src/PhpSpreadsheet/Chart/Axis.php

Doc Comments +1 added lines, -5 removed lines

@@ -332,7 +332,7 @@ 
     /**
      * Set Shadow Properties
      *
-     * @param int $shadow_presets
+     * @param int $sh_presets
      * @param string $sh_color_value
      * @param string $sh_color_type
      * @param string $sh_color_alpha
@@ -467,10 +467,6 @@ 
     /**
      * Get Glow Property
      *
-     * @param float $size
-     * @param string $color_value
-     * @param int $color_alpha
-     * @param string $color_type
      */
     public function getShadowProperty($elements)
     {

src/PhpSpreadsheet/Chart/Layout.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
      * Set Layout Target
      *
      * @param Layout Target $value
+     * @param string $value
      * @return Layout
      */
     public function setLayoutTarget($value)