Charcoal\Cms\Service\Manager\NewsManager

Complexity

Total Complexity

81

Size/Duplication

Total Lines	593
Duplicated Lines	41.15 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	19	19	2
B	entries()	23	23	5
A	entry()	13	13	4
A	all()	0	10	2
A	loadCategoryItems()	8	8	1
A	categoryItem()	0	10	2
C	featList()	56	56	14
B	archive()	25	25	5
A	latest()	11	11	2
A	prev()	0	8	2
A	next()	0	8	2
C	currentPage()	23	23	7
A	currentNews()	0	8	2
A	numPerPage()	0	4	1
A	entryCycle()	0	4	1
A	numNews()	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	setCurrentNews()	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
C	setPrevNext()	49	49	11

<?php

namespace Charcoal\Cms\Service\Manager;

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

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

// Local dependencies
use Charcoal\Cms\Config\CmsConfig;
use Charcoal\Cms\NewsInterface;
use Charcoal\Cms\Service\Loader\NewsLoader;

// Psr-7 dependencies
use Exception;

/**
 * News manager
 */
class NewsManager extends AbstractManager
{
    use CategoryTrait;

    /** @var NewsInterface $currentNews The current news. */
    protected $currentNews;

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

    /** @var integer $numPerPage News by page. */
    protected $numPerPage = 0;

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

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

    /** @var NewsInterface $nextNews */
    protected $nextNews;

    /** @var NewsInterface $prevNews */
    protected $prevNews;

    /** @var integer $page */
    protected $page = 0;

    /** @var integer $category */
    protected $category = 0;

    /** @var NewsInterface[] $all All the news. */
    protected $all = [];

    /** @var NewsInterface[] $entries The news collection. */
    protected $entries = [];

    /** @var NewsInterface[] $archive The archive news collection. */
    protected $archive = [];

    /** @var NewsInterface $entry A news. */
    protected $entry;

    /** @var object $objType The news object model. */
    protected $objType;

    /** @var string $featIdent The config ident for featured news. */
    protected $featIdent;

    /** @var NewsInterface[] $featList The config ident for featured news. */
    protected $featList = [];

    /** @var NewsLoader $loader The news loader provider. */
    protected $loader;

    /**
     * @var array
     */
    protected $categoryItem = [];

    /**
     * NewsManager 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['news/loader'])) {
            throw new Exception('News Loader must be defined in the NewsManager constructor.');
        }

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

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

        $this->setNumPerPage($newsConfig->get('numPerPage'));
        $this->setEntryCycle($newsConfig->get('entryCycle'));
        $this->setObjType($newsConfig->get('objType'));
        $this->setCategoryItemType($newsConfig->get('category'));
        $this->setFeatIdent($newsConfig->get('configFeatIdent'));
    }

    /**
     * To be displayed news list.
     * @return mixed The news collection.
     */
    public function entries()

This method seems to be duplicated in your project.

    {
        $page = $this->page();
        $cat = $this->category();
        if (isset($this->entries[$cat])) {
            if (isset($this->entries[$cat][$page])) {
                return $this->entries[$cat][$page];
            }
        }
        $loader = $this->loader()->upcoming();
        $loader->addOrder('news_date', 'desc');

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

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

    /**
     * @param integer|null $id The news 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->currentNews();
        }

        if (!isset($this->entry[$id])) {
            $entry = $this->modelFactory()->get($this->objType())->loadFrom('id', $id);
            $this->entry[$id] = $entry->id() ? $entry : $this->currentNews();
        }

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

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

The expression $this->all of type Charcoal\Cms\NewsInterface[] 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()->addOrder('news_date', 'desc')->load();

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

        return $this->all;
    }

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

This method seems to be duplicated in your project.

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

        return $loader->load();
    }

    /**
     * @param integer $id The category id.
     * @return CategoryInterface
     */
    public function categoryItem($id)
    {
        if (isset($this->categoryItem[$id])) {
            return $this->categoryItem[$id];
        }
        $category = $this->modelFactory()->create($this->categoryItemType());

        $this->categoryItem[$id] = $category->load($id);
        return $this->categoryItem[$id];
    }

    /**
     * @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\NewsInterface[] 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\NewsInterface>>. Maybe add an additional type check?

        return $this->featList;
    }

    /**
     * @return NewsInterface[]|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();
        $loader->addOrder('news_date', 'desc');

        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 news.
     * @return NewsInterface|array The latest news.
     */
    public function latest()

This method seems to be duplicated in your project.

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

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

    /**
     * @return mixed The previous news
     */
    public function prev()
    {
        if ($this->prevNews) {
            return $this->prevNews;
        }

        return $this->setPrevNext()->prevNews;
    }

    /**
     * @return mixed The next news
     */
    public function next()
    {
        if ($this->nextNews) {
            return $this->nextNews;
        }

        return $this->setPrevNext()->nextNews;
    }

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

This method seems to be duplicated in your project.

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

            return 1;
        }
        $all = $this->all();
        $i = 0;
        foreach ($all as $news) {
            $i++;
            if ($news->id() == $this->currentNews()['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;
    }

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

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

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

        }

        return $this->currentNews;
    }

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

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

    /**
     * Amount of news (total)
     * @return integer How many news?
     */
    public function numNews()
    {
        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 NewsLoader
     */
    public function loader()
    {
        return $this->loader;
    }

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

    /**
     * @param mixed $currentNews The current news context.
     * @return self .
     */
    public function setCurrentNews($currentNews)
    {
        $this->currentNews = $currentNews;

        return $this;
    }

    /**
     * @param integer $numPerPage The number of news 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 news 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 NewsLoader $loader The news loader provider.
     * @return self
     */
    public function setLoader(NewsLoader $loader)
    {
        $this->loader = $loader;

        return $this;
    }

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

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

This method seems to be duplicated in your project.

    {
        if ($this->nextNews && $this->prevNews) {
            return $this;
        }
        $entries = $this->entries();

        $isPrev = false;
        $isNext = false;
        $firstNews = false;
        $lastNews = false;

        /** @var NewsInterface $news */
        foreach ($entries as $news) {
            // Obtain th first news.
            if (!$firstNews) {
                $firstNews = $news;
            }
            $lastNews = $news;
            // Find the current news
            if ($news->id() == $this->currentNews()['id']) {
                $isNext = true;
                $isPrev = true;

                continue;
            }
            if (!$isPrev) {
                $this->prevNews = $news;
            }
            // Store the next news
            if ($isNext) {
                $this->nextNews = $news;

                $isNext = false;
            }
        }

        if ($this->entryCycle()) {
            if (!$this->nextNews) {
                $this->nextNews = $firstNews;
            }

            if (!$this->prevNews) {
                $this->prevNews = $lastNews;
            }
        }

        return $this;
    }
}