AlumniCategoryHandler

Complexity

Total Complexity

18

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getSubCatArray()	0	15	4
B	getCategoriesCount()	0	20	6
C	getCategoriesForSearch()	0	36	7

<?php
/*
 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.
*/

/**
 * Alumni module for Xoops
 *
 * @copyright       XOOPS Project https://xoops.org/
 * @license         GPL 2.0 or later
 * @package         alumni
 * @since           2.6.x
 * @author          John Mordo (jlm69)
 */

use Xoops\Core\Database\Connection;
use Xoops\Core\Kernel\XoopsObject;
use Xoops\Core\Kernel\XoopsPersistableObjectHandler;
use Xoops\Core\Kernel\Criteria;
use Xoops\Core\Kernel\CriteriaCompo;

/**
 * Class AlumniCategory
 */
class AlumniCategory extends XoopsObject

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

{
    public $alumni = null;

    /**
     * @var array
     */
    public $_categoryPath = false;

$_categoryPath does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    //Constructor
    public function __construct()
    {
        $this->alumni = Alumni::getInstance();
        $this->initVar('cid', XOBJ_DTYPE_INT, null, false, 11);
        $this->initVar('pid', XOBJ_DTYPE_INT, null, false, 5);
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scaddress', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scaddress2', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('sccity', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scstate', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('sczip', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scphone', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scfax', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scmotto', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scurl', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('img', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('scphoto', XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('ordre', XOBJ_DTYPE_INT, null, false, 5);
    }

    /**
     * @param null|int   $id
     * @param string $path
     * @return string
     */
    public function getPathFromId($id = null, $path = '')
    {
        $id   = null !== $id ? (int)$id : $this->cid;

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

        $myts = MyTextSanitizer::getInstance();
        $name = $myts->htmlSpecialChars($this->title);
        $path = "/{$name}{$path}";
        if (0 != $this->pid) {
            $path = $this->getPathFromId($this->pid, $path);
        }
        return $path;
    }

    /**
     * @return array
     */
    public function getGroups_view()

function getGroups_view() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-zA-Z0-9]*$).

    {
        return $this->alumni->getPermissionHandler()->getGrantedGroupsById('alumni_view', $this->getVar('cid'));
    }
}

/**
 * Class AlumniCategoryHandler
 */
class AlumniCategoryHandler extends XoopsPersistableObjectHandler

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 $alumni = null;

    /**
     * AlumniCategoryHandler constructor.
     * @param \Xoops\Core\Database\Connection|null $db
     */
    public function __construct(Connection $db = null)

Avoid variables with short names like $db. Configured minimum length is 3.

    {
        $this->alumni = Alumni::getInstance();
        parent::__construct($db, 'alumni_category', 'alumnicategory', 'cid', 'title');
    }

    /**
     * @param $by_cat
     * @param $level
     * @param $cat_array
     * @param $cat_result
     */
    public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)

$by_cat does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        global $theresult;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $spaces = '';
        for ($j = 0; $j < $level; ++$j) {
            $spaces .= '--';
        }
        $theresult[$by_cat['cid']] = $spaces . $by_cat['title'];

$by_cat does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if (isset($cat_array[$by_cat['cid']])) {

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $level = ++$level;
            foreach ($cat_array[$by_cat['cid']] as $cat) {

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $this->getSubCatArray($cat, $level, $cat_array, $cat_result);

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            }
        }
    }

    /**
     * @param int $pid
     * @return int
     */
    public function getCategoriesCount($pid = 0)
    {
        $xoops = Xoops::getInstance();
        if ($pid == -1) {
            return $this->getCount();
        }
        $criteria = new CriteriaCompo();
        if (null !== $pid && ($pid != -1)) {
            $criteria->add(new criteria('pid', $pid));
            if (!$xoops->userIsAdmin) {
                $categoriesGranted = $this->alumni->getPermissionHandler()->getGrantedItems('alumni_view');
                if (count($categoriesGranted) > 0) {
                    $criteria->add(new Criteria('cid', '(' . implode(',', $categoriesGranted) . ')', 'IN'));
                } else {
                    return 0;
                }
            }
        }
        return $this->getCount($criteria);
    }

    /**
     * @return array
     */
    public function &getCategoriesForSearch()
    {
        global $theresult, $xoops, $alumni;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $xoops    = Xoops::getInstance();
        $alumni   = Alumni::getInstance();
        $moduleId = $alumni->getModule()->mid();
        $ret      = [];
        $criteria = new CriteriaCompo();
        $criteria->setSort('cid');
        $criteria->setOrder('ASC');
        if (!$xoops->isAdmin()) {
            //          $gperm_handler        = $xoops->gethandler('groupperm');

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

            $groups               = is_object($xoops->isUser()) ? $$xoops->isUser()->getGroups() : '3';
            $allowedCategoriesIds = $alumni->getGrouppermHandler()->getItemIds('alumni_view', $groups, $moduleId);
            $criteria->add(new Criteria('cid', '(' . implode(',', $allowedCategoriesIds) . ')', 'IN'));
        }
        $categories = $this->getAll($criteria, ['cid', 'pid', 'title'], false, false);
        if (0 == count($categories)) {
            return $ret;
        }
        $cat_array = [];

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        foreach ($categories as $cat) {
            $cat_array[$cat['pid']][$cat['cid']] = $cat;

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }

        if (!isset($cat_array[0])) {

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            return $ret;
        }
        $cat_result = [];

$cat_result does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        foreach ($cat_array[0] as $thecat) {

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $level = 0;
            $this->getSubCatArray($thecat, $level, $cat_array, $cat_result);

$cat_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }

        return $theresult;
    }
}