ExtcalCatHandler

Complexity

Total Complexity

21

Size/Duplication

Total Lines	178
Duplicated Lines	19.1 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
B	createCat()	16	40	6
A	modifyCat()	0	7	1
A	deleteCat()	0	7	1
A	getCat()	0	14	3
A	getAllCat()	0	9	2
A	getAllCatById()	0	16	3
A	_addCatPermCriteria()	16	16	3
A	haveSubmitRight()	0	4	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 22.

/*
 * 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    {@link https://xoops.org/ XOOPS Project}
 * @license      {@link http://www.gnu.org/licenses/gpl-2.0.html GNU GPL 2 or later}
 * @package      extcal
 * @since
 * @author       XOOPS Development Team,
 */

// defined('XOOPS_ROOT_PATH') || exit('Restricted access.');

70% of this comment could be valid code. Did you maybe forget this after debugging?

require_once __DIR__ . '/ExtcalPersistableObjectHandler.php';
require_once __DIR__ . '/perm.php';
require_once __DIR__ . '/time.php';

/**
 * Class ExtcalCat.
 */
class ExtcalCat extends XoopsObject

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public $externalKey = [];

    /**
     * ExtcalCat constructor.
     */
    public function __construct()
    {
        $this->initVar('cat_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('cat_name', XOBJ_DTYPE_TXTBOX, null, true, 255);
        $this->initVar('cat_desc', XOBJ_DTYPE_TXTAREA, null, false);
        $this->initVar('cat_color', XOBJ_DTYPE_TXTBOX, '000000', false, 255);
        $this->initVar('cat_weight', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('cat_icone', XOBJ_DTYPE_TXTBOX, '', false, 50);
    }
}

/**
 * Class ExtcalCatHandler.
 */
class ExtcalCatHandler extends ExtcalPersistableObjectHandler

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public $_extcalPerm;

    /**
     * @param $db
     */
    public function __construct(XoopsDatabase $db)
    {
        $this->_extcalPerm = ExtcalPerm::getHandler();
        parent::__construct($db, 'extcal_cat', _EXTCAL_CLN_CAT, 'cat_id');
    }

    /**
     * @param $data
     *
     * @return bool
     */
    public function createCat($data)

createCat uses the super-global variable $GLOBALS which is generally not recommended.

    {
        $cat = $this->create();
        $cat->setVars($data);
        $this->insert($cat);

        $catId = $this->getInsertId();

$catId is not used, you could remove the assignment.

        // Retriving permission mask
        /** @var XoopsGroupPermHandler $groupPermissionHandler */
        $groupPermissionHandler = xoops_getHandler('groupperm');
        $moduleId               = $GLOBALS['xoopsModule']->getVar('mid');

        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('gperm_name', 'extcal_perm_mask'));
        $criteria->add(new Criteria('gperm_modid', $moduleId));
        $permMask = $groupPermissionHandler->getObjects($criteria);

        // Retriving group list
        $memberHandler = xoops_getHandler('member');
        $glist         = $memberHandler->getGroupList();

$glist is not used, you could remove the assignment.

        // Applying permission mask
        foreach ($permMask as $perm) {
            if (1 == $perm->getVar('gperm_itemid')) {

This code seems to be duplicated across your project.

                $groupPermissionHandler->addRight('extcal_cat_view', $cat->getVar('cat_id'), $perm->getVar('gperm_groupid'), $moduleId);
            }
            if (2 == $perm->getVar('gperm_itemid')) {

This code seems to be duplicated across your project.

                $groupPermissionHandler->addRight('extcal_cat_submit', $cat->getVar('cat_id'), $perm->getVar('gperm_groupid'), $moduleId);
            }
            if (4 == $perm->getVar('gperm_itemid')) {

This code seems to be duplicated across your project.

                $groupPermissionHandler->addRight('extcal_cat_autoapprove', $cat->getVar('cat_id'), $perm->getVar('gperm_groupid'), $moduleId);
            }
            if (8 == $perm->getVar('gperm_itemid')) {

This code seems to be duplicated across your project.

                $groupPermissionHandler->addRight('extcal_cat_edit', $cat->getVar('cat_id'), $perm->getVar('gperm_groupid'), $moduleId);
            }
        }

        return true;
    }

    /**
     * @param $catId
     * @param $data
     *
     * @return bool
     */
    public function modifyCat($catId, $data)
    {
        $cat = $this->get($catId);
        $cat->setVars($data);

        return $this->insert($cat);
    }

    /**
     * @param $catId
     */
    public function deleteCat($catId)
    {
        /* TODO :
           - Delete all events in this category
          */
        $this->deleteById($catId);
    }

    // Return one cat selected by his id

    /**
     * @param      $catId
     * @param bool $skipPerm
     *
     * @return bool
     */
    public function getCat($catId, $skipPerm = false)

getCat uses the super-global variable $GLOBALS which is generally not recommended.

    {
        $criteriaCompo = new CriteriaCompo();
        $criteriaCompo->add(new Criteria('cat_id', $catId));
        if (!$skipPerm) {
            $this->_addCatPermCriteria($criteriaCompo, $GLOBALS['xoopsUser']);
        }
        $ret = $this->getObjects($criteriaCompo);
        if (isset($ret[0])) {
            return $ret[0];
        } else {
            return false;
        }
    }

    /**
     * @param        $user
     * @param string $perm
     *
     * @return array
     */
    public function getAllCat($user, $perm = 'extcal_cat_view')
    {
        $criteriaCompo = new CriteriaCompo();
        if ('all' !== $perm) {
            $this->_addCatPermCriteria($criteriaCompo, $user, $perm);
        }

        return $this->getObjects($criteriaCompo);
    }

    /**
     * @param        $user
     * @param string $perm
     *
     * @return array
     */
    public function getAllCatById($user, $perm = 'all')
    {
        $criteriaCompo = new CriteriaCompo();
        if ('all' !== $perm) {
            $this->_addCatPermCriteria($criteriaCompo, $user, $perm);
        }

        $t = $this->objectToArray($this->getObjects($criteriaCompo));
        $r = [];
        //        while (list($k, $v) = each($t)) {

62% of this comment could be valid code. Did you maybe forget this after debugging?

        foreach ($t as $k => $v) {
            $r[$v['cat_id']] = $v;
        }

        return $r;
    }

    /**
     * @param        $criteria
     * @param        $user
     * @param string $perm
     */
    public function _addCatPermCriteria(&$criteria, &$user, $perm = 'extcal_cat_view')

This method seems to be duplicated in your project.

    {
        $authorizedAccessCats = $this->_extcalPerm->getAuthorizedCat($user, 'extcal_cat_view');
        $count                = count($authorizedAccessCats);
        if ($count > 0) {
            $in = '(' . $authorizedAccessCats[0];
            array_shift($authorizedAccessCats);
            foreach ($authorizedAccessCats as $authorizedAccessCat) {
                $in .= ',' . $authorizedAccessCat;
            }
            $in .= ')';
            $criteria->add(new Criteria('cat_id', $in, 'IN'));
        } else {
            $criteria->add(new Criteria('cat_id', '(0)', 'IN'));
        }
    }

    /**
     * @param $xoopsUser
     *
     * @return bool
     */
    public function haveSubmitRight(&$xoopsUser)
    {
        return count($this->_extcalPerm->getAuthorizedCat($xoopsUser, 'extcal_cat_submit')) > 0;
    }
}