CultuurNet\UDB3\CalendarFactory

Complexity

Total Complexity

40

Size/Duplication

Total Lines	283
Duplicated Lines	5.3 %

Coupling/Cohesion

Components	1
Dependencies	17

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
F	createFromCdbCalendar()	15	133	23
A	createFromWeekScheme()	0	18	2
B	createOpeningHoursFromWeekScheme()	0	31	6
A	openingHoursToArray()	0	22	2
B	createMergedOpeningHours()	0	22	5
B	createTimestamp()	0	25	2

<?php

namespace CultuurNet\UDB3;

use CultuurNet\UDB3\Cdb\DateTimeFactory;
use ValueObjects\DateTime\Time;
use ValueObjects\DateTime\WeekDay;

class CalendarFactory implements CalendarFactoryInterface
{
    /**
     * @inheritdoc
     */
    public function createFromCdbCalendar(\CultureFeed_Cdb_Data_Calendar $cdbCalendar)
    {
        //
        // Get the calendar type.
        //
        $calendarType = '';
        if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_Permanent) {
            $calendarType = 'permanent';
        } else if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_PeriodList) {
            $calendarType = 'periodic';
        } else if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_TimestampList) {
            $calendarType = 'single';
            if (iterator_count($cdbCalendar) > 1) {
                $calendarType = 'multiple';
            }
        }

        //
        // Get the start day.
        //
        $cdbCalendar->rewind();
        $startDateString = '';
        if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_PeriodList) {
            /** @var \CultureFeed_Cdb_Data_Calendar_Period $period */
            $period = $cdbCalendar->current();
            $startDateString = $period->getDateFrom() . 'T00:00:00';
        } else if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_TimestampList) {

This code seems to be duplicated across your project.

            /** @var \CultureFeed_Cdb_Data_Calendar_Timestamp $timestamp */
            $timestamp = $cdbCalendar->current();
            if ($timestamp->getStartTime()) {
                $startDateString = $timestamp->getDate() . 'T' . $timestamp->getStartTime();
            } else {
                $startDateString = $timestamp->getDate() . 'T00:00:00';
            }
        }
        $startDate = !empty($startDateString) ? DateTimeFactory::dateTimeFromDateString($startDateString) : null;

        //
        // Get the end day.
        //
        $cdbCalendar->rewind();
        $endDateString = '';
        if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_PeriodList) {
            /** @var \CultureFeed_Cdb_Data_Calendar_Period $period */
            $period = $cdbCalendar->current();
            $endDateString = $period->getDateTo() . 'T00:00:00';
        } else if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_TimestampList) {
            $firstTimestamp = $cdbCalendar->current();
            /** @var \CultureFeed_Cdb_Data_Calendar_Timestamp $timestamp */
            $cdbCalendarAsArray = iterator_to_array($cdbCalendar);
            $timestamp = iterator_count($cdbCalendar) > 1 ? end($cdbCalendarAsArray) : $firstTimestamp;
            if ($timestamp->getEndTime()) {

This code seems to be duplicated across your project.

                $endDateString = $timestamp->getDate() . 'T' . $timestamp->getEndTime();
            } else {
                $endTime = $timestamp->getStartTime() ? $timestamp->getStartTime() : '00:00:00';
                $endDateString = $timestamp->getDate() . 'T' . $endTime;
            }
        }
        $endDate = !empty($endDateString) ? DateTimeFactory::dateTimeFromDateString($endDateString) : null;

        //
        // Get the time stamps.
        //
        $cdbCalendar->rewind();
        $timestamps = [];
        if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_TimestampList) {
            while ($cdbCalendar->valid()) {
                /** @var \CultureFeed_Cdb_Data_Calendar_Timestamp $timestamp */
                $timestamp = $cdbCalendar->current();
                $cdbCalendar->next();

                $startTime = $timestamp->getStartTime() ? $timestamp->getStartTime() : '00:00:00';
                $startDateString = $timestamp->getDate() . 'T' . $startTime;

                if ($timestamp->getEndTime()) {
                    $endDateString = $timestamp->getDate() . 'T' . $timestamp->getEndTime();
                } else {
                    $endDateString = $timestamp->getDate() . 'T' . $startTime;
                }

                $timestamps[] = $this->createTimestamp(
                    $startDateString,
                    $endDateString
                );
            }
        }

        //
        // Get the opening hours.
        //
        $cdbCalendar->rewind();
        $openingHoursAsArray = [];

        $weekSchema = null;
        if ($cdbCalendar instanceof \CultureFeed_Cdb_Data_Calendar_PeriodList) {
            $period = $cdbCalendar->current();
            $weekSchema = $period->getWeekScheme();
        } else if ($cdbCalendar instanceof  \CultureFeed_Cdb_Data_Calendar_Permanent) {
            $weekSchema = $cdbCalendar->getWeekScheme();
        }

        if ($weekSchema) {
            $openingHours = $this->createOpeningHoursFromWeekScheme($weekSchema);
            $openingHoursAsArray = $this->openingHoursToArray($openingHours);
        }

        // End date might be before start date in cdbxml when event takes place
        // between e.g. 9 PM and 3 AM (the next day). UDB3 does not support this
        // and gracefully ignores the end time.
        //
        // Example cdbxml:
        //
        // <timestamp>
        //   <date>2016-12-16</date>
        //   <timestart>21:00:00</timestart>

39% of this comment could be valid code. Did you maybe forget this after debugging?

        //   <timeend>05:00:00</timeend>

39% of this comment could be valid code. Did you maybe forget this after debugging?

        // </timestamp>
        //
        if ($endDate < $startDate) {
            $endDate = $startDate;
        }

        //
        // Create the calendar value object.
        //
        return new Calendar(
            CalendarType::fromNative($calendarType),
            $startDate,
            $endDate,
            $timestamps,
            $openingHoursAsArray
        );
    }

    /**
     * @param \CultureFeed_Cdb_Data_Calendar_Weekscheme|null $weekScheme
     * @return Calendar
     */
    public function createFromWeekScheme(
        \CultureFeed_Cdb_Data_Calendar_Weekscheme $weekScheme = null
    ) {
        $openingHoursAsArray = [];

        if ($weekScheme) {
            $openingHours = $this->createOpeningHoursFromWeekScheme($weekScheme);
            $openingHoursAsArray = $this->openingHoursToArray($openingHours);
        }

        return new Calendar(
            CalendarType::PERMANENT(),
            null,
            null,
            [],
            $openingHoursAsArray
        );
    }

    /**
     * @param \CultureFeed_Cdb_Data_Calendar_Weekscheme $weekScheme
     * @return OpeningHours
     */
    private function createOpeningHoursFromWeekScheme(
        \CultureFeed_Cdb_Data_Calendar_Weekscheme $weekScheme
    ) {
        $openingHours = new OpeningHours();

        foreach ($weekScheme->getDays() as $day) {
            if ($day->isOpen()) {
                /** @var \CultureFeed_Cdb_Data_Calendar_OpeningTime[] $openingTimes */
                $openingTimes = $day->getOpeningTimes();

                $opens = \DateTime::createFromFormat(
                    'H:i:s',
                    $openingTimes ? $openingTimes[0]->getOpenFrom() : '00:00:00'
                );
                $closes = \DateTime::createFromFormat(
                    'H:i:s',
                    $openingTimes ? $openingTimes[0]->getOpenTill() : '00:00:00'
                );

                $openingHour = new OpeningHour(
                    WeekDay::fromNative(ucfirst($day->getDayName())),
                    Time::fromNativeDateTime($opens),

It seems like $opens defined by \DateTime::createFromFormat('H:i:s', $openingTimes ? $openingTimes[0]->getOpenFrom() : '00:00:00') on line 185 can also be of type false; however, ValueObjects\DateTime\Time::fromNativeDateTime() does only seem to accept object<DateTime>, did you maybe forget to handle an error condition?

                    $closes ? Time::fromNativeDateTime($closes) : Time::fromNativeDateTime($opens)

It seems like $opens defined by \DateTime::createFromFormat('H:i:s', $openingTimes ? $openingTimes[0]->getOpenFrom() : '00:00:00') on line 185 can also be of type false; however, ValueObjects\DateTime\Time::fromNativeDateTime() does only seem to accept object<DateTime>, did you maybe forget to handle an error condition?

                );

                $openingHours->addOpeningHour($openingHour);
            }
        }

        return $openingHours;
    }

    /**
     * @param OpeningHours $openingHours
     * @return array
     */
    private function openingHoursToArray(OpeningHours $openingHours)
    {
        $openingHoursAsArray = [];

        $mergedOpeningHours = $this->createMergedOpeningHours($openingHours);

        foreach ($mergedOpeningHours as $mergedOpeningHour) {
            $openingHour = $mergedOpeningHour->getOpeningHours()[0];
            $openingHoursAsArray[] = [
                'dayOfWeek' => array_map(
                    function (WeekDay $weekDay) {
                        return strtolower($weekDay->toNative());
                    },
                    $mergedOpeningHour->getWeekDays()
                ),
                'opens' => $openingHour->getOpens()->toNativeDateTime()->format('H:i'),
                'closes' => $openingHour->getCloses()->toNativeDateTime()->format('H:i'),
            ];
        }

        return $openingHoursAsArray;
    }

    /**
     * @param OpeningHours $openingHours
     * @return OpeningHours[]
     */
    private function createMergedOpeningHours(OpeningHours $openingHours)
    {
        /** @var OpeningHours[] $mergedOpeningHours */
        $mergedOpeningHours = [];

        foreach ($openingHours->getOpeningHours() as $openingHour) {
            $merged = false;
            foreach ($mergedOpeningHours as $mergedOpeningHour) {
                if ($mergedOpeningHour->equalOpeningHour($openingHour)) {
                    $mergedOpeningHour->addOpeningHour($openingHour);
                    $merged = true;
                    break;
                }
            }

            if (!$merged) {
                $mergedOpeningHours[] = new OpeningHours([$openingHour]);
            }
        }

        return $mergedOpeningHours;
    }

    /**
     * @param string $startDateString
     * @param string $endDateString
     * @return Timestamp
     */
    private function createTimestamp(
        $startDateString,
        $endDateString
    ) {
        $startDate = DateTimeFactory::dateTimeFromDateString($startDateString);
        $endDate = DateTimeFactory::dateTimeFromDateString($endDateString);

        // End date might be before start date in cdbxml when event takes place
        // between e.g. 9 PM and 3 AM (the next day). UDB3 does not support this
        // and gracefully ignores the end time.
        //
        // Example cdbxml:
        //
        // <timestamp>
        //   <date>2016-12-16</date>
        //   <timestart>21:00:00</timestart>

39% of this comment could be valid code. Did you maybe forget this after debugging?

        //   <timeend>05:00:00</timeend>

39% of this comment could be valid code. Did you maybe forget this after debugging?

        // </timestamp>
        //
        if ($endDate < $startDate) {
            $endDate = $startDate;
        }

        return new Timestamp($startDate, $endDate);
    }
}