Read::getAll() - Code Metrics - Inspection of "Fix composer.json.dist" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#607)

by Richard

created 2019-06-01 16:20 UTC

Read::getAll() C

↳ Parent: Read

Complexity

Conditions	13
Paths	42

Size

Total Lines	54
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	33
CRAP Score	13.0314

Importance

Changes

Metric	Value
cc	13
eloc	39
nc	42
nop	4
dl	0
loc	54
rs	6.6166
c	0
b	0
f	0
ccs	33
cts	35
cp	0.9429
crap	13.0314

How to fix Long Method Complexity

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

namespace Xoops\Core\Kernel\Model;

use Xoops\Core\Kernel\CriteriaElement;
use Xoops\Core\Kernel\XoopsModelAbstract;
use Doctrine\DBAL\FetchMode;

/**
 * Object render handler class.
 *
 * @category  Xoops\Core\Kernel\Model\Read
 * @package   Xoops\Core\Kernel
 * @author    Taiwen Jiang <[email protected]>
 * @copyright 2000-2019 XOOPS Project (https://xoops.org)
 * @license   GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 */
class Read extends XoopsModelAbstract
{
    /**
     * get all objects matching a condition
     *
     * @param CriteriaElement|null $criteria  criteria to match
     * @param array                $fields    variables to fetch
     * @param bool                 $asObject  flag indicating as object, otherwise as array
     * @param bool                 $id_as_key use the ID as key for the array
     *
     * @return array of objects/array as specified in $asObject
     */
    public function getAll(CriteriaElement $criteria = null, $fields = null, $asObject = true, $id_as_key = true)
    {
        $qb = $this->handler->db2->createXoopsQueryBuilder();

        if (is_array($fields) && count($fields) > 0) {
            if (!in_array($this->handler->keyName, $fields)) {
                $fields[] = $this->handler->keyName;
            }
            $first=true;
            foreach ($fields as $field) {
                if ($first) {
                    $first=false;
                    $qb->select($field);
                } else {
                    $qb->addSelect($field);
                }
            }
        } else {
            $qb->select('*');
        }
        $qb->from($this->handler->table, null);
        if (isset($criteria)) {
            $qb = $criteria->renderQb($qb);
        }

        $ret = array();
        $result = $qb->execute();
        if (!$result) {
            return $ret;
        }
        if ($asObject) {
            while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
                $object = $this->handler->create(false);
                $object->assignVars($myrow);
                if ($id_as_key) {
                    $ret[$myrow[$this->handler->keyName]] = $object;
                } else {
                    $ret[] = $object;
                }
                unset($object);
            }
        } else {
            $object = $this->handler->create(false);
            while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
                $object->assignVars($myrow);
                if ($id_as_key) {
                    $ret[$myrow[$this->handler->keyName]] = $object->getValues();
                } else {
                    $ret[] = $object->getValues();
                }
            }
            unset($object);
        }
        return $ret;
    }

    /**
     * retrieve objects from the database
     *
     * For performance consideration, getAll() is recommended
     *
     * @param CriteriaElement|null $criteria  criteria to match
     * @param bool                 $id_as_key use the ID as key for the array
     * @param bool                 $as_object return an array of objects?
     *
     * @return array
     */
    public function getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true)
    {
        $objects = $this->getAll($criteria, null, $as_object, $id_as_key);
        return $objects;
    }

    /**
     * Retrieve a list of objects data
     *
     * @param CriteriaElement|null $criteria criteria to match
     * @param int                  $limit    Max number of objects to fetch
     * @param int                  $start    Which record to start at
     *
     * @return array
     */
    public function getList(CriteriaElement $criteria = null, $limit = 0, $start = 0)
    {
        //$qb = Xoops::getInstance()->db()->createXoopsQueryBuilder();
        $qb = $this->handler->db2->createXoopsQueryBuilder();

        $ret = array();

        $qb->select($this->handler->keyName);
        if (!empty($this->handler->identifierName)) {
            $qb->addSelect($this->handler->identifierName);
        }
        $qb->from($this->handler->table, null);
        if ($limit!=0 || $start!=0) {
            $qb->setFirstResult($start)
                ->setMaxResults($limit);
        }
        $qb->orderBy($this->handler->keyName); // any criteria order will override
        if (!empty($criteria)) {
            $qb = $criteria->renderQb($qb);
        }
        $result = $qb->execute();
        if (!$result) {
            return $ret;
        }

        $myts = \Xoops\Core\Text\Sanitizer::getInstance();
        while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
            // identifiers should be textboxes, so sanitize them like that
            $ret[$myrow[$this->handler->keyName]] = empty($this->handler->identifierName) ? 1
                : $myts->htmlSpecialChars($myrow[$this->handler->identifierName]);
        }
        return $ret;
    }

    /**
     * get IDs of objects matching a condition
     *
     * @param CriteriaElement|null $criteria criteria to match
     *
     * @return array of object IDs
     */
    public function getIds(CriteriaElement $criteria = null)
    {
        $qb = $this->handler->db2->createXoopsQueryBuilder();

        $ret = array();

        $qb->select($this->handler->keyName);
        $qb->from($this->handler->table, null);
        if (!empty($criteria)) {
            $qb = $criteria->renderQb($qb);
        }
        $result = $qb->execute();
        if (!$result) {
            return $ret;
        }

        while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
            $ret[] = $myrow[$this->handler->keyName];
        }
        return $ret;
    }

    /**
     * getRandomObject - return a randomly selected object
     *
     * @param CriteriaElement|null $criteria criteria to match
     *
     * @return \Xoops\Core\Kernel\XoopsObject|null object or null if no matching object found
     */
    public function getRandomObject(CriteriaElement $criteria = null)
    {
        $qb = $this->handler->db2->createXoopsQueryBuilder();
        $qb ->select('COUNT(*)')
            ->from($this->handler->table, null);
        if (null !== $criteria) {
            $qb = $criteria->renderQb($qb);
        }
        $result = $qb->execute();
        $count = $result->fetchColumn();

        $offset = mt_rand(0, $count - 1);

        $qb = $this->handler->db2->createXoopsQueryBuilder();
        $qb ->select($this->handler->keyName)
            ->from($this->handler->table, null);
        if (null !== $criteria) {
            $qb = $criteria->renderQb($qb);
        }
        $qb ->setFirstResult($offset)
            ->setMaxResults(1);

        $result = $qb->execute();
        $randomKey = $result->fetchColumn();

        return $this->handler->get($randomKey);
    }
}


1		<?php
2		/*
3		You may not change or alter any portion of this comment or credits
4		of supporting developers from this source code or any supporting source code
5		which is considered copyrighted (c) material of the original comment or credit authors.
6
7		This program is distributed in the hope that it will be useful,
8		but WITHOUT ANY WARRANTY; without even the implied warranty of
9		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10		*/
11
12		namespace Xoops\Core\Kernel\Model;
13
14		use Xoops\Core\Kernel\CriteriaElement;
15		use Xoops\Core\Kernel\XoopsModelAbstract;
16		use Doctrine\DBAL\FetchMode;
17
18		/**
19		* Object render handler class.
20		*
21		* @category Xoops\Core\Kernel\Model\Read
22		* @package Xoops\Core\Kernel
23		* @author Taiwen Jiang <[email protected]>
24		* @copyright 2000-2019 XOOPS Project (https://xoops.org)
25		* @license GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
26		*/
27		class Read extends XoopsModelAbstract
28		{
29		/**
30		* get all objects matching a condition
31		*
32		* @param CriteriaElement\|null $criteria criteria to match
33		* @param array $fields variables to fetch
34		* @param bool $asObject flag indicating as object, otherwise as array
35		* @param bool $id_as_key use the ID as key for the array
36		*
37		* @return array of objects/array as specified in $asObject
38		*/
39	30	public function getAll(CriteriaElement $criteria = null, $fields = null, $asObject = true, $id_as_key = true)
40		{
41	30	$qb = $this->handler->db2->createXoopsQueryBuilder();
42
43	30	if (is_array($fields) && count($fields) > 0) {
44	1	if (!in_array($this->handler->keyName, $fields)) {
45	1	$fields[] = $this->handler->keyName;
46		}
47	1	$first=true;
48	1	foreach ($fields as $field) {
49	1	if ($first) {
50	1	$first=false;
51	1	$qb->select($field);
52		} else {
53	1	$qb->addSelect($field);
54		}
55		}
56		} else {
57	29	$qb->select('*');
58		}
59	30	$qb->from($this->handler->table, null);
60	30	if (isset($criteria)) {
61	23	$qb = $criteria->renderQb($qb);
62		}
63
64	30	$ret = array();
65	30	$result = $qb->execute();
66	30	if (!$result) {
67		return $ret;
68		}
69	30	if ($asObject) {
70	29	while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
71	25	$object = $this->handler->create(false);
72	25	$object->assignVars($myrow);
73	25	if ($id_as_key) {
74	16	$ret[$myrow[$this->handler->keyName]] = $object;
75		} else {
76	9	$ret[] = $object;
77		}
78	25	unset($object);
79		}
80		} else {
81	1	$object = $this->handler->create(false);
82	1	while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
83	1	$object->assignVars($myrow);
84	1	if ($id_as_key) {
85		$ret[$myrow[$this->handler->keyName]] = $object->getValues();
86		} else {
87	1	$ret[] = $object->getValues();
88		}
89		}
90	1	unset($object);
91		}
92	30	return $ret;
93		}
94
95		/**
96		* retrieve objects from the database
97		*
98		* For performance consideration, getAll() is recommended
99		*
100		* @param CriteriaElement\|null $criteria criteria to match
101		* @param bool $id_as_key use the ID as key for the array
102		* @param bool $as_object return an array of objects?
103		*
104		* @return array
105		*/
106	27	public function getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true)
107		{
108	27	$objects = $this->getAll($criteria, null, $as_object, $id_as_key);
109	27	return $objects;
110		}
111
112		/**
113		* Retrieve a list of objects data
114		*
115		* @param CriteriaElement\|null $criteria criteria to match
116		* @param int $limit Max number of objects to fetch
117		* @param int $start Which record to start at
118		*
119		* @return array
120		*/
121	2	public function getList(CriteriaElement $criteria = null, $limit = 0, $start = 0)
122		{
123		//$qb = Xoops::getInstance()->db()->createXoopsQueryBuilder();
124	2	$qb = $this->handler->db2->createXoopsQueryBuilder();
125
126	2	$ret = array();
127
128	2	$qb->select($this->handler->keyName);
129	2	if (!empty($this->handler->identifierName)) {
130	2	$qb->addSelect($this->handler->identifierName);
131		}
132	2	$qb->from($this->handler->table, null);
133	2	if ($limit!=0 \|\| $start!=0) {
134		$qb->setFirstResult($start)
135		->setMaxResults($limit);
136		}
137	2	$qb->orderBy($this->handler->keyName); // any criteria order will override
138	2	if (!empty($criteria)) {
139		$qb = $criteria->renderQb($qb);
140		}
141	2	$result = $qb->execute();
142	2	if (!$result) {
143		return $ret;
144		}
145
146	2	$myts = \Xoops\Core\Text\Sanitizer::getInstance();
147	2	while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
148		// identifiers should be textboxes, so sanitize them like that
149	2	$ret[$myrow[$this->handler->keyName]] = empty($this->handler->identifierName) ? 1
150	2	: $myts->htmlSpecialChars($myrow[$this->handler->identifierName]);
151		}
152	2	return $ret;
153		}
154
155		/**
156		* get IDs of objects matching a condition
157		*
158		* @param CriteriaElement\|null $criteria criteria to match
159		*
160		* @return array of object IDs
161		*/
162	2	public function getIds(CriteriaElement $criteria = null)
163		{
164	2	$qb = $this->handler->db2->createXoopsQueryBuilder();
165
166	2	$ret = array();
167
168	2	$qb->select($this->handler->keyName);
169	2	$qb->from($this->handler->table, null);
170	2	if (!empty($criteria)) {
171		$qb = $criteria->renderQb($qb);
172		}
173	2	$result = $qb->execute();
174	2	if (!$result) {
175		return $ret;
176		}
177
178	2	while ($myrow = $result->fetch(FetchMode::ASSOCIATIVE)) {
179	2	$ret[] = $myrow[$this->handler->keyName];
180		}
181	2	return $ret;
182		}
183
184		/**
185		* getRandomObject - return a randomly selected object
186		*
187		* @param CriteriaElement\|null $criteria criteria to match
188		*
189		* @return \Xoops\Core\Kernel\XoopsObject\|null object or null if no matching object found
190		*/
191	1	public function getRandomObject(CriteriaElement $criteria = null)
192		{
193	1	$qb = $this->handler->db2->createXoopsQueryBuilder();
194	1	$qb ->select('COUNT(*)')
195	1	->from($this->handler->table, null);
196	1	if (null !== $criteria) {
197		$qb = $criteria->renderQb($qb);
198		}
199	1	$result = $qb->execute();
200	1	$count = $result->fetchColumn();
201
202	1	$offset = mt_rand(0, $count - 1);
203
204	1	$qb = $this->handler->db2->createXoopsQueryBuilder();
205	1	$qb ->select($this->handler->keyName)
206	1	->from($this->handler->table, null);
207	1	if (null !== $criteria) {
208		$qb = $criteria->renderQb($qb);
209		}
210	1	$qb ->setFirstResult($offset)
211	1	->setMaxResults(1);
212
213	1	$result = $qb->execute();
214	1	$randomKey = $result->fetchColumn();
215
216	1	return $this->handler->get($randomKey);
217		}
218		}
219

XOOPS / XoopsCore

Pull Request — master (#607)

Read::getAll() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like