Charcoal\Cms\Service\Manager\EventManager

Complexity

Total Complexity

111

Size/Duplication

Total Lines	851
Duplicated Lines	27.14 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

42 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	20	20	2
D	entries()	0	103	15
A	entry()	16	16	4
A	all()	0	11	2
A	loadCategoryItems()	10	10	1
A	categoryItem()	0	6	1
C	featList()	56	56	14
B	archive()	24	24	5
A	latest()	11	11	2
A	prev()	0	8	2
A	next()	0	8	2
C	currentPage()	23	23	7
A	getEventsByDate()	3	17	3
A	currentEvent()	0	8	2
A	numPerPage()	0	4	1
A	entryCycle()	0	4	1
A	numEvent()	0	4	1
A	numPages()	17	17	3
A	hasPager()	0	4	1
A	page()	0	4	1
A	category()	0	4	1
A	objType()	0	4	1
A	featIdent()	0	4	1
A	loader()	0	4	1
A	date()	0	4	1
A	year()	0	4	1
A	month()	0	4	1
A	day()	0	4	1
A	setCurrentEvent()	0	6	1
A	setNumPerPage()	0	6	1
A	setEntryCycle()	0	6	1
A	setPage()	0	6	1
A	setCategory()	0	6	1
A	setObjType()	0	6	1
A	setFeatIdent()	0	6	1
A	setLoader()	0	6	1
A	setDate()	0	6	1
A	setYear()	0	9	2
A	setMonth()	0	9	2
A	setDay()	0	9	2
C	setPrevNext()	48	48	11
C	mapEvents()	3	43	7

<?php

namespace Charcoal\Cms\Service\Manager;

// dependencies from `charcoal-core`
use Charcoal\Model\Collection;
use Charcoal\Model\Model;

// dependencies from `charcoal-base`
use Charcoal\Object\CategoryInterface;
use Charcoal\Object\CategoryTrait;

// Local dependencies
use Charcoal\Cms\EventCategory;
use Charcoal\Cms\Config\CmsConfig;
use Charcoal\Cms\EventInterface;
use Charcoal\Cms\Service\Loader\EventLoader;

// Psr-7 dependencies
use DateTime;
use DateTimeInterface;
use Exception;

/**
 * Event manager
 */
class EventManager extends AbstractManager
{
    use CategoryTrait;

    /** @var EventInterface $currentEvent The current event. */
    private $currentEvent;

    /** @var integer $currentPage The current Page. */
    private $currentPage;

    /** @var integer $numPerPage Events by page. */
    private $numPerPage = 0;

    /** @var integer $numPage How many pages. */
    private $numPage;

    /** @var boolean $entryCycle Does the pager can cycle indefinitely. */
    private $entryCycle = false;

    /** @var EventInterface $nextEvent */
    private $nextEvent;

    /** @var EventInterface $prevEvent */
    private $prevEvent;

    /** @var integer $page The page number. */
    private $page = 0;

    /** @var integer $category Id for category. */
    private $category = 0;

    /** @var EventInterface[] $all All the events. */
    private $all = [];

    /** @var EventInterface[] $entries The event collection. */
    private $entries = [];

    /** @var EventInterface[] $archive The archive events collection. */
    private $archive = [];

    /** @var EventInterface $entry An event. */
    private $entry;

    /** @var object $objType The event object model. */
    private $objType;

    /** @var string $featIdent The config ident for featured events. */
    private $featIdent;

    /** @var EventInterface[] $featList The config ident for featured events. */
    private $featList = [];

    /** @var EventLoader $loader The event loader provider. */
    private $loader;

    /** @var array $mapEvents The events mapped per [year][month][date]. */
    private $mapEvents = [];

    /** @var datetime $date Datetime filter */
    private $date;

    /** @var mixed $year Year filter. */
    private $year;

    /** @var mixed $month Month filter. */
    private $month;

    /** @var mixed $day Day filter. */
    private $day;

    /**
     * EventManager constructor.
     * @param array $data The Data.
     * @throws Exception When $data index is not set.
     */
    public function __construct(array $data)

This method seems to be duplicated in your project.

    {
        parent::__construct($data);

        if (!isset($data['event/loader'])) {
            throw new Exception('Event Loader must be defined in the EventManager constructor.');
        }

        $this->setLoader($data['event/loader']);

        /** @var CmsConfig $eventConfig */
        $eventConfig = $this->adminConfig()->eventConfig();

        // City.json
        $this->setNumPerPage($eventConfig->get('numPerPage'));
        $this->setEntryCycle($eventConfig->get('entryCycle'));
        $this->setObjType($eventConfig->get('objType'));
        $this->setCategoryItemType($eventConfig->get('category'));
        $this->setFeatIdent($eventConfig->get('configFeatIdent'));
    }

    /**
     * To be displayed events list.
     * @return mixed The event collection.
     */
    public function entries()
    {
        // Used loader
        $loader = $this->loader()->upcoming();

        // Pagination
        $page = $this->page();

        // Filters
        $cat = $this->category();
        $date = $this->date();
        $year = $this->year();
        $month = $this->month();
        $day = $this->day();

        // Basicly.
        if ($year && $month && $day && !$date) {
            $date = new DateTime($year.'-'.$month.'-'.$day);
        }

        // Category is still valid.
        $extraSql = '';
        if ($cat) {
            $extraSql = '
            AND
                \''.$cat.'\' IN (category)';
        }

        // Get event from specific date.
        if ($date) {
            $loader = $this->loader()->all();
            $proto = $this->loader()->proto();
            $table = $proto->source()->table();
            $q = 'SELECT * FROM '.$table.'
                WHERE
                    \''.$date->format('Y-m-d').'\'
                BETWEEN
                    DATE(start_date) AND DATE(end_date)
                AND
                    active = 1'.$extraSql;

            $collection = $loader->loadFromQuery($q);

            return $collection;
        }

        // YEAR only filter.
        if ($year && !$month) {
            $loader = $this->loader()->all();
            $proto = $this->loader()->proto();
            $table = $proto->source()->table();
            $q = 'SELECT * FROM '.$table.'
                WHERE
                    \''.$this->year().'\' = YEAR(start_date)
                OR
                    \''.$this->year().'\' = YEAR(end_date)
                AND
                    active = 1'.$extraSql;

            $collection = $loader->loadFromQuery($q);

            return $collection;
        }

        // Year AND month filter.
        if ($year && $month) {
            $between = new DateTime($year.'-'.$month.'-01');
            $loader = $this->loader()->all();
            $proto = $this->loader()->proto();
            $table = $proto->source()->table();
            $q = 'SELECT * FROM '.$table.'
                WHERE
                    \''.$between->format('Y-m-d H:i:s').'\'
                BETWEEN
                    CAST(CONCAT(YEAR(start_date), \'-\', MONTH(start_date), \'-\', 01) AS DATETIME)
                AND
                    CAST(CONCAT(YEAR(end_date), \'-\', MONTH(end_date), \'-\', 01) AS DATETIME)
                AND
                    active = 1'.$extraSql;

            $collection = $loader->loadFromQuery($q);

            return $collection;
        }

        if (isset($this->entries[$cat])) {
            if (isset($this->entries[$cat][$page])) {
                return $this->entries[$cat][$page];
            }
        }

        if ($this->category()) {
            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
        }

        if ($this->numPerPage()) {
            $loader->setPage($page);
            $loader->setNumPerPage($this->numPerPage());
        }
        $this->entries[$cat][$page] = $loader->load();

        return $this->entries[$cat][$page];
    }

    /**
     * @param integer|null $id The event id.
     * @return mixed
     */
    public function entry($id = null)

This method seems to be duplicated in your project.

    {
        if (!$id) {

The expression $id of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

            return $this->currentEvent();
        }

        if (!isset($this->entry[$id])) {
            /** @var Model $model */
            $model = $this->modelFactory();
            /** @var EventInterface $entry */
            $entry = $model->get($this->objType())->loadfrom('id', $id);

$this->objType() is of type object, but the function expects a string.

            $this->entry[$id] = $entry->id() ? $entry : $this->currentEvent();
        }

        return $this->entry[$id];
    }

    /**
     * All available events
     * @return EventInterface[]|Collection The events collection
     */
    public function all()
    {
        if ($this->all) {

The expression $this->all of type Charcoal\Cms\EventInterface[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return $this->all;
        }

        $this->all = $this->loader()->all()

It seems like $this->loader()->all()->addOrder('start_date', 'asc')->load() can also be of type object. However, the property $all is declared as type array<integer,object<Charcoal\Cms\EventInterface>>. Maybe add an additional type check?

            ->addOrder('start_date', 'asc')->load();

        return $this->all;
    }

    /**
     * @return CategoryInterface[]|Collection The category collection.
     */
    public function loadCategoryItems()

This method seems to be duplicated in your project.

    {
        /** @var Model $model */
        $model = $this->modelFactory();
        $proto = $model->get($this->categoryItemType());
        $loader = $this->collectionLoader()->setModel($proto);
        $loader->addFilter('active', true);

        return $loader->load();
    }

    /**
     * @param integer $id The category id.
     * @return CategoryInterface|EventCategory
     */
    public function categoryItem($id)
    {
        $category = $this->modelFactory()->get($this->categoryItemType());

        return $category->load($id);
    }

    /**
     * Get featured events from config objects with custom filters as options.
     * @return mixed
     * @param array $options The options for the collection loader.
     * @throws Exception When featured news ident is not valid.
     */
    public function featList(array $options = [])

This method seems to be duplicated in your project.

    {
        if ($this->featList) {

The expression $this->featList of type Charcoal\Cms\EventInterface[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return $this->featList;
        }

        $loader = $this->loader()->published();
        $ident = $this->featIdent();
        $config = $this->adminConfig();

        if (!$ident || !method_exists($config, $ident)) {
            throw new Exception(sprintf(
                'The featured news ident "%s" doesn\'t exist the class "%s"',
                $ident,
                get_class($config)
            ));
        }
        $ids = $config->{$ident}();

        if (!$ids) {
            return null;
        }

        $ids = explode(',', $ids);

        $loader->addFilter('id', $ids, [ 'operator' => 'in' ])
            ->addOrder('id', 'values', [ 'values' => $ids ]);

        if (count($options) > 0) {
            foreach ($options as $key => $option) {
                switch ($key) {
                    case 'filters':
                        $filters = $option;
                        foreach ($filters as $f) {
                            $filter[] = $f['property'] ?: '';

$filter was never initialized. Although not strictly required by PHP, it is generally a good practice to add $filter = array(); before regardless.

                            $filter[] = $f['val'] ?: '';

The variable $filter does not seem to be defined for all execution paths leading up to this point.

                            $filter[] = $f['options'] ?: '';
                            $filter = join(',', $filter);

                            $loader->addFilter($filter);
                        }
                        break;
                    case 'page':
                        $loader->setPage($option);
                        break;
                    case 'numPerPage':
                        $loader->setNumPerPage($option);
                        break;
                }
            }
        }

        $this->featList = $loader->load();

It seems like $loader->load() can also be of type object. However, the property $featList is declared as type array<integer,object<Charcoal\Cms\EventInterface>>. Maybe add an additional type check?

        return $this->featList;
    }

    /**
     * @return EventInterface[]|Collection
     */
    public function archive()

This method seems to be duplicated in your project.

    {
        $page = $this->page();
        $cat = $this->category();
        if (isset($this->archive[$cat])) {
            if (isset($this->archive[$cat][$page])) {
                return $this->archive[$cat][$page];
            }
        }

        $loader = $this->loader()->archive();

        if ($this->category()) {
            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
        }
        if ($this->numPerPage()) {
            $loader->setPage($this->page());
            $loader->setNumPerPage($this->numPerPage());
        }

        $this->archive[$cat][$page] = $loader->load();

        return $this->archive[$cat][$page];
    }

    /**
     * Get the latest event.
     * @return EventInterface|array The latest event.
     */
    public function latest()

This method seems to be duplicated in your project.

    {
        $entries = $this->entries();

        if (isset($entries[0])) {
            return $entries[0];
        } else {
            // NO EVENT!
            return [];
        }
    }

    /**
     * @return mixed The previous event
     */
    public function prev()
    {
        if ($this->prevEvent) {
            return $this->prevEvent;
        } else {
            return $this->setPrevNext()->prevEvent;
        }
    }

    /**
     * @return mixed The next event
     */
    public function next()
    {
        if ($this->nextEvent) {
            return $this->nextEvent;
        } else {
            return $this->setPrevNext()->nextEvent;
        }
    }

    /**
     * @return float|int The current event index page ident.
     */
    public function currentPage()

This method seems to be duplicated in your project.

    {
        if ($this->currentPage) {
            return $this->currentPage;
        }
        if (!$this->currentEvent() || !$this->currentEvent()['id']) {
            $this->currentPage = 1;

            return 1;
        }
        $all = $this->all();
        $i = 0;
        foreach ($all as $event) {
            $i++;
            if ($event->id() == $this->currentEvent()['id']) {
                break;
            }
        }

        $this->currentPage = $this->numPerPage() ? ceil($i / $this->numPerPage()) : 1;

It seems like $this->numPerPage() ? ceil($i / $this->numPerPage()) : 1 can also be of type double. However, the property $currentPage is declared as type integer. Maybe add an additional type check?

        return $this->currentPage;
    }

    /**
     * @param mixed $date The date from which to load.
     * @return array
     */
    public function getEventsByDate($date)
    {
        if (!($date instanceof DateTimeInterface)) {
            $date = new DateTime($date);
        }

        $map = $this->mapEvents();
        $year = $date->format('Y');
        $month = $date->format('m');
        $day = $date->format('d');

        if (isset($map[$year][$month][$day])) {

This code seems to be duplicated across your project.

            return $map[$year][$month][$day];
        }

        return [];
    }

    // ==========================================================================
    // GETTERS
    // ==========================================================================

    /**
     * @return mixed
     */
    public function currentEvent()
    {
        if (!$this->currentEvent) {
            $this->currentEvent = $this->latest();

It seems like $this->latest() can also be of type array. However, the property $currentEvent is declared as type object<Charcoal\Cms\EventInterface>. Maybe add an additional type check?

        }

        return $this->currentEvent;
    }

    /**
     * @return integer
     */
    public function numPerPage()
    {
        return $this->numPerPage;
    }

    /**
     * @return boolean
     */
    public function entryCycle()
    {
        return $this->entryCycle;
    }

    /**
     * Amount of event (total)
     * @return integer How many event?
     */
    public function numEvent()
    {
        return !!(count($this->entries()));
    }

    /**
     * The total amount of pages.
     * @return float
     */
    public function numPages()

This method seems to be duplicated in your project.

    {
        if ($this->numPage) {
            $this->numPage;
        };

        $entries = $this->entries();
        $count = count($entries);

        if ($this->numPerPage()) {
            $this->numPage = ceil($count / $this->numPerPage());

The property $numPage was declared of type integer, but ceil($count / $this->numPerPage()) is of type double. Maybe add a type cast?

        } else {
            $this->numPage = 1;
        }

        return $this->numPage;
    }

    /**
     * Is there a pager.
     * @return boolean
     */
    public function hasPager()
    {
        return ($this->numPages() > 1);
    }

    /**
     * @return integer
     */
    public function page()
    {
        return $this->page;
    }

    /**
     * @return integer
     */
    public function category()
    {
        return $this->category;
    }

    /**
     * @return mixed
     */
    public function objType()
    {
        return $this->objType;
    }

    /**
     * @return mixed
     */
    public function featIdent()
    {
        return $this->featIdent;
    }

    /**
     * @return EventLoader
     */
    public function loader()
    {
        return $this->loader;
    }

    /**
     * Datetime object OR null.
     * @return mixed Datetime or null.
     */
    public function date()
    {
        return $this->date;
    }

    /**
     * Full year
     * @return integer Full year.
     */
    public function year()
    {
        return $this->year;
    }

    /**
     * Month
     * @return mixed month.
     */
    public function month()
    {
        return $this->month;
    }

    /**
     * Day
     * @return mixed day.
     */
    public function day()
    {
        return $this->day;
    }

    // ==========================================================================
    // SETTERS
    // ==========================================================================

    /**
     * @param mixed $currentEvent The current event context.
     * @return self
     */
    public function setCurrentEvent($currentEvent)
    {
        $this->currentEvent = $currentEvent;

        return $this;
    }

    /**
     * @param integer $numPerPage The number of event per page.
     * @return self
     */
    public function setNumPerPage($numPerPage)
    {
        $this->numPerPage = $numPerPage;

        return $this;
    }

    /**
     * @param boolean $entryCycle Next and Prev cycles indefinitely.
     * @return self
     */
    public function setEntryCycle($entryCycle)
    {
        $this->entryCycle = $entryCycle;

        return $this;
    }

    /**
     * @param integer $page The page number to load.
     * @return self
     */
    public function setPage($page)
    {
        $this->page = $page;

        return $this;
    }

    /**
     * @param integer $category The current entry category.
     * @return self
     */
    public function setCategory($category)
    {
        $this->category = $category;

        return $this;
    }

    /**
     * @param mixed $objType The object type.
     * @return self
     */
    public function setObjType($objType)
    {
        $this->objType = $objType;

        return $this;
    }

    /**
     * @param mixed $featIdent The featured list ident.
     * @return self
     */
    public function setFeatIdent($featIdent)
    {
        $this->featIdent = $featIdent;

        return $this;
    }

    /**
     * @param EventLoader|null $loader The event loader provider.
     * @return self
     */
    public function setLoader($loader)
    {
        $this->loader = $loader;

        return $this;
    }

    /**
     * Set date filter.
     * @param DateTime $date Date filter.
     * @return self
     */
    public function setDate(DateTime $date)
    {
        $this->date = $date;

It seems like $date of type object<DateTime> is incompatible with the declared type object<Charcoal\Cms\Service\Manager\datetime> of property $date.

        return $this;
    }

    /**
     * Full year.
     * @param mixed $year Full year.
     * @throws Exception If argument is not scalar.
     * @return EventManager
     */
    public function setYear($year)
    {
        if (!is_scalar($year)) {
            throw new Exception('Year must be a string or an integer in EventManager setYear method.');
        }
        $this->year = $year;

        return $this->year;
    }

    /**
     * Month.
     * @param mixed $month Specific month.
     * @throws Exception If argument is not scalar.
     * @return EventManager
     */
    public function setMonth($month)
    {
        if (!is_scalar($month)) {
            throw new Exception('Month must be a string or an integer in EventManager setMonth method.');
        }
        $this->month = $month;

        return $this;
    }

    /**
     * Day.
     * @param mixed $day Specific day.
     * @throws Exception If argument is not scalar.
     * @return EventManager
     */
    public function setDay($day)
    {
        if (!is_scalar($day)) {
            throw new Exception('Day must be a string or an integer in EventManager setDay method.');
        }
        $this->day = $day;

        return $this;
    }

    // ==========================================================================
    // UTILS
    // ==========================================================================

    /**
     * Set the Prev and Next event
     * @return $this
     */
    public function setPrevNext()

This method seems to be duplicated in your project.

    {
        if ($this->prevEvent && $this->nextEvent) {
            return $this;
        }
        $entries = $this->entries();

        $isPrev = false;
        $isNext = false;
        $firstEvent = false;
        $lastEvent = false;

        foreach ($entries as $event) {
            // Obtain th first event.
            if (!$firstEvent) {
                $firstEvent = $event;
            }
            $lastEvent = $event;
            // Find the current event
            if ($event->id() == $this->currentEvent()['id']) {
                $isNext = true;
                $isPrev = true;

                continue;
            }
            if (!$isPrev) {
                $this->prevEvent = $event;
            }
            // Store the next event
            if ($isNext) {
                $this->nextEvent = $event;

                $isNext = false;
            }
        }

        if ($this->entryCycle()) {
            if (!$this->nextEvent) {
                $this->nextEvent = $firstEvent;
            }

            if (!$this->prevEvent) {
                $this->prevEvent = $lastEvent;
            }
        }

        return $this;
    }

    /**
     * Mapping between events and dates
     * @return array The array containing events stored as [$year][$month][$day][event]
     */
    public function mapEvents()
    {
        if ($this->mapEvents) {

The expression $this->mapEvents of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return $this->mapEvents;
        }

        $events = $this->all();

        $out = [];
        foreach ($events as $ev) {
            $firstDate = $ev->startDate();
            $lastDate = $ev->endDate();

            $current = new DateTime();
            $current->setTimestamp($firstDate->getTimestamp());

            while ($current <= $lastDate) {
                $year = $current->format('Y');
                $month = $current->format('m');
                $day = $current->format('d');

                if (!isset($out[$year])) {
                    $out[$year] = [];
                }

                if (!isset($out[$year][$month])) {
                    $out[$year][$month] = [];
                }

                if (!isset($out[$year][$month][$day])) {

This code seems to be duplicated across your project.

                    $out[$year][$month][$day] = [];
                }

                $out[$year][$month][$day][] = $ev;

                $current->modify('+1 day');
            }
        }

        $this->mapEvents = $out;

        return $this->mapEvents;
    }
}