PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Worksheet.php

Doc Comments +7 added lines, -7 removed lines

@@ -558,7 +558,7 @@ 
      *
      * @throws Exception
      *
-     * @return Chart|false
+     * @return Chart
      */
     public function getChartByIndex($index)
     {
@@ -1069,7 +1069,7 @@ 
      * @param string $column Return the highest data row for the specified column,
      *                                     or the highest data row of any column if no column letter is passed
      *
-     * @return string Highest row number that contains data
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1121,7 +1121,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell, eg: 'A1'
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type, see Cell\DataType::TYPE_*
      *
      * @return Worksheet
@@ -1327,7 +1327,7 @@ 
      * Get row dimension at a specific row.
      *
      * @param int $pRow Numeric index of the row
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\RowDimension
      */
@@ -1353,7 +1353,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column eg: 'A'
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\ColumnDimension
      */
@@ -1899,7 +1899,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param string|Worksheet\AutoFilter $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception
@@ -2965,7 +2965,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue, $validate = true)
     {

tests/data/Calculation/DateTime/DAY.php

Spacing +20 added lines, -20 removed lines

@@ -4,53 +4,53 @@
 
 return [
     [
-        19,         // Result for Excel
-        19,         // Result for OpenOffice
+        19, // Result for Excel
+        19, // Result for OpenOffice
         22269,
     ],
     [
-        1,          // Result for Excel
-        1,          // Result for OpenOffice
+        1, // Result for Excel
+        1, // Result for OpenOffice
         30348,
     ],
     [
-        10,         // Result for Excel
-        10,         // Result for OpenOffice
+        10, // Result for Excel
+        10, // Result for OpenOffice
         30843,
     ],
     [
-        11,         // Result for Excel
-        11,         // Result for OpenOffice
+        11, // Result for Excel
+        11, // Result for OpenOffice
         '11-Nov-1918',
     ],
     [
-        28,         // Result for Excel
-        28,         // Result for OpenOffice
+        28, // Result for Excel
+        28, // Result for OpenOffice
         '28-Feb-1904',
     ],
     [
-        '#VALUE!',  // Result for Excel
-        '#VALUE!',  // Result for OpenOffice
+        '#VALUE!', // Result for Excel
+        '#VALUE!', // Result for OpenOffice
         'Invalid',
     ],
     [
-        '#NUM!',  // Result for Excel
-        29,       // Result for OpenOffice
+        '#NUM!', // Result for Excel
+        29, // Result for OpenOffice
         -1,
     ],
     [
-        1,         // Result for Excel
-        31,        // Result for OpenOffice
+        1, // Result for Excel
+        31, // Result for OpenOffice
         1,
     ],
     [
-        0,         // Result for Excel
-        30,        // Result for OpenOffice
+        0, // Result for Excel
+        30, // Result for OpenOffice
         0.5,
     ],
     [
-        0,         // Result for Excel
-        30,        // Result for OpenOffice
+        0, // Result for Excel
+        30, // Result for OpenOffice
         0,
     ],
 ];

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +49 added lines, -42 removed lines

@@ -15,7 +15,7 @@ 
      *
      * Returns a boolean TRUE/FALSE indicating if this date is the last date of the month
      *
-     * @param DateTime $testDate The date for testing
+     * @param \DateTime $testDate The date for testing
      *
      * @return bool
      */
@@ -24,6 +24,10 @@ 
         return $testDate->format('d') == $testDate->format('t');
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -45,6 +49,9 @@ 
         return Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -126,7 +133,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 int $frequency the number of coupon payments per year.
      *                                    Valid frequency values are:
@@ -199,8 +206,8 @@ 
      * @param mixed $issue
      * @param mixed $settlement
      * @param mixed $rate
-     * @param mixed $par
-     * @param mixed $basis
+     * @param integer $par
+     * @param integer $basis
      *
      * @return float
      */
@@ -266,7 +273,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -351,7 +358,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -421,8 +428,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -485,7 +492,7 @@ 
      * @param int $frequency
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -562,8 +569,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -626,7 +633,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -687,8 +694,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return int
      */
@@ -764,7 +771,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -916,7 +923,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $month
+     * @param integer $month
      *
      * @return float
      */
@@ -991,7 +998,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $factor
+     * @param double $factor
      *
      * @return float
      */
@@ -1060,7 +1067,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1179,7 +1186,7 @@ 
      *
      * @category Financial Functions
      *
-     * @param float $nominal_rate Nominal interest rate
+     * @param integer $nominal_rate Nominal interest rate
      * @param int $npery Number of compounding payments per year
      *
      * @return float
@@ -1207,12 +1214,12 @@ 
      *
      * @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 int $type A number 0 or 1 and indicates when payments are due:
      *                                0 or omitted    At the end of the period.
@@ -1330,7 +1337,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
@@ -1525,7 +1532,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
@@ -1549,10 +1556,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
@@ -1618,10 +1625,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
@@ -1656,7 +1663,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
@@ -1746,7 +1753,7 @@ 
      * @param mixed $maturity
      * @param mixed $discount
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1798,7 +1805,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $yield
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1852,10 +1859,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
@@ -1912,9 +1919,9 @@ 
      * @param mixed $nper
      * @param mixed $pmt
      * @param mixed $pv
-     * @param mixed $fv
-     * @param mixed $type
-     * @param mixed $guess
+     * @param double $fv
+     * @param integer $type
+     * @param double $guess
      *
      * @return float
      **/
@@ -1983,7 +1990,7 @@ 
      * @param mixed $maturity
      * @param mixed $investment
      * @param mixed $discount
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2353,7 +2360,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2410,7 +2417,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $price
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +8 added lines, -13 removed lines

@@ -114,8 +114,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)
     {
@@ -717,8 +717,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
      */
@@ -756,8 +756,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
      */
@@ -1823,7 +1823,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
      */
@@ -2554,7 +2553,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2605,7 +2603,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
      */
@@ -2726,7 +2724,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2759,7 +2756,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
      */
@@ -2901,7 +2898,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
      */
@@ -3365,7 +3361,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */

src/PhpSpreadsheet/Reader/Html.php

Doc Comments +12 added lines

@@ -155,16 +155,25 @@ 
         return fread($this->fileHandle, $blockSize);
     }
 
+    /**
+     * @param string $data
+     */
     private static function startsWithTag($data)
     {
         return '<' === substr(trim($data), 0, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function endsWithTag($data)
     {
         return '>' === substr(trim($data), -1, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function containsTags($data)
     {
         return strlen($data) !== strlen(strip_tags($data));
@@ -238,6 +247,9 @@ 
         return array_pop($this->nestedColumn);
     }
 
+    /**
+     * @param integer $row
+     */
     protected function flushCell(Worksheet $sheet, $column, $row, &$cellContent)
     {
         if (is_string($cellContent)) {

src/PhpSpreadsheet/Reader/Xml.php

Doc Comments +9 added lines

@@ -236,6 +236,9 @@ 
         return $this->loadIntoExisting($pFilename, $spreadsheet);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     private static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -811,6 +814,9 @@ 
         return $spreadsheet;
     }
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {
@@ -820,6 +826,9 @@ 
         return $string;
     }
 
+    /**
+     * @param string $is
+     */
     protected function parseRichText($is)
     {
         $value = new RichText();

src/PhpSpreadsheet/Shared/OLE.php

Doc Comments +1 added lines, -1 removed lines

@@ -536,7 +536,7 @@
      *
      * @param int $string A binary string with the encoded date
      *
-     * @return string The timestamp corresponding to the string
+     * @return double The timestamp corresponding to the string
      */
     public static function OLE2LocalDate($string)
     {