SuiteCRM-Core/core/backend/Statistics/DateTimeStatisticsHandlingTrait.php

<?php
/**
 * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
 * Copyright (C) 2021 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Supercharged by SuiteCRM".
 */


namespace App\Statistics;

use App\Statistics\Entity\Statistic;
use DateTimeService;
use Exception;

trait DateTimeStatisticsHandlingTrait
{
    use StatisticsHandlingTrait;

    /**
     * @param string $key
     * @param string $start
     * @param string|null $end
     * @return Statistic
     * @throws Exception
     */
    protected function getDateDiffStatistic(string $key, string $start, string $end = null): Statistic
    {
        /* @noinspection PhpIncludeInspection */
        require_once 'include/portability/Services/DateTime/DateTimeService.php';
        $datetimeService = new DateTimeService();
        $diff = $datetimeService->diffDateStrings($start, $end);
        $days = $diff['days'] ?? null;
        $hours = $diff['hours'] ?? null;
        $minutes = $diff['minutes'] ?? null;
        $seconds = $diff['seconds'] ?? null;

        if ($days === null || $hours === null || $minutes === null || $seconds === null) {
            return $this->getEmptyResponse($key);
        }

        $dataType = 'int';

        if ($days == 0 && ($hours > 0 || $minutes > 0 || $seconds >= 0)) {
            $days = '< 1';
            $dataType = 'string';
        }

        $result = [
            'value' => $days
        ];

        return $this->buildSingleValueResponse($key, $dataType, $result);
    }
}