XoopsModules\Pedigree\CountOverload

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getCount()	0	3	1
A	getCounts()	0	6	1
A	castType()	0	8	2

<?php

namespace XoopsModules\Pedigree;

/*
 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.
*/
/**
 *
 * @package         XoopsModules\Pedigree
 * @author          XOOPS Development Team - <https://xoops.org>
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GPL 2.0 or later
 * @link            https://xoops.org/
 * @since           1.32
 */

/**
 * Class Trait to overload XoopsObject getCount() & getCounts() methods because XOOPS
 * doesn't return int as expected in XOOPS <= 2.5.10, need to check in later versions
 *
 * To use: add 'use CountOverload' in the class that extends \XoopsPersistableObjectHandler
 *
 **/
trait CountOverload
{
    /**
     * count objects matching a condition
     *
     * Overload of XoopsObject getCount() because XOOPS doesn't return int as expected
     * in XOOPS <= 2.5.10, need to check in later versions
     *
     * @param  \CriteriaElement|null $criteria {@link \CriteriaElement} to match
     * @return int count of objects
     */
    public function getCount(?\CriteriaElement $criteria = null): int

The parameter $criteria is not used and could be removed.

    {
        return (int) parent::getCount($criteria = null);
    }

    /**
     * Get counts of objects matching a condition
     *
     * @param  \CriteriaElement|null $criteria {@link CriteriaElement} to match
     * @return int[] of counts
     */
    public function getCounts(?\CriteriaElement $criteria = null): array

The parameter $criteria is not used and could be removed.

    {
        $countArray = parent::getCounts($criteria = null);
        array_walk($countArray, 'self::castType', 'int');

        return $countArray;
    }

    /**
     * Cast a variable to a known type
     *
     * @param mixed $var variable to cast (by reference)
     * @param string $type new type
     * @return bool true if type set was successful, false otherwise
     */
    private static function castType(&$var, $key,  ?string $type = 'int'): bool

The parameter $key is not used and could be removed.

    {
        $validTypes = ['bool', 'boolean', 'int', 'integer', 'float', 'double', 'string', 'array', 'object', 'null'];
        $success    = false;
        if (in_array($type, $validTypes)) {
            $success = settype($var, $type);

It seems like $type can also be of type null; however, parameter $type of settype() does only seem to accept string, maybe add an additional type check?

        }
        return $success;
    }
}