Odiseo\SyliusReportPlugin\DataFetcher\TimePeriodDataFetcher

Complexity

Total Complexity

24

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getPeriodChoices()	0	6	1
A	fillEmptyRecords()	0	22	3
F	fetch()	0	68	14
A	setExtraConfiguration()	0	12	1
A	getMediaResults()	0	23	5

<?php

namespace Odiseo\SyliusReportPlugin\DataFetcher;

/**
 * Abstract class to provide time periods logic.
 *
 * @author Łukasz Chruściel <lukasz.chrusciel@lakion.com>
 * @author Diego D'amico <diego@odiseo.com.ar>
 */
abstract class TimePeriodDataFetcher extends BaseDataFetcher
{
    const PERIOD_DAY = 'day';
    const PERIOD_MONTH = 'month';
    const PERIOD_YEAR = 'year';

    /**
     * @return array
     */
    public static function getPeriodChoices()
    {
        return [
            'Daily' => self::PERIOD_DAY,
            'Monthly' => self::PERIOD_MONTH,
            'Yearly' => self::PERIOD_YEAR,
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function fetch(array $configuration): Data
    {
        $data = new Data();

        /** @var \DateTime $endDate */
        $endDate = $configuration['timePeriod']['end'];

        //There is added 23 hours 59 minutes 59 seconds to the end date to provide records for whole end date
        $configuration['timePeriod']['end'] = $endDate?$endDate->add(new \DateInterval('PT23H59M59S')):null;

$endDate is of type DateTime, thus it always evaluated to true.

        switch ($configuration['timePeriod']['period']) {
            case self::PERIOD_DAY:
                $this->setExtraConfiguration($configuration, 'P1D', '%a', 'Y-m-d', ['date']);
                break;
            case self::PERIOD_MONTH:
                $this->setExtraConfiguration($configuration, 'P1M', '%m', 'F Y', ['month', 'year']);
                break;
            case self::PERIOD_YEAR:
                $this->setExtraConfiguration($configuration, 'P1Y', '%y', 'Y', ['year']);
                break;
            default:
                throw new \InvalidArgumentException('Wrong data fetcher period');
        }

        $rawData = $this->getData($configuration);

        if (empty($rawData)) {
            return $data;
        }

        $labelsAux = array_keys($rawData[0]);
        $labels = [];
        foreach ($labelsAux as $label) {
            if (!in_array($label, ['MonthDate', 'YearDate', 'DateDate'])) {
                $labels[] = $label;
            }
        }
        $data->setLabels($labels);

        $fetched = [];

        if ($configuration['empty_records']) {
            $fetched = $this->fillEmptyRecords($fetched, $configuration);
        }
        foreach ($rawData as $row) {
            $rowFetched = [];
            foreach ($labels as $i => $label) {
                if ($i === 0) {
                    $date = new \DateTime($row[$labels[0]]);
                    $rowFetched[] = $date->format($configuration['timePeriod']['presentationFormat']);
                } else {
                    $rowFetched[] = $row[$labels[$i]];
                }
            }
            $fetched[] = $rowFetched;
        }

        $data->setData($fetched);

        $labels = [];
        foreach ($labelsAux as $label) {
            if (!in_array($label, ['MonthDate', 'YearDate', 'DateDate'])) {
                $labels[] = preg_replace('/(?!^)[A-Z]{2,}(?=[A-Z][a-z])|[A-Z][a-z]/', ' $0', $label);
            }
        }
        $data->setLabels($labels);

        return $data;
    }

    /**
     * @param array  $configuration
     * @param string $interval
     * @param string $periodFormat
     * @param string $presentationFormat
     * @param array  $groupBy
     */
    protected function setExtraConfiguration(
        array &$configuration,
        $interval,
        $periodFormat,
        $presentationFormat,
        array $groupBy
    ) {
        $configuration['timePeriod']['interval'] = $interval;
        $configuration['timePeriod']['periodFormat'] = $periodFormat;
        $configuration['timePeriod']['presentationFormat'] = $presentationFormat;
        $configuration['groupBy'] = $groupBy;
        $configuration['empty_records'] = false;
    }

    /**
     * @param array $fetched
     * @param array $configuration
     *
     * @return array
     */
    private function fillEmptyRecords(array $fetched, array $configuration)
    {
        /** @var \DateTime $startDate */
        $startDate = $configuration['start'];
        /** @var \DateTime $startDate */
        $endDate = $configuration['end'];

        try {
            $dateInterval = new \DateInterval($configuration['interval']);
        } catch (\Exception $e) {
            return $fetched;
        }

        $numberOfPeriods = $startDate->diff($endDate);
        $formattedNumberOfPeriods = $numberOfPeriods->format($configuration['periodFormat']);

        for ($i = 0; $i <= $formattedNumberOfPeriods; ++$i) {
            $fetched[$startDate->format($configuration['presentationFormat'])] = 0;
            $startDate = $startDate->add($dateInterval);
        }

        return $fetched;
    }

    /**
     * @param array $datas
     * @param array $configuration
     * @return array
     */
    protected function getMediaResults(array $datas = [], array $configuration = [])
    {
        if (empty($datas)) {
            return [];
        }
        $labels = array_keys($datas[0]);
        $datesMedia = [];
        foreach ($datas as $data) {
            $date = new \DateTime($data[$labels[0]]);
            $dateFormated = $date->format($configuration['timePeriod']['presentationFormat']);
            $currentDateMedia = isset($datesMedia[$dateFormated])?$datesMedia[$dateFormated]:array('quantity' => 0, 'media' => 0);
            $currentDateMedia['quantity'] = $currentDateMedia['quantity']+1;
            $currentDateMedia['media'] = $currentDateMedia['media']+$data[$labels[1]];
            $datesMedia[$dateFormated] = $currentDateMedia;
        }
        $fetched = [];
        foreach ($datesMedia as $date => $dateMedia) {
            $fetched[] = [
                $labels[0] => $date,
                $labels[1] => round($dateMedia['media']/$dateMedia['quantity'], 1)
            ];
        }
        return $fetched;
    }
}