PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/PCLZip/PclZip.php

Doc Comments +12 added lines

@@ -1367,6 +1367,10 @@ 
     //     1 on success.
     //     0 on failure.
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param integer $p_size
+     */
     public function privParseOptions(&$p_options_list, $p_size, &$v_result_list, $v_requested_options = false)
     {
         $v_result = 1;
@@ -2218,6 +2222,10 @@ 
     // Description :
     // Parameters :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_mode
+     */
     public function privOpenFd($p_mode)
     {
         $v_result = 1;
@@ -3831,6 +3839,10 @@ 
     // Parameters :
     // Return Values :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_string
+     */
     public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
     {
         $v_result = 1;

src/PhpSpreadsheet/Writer/Xls/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -505,7 +505,7 @@ 
      *
      * @param mixed $token the token to convert
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -574,7 +574,7 @@ 
      *
      * @param string $string a string for conversion to its ptg value
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -652,7 +652,7 @@ 
      *
      * @param string $token an Excel range in the Sheet1!A1:A2 format
      *
-     * @return mixed the packed ptgArea3d token on success
+     * @return string the packed ptgArea3d token on success
      */
     private function convertRange3d($token)
     {
@@ -704,7 +704,7 @@ 
      *
      * @param string $cell An Excel cell reference
      *
-     * @return mixed the packed ptgRef3d token on success
+     * @return string the packed ptgRef3d token on success
      */
     private function convertRef3d($cell)
     {
@@ -803,7 +803,7 @@ 
      *
      * @param string $ext_ref The name of the external reference
      *
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -894,7 +894,7 @@ 
      *
      * @param string $cell The Excel cell reference to be packed
      *
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -923,7 +923,7 @@ 
      *
      * @param string $range The Excel range to be packed
      *
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1039,7 +1039,7 @@ 
     /**
      * Checks if it's a valid token.
      *
-     * @param mixed $token the token to check
+     * @param string $token the token to check
      *
      * @return mixed       The checked token or false on failure
      */
@@ -1125,7 +1125,7 @@ 
      * @param string $formula the formula to parse, without the initial equal
      *                        sign (=)
      *
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {

src/PhpSpreadsheet/Writer/Xlsx/Chart.php

Doc Comments +6 added lines, -6 removed lines

@@ -410,8 +410,8 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  bool $isMultiLevelSeries
-     * @param mixed $xAxis
-     * @param mixed $yAxis
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
      *
      * @throws  \PhpOffice\PhpSpreadsheet\Writer\Exception
      */
@@ -533,10 +533,10 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  bool $isMultiLevelSeries
-     * @param mixed $xAxis
-     * @param mixed $yAxis
-     * @param mixed $majorGridlines
-     * @param mixed $minorGridlines
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
+     * @param null|GridLines $majorGridlines
+     * @param null|GridLines $minorGridlines
      *
      * @throws  \PhpOffice\PhpSpreadsheet\Writer\Exception
      */

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

Doc Comments +3 added lines, -3 removed lines

@@ -218,7 +218,7 @@ 
      * set ribbon XML data.
      *
      * @param null|mixed $target
-     * @param null|mixed $xmlData
+     * @param string $xmlData
      */
     public function setRibbonXMLData($target = null, $xmlData = null)
     {
@@ -234,7 +234,7 @@ 
      *
      * return string|null|array
      *
-     * @param mixed $what
+     * @param string $what
      *
      * @return string
      */
@@ -285,7 +285,7 @@ 
     /**
      * retrieve Binaries Ribbon Objects.
      *
-     * @param mixed $What
+     * @param string $What
      */
     public function getRibbonBinObjects($What = 'all')
     {

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

Doc Comments +1 added lines, -1 removed lines

@@ -472,7 +472,7 @@
      *
      * @param    int        $pValue        Sheet index
      *
-     * @return SYLK
+     * @return Slk
      */
     public function setSheetIndex($pValue = 0)
     {

src/PhpSpreadsheet/Reader/Xml.php

Doc Comments +6 added lines

@@ -231,6 +231,9 @@ 
         return $this->loadIntoExisting($pFilename, $objPHPExcel);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     protected static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -786,6 +789,9 @@ 
     }
 
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {

src/PhpSpreadsheet/Writer/Html.php

Doc Comments +1 added lines, -1 removed lines

@@ -1165,7 +1165,7 @@
      * @param    \PhpOffice\PhpSpreadsheet\Worksheet    $pSheet            \PhpOffice\PhpSpreadsheet\Worksheet
      * @param    array                $pValues        Array containing cells in a row
      * @param    int                    $pRow            Row number (0-based)
-     * @param mixed $cellType
+     * @param string $cellType
      *
      * @throws    \PhpOffice\PhpSpreadsheet\Writer\Exception
      *