Add some return types

PHPOffice · Dec 9, 2023 · 3c0350e · 3c0350e
1 parent f62245b
commit 3c0350e
Show file tree

Hide file tree

Showing 51 changed files with 127 additions and 291 deletions.
diff --git a/src/PhpSpreadsheet/Calculation/Database/DAverage.php b/src/PhpSpreadsheet/Calculation/Database/DAverage.php
@@ -29,8 +29,6 @@ class DAverage extends DatabaseAbstract
      *                              includes at least one column label and at least one cell below
      *                              the column label in which you specify a condition for the
      *                              column.
-     *
-     * @return float|string
      */
     public static function evaluate($database, $field, $criteria): string|int|float
     {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DGet.php b/src/PhpSpreadsheet/Calculation/Database/DGet.php
@@ -29,10 +29,8 @@ class DGet extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return mixed
      */
-    public static function evaluate($database, $field, $criteria)
+    public static function evaluate($database, $field, $criteria): null|float|int|string
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DMax.php b/src/PhpSpreadsheet/Calculation/Database/DMax.php
@@ -30,10 +30,8 @@ class DMax extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return null|float|string
      */
-    public static function evaluate($database, $field, $criteria, bool $returnError = true)
+    public static function evaluate($database, $field, $criteria, bool $returnError = true): null|float|string
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DMin.php b/src/PhpSpreadsheet/Calculation/Database/DMin.php
@@ -30,10 +30,8 @@ class DMin extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return null|float|string
      */
-    public static function evaluate($database, $field, $criteria, bool $returnError = true)
+    public static function evaluate($database, $field, $criteria, bool $returnError = true): float|string|null
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DStDev.php b/src/PhpSpreadsheet/Calculation/Database/DStDev.php
@@ -30,10 +30,8 @@ class DStDev extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return float|string
      */
-    public static function evaluate($database, $field, $criteria)
+    public static function evaluate($database, $field, $criteria): float|string
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DStDevP.php b/src/PhpSpreadsheet/Calculation/Database/DStDevP.php
@@ -30,10 +30,8 @@ class DStDevP extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return float|string
      */
-    public static function evaluate($database, $field, $criteria)
+    public static function evaluate($database, $field, $criteria): float|string
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DSum.php b/src/PhpSpreadsheet/Calculation/Database/DSum.php
@@ -29,10 +29,8 @@ class DSum extends DatabaseAbstract
      *                                        includes at least one column label and at least one cell below
      *                                        the column label in which you specify a condition for the
      *                                        column.
-     *
-     * @return null|float|string
      */
-    public static function evaluate($database, $field, $criteria, bool $returnNull = false)
+    public static function evaluate($database, $field, $criteria, bool $returnNull = false): null|float|string
     {
         $field = self::fieldExtract($database, $field);
         if ($field === null) {

diff --git a/src/PhpSpreadsheet/Calculation/Database/DatabaseAbstract.php b/src/PhpSpreadsheet/Calculation/Database/DatabaseAbstract.php
@@ -12,10 +12,8 @@ abstract class DatabaseAbstract
      * @param array $database
      * @param null|int|string $field
      * @param array $criteria
-     *
-     * @return null|float|int|string
      */
-    abstract public static function evaluate($database, $field, $criteria);
+    abstract public static function evaluate($database, $field, $criteria): null|float|int|string;
 
     /**
      * fieldExtract.
@@ -163,10 +161,7 @@ private static function executeQuery(array $database, string $query, array $crit
         return $database;
     }
 
-    /**
-     * @return mixed
-     */
-    private static function processCondition(string $criterion, array $fields, array $dataValues, string $conditions)
+    private static function processCondition(string $criterion, array $fields, array $dataValues, string $conditions): mixed
     {
         $key = array_search($criterion, $fields, true);
 

diff --git a/src/PhpSpreadsheet/Calculation/DateTimeExcel/Difference.php b/src/PhpSpreadsheet/Calculation/DateTimeExcel/Difference.php
@@ -82,10 +82,8 @@ private static function initialDiff(float $startDate, float $endDate): float
      * Decide whether it's time to set retVal.
      *
      * @param bool|int $retVal
-     *
-     * @return null|bool|int
      */
-    private static function replaceRetValue($retVal, string $unit, string $compare)
+    private static function replaceRetValue($retVal, string $unit, string $compare): null|bool|int
     {
         if ($retVal !== false || $unit !== $compare) {
             return $retVal;

diff --git a/src/PhpSpreadsheet/Calculation/DateTimeExcel/Helpers.php b/src/PhpSpreadsheet/Calculation/DateTimeExcel/Helpers.php
@@ -159,17 +159,15 @@ public static function returnIn3FormatsArray(array $dateArray, bool $noFrac = fa
 
     /**
      * Return result in one of three formats.
-     *
-     * @return mixed
      */
-    public static function returnIn3FormatsFloat(float $excelDateValue)
+    public static function returnIn3FormatsFloat(float $excelDateValue): float|int|DateTime
     {
         $retType = Functions::getReturnDateType();
         if ($retType === Functions::RETURNDATE_EXCEL) {
             return $excelDateValue;
         }
         if ($retType === Functions::RETURNDATE_UNIX_TIMESTAMP) {
-            return (int) SharedDateHelper::excelToTimestamp($excelDateValue);
+            return SharedDateHelper::excelToTimestamp($excelDateValue);
         }
         // RETURNDATE_PHP_DATETIME_OBJECT
 
@@ -242,10 +240,8 @@ public static function validateNumericNull(mixed $number): int|float
 
     /**
      * Many functions accept null/false/true argument treated as 0/0/1.
-     *
-     * @return float
      */
-    public static function validateNotNegative(mixed $number)
+    public static function validateNotNegative(mixed $number): float
     {
         if (!is_numeric($number)) {
             throw new Exception(ExcelError::VALUE());

diff --git a/src/PhpSpreadsheet/Calculation/DateTimeExcel/WorkDay.php b/src/PhpSpreadsheet/Calculation/DateTimeExcel/WorkDay.php
@@ -2,6 +2,7 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel;
 
+use DateTime;
 use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Exception;
 use PhpOffice\PhpSpreadsheet\Calculation\Functions;
@@ -71,10 +72,8 @@ public static function date($startDate, $endDays, ...$dateArgs)
 
     /**
      * Use incrementing logic to determine Workday.
-     *
-     * @return mixed
      */
-    private static function incrementing(float $startDate, int $endDays, array $holidayArray)
+    private static function incrementing(float $startDate, int $endDays, array $holidayArray): float|int|DateTime
     {
         //    Adjust the start date if it falls over a weekend
         $startDoW = self::getWeekDay($startDate, 3);
@@ -132,10 +131,8 @@ private static function incrementingArray(float $startDate, float $endDate, arra
 
     /**
      * Use decrementing logic to determine Workday.
-     *
-     * @return mixed
      */
-    private static function decrementing(float $startDate, int $endDays, array $holidayArray)
+    private static function decrementing(float $startDate, int $endDays, array $holidayArray): float|int|DateTime
     {
         //    Adjust the start date if it falls over a weekend
         $startDoW = self::getWeekDay($startDate, 3);

diff --git a/src/PhpSpreadsheet/Calculation/Engine/CyclicReferenceStack.php b/src/PhpSpreadsheet/Calculation/Engine/CyclicReferenceStack.php
@@ -29,10 +29,8 @@ public function push(mixed $value): void
 
     /**
      * Pop the last entry from the stack.
-     *
-     * @return mixed
      */
-    public function pop()
+    public function pop(): mixed
     {
         return array_pop($this->stack);
     }

diff --git a/src/PhpSpreadsheet/Calculation/Engine/Logger.php b/src/PhpSpreadsheet/Calculation/Engine/Logger.php
@@ -8,20 +8,16 @@ class Logger
      * Flag to determine whether a debug log should be generated by the calculation engine
      *        If true, then a debug log will be generated
      *        If false, then a debug log will not be generated.
-     *
-     * @var bool
      */
-    private $writeDebugLog = false;
+    private bool $writeDebugLog = false;
 
     /**
      * Flag to determine whether a debug log should be echoed by the calculation engine
      *        If true, then a debug log will be echoed
      *        If false, then a debug log will not be echoed
      * A debug log can only be echoed if it is generated.
-     *
-     * @var bool
      */
-    private $echoDebugLog = false;
+    private bool $echoDebugLog = false;
 
     /**
      * The debug log generated by the calculation engine.
@@ -55,10 +51,8 @@ public function setWriteDebugLog($writeDebugLog): void
 
     /**
      * Return whether calculation engine logging is enabled or disabled.
-     *
-     * @return bool
      */
-    public function getWriteDebugLog()
+    public function getWriteDebugLog(): bool
     {
         return $this->writeDebugLog;
     }
@@ -75,10 +69,8 @@ public function setEchoDebugLog($echoDebugLog): void
 
     /**
      * Return whether echoing of debug log information is enabled or disabled.
-     *
-     * @return bool
      */
-    public function getEchoDebugLog()
+    public function getEchoDebugLog(): bool
     {
         return $this->echoDebugLog;
     }

diff --git a/src/PhpSpreadsheet/Calculation/Engineering/Complex.php b/src/PhpSpreadsheet/Calculation/Engineering/Complex.php
@@ -28,8 +28,7 @@ class Complex
      *                          If omitted, the suffix is assumed to be "i".
      *                      Or can be an array of values
      *
-     * @return array|string
-     *         If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function COMPLEX(mixed $realNumber = 0.0, mixed $imaginary = 0.0, mixed $suffix = 'i'): array|string