Category::getTemplate() - Code Metrics - Inspection of "1.07 RC1" - mambax7/publisher - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — master (294c87)

by Michael
created 2019-02-09 10:45 UTC
Category::getTemplate() A

↳ Parent: Category
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

namespace XoopsModules\Publisher;

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * @copyright       The XUUPS Project http://sourceforge.net/projects/xuups/
 * @license         http://www.fsf.org/copyleft/gpl.html GNU public license
 * @package         Publisher
 * @since           1.0
 * @author          trabis <[email protected]>
 * @author          The SmartFactory <www.smartfactory.ca>
 */

use XoopsModules\Publisher;

// defined('XOOPS_ROOT_PATH') || die('Restricted access');

require_once dirname(__DIR__) . '/include/common.php';

/**
 * Class Publisher\Category
 */
class Category extends \XoopsObject
{
    /**
     * @var Publisher\Helper
     */
    public $helper;

    /**
     * @var array
     */
    public $categoryPath = false;
    public $categoryid;
    public $parentid;
    public $name;
    public $description;
    public $image;
    public $total;
    public $weight;
    public $created;
    public $template;
    public $header;
    public $meta_keywords;
    public $meta_description;
    public $short_url;
    public $moderator;

    /**
     * constructor
     */
    public function __construct()
    {
        /** @var \XoopsModules\Publisher\Helper $this->helper */
        $this->helper = \XoopsModules\Publisher\Helper::getInstance();
        $this->initVar('categoryid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('parentid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('name', XOBJ_DTYPE_TXTBOX, null, true, 100);
        $this->initVar('description', XOBJ_DTYPE_TXTAREA, null, false, 255);
        $this->initVar('image', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('total', XOBJ_DTYPE_INT, 1, false);
        $this->initVar('weight', XOBJ_DTYPE_INT, 1, false);
        $this->initVar('created', XOBJ_DTYPE_INT, null, false);
        $this->initVar('template', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('header', XOBJ_DTYPE_TXTAREA, null, false);
        $this->initVar('meta_keywords', XOBJ_DTYPE_TXTAREA, null, false);
        $this->initVar('meta_description', XOBJ_DTYPE_TXTAREA, null, false);
        $this->initVar('short_url', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('moderator', XOBJ_DTYPE_INT, null, false, 0);
        //not persistent values
        $this->initVar('itemcount', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('last_itemid', XOBJ_DTYPE_INT);
        $this->initVar('last_title_link', XOBJ_DTYPE_TXTBOX);
        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
    }

    /**
     * @param string $method
     * @param array  $args
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        $arg = isset($args[0]) ? $args[0] : null;

        return $this->getVar($method, $arg);
    }

    /**
     * @return bool
     */
    public function notLoaded()
    {
        return (-1 == $this->getVar('categoryid'));
    }

    /**
     * @return bool
     */
    public function checkPermission()
    {
        //        global $publisherIsAdmin;
        $ret = false;
        if ($GLOBALS['publisherIsAdmin']) {
            return true;
        }
        if (is_object($GLOBALS['xoopsUser']) && $GLOBALS['xoopsUser']->getVar('uid') == $this->moderator) {
            return true;
        }
        /** @var \XoopsModules\Publisher\PermissionHandler $permissionHandler */
        $permissionHandler = $this->helper->getHandler('Permission');
        $categoriesGranted = $permissionHandler->getGrantedItems('category_read');
        if (in_array($this->categoryid(), $categoriesGranted, true)) {
        if (in_array($this->/** @scrutinizer ignore-call */ categoryid(), $categoriesGranted, true)) {
            $ret = true;
        }

        return $ret;
    }

    /**
     * @param string $format
     *
     * @return mixed|string
     */
    public function getImage($format = 's')
    {
        if ('' != $this->getVar('image')) {
            return $this->getVar('image', $format);
        }

        return 'blank.png';
    }

    /**
     * @param string $format
     *
     * @return mixed
     */
    public function getTemplate($format = 'n')
    {
        return $this->getVar('template', $format);
    }

    /**
     * @param bool $withAllLink
     *
     * @return array|bool|string
     */
    public function getCategoryPath($withAllLink = true)
    {
        if (empty($this->categoryPath)) {
            if ($withAllLink) {
                $ret = $this->getCategoryLink();
            } else {
                $ret = $this->name();
                $ret = $this->name();
            }
            $parentid = $this->parentid();
            $parentid = $this->parentid();
            if (0 != $parentid) {
                /** @var Publisher\CategoryHandler $categoryHandler */
                $categoryHandler = $this->helper->getHandler('Category');
                $parentObj       = $categoryHandler->get($parentid);
                //                if ($parentObj->notLoaded()) {
                //                    exit;
                //                }

                try {
                    if ($parentObj->notLoaded()) {
                    if ($parentObj->/** @scrutinizer ignore-call */ notLoaded()) {
                        throw new \RuntimeException(_NOPERM);
                    }
                }
                catch (\Exception $e) {
                    $this->helper->addLog($e);
                    //                    redirect_header('javascript:history.go(-1)', 1, _NOPERM);
                }

                $ret = $parentObj->getCategoryPath($withAllLink) . ' <li> ' . $ret . '</li>';
                $ret = $parentObj->/** @scrutinizer ignore-call */ getCategoryPath($withAllLink) . ' <li> ' . $ret . '</li>';
            }
            $this->categoryPath = $ret;
        }

        return $this->categoryPath;
    }

    /**
     * @return mixed|string
     */
    public function getCategoryPathForMetaTitle()
    {
        $ret      = '';
        $parentid = $this->parentid();
        if (0 != $parentid) {
            /** @var Publisher\CategoryHandler $categoryHandler */
            $categoryHandler = $this->helper->getHandler('Category');
            $parentObj       = $categoryHandler->get($parentid);
            //            if ($parentObj->notLoaded()) {
            //                exit('NOT LOADED');
            //            }

            try {
                if ($parentObj->notLoaded()) {
                    throw new \RuntimeException('NOT LOADED');
                }
            }
            catch (\Exception $e) {
                $this->helper->addLog($e);
                //                    redirect_header('javascript:history.go(-1)', 1, _NOPERM);
            }

            $ret = $parentObj->getCategoryPath(false);
            $ret = str_replace(' >', ' -', $ret);
        }

        return $ret;
    }

    /**
     * @return array|null
     */
    public function getGroupsRead()
    {
        /** @var Publisher\PermissionHandler $permissionHandler */
        $permissionHandler = $this->helper->getHandler('Permission');

        return $permissionHandler->getGrantedGroupsById('category_read', $this->categoryid());
    }

    /**
     * @return array|null
     */
    public function getGroupsSubmit()
    {
        /** @var Publisher\PermissionHandler $permissionHandler */
        $permissionHandler = $this->helper->getHandler('Permission');

        return $permissionHandler->getGrantedGroupsById('item_submit', $this->categoryid());
    }

    /**
     * @return array|null
     */
    public function getGroupsModeration()
    {
        /** @var Publisher\PermissionHandler $permissionHandler */
        $permissionHandler = $this->helper->getHandler('Permission');

        return $permissionHandler->getGrantedGroupsById('category_moderation', $this->categoryid());
    }

    /**
     * @return string
     */
    public function getCategoryUrl()
    {
        return Publisher\Seo::generateUrl('category', $this->categoryid(), $this->short_url());
        return Publisher\Seo::generateUrl('category', $this->categoryid(), $this->/** @scrutinizer ignore-call */ short_url());
    }

    /**
     * @param bool $class
     *
     * @return string
     */
    public function getCategoryLink($class = false)
    {
        if ($class) {
            return "<a class='$class' href='" . $this->getCategoryUrl() . "'>" . $this->name() . '</a>';
        }

        return "<a href='" . $this->getCategoryUrl() . "'>" . $this->name() . '</a>';
    }

    /**
     * @param bool $sendNotifications
     * @param bool $force
     *
     * @return mixed
     */
    public function store($sendNotifications = true, $force = true)
    {
        $ret = $this->helper->getHandler('Category')->insert($this, $force);
        $ret = $this->helper->getHandler('Category')->/** @scrutinizer ignore-call */ insert($this, $force);
        if ($sendNotifications && $ret && $this->isNew()) {
            $this->sendNotifications();
        }
        $this->unsetNew();

        return $ret;
    }

    /**
     * Send notifications
     */
    public function sendNotifications()
    {
        $tags                  = [];
        $tags['MODULE_NAME']   = $this->helper->getModule()->getVar('name');
        $tags['CATEGORY_NAME'] = $this->name();
        $tags['CATEGORY_URL']  = $this->getCategoryUrl();
        /* @var  \XoopsNotificationHandler $notificationHandler */
        $notificationHandler = xoops_getHandler('notification');
        $notificationHandler->triggerEvent('global_item', 0, 'category_created', $tags);
    }

    /**
     * @param array $category
     *
     * @return array
     */
    public function toArraySimple($category = [])
    {
        $category['categoryid']       = $this->categoryid();
        $category['name']             = $this->name();
        $category['categorylink']     = $this->getCategoryLink();
        $category['categoryurl']      = $this->getCategoryUrl();
        $category['total']            = ($this->getVar('itemcount') > 0) ? $this->getVar('itemcount') : '';
        $category['description']      = $this->description();
        $category['header']           = $this->header();
        $category['meta_keywords']    = $this->meta_keywords();
        $category['meta_description'] = $this->meta_description();
        $category['short_url']        = $this->short_url();
        if ($this->getVar('last_itemid') > 0) {
            $category['last_itemid']     = $this->getVar('last_itemid', 'n');
            $category['last_title_link'] = $this->getVar('last_title_link', 'n');
        }
        if ('blank.png' !== $this->getImage()) {
            $category['image_path'] = Publisher\Utility::getImageDir('category', false) . $this->getImage();
        } else {
            $category['image_path'] = '';
        }
        $category['lang_subcategories'] = sprintf(_CO_PUBLISHER_SUBCATEGORIES_INFO, $this->name());

        return $category;
    }

    /**
     * @param array $category
     *
     * @return array
     */
    public function toArrayTable($category = [])
    {
        $category['categoryid']   = $this->categoryid();
        $category['categorylink'] = $this->getCategoryLink();
        $category['total']        = ($this->getVar('itemcount') > 0) ? $this->getVar('itemcount') : '';
        $category['description']  = $this->description();
        if ($this->getVar('last_itemid') > 0) {
            $category['last_itemid']     = $this->getVar('last_itemid', 'n');
            $category['last_title_link'] = $this->getVar('last_title_link', 'n');
        }
        if ('blank.png' !== $this->getImage()) {
            $category['image_path'] = Publisher\Utility::getImageDir('category', false) . $this->getImage();
        } else {
            $category['image_path'] = '';
        }
        $category['lang_subcategories'] = sprintf(_CO_PUBLISHER_SUBCATEGORIES_INFO, $this->name());

        return $category;
    }

    public function createMetaTags()
    {
        $publisherMetagen = new Publisher\Metagen($this->name(), $this->meta_keywords(), $this->meta_description());
        $publisherMetagen = new Publisher\Metagen($this->name(), /** @scrutinizer ignore-type */ $this->meta_keywords(), $this->meta_description());
        $publisherMetagen->createMetaTags();
    }

    /**
     * @param int $subCatsCount
     *
     * @return \XoopsModules\Publisher\Form\CategoryForm
     */
    public function getForm($subCatsCount = 4)
    {
        //        require_once $GLOBALS['xoops']->path('modules/' . PUBLISHER_DIRNAME . '/class/form/category.php');
        $form = new Publisher\Form\CategoryForm($this, $subCatsCount);

        return $form;
    }
}

mambax7 / publisher

Branch — master (294c87)

Category::getTemplate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
