Categories

Complexity

Total Complexity

23

Size/Duplication

Total Lines	224
Duplicated Lines	10.71 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	getCategory()	12	12	1
A	getCategoryValue()	12	12	1
B	getAssignedElements()	0	24	4
A	getAllAssignedElements()	0	9	2
A	deleteCategory()	0	18	2
B	updateCategory()	0	23	4
A	addCategory()	0	22	3
A	isCategoryExists()	0	18	2

<?php

/**
 * Class to handle the modx-categories
 */
class Categories

The property $db_tbl is not named in camelCase.

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

{
    /**
     * @var DBAPI
     */
    public $db;

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

    public $db_tbl = array();
    public $elements = array('templates', 'tmplvars', 'htmlsnippets', 'snippets', 'plugins', 'modules');

    public function __construct()
    {
        global $modx;

        $this->db = &$modx->db;
        $this->db_tbl['categories'] = $modx->getFullTableName('categories');

        foreach ($this->elements as $element) {
            $this->db_tbl[$element] = $modx->getFullTableName('site_' . $element);
        }
    }


    /**
     * Get all categories
     * @return  array   $categories / array contains all categories
     */
    public function getCategories()
    {
        $categories = $this->db->makeArray(
            $this->db->select(
                '*',
                $this->db_tbl['categories'],
                '1',
                '`rank`,`category`'
            )
        );

        return empty($categories) ? array() : $categories;
    }

    /**
     * @param string $search
     * @param string $where
     * @return array|bool|object|stdClass
     */
    public function getCategory($search, $where = 'category')

This method seems to be duplicated in your project.

    {
        $category = $this->db->getRow(
            $this->db->select(
                '*',
                $this->db_tbl['categories'],
                "`" . $where . "` = '" . $this->db->escape($search) . "'"
            )
        );

        return $category;
    }

    /**
     * @param string $value
     * @param string $search
     * @param string $where
     * @return bool|int|string
     */
    public function getCategoryValue($value, $search, $where = 'category')

This method seems to be duplicated in your project.

    {
        $_value = $this->db->getValue(
            $this->db->select(
                '`' . $value . '`',
                $this->db_tbl['categories'],
                "`" . $where . "` = '" . $this->db->escape($search) . "'"
            )
        );

        return $_value;
    }

    /**
     * @param int $category_id
     * @param string $element
     * @return array|bool

Consider making the return type a bit more specific; maybe use false|array.

     */
    public function getAssignedElements($category_id, $element)

The parameter $category_id is not named in camelCase.

    {
        if (in_array($element, $this->elements, true)) {
            $elements = $this->db->makeArray(
                $this->db->select(
                    '*',
                    $this->db_tbl[$element],
                    "`category` = '" . (int)$category_id . "'"
                )
            );

            // correct the name of templates
            if ($element === 'templates') {
                $_elements_count = count($elements);
                for ($i = 0; $i < $_elements_count; $i++) {
                    $elements[$i]['name'] = $elements[$i]['templatename'];
                }
            }

            return $elements;
        }

        return false;
    }

    /**
     * @param int $category_id
     * @return array
     */
    public function getAllAssignedElements($category_id)

The parameter $category_id is not named in camelCase.

    {
        $elements = array();
        foreach ($this->elements as $element) {
            $elements[$element] = $this->getAssignedElements($category_id, $element);
        }

        return $elements;
    }

    /**
     * @param int $category_id
     * @return bool
     */
    public function deleteCategory($category_id)

The parameter $category_id is not named in camelCase.

    {
        $_update = array('category' => 0);
        foreach ($this->elements as $element) {
            $this->db->update(
                $_update,
                $this->db_tbl[$element],
                "`category` = '" . (int)$category_id . "'"
            );
        }

        $this->db->delete(
            $this->db_tbl['categories'],
            "`id` = '" . (int)$category_id . "'"
        );

        return $this->db->getAffectedRows() === 1;
    }

    /**
     * @param int $category_id
     * @param array $data
     * @return bool
     */
    public function updateCategory($category_id, $data = array())

The parameter $category_id is not named in camelCase.

    {
        if (empty($data) || empty($category_id)) {
            return false;
        }

        $_update = array(
            'category' => $this->db->escape($data['category']),
            'rank'     => (int)$data['rank']
        );

        $this->db->update(
            $_update,
            $this->db_tbl['categories'],
            "`id` = '" . (int)$category_id . "'"
        );

        if ($this->db->getAffectedRows() === 1) {

This if statement, and the following return statement can be replaced with return $this->db->getAffectedRows() === 1;.

            return true;
        }

        return false;
    }

    /**
     * @param string $category_name
     * @param int $category_rank
     * @return bool|int|mixed

Consider making the return type a bit more specific; maybe use false|integer.

     */
    public function addCategory($category_name, $category_rank)

The parameter $category_name is not named in camelCase.

The parameter $category_rank is not named in camelCase.

    {
        if ($this->isCategoryExists($category_name)) {
            return false;
        }

        $_insert = array(
            'category' => $this->db->escape($category_name),
            'rank'     => (int)$category_rank
        );

        $this->db->insert(
            $_insert,
            $this->db_tbl['categories']
        );

        if ($this->db->getAffectedRows() === 1) {
            return $this->db->getInsertId();
        }

        return false;
    }

    /**
     * @param string $category_name
     * @return bool|int|string
     */
    public function isCategoryExists($category_name)

The parameter $category_name is not named in camelCase.

    {
        $category = $this->db->escape($category_name);

        $category_id = $this->db->getValue(
            $this->db->select(
                '`id`',
                $this->db_tbl['categories'],
                "`category` = '" . $category . "'"
            )
        );

        if ($this->db->getAffectedRows() === 1) {
            return $category_id;
        }

        return false;
    }
}