PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/JAMA/utils/Error.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 
 /**
  *    Custom error handler
- *    @param int $num Error number
+ * @return string|null
  */
 function JAMAError($errorNumber = null)
 {

src/PhpSpreadsheet/Shared/OLERead.php

Doc Comments +2 added lines, -1 removed lines

@@ -74,7 +74,7 @@ 
     /**
      * Read the file
      *
-     * @param $sFileName string Filename
+     * @param string $sFileName string Filename
      * @throws \PHPExcel\Reader\Exception
      */
     public function read($sFileName)
@@ -172,6 +172,7 @@ 
     /**
      * Extract binary stream data
      *
+     * @param integer $stream
      * @return string
      */
     public function getStream($stream)

src/PhpSpreadsheet/Shared/PCLZip/PclZip.php

Doc Comments +12 added lines

@@ -215,6 +215,10 @@ 
     //     Note that no real action is taken, if the archive does not exist it is not
     //     created. Use create() for that.
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_zipname
+     */
     public function __construct($p_zipname)
     {
 
@@ -2193,6 +2197,10 @@ 
     // Description :
     // Parameters :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_mode
+     */
     public function privOpenFd($p_mode)
     {
         $v_result=1;
@@ -3772,6 +3780,10 @@ 
     // Parameters :
     // Return Values :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_string
+     */
     public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
     {
         $v_result=1;

Indentation +25 added lines, -25 removed lines

@@ -541,12 +541,12 @@ 
 
         // ----- For each file in the list check the attributes
         $v_supported_attributes = [
-          PCLZIP_ATT_FILE_NAME => 'mandatory',
-          PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional',
-          PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional',
-          PCLZIP_ATT_FILE_MTIME => 'optional',
-          PCLZIP_ATT_FILE_CONTENT => 'optional',
-          PCLZIP_ATT_FILE_COMMENT => 'optional',
+            PCLZIP_ATT_FILE_NAME => 'mandatory',
+            PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional',
+            PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional',
+            PCLZIP_ATT_FILE_MTIME => 'optional',
+            PCLZIP_ATT_FILE_CONTENT => 'optional',
+            PCLZIP_ATT_FILE_COMMENT => 'optional',
         ];
         foreach ($v_att_list as $v_entry) {
             $v_result = $this->privFileDescrParseAtt($v_entry, $v_filedescr_list[], $v_options, $v_supported_attributes);
@@ -704,25 +704,25 @@ 
             if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
                 // ----- Parse the options
                 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, [
-                  PCLZIP_OPT_PATH => 'optional',
-                  PCLZIP_OPT_REMOVE_PATH => 'optional',
-                  PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
-                  PCLZIP_OPT_ADD_PATH => 'optional',
-                  PCLZIP_CB_PRE_EXTRACT => 'optional',
-                  PCLZIP_CB_POST_EXTRACT => 'optional',
-                  PCLZIP_OPT_SET_CHMOD => 'optional',
-                  PCLZIP_OPT_BY_NAME => 'optional',
-                  PCLZIP_OPT_BY_EREG => 'optional',
-                  PCLZIP_OPT_BY_PREG => 'optional',
-                  PCLZIP_OPT_BY_INDEX => 'optional',
-                  PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
-                  PCLZIP_OPT_EXTRACT_IN_OUTPUT => 'optional',
-                  PCLZIP_OPT_REPLACE_NEWER => 'optional',
-                  PCLZIP_OPT_STOP_ON_ERROR => 'optional',
-                  PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
-                  PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
-                  PCLZIP_OPT_TEMP_FILE_ON => 'optional',
-                  PCLZIP_OPT_TEMP_FILE_OFF => 'optional',
+                    PCLZIP_OPT_PATH => 'optional',
+                    PCLZIP_OPT_REMOVE_PATH => 'optional',
+                    PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
+                    PCLZIP_OPT_ADD_PATH => 'optional',
+                    PCLZIP_CB_PRE_EXTRACT => 'optional',
+                    PCLZIP_CB_POST_EXTRACT => 'optional',
+                    PCLZIP_OPT_SET_CHMOD => 'optional',
+                    PCLZIP_OPT_BY_NAME => 'optional',
+                    PCLZIP_OPT_BY_EREG => 'optional',
+                    PCLZIP_OPT_BY_PREG => 'optional',
+                    PCLZIP_OPT_BY_INDEX => 'optional',
+                    PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
+                    PCLZIP_OPT_EXTRACT_IN_OUTPUT => 'optional',
+                    PCLZIP_OPT_REPLACE_NEWER => 'optional',
+                    PCLZIP_OPT_STOP_ON_ERROR => 'optional',
+                    PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
+                    PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
+                    PCLZIP_OPT_TEMP_FILE_ON => 'optional',
+                    PCLZIP_OPT_TEMP_FILE_OFF => 'optional',
                 ]);
                 if ($v_result != 1) {
                     return 0;

Spacing +2 added lines, -2 removed lines

@@ -2592,7 +2592,7 @@ 
                 // ----- Set the file properties
                 $p_header['size'] = 0;
                 //$p_header['external'] = 0x41FF0010;     // Value for a folder : to be checked
-                $p_header['external'] = 0x00000010;     // Value for a folder : to be checked
+                $p_header['external'] = 0x00000010; // Value for a folder : to be checked
 
                 // ----- Call the header generation
                 if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
@@ -4980,7 +4980,7 @@ 
                 if ($v_skip > 0) {
                     --$v_skip;
                 } else {
-                    $v_result = $v_list[$i] . ($i != (sizeof($v_list) - 1)?'/' . $v_result:'');
+                    $v_result = $v_list[$i] . ($i != (sizeof($v_list) - 1) ? '/' . $v_result : '');
                 }
             }
         }

src/PhpSpreadsheet/Shared/TimeZone.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     /**
      *    Return the Timezone transition for the specified timezone and timestamp
      *
-     *    @param        DateTimeZone         $objTimezone    The timezone for finding the transitions
+     *    @param        \DateTimeZone         $objTimezone    The timezone for finding the transitions
      *    @param        integer                 $timestamp        PHP date/time value for finding the current transition
      *    @return         array                The current transition details
      */

src/PhpSpreadsheet/Shared/Trend/BestFit.php

Doc Comments +11 added lines, -3 removed lines

@@ -122,7 +122,7 @@ 
      * Return the Y-Value for a specified value of X
      *
      * @param     float        $xValue            X-Value
-     * @return     float                        Y-Value
+     * @return     boolean                        Y-Value
      */
     public function getValueOfYForX($xValue)
     {
@@ -133,7 +133,7 @@ 
      * Return the X-Value for a specified value of Y
      *
      * @param     float        $yValue            Y-Value
-     * @return     float                        X-Value
+     * @return     boolean                        X-Value
      */
     public function getValueOfXForY($yValue)
     {
@@ -154,7 +154,7 @@ 
      * Return the Equation of the best-fit line
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     boolean
      */
     public function getEquation($dp = 0)
     {
@@ -306,6 +306,9 @@ 
         return $this->yBestFitValues;
     }
 
+    /**
+     * @param double $sumY2
+     */
     protected function calculateGoodnessOfFit($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)
     {
         $SSres = $SScov = $SScor = $SStot = $SSsex = 0.0;
@@ -360,6 +363,11 @@ 
         }
     }
 
+    /**
+     * @param double[] $yValues
+     * @param double[] $xValues
+     * @param boolean $const
+     */
     protected function leastSquareFit($yValues, $xValues, $const)
     {
         // calculate sums

src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php

Doc Comments +2 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
      * Return the Slope of the line
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getSlope($dp = 0)
     {
@@ -91,7 +91,7 @@ 
      * Return the Value of X where it intersects Y = 0
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getIntersect($dp = 0)
     {

src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      * Return the Value of X where it intersects Y = 0
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getIntersect($dp = 0)
     {

src/PhpSpreadsheet/Shared/XMLWriter.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
      * Fallback method for writeRaw, introduced in PHP 5.2
      *
      * @param string $text
-     * @return string
+     * @return boolean
      */
     public function writeRawData($text)
     {

src/PhpSpreadsheet/Shared/ZipArchive.php

Doc Comments +3 added lines

@@ -155,6 +155,9 @@
         return $contents;
     }
 
+    /**
+     * @param integer $index
+     */
     public function getFromIndex($index)
     {
         $extracted = $this->zip->extractByIndex($index, PCLZIP_OPT_EXTRACT_AS_STRING);