PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/FormulaParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
      *
      * @throws Exception
      *
-     * @return string
+     * @return FormulaToken
      */
     public function getToken($pId = 0)
     {

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

docs/Examples/Reader/exampleReader13.php

Spacing +2 added lines, -2 removed lines

@@ -30,11 +30,11 @@
 
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
 $inputFileName = array_shift($inputFileNames);
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' into WorkSheet #1 using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' into WorkSheet #1 using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $spreadsheet = $reader->load($inputFileName);
 $spreadsheet->getActiveSheet()->setTitle(pathinfo($inputFileName, PATHINFO_BASENAME));
 foreach ($inputFileNames as $sheet => $inputFileName) {
-    echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' into WorkSheet #',($sheet + 2),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+    echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' into WorkSheet #', ($sheet + 2), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
     $reader->setSheetIndex($sheet + 1);
     $reader->loadIntoExisting($inputFileName, $spreadsheet);
     $spreadsheet->getActiveSheet()->setTitle(pathinfo($inputFileName, PATHINFO_BASENAME));

docs/Examples/Reader/exampleReader15.php

Spacing +3 added lines, -3 removed lines

@@ -26,17 +26,17 @@
 $inputFileName = './sampleData/example1.tsv';
 
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' into WorkSheet #1 using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' into WorkSheet #1 using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader->setDelimiter("\t");
 $spreadsheet = $reader->load($inputFileName);
 $spreadsheet->getActiveSheet()->setTitle(pathinfo($inputFileName, PATHINFO_BASENAME));
 
 echo '<hr />';
 
-echo $spreadsheet->getSheetCount(),' worksheet',(($spreadsheet->getSheetCount() == 1) ? '' : 's'),' loaded<br /><br />';
+echo $spreadsheet->getSheetCount(), ' worksheet', (($spreadsheet->getSheetCount() == 1) ? '' : 's'), ' loaded<br /><br />';
 $loadedSheetNames = $spreadsheet->getSheetNames();
 foreach ($loadedSheetNames as $sheetIndex => $loadedSheetName) {
-    echo '<b>Worksheet #',$sheetIndex,' -> ',$loadedSheetName,' (Formatted)</b><br />';
+    echo '<b>Worksheet #', $sheetIndex, ' -> ', $loadedSheetName, ' (Formatted)</b><br />';
     $spreadsheet->setActiveSheetIndexByName($loadedSheetName);
     $sheetData = $spreadsheet->getActiveSheet()->toArray(null, true, true, true);
     var_dump($sheetData);

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/Reader/Html.php

Doc Comments +13 added lines

@@ -168,16 +168,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));
@@ -249,6 +258,10 @@ 
         return array_pop($this->nestedColumn);
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     */
     protected function flushCell($sheet, $column, $row, &$cellContent)
     {
         if (is_string($cellContent)) {

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;