XoopsImageCategoryHandler::get() - Code Metrics - Inspection of "PhpDocs, PhpStan, cosmetics" - mambax7/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — feature/php-docs2 (404c3e)

by Michael
created 2022-02-27 17:49 UTC
XoopsImageCategoryHandler::get() A

↳ Parent: XoopsImageCategoryHandler
Complexity

Conditions	4
Paths	4
Size

Total Lines	17
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	11
nc	4
nop	1
dl	0
loc	17
rs	9.9
c	0
b	0
f	0
<?php
/**
 * XOOPS Kernel Class
 *
 * 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       (c) 2000-2016 XOOPS Project (www.xoops.org)
 * @license             GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @package             kernel
 * @since               2.0.0
 * @author              Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 */
defined('XOOPS_ROOT_PATH') || exit('Restricted access');

/**
 * @author              Kazumi Ono <[email protected]>
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 **/

/**
 * XOOPS Image Category
 *
 * @package             kernel
 *
 * @author              Kazumi Ono    <[email protected]>
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 */
class XoopsImageCategory extends XoopsObject
{
    /**
     * @var int
     */
    public $_imageCount;

    /**
     * Constructor
     **/
    public function __construct()
    {
        parent::__construct();
        $this->initVar('imgcat_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('imgcat_name', XOBJ_DTYPE_TXTBOX, null, true, 100);
        $this->initVar('imgcat_display', XOBJ_DTYPE_INT, 1, false);
        $this->initVar('imgcat_weight', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('imgcat_maxsize', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('imgcat_maxwidth', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('imgcat_maxheight', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('imgcat_type', XOBJ_DTYPE_OTHER, null, false);
        $this->initVar('imgcat_storetype', XOBJ_DTYPE_OTHER, null, false);
    }

    /**
     * Returns Class Base Variable imgcat_id
     * @param  string $format
     * @return mixed
     */
    public function id($format = 'N')
    {
        return $this->getVar('imgcat_id', $format);
    }

    /**
     * Returns Class Base Variable imgcat_id
     * @param  string $format
     * @return mixed
     */
    public function imgcat_id($format = '')
    {
        return $this->getVar('imgcat_id', $format);
    }

    /**
     * Returns Class Base Variable imgcat_name
     * @param  string $format
     * @return mixed
     */
    public function imgcat_name($format = '')
    {
        return $this->getVar('imgcat_name', $format);
    }

    /**
     * Returns Class Base Variable imgcat_display
     * @param  string $format
     * @return mixed
     */
    public function imgcat_display($format = '')
    {
        return $this->getVar('imgcat_display', $format);
    }

    /**
     * Returns Class Base Variable imgcat_weight
     * @param  string $format
     * @return mixed
     */
    public function imgcat_weight($format = '')
    {
        return $this->getVar('imgcat_weight', $format);
    }

    /**
     * Returns Class Base Variable imgcat_maxsize
     * @param  string $format
     * @return mixed
     */
    public function imgcat_maxsize($format = '')
    {
        return $this->getVar('imgcat_maxsize', $format);
    }

    /**
     * Returns Class Base Variable imgcat_maxwidth
     * @param  string $format
     * @return mixed
     */
    public function imgcat_maxwidth($format = '')
    {
        return $this->getVar('imgcat_maxwidth', $format);
    }

    /**
     * Returns Class Base Variable imgcat_maxheight
     * @param  string $format
     * @return mixed
     */
    public function imgcat_maxheight($format = '')
    {
        return $this->getVar('imgcat_maxheight', $format);
    }

    /**
     * Returns Class Base Variable imgcat_type
     * @param  string $format
     * @return mixed
     */
    public function imgcat_type($format = '')
    {
        return $this->getVar('imgcat_type', $format);
    }

    /**
     * Returns Class Base Variable imgcat_storetype
     * @param  string $format
     * @return mixed
     */
    public function imgcat_storetype($format = '')
    {
        return $this->getVar('imgcat_storetype', $format);
    }

    /**
     * Enter description here...
     *
     * @param int $value
     */
    public function setImageCount($value)
    {
        $this->_imageCount = (int)$value;
    }

    /**
     * Enter description here...
     *
     * @return int
     */
    public function getImageCount()
    {
        return $this->_imageCount;
    }
}

/**
 * XOOPS image category handler class.
 * This class is responsible for providing data access mechanisms to the data source
 * of XOOPS image category class objects.
 *
 * @author  Kazumi Ono <[email protected]>
 *
 * @property XoopsMySQLDatabase $db
 */
class XoopsImageCategoryHandler extends XoopsObjectHandler
{
    /**
     * Create a new {@link XoopsImageCategory}
     *
     * @param  bool $isNew Flag the object as "new"
     * @return XoopsImageCategory
     **/
    public function create($isNew = true)
    {
        $imgcat = new XoopsImageCategory();
        if ($isNew) {
            $imgcat->setNew();
        }

        return $imgcat;
    }

    /**
     * Load a {@link XoopsImageCategory} object from the database
     *
     * @param int $id ID
     *
     * @return false|\XoopsImageCategory {@link XoopsImageCategory}, FALSE on fail
     * @internal param bool $getbinary
     */
    public function get($id)
    {
        $id = (int)$id;
        $imgcat = false;
        if ($id > 0) {
            $sql = 'SELECT * FROM ' . $this->db->prefix('imagecategory') . ' WHERE imgcat_id=' . $id;
            if (!$result = $this->db->query($sql)) {
                return $imgcat;
            }
            $numrows = $this->db->getRowsNum($result);
            $numrows = $this->db->getRowsNum(/** @scrutinizer ignore-type */ $result);
            if ($numrows == 1) {
                $imgcat = new \XoopsImageCategory();
                $imgcat->assignVars($this->db->fetchArray($result));
                $imgcat->assignVars($this->db->fetchArray(/** @scrutinizer ignore-type */ $result));
            }
        }

        return $imgcat;
    }

    /**
     * Write a {@link XoopsImageCategory} object to the database
     *
     * @param  XoopsObject|XoopsImageCategory $imgcat a XoopsImageCategory object
     *
     * @return bool true on success, otherwise false
     **/
    public function insert(XoopsObject $imgcat)
    {
        $className = 'XoopsImageCategory';
        if (!($imgcat instanceof $className)) {
            return false;
        }

        if (!$imgcat->isDirty()) {
            return true;
        }
        if (!$imgcat->cleanVars()) {
            return false;
        }
        foreach ($imgcat->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if ($imgcat->isNew()) {
            $imgcat_id = $this->db->genId('imgcat_imgcat_id_seq');
            $sql       = sprintf('INSERT INTO %s (imgcat_id, imgcat_name, imgcat_display, imgcat_weight, imgcat_maxsize, imgcat_maxwidth, imgcat_maxheight, imgcat_type, imgcat_storetype) VALUES (%u, %s, %u, %u, %u, %u, %u, %s, %s)', $this->db->prefix('imagecategory'), $imgcat_id, $this->db->quoteString($imgcat_name), $imgcat_display, $imgcat_weight, $imgcat_maxsize, $imgcat_maxwidth, $imgcat_maxheight, $this->db->quoteString($imgcat_type), $this->db->quoteString($imgcat_storetype));

        } else {
            $sql = sprintf('UPDATE %s SET imgcat_name = %s, imgcat_display = %u, imgcat_weight = %u, imgcat_maxsize = %u, imgcat_maxwidth = %u, imgcat_maxheight = %u, imgcat_type = %s WHERE imgcat_id = %u', $this->db->prefix('imagecategory'), $this->db->quoteString($imgcat_name), $imgcat_display, $imgcat_weight, $imgcat_maxsize, $imgcat_maxwidth, $imgcat_maxheight, $this->db->quoteString($imgcat_type), $imgcat_id);

        }
        if (!$result = $this->db->query($sql)) {

            return false;
        }
        if (empty($imgcat_id)) {
            $imgcat_id = $this->db->getInsertId();
        }
        $imgcat->assignVar('imgcat_id', $imgcat_id);

        return true;
    }

    /**
     * Delete an image from the database
     *
     * @param  XoopsObject|XoopsImageCategory $imgcat a XoopsImageCategory object
     *
     * @return bool true on success, otherwise false
     **/
    public function delete(XoopsObject $imgcat)
    {
        $className = 'XoopsImageCategory';
        if (!($imgcat instanceof $className)) {
            return false;
        }

        $sql = sprintf('DELETE FROM %s WHERE imgcat_id = %u', $this->db->prefix('imagecategory'), $imgcat->getVar('imgcat_id'));
        $sql = sprintf('DELETE FROM %s WHERE imgcat_id = %u', $this->db->prefix('imagecategory'), /** @scrutinizer ignore-type */ $imgcat->getVar('imgcat_id'));
        if (!$result = $this->db->query($sql)) {

            return false;
        }

        return true;
    }

    /**
     * Enter description here...
     *
     * @param \CriteriaElement|null $criteria
     * @param  bool            $id_as_key if true, use id as array key
     * @return array of XoopsImageCategory objects
     */
    public function getObjects(CriteriaElement $criteria = null, $id_as_key = false)
    {
        $ret   = array();
        $limit = $start = 0;
        $sql   = 'SELECT DISTINCT c.* FROM ' . $this->db->prefix('imagecategory') . ' c LEFT JOIN ' . $this->db->prefix('group_permission') . " l ON l.gperm_itemid=c.imgcat_id WHERE (l.gperm_name = 'imgcat_read' OR l.gperm_name = 'imgcat_write')";
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $where = $criteria->render();
            $sql .= ($where != '') ? ' AND ' . $where : '';
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $sql .= ' ORDER BY imgcat_weight, imgcat_id ASC';
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while (false !== ($myrow = $this->db->fetchArray($result))) {
        while (false !== ($myrow = $this->db->fetchArray(/** @scrutinizer ignore-type */ $result))) {
            $imgcat = new XoopsImageCategory();
            $imgcat->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] = $imgcat;
            } else {
                $ret[$myrow['imgcat_id']] = $imgcat;
            }
            unset($imgcat);
        }

        return $ret;
    }

    /**
     * Count some images
     *
     * @param \CriteriaElement|null $criteria {@link CriteriaElement}
     * @return int
     **/
    public function getCount(CriteriaElement $criteria = null)
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('imagecategory') . ' i LEFT JOIN ' . $this->db->prefix('group_permission') . " l ON l.gperm_itemid=i.imgcat_id WHERE (l.gperm_name = 'imgcat_read' OR l.gperm_name = 'imgcat_write')";
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $where = $criteria->render();
            $sql .= ($where != '') ? ' AND ' . $where : '';
        }
        if (!$result = $this->db->query($sql)) {
            return 0;
        }
        list($count) = $this->db->fetchRow($result);
        list($count) = $this->db->fetchRow(/** @scrutinizer ignore-type */ $result);

        return $count;
    }

    /**
     * Get a list of image categories
     *
     * @param array    $groups
     * @param string   $perm
     * @param int|null $display
     * @param int|null $storetype
     * @return array Array of {@link XoopsImage} objects
     * @internal param bool $image_display
     * @internal param int $imgcat_id
     */
    public function getList($groups = array(), $perm = 'imgcat_read', $display = null, $storetype = null)
    {
        $criteria = new CriteriaCompo();
        if (is_array($groups) && !empty($groups)) {
            $criteriaTray = new CriteriaCompo();
            foreach ($groups as $gid) {
                $criteriaTray->add(new Criteria('gperm_groupid', $gid), 'OR');
            }
            $criteria->add($criteriaTray);
            if ($perm === 'imgcat_read' || $perm === 'imgcat_write') {
                $criteria->add(new Criteria('gperm_name', $perm));
                $criteria->add(new Criteria('gperm_modid', 1));
            }
        }
        if (isset($display)) {
            $criteria->add(new Criteria('imgcat_display', (string)$display));
        }
        if (isset($storetype)) {
            $criteria->add(new Criteria('imgcat_storetype', (string)$storetype));
        }
        $categories = $this->getObjects($criteria, true);
        $ret        = array();
        foreach (array_keys($categories) as $i) {
            $ret[$i] = $categories[$i]->getVar('imgcat_name');
        }

        return $ret;
    }
}

mambax7 / XoopsCore25

Branch — feature/php-docs2 (404c3e)

XoopsImageCategoryHandler::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
