net_nehmer_blog_navigation

Complexity

Total Complexity

25

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Test Coverage

Coverage

31.43%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	get_leaves()	0	12	3
C	_add_pseudo_leaves()	0	49	12
A	add_scheduling_constraints()	0	13	4
A	_get_url()	0	8	3
A	_add_article_leaves()	0	16	3

<?php
/**
 * @package net.nehmer.blog
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * Blog navigation interface class
 *
 * @package net.nehmer.blog
 */
class net_nehmer_blog_navigation extends midcom_baseclasses_components_navigation
{
    const LEAFID_FEEDS = 2;

    /**
     * Returns a static leaf list with access to the archive.
     */
    public function get_leaves() : array
    {
        $leaves = [];

        if ($this->_config->get('show_navigation_pseudo_leaves')) {
            $this->_add_pseudo_leaves($leaves);
        }

        if ($this->_config->get('show_latest_in_navigation')) {
            $this->_add_article_leaves($leaves);
        }
        return $leaves;
    }

    private function _add_article_leaves(array &$leaves)
    {
        $qb = midcom_db_article::new_query_builder();
        self::add_scheduling_constraints($qb, $this->_config);

        $qb->add_constraint('topic', '=', $this->_topic->id);
        $qb->add_constraint('up', '=', 0);
        $qb->add_order('metadata.published', 'DESC');
        $qb->set_limit((int) $this->_config->get('index_entries'));

        foreach ($qb->execute() as $article) {
            $leaves[$article->id] = [
                MIDCOM_NAV_URL => $this->_get_url($article),
                MIDCOM_NAV_NAME => $article->title ?: $article->name,
                MIDCOM_NAV_GUID => $article->guid,
                MIDCOM_NAV_OBJECT => $article,
            ];
        }
    }

    private function _get_url(midcom_db_article $article) : string
    {
        $view_url = $article->name ?: $article->guid;

        if ($this->_config->get('view_in_url')) {
            $view_url = 'view/' . $view_url;
        }
        return $view_url . '/';
    }

    private function _add_pseudo_leaves(array &$leaves)
    {
        if (   $this->_config->get('archive_enable')
            && $this->_config->get('archive_in_navigation')) {
            $leaves["{$this->_topic->id}_ARCHIVE"] = [
                MIDCOM_NAV_URL => "archive/",
                MIDCOM_NAV_NAME => $this->_l10n->get('archive'),
            ];
        }
        if (   $this->_config->get('rss_enable')
            && $this->_config->get('feeds_in_navigation')) {
            $leaves[self::LEAFID_FEEDS] = [
                MIDCOM_NAV_URL => "feeds/",
                MIDCOM_NAV_NAME => $this->_l10n->get('available feeds'),
            ];
        }

        if (   $this->_config->get('categories_in_navigation')
            && $this->_config->get('categories') != '') {
            $categories = explode(',', $this->_config->get('categories'));

It seems like $this->_config->get('categories') can also be of type false; however, parameter $string of explode() does only seem to accept string, maybe add an additional type check?

            foreach ($categories as $category) {
                $leaves["{$this->_topic->id}_CAT_{$category}"] = [
                    MIDCOM_NAV_URL => "category/{$category}/",
                    MIDCOM_NAV_NAME => $category,
                ];
            }
        }

        if (   $this->_config->get('archive_years_in_navigation')
            && $this->_config->get('archive_years_enable')) {
            $qb = midcom_db_article::new_query_builder();
            $qb->add_constraint('topic', '=', $this->_topic->id);
            self::add_scheduling_constraints($qb, $this->_config);

            $qb->add_order('metadata.published');
            $qb->set_limit(1);

            if ($result = $qb->execute_unchecked()) {
                $first_year = (int) gmdate('Y', (int) $result[0]->metadata->published);
                $year = $first_year;
                $this_year = (int) gmdate('Y', time());
                while ($year <= $this_year) {
                    $leaves["{$this->_topic->id}_ARCHIVE_{$year}"] = [
                        MIDCOM_NAV_URL => "archive/year/{$year}/",
                        MIDCOM_NAV_NAME => $year,
                    ];
                    $year++;
                }
                $leaves = array_reverse($leaves);
            }
        }
    }

    /**
     * Hide the articles that have the publish time in the future if
     * the user is not administrator
     *
     * @param midcom_core_querybuilder $qb (or qbpager)
     */
    public static function add_scheduling_constraints($qb, midcom_helper_configuration $config)
    {
        if (   $config->get('enable_scheduled_publishing')
            && !midcom::get()->auth->admin) {
            // Show the article only if the publishing time has passed or the viewer
            // is the author
            $qb->begin_group('OR');
            $qb->add_constraint('metadata.published', '<', gmdate('Y-m-d H:i:s'));

            if (!empty(midcom::get()->auth->user->guid)) {
                $qb->add_constraint('metadata.authors', 'LIKE', '%|' . midcom::get()->auth->user->guid . '|%');
            }
            $qb->end_group();
        }
    }
}