Files
Cloud-CMS/lib/Report/PeriodTrait.php
Matt Batchelder 05ce0da296 Initial Upload
2025-12-02 10:32:59 -05:00

104 lines
3.3 KiB
PHP

<?php
/*
* Copyright (C) 2021 Xibo Signage Ltd
*
* Xibo - Digital Signage - http://www.xibo.org.uk
*
* This file is part of Xibo.
*
* Xibo is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* Xibo 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 Xibo. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Xibo\Report;
use Carbon\Carbon;
/**
* Trait PeriodTrait
* @package Xibo\Report
*/
trait PeriodTrait
{
public function generateHourPeriods($filterRangeStart, $filterRangeEnd, $start, $end, $ranges)
{
$periodData = []; // to generate periods table
// Generate all hours of the period
foreach ($ranges as $range) {
$startHour = $start->addHour()->format('U');
// Remove the period which crossed the end range
if ($startHour >= $filterRangeEnd) {
continue;
}
// Period start
$periodData[$range]['start'] = $startHour;
if ($periodData[$range]['start'] < $filterRangeStart) {
$periodData[$range]['start'] = $filterRangeStart;
}
// Period end
$periodData[$range]['end'] = $end->addHour()->format('U');
if ($periodData[$range]['end'] > $filterRangeEnd) {
$periodData[$range]['end'] = $filterRangeEnd;
}
$hourofday = Carbon::createFromTimestamp($periodData[$range]['start'])->hour;
// groupbycol = hour
$periodData[$range]['groupbycol'] = $hourofday;
}
return $periodData;
}
public function generateDayPeriods($filterRangeStart, $filterRangeEnd, $start, $end, $ranges, $groupByFilter = null)
{
$periodData = []; // to generate periods table
// Generate all days of the period
foreach ($ranges as $range) {
$startDay = $start->addDay()->format('U');
// Remove the period which crossed the end range
if ($startDay >= $filterRangeEnd) {
continue;
}
// Period start
$periodData[$range]['start'] = $startDay;
if ($periodData[$range]['start'] < $filterRangeStart) {
$periodData[$range]['start'] = $filterRangeStart;
}
// Period end
$periodData[$range]['end'] = $end->addDay()->format('U');
if ($periodData[$range]['end'] > $filterRangeEnd) {
$periodData[$range]['end'] = $filterRangeEnd;
}
if ($groupByFilter == 'bydayofweek') {
$groupbycol = Carbon::createFromTimestamp($periodData[$range]['start'])->dayOfWeekIso;
} else {
$groupbycol = Carbon::createFromTimestamp($periodData[$range]['start'])->day;
}
// groupbycol = dayofweek
$periodData[$range]['groupbycol'] = $groupbycol;
}
return $periodData;
}
}