Charcoal\Cms\Service\Loader\EventLoader

Complexity

Total Complexity

16

Size/Duplication

Total Lines	170
Duplicated Lines	19.41 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	proto()	0	8	2
A	all()	8	8	1
A	published()	9	9	1
A	upcoming()	0	7	2
A	archive()	0	7	2
A	since()	8	8	1
A	to()	8	8	1
A	lifespan()	0	4	1
A	objType()	0	4	1
A	setLifespan()	0	6	1
A	setObjType()	0	6	1
A	parseAsDate()	0	8	2

<?php

namespace Charcoal\Cms\Service\Loader;

use Charcoal\Loader\CollectionLoader;
use DateTime;
use DateTimeInterface;

/**
 * Event Loader
 */
class EventLoader extends AbstractLoader
{
    /**
     * Event prototype.
     * @var ModelInterface $proto
     */
    private $proto;

    /**
     * @var string $lifespan The lifespan of events.
     */
    private $lifespan;

    /**
     * [proto description]
     * @return [type] [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function proto()
    {
        if (!$this->proto) {
            $this->proto = $this->modelFactory()->get($this->objType());
        }

        return $this->proto;
    }

    /**
     * @return CollectionLoader
     */
    public function all()

This method seems to be duplicated in your project.

    {
        $proto = $this->proto();
        $loader = $this->collectionLoader()->setModel($proto);
        $loader->addFilter('active', true);

        return $loader;
    }

    /**
     * @return CollectionLoader
     */
    public function published()

This method seems to be duplicated in your project.

    {
        $now = new DateTime();
        $loader = $this->all();
        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '<=' ])
            ->addOrder('start_date', 'asc');

        return $loader;
    }

    /**
     * Fetch upcoming entries based on the lifespan or now.
     * @return CollectionLoader
     */
    public function upcoming()
    {
        $lifespan = $this->lifespan();
        $date = is_string($lifespan) ? new DateTime($lifespan) : new DateTime();

        return $this->since($date);
    }

    /**
     * Fetch upcoming entries based on the lifespan or now.
     * @return CollectionLoader
     */
    public function archive()
    {
        $lifespan = $this->lifespan();
        $date = is_string($lifespan) ? new DateTime($lifespan) : new DateTime();

        return $this->to($date);
    }

    /**
     * @param mixed $date The news date to filter
     *                    [startDate, endDate]
     *                    DateTimeInterface
     *                    string.
     * @return CollectionLoader
     */
    public function since($date)

This method seems to be duplicated in your project.

    {
        $date = $this->parseAsDate($date);
        $loader = $this->published();
        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), [ 'operator' => '>=' ]);

        return $loader;
    }

    /**
     * @param mixed $date The news date to filter
     *                    [startDate, endDate]
     *                    DateTimeInterface
     *                    string.
     * @return CollectionLoader
     */
    public function to($date)

This method seems to be duplicated in your project.

    {
        $date = $this->parseAsDate($date);
        $loader = $this->published();
        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), [ 'operator' => '<' ]);

        return $loader;
    }

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

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

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

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

    /**
     * @param string $lifespan The lifespan of events.
     * @return self Chainable
     */
    public function setLifespan($lifespan)
    {
        $this->lifespan = $lifespan;

        return $this;
    }

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

        return $this;
    }

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

    /**
     * @param mixed $date The date to convert.
     * @return DateTime
     */
    private function parseAsDate($date)
    {
        if ($date instanceof DateTimeInterface) {
            return $date;
        }

        return new DateTime($date);
    }
}