NewsManager::currentPage() - Code Metrics - Inspection of "Merge pull request #2 from locomotivemtl/cms_servi..." - locomotivemtl/charcoal-cms - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( dc68d1...1f5199 )

by Mathieu
created 2017-04-03 15:56 UTC
NewsManager::currentPage() C

↳ Parent: NewsManager
Complexity

Conditions	7
Paths	8
Size

Total Lines	23
Code Lines	14
Duplication

Lines	23
Ratio	100 %
Importance

Changes
Metric	Value
dl	23
loc	23
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	14
nc	8
nop	0
<?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)

    {
        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()

    {
        $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)

    {
        if (!$id) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            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) {

            return $this->all;
        }

        $this->all = $this->loader()->all()->addOrder('news_date', 'desc')->load();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this->all;
    }

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

    {
        $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 = [])

    {
        if ($this->featList) {

            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'] ?: '';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                            $filter[] = $f['val'] ?: '';
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                            $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();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this->featList;
    }

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

    {
        $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()

    {
        $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()

    {
        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;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this->currentPage;
    }

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

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

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }

        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()

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

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

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

$correct = false;

$correct = (bool) $answer;
        } 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()

    {
        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;
    }
}

1			<?php
2
3			namespace Charcoal\Cms\Service\Manager;
4
5			// dependencies from `charcoal-core`
6			use Charcoal\Model\Collection;
7
8			// dependencies from `charcoal-base`
9			use Charcoal\Object\CategoryInterface;
10			use Charcoal\Object\CategoryTrait;
11
12			// Local dependencies
13			use Charcoal\Cms\Config\CmsConfig;
14			use Charcoal\Cms\NewsInterface;
15			use Charcoal\Cms\Service\Loader\NewsLoader;
16
17			// Psr-7 dependencies
18			use Exception;
19
20			/**
21			* News manager
22			*/
23			class NewsManager extends AbstractManager
24			{
25			use CategoryTrait;
26
27			/** @var NewsInterface $currentNews The current news. */
28			protected $currentNews;
29
30			/** @var integer $currentPage The current Page. */
31			protected $currentPage;
32
33			/** @var integer $numPerPage News by page. */
34			protected $numPerPage = 0;
35
36			/** @var integer $numPage How many pages. */
37			protected $numPage;
38
39			/** @var boolean $pageCycle Does the pager can cycle indefinitely. */
40			protected $entryCycle = false;
locomotivemtl / charcoal-cms

Push — master ( dc68d1...1f5199 )

NewsManager::currentPage() C

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like
