More work on array-enabling date functions

Author: MarkBaker

src/PhpSpreadsheet/Calculation/DateTime.php

@@ -278,9 +278,9 @@ public static function TIMEVALUE($timeValue)
      *                                    or a standard date string
      * @param mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
-     * @param string $unit
+     * @param array|string $unit
      *
-     * @return int|string Interval between the dates
+     * @return array|int|string Interval between the dates
      */
     public static function DATEDIF($startDate = 0, $endDate = 0, $unit = 'D')
     {
@@ -300,12 +300,12 @@ public static function DATEDIF($startDate = 0, $endDate = 0, $unit = 'D')
      * @See DateTimeExcel\Days::between()
      *      Use the between method in the DateTimeExcel\Days class instead
      *
-     * @param DateTimeInterface|float|int|string $endDate Excel date serial value (float),
+     * @param array|DateTimeInterface|float|int|string $endDate Excel date serial value (float),
      * PHP date timestamp (integer), PHP DateTime object, or a standard date string
-     * @param DateTimeInterface|float|int|string $startDate Excel date serial value (float),
+     * @param array|DateTimeInterface|float|int|string $startDate Excel date serial value (float),
      * PHP date timestamp (integer), PHP DateTime object, or a standard date string
      *
-     * @return int|string Number of days between start date and end date or an error
+     * @return array|int|string Number of days between start date and end date or an error
      */
     public static function DAYS($endDate = 0, $startDate = 0)
     {
@@ -331,7 +331,7 @@ public static function DAYS($endDate = 0, $startDate = 0)
      *                                        PHP DateTime object, or a standard date string
      * @param mixed $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
+     * @param array|bool $method US or European Method
      *                                        FALSE or omitted: U.S. (NASD) method. If the starting date is
      *                                        the last day of a month, it becomes equal to the 30th of the
      *                                        same month. If the ending date is the last day of a month and
@@ -343,7 +343,7 @@ public static function DAYS($endDate = 0, $startDate = 0)
      *                                        occur on the 31st of a month become equal to the 30th of the
      *                                        same month.
      *
-     * @return int|string Number of days between start date and end date
+     * @return array|int|string Number of days between start date and end date
      */
     public static function DAYS360($startDate = 0, $endDate = 0, $method = false)
     {

src/PhpSpreadsheet/Calculation/DateTimeExcel/Days360.php

@@ -46,7 +46,7 @@ class Days360
      */
     public static function between($startDate = 0, $endDate = 0, $method = false)
     {
-        if (is_array($endDate) || is_array($startDate) || is_array($method)) {
+        if (is_array($startDate) || is_array($endDate) || is_array($method)) {
             return self::evaluateArrayArguments([self::class, __FUNCTION__], $startDate, $endDate, $method);
         }
 

src/PhpSpreadsheet/Calculation/DateTimeExcel/Difference.php

@@ -4,25 +4,37 @@
 
 use DateInterval;
 use DateTime;
+use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Exception;
 use PhpOffice\PhpSpreadsheet\Calculation\Functions;
 use PhpOffice\PhpSpreadsheet\Shared\Date as SharedDateHelper;
 
 class Difference
 {
+    use ArrayEnabled;
+
     /**
      * DATEDIF.
      *
      * @param mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
+     *                         Or can be an array of date values
      * @param mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
-     * @param string $unit
+     *                         Or can be an array of date values
+     * @param array|string $unit
+     *                         Or can be an array of unit values
      *
-     * @return int|string Interval between the dates
+     * @return array|int|string Interval between the dates
+     *         If an array of values is passed for the $startDate or $endDays,arguments, then the returned result
+     *            will also be an array with matching dimensions
      */
     public static function interval($startDate, $endDate, $unit = 'D')
     {
+        if (is_array($startDate) || is_array($endDate) || is_array($unit)) {
+            return self::evaluateArrayArguments([self::class, __FUNCTION__], $startDate, $endDate, $unit);
+        }
+
         try {
             $startDate = Helpers::getDateValue($startDate);
             $endDate = Helpers::getDateValue($endDate);

src/PhpSpreadsheet/Calculation/DateTimeExcel/WorkDay.php

@@ -28,7 +28,7 @@ class WorkDay
      *                                        startDate. A positive value for days yields a future date; a
      *                                        negative value yields a past date.
      *                         Or can be an array of int values
-     * @param mixed $dateArgs
+     * @param null|mixed $dateArgs
      *
      * @return array|mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -194,8 +194,8 @@ private static function decrementingArray(float $startDate, float $endDate, arra
 
     private static function getWeekDay(float $date, int $wd): int
     {
-        $result = Week::day($date, $wd);
+        $result = Functions::scalar(Week::day($date, $wd));
 
-        return is_string($result) ? -1 : $result;
+        return is_int($result) ? $result : -1;
     }
 }

src/PhpSpreadsheet/Calculation/Functions.php

@@ -608,6 +608,24 @@ public static function flattenArray($array)
         return $arrayValues;
     }
 
+    /**
+     * @param mixed $value
+     *
+     * @return null|mixed
+     */
+    public static function scalar($value)
+    {
+        if (!is_array($value)) {
+            return $value;
+        }
+
+        do {
+            $value = array_pop($value);
+        } while (is_array($value));
+
+        return $value;
+    }
+
     /**
      * Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
      *

tests/PhpSpreadsheetTests/Calculation/Functions/DateTime/DateDifTest.php

@@ -2,6 +2,8 @@
 
 namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\DateTime;
 
+use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
+
 class DateDifTest extends AllSetupTeardown
 {
     /**
@@ -22,4 +24,30 @@ public function providerDATEDIF(): array
     {
         return require 'tests/data/Calculation/DateTime/DATEDIF.php';
     }
+
+    /**
+     * @dataProvider providerDateDifArray
+     */
+    public function testDateDifArray(array $expectedResult, string $startDate, string $endDate, ?string $methods): void
+    {
+        $calculation = Calculation::getInstance();
+
+        if ($methods === null) {
+            $formula = "=DATEDIF({$startDate}, {$endDate})";
+        } else {
+            $formula = "=DATEDIF({$startDate}, {$endDate}, {$methods})";
+        }
+        $result = $calculation->_calculateFormulaValue($formula);
+        self::assertEqualsWithDelta($expectedResult, $result, 1.0e-14);
+    }
+
+    public function providerDateDifArray(): array
+    {
+        return [
+            'row vector #1' => [[[364, 202, '#NUM!']], '{"2022-01-01", "2022-06-12", "2023-07-22"}', '"2022-12-31"', null],
+            'column vector #1' => [[[364], [362], [359]], '{"2022-01-01"; "2022-01-03"; "2022-01-06"}', '"2022-12-31"', null],
+            'matrix #1' => [[[365, 266], [139, 1]], '{"2022-01-01", "2022-04-10"; "2022-08-15", "2022-12-31"}', '"2023-01-01"', null],
+            'column vector with methods' => [[[364, 11], [242, 7], [173, 5]], '{"2022-01-01"; "2022-05-03"; "2022-07-11"}', '"2022-12-31"', '{"D", "M"}'],
+        ];
+    }
 }