Joint::updateByLink() - Code Metrics - Inspection of "Move to more sensible project structure - step 1" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#563)

by Richard

created 2018-02-13 21:44 UTC

Joint::updateByLink() B

↳ Parent: Joint

Complexity

Conditions	7
Paths	6

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	7.0178

Importance

Changes

Metric	Value
cc	7
eloc	13
nc	6
nop	2
dl	0
loc	21
rs	7.551
c	0
b	0
f	0
ccs	13
cts	14
cp	0.9286
crap	7.0178

<?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;

/**
 * Object joint handler class.
 *
 * @category  Xoops\Core\Kernel\Model\Joint
 * @package   Xoops\Core\Kernel
 * @author    Taiwen Jiang <[email protected]>
 * @copyright 2000-2015 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 * @since     2.3.0
 *
 * Usage of methods provided by XoopsModelJoint:
 *
 * Step #1: set linked table and joint fields through XoopsPersistableObjectHandler:
 *      $handler->table_link = $handler->db2->prefix("the_linked_table");
 *          full name of the linked table that is used for the query
 *      $handler->field_link = "the_linked_field";
 *          name of field in linked table that will be used to link the linked table
 *          with current table
 *      $handler->field_object = "the_object_field";
 *          name of field in current table that will be used to link the linked table
 *          with current table; linked field name will be used if the field name is
 *          not set
 * Step #2: fetch data
 */
class Joint extends XoopsModelAbstract
{
    /**
     * Validate information for the linkage
     *
     * @return bool
     */
    private function validateLinks()
    {
        if (empty($this->handler->table_link) || empty($this->handler->field_link)) {
            trigger_error("The linked table is not set yet.", E_USER_WARNING);
            return false;
        }
        if (empty($this->handler->field_object)) {
            $this->handler->field_object = $this->handler->field_link;
        }
        return true;
    }

    /**
     * get a list of objects matching a condition joint with another related object
     *
     * @param CriteriaElement|null $criteria     criteria to match
     * @param array                $fields       variables to fetch
     * @param bool                 $asObject     flag indicating as object, otherwise as array
     * @param string               $field_link   field of linked object for JOIN;
     *                                            deprecated, for backward compatibility only
     * @param string               $field_object field of current object for JOIN;
     *                                            deprecated, for backward compatibility only
     *
     * @return false|array array as requested by $asObject
     */
    public function getByLink(
        CriteriaElement $criteria = null,
        $fields = null,
        $asObject = true,
        $field_link = null,
        $field_object = null
    ) {
        if (!empty($field_link)) {
            $this->handler->field_link = $field_link;
        }
        if (!empty($field_object)) {
            $this->handler->field_object = $field_object;
        }
        if (!$this->validateLinks()) {
            return false;
        }

        $qb = $this->handler->db2->createXoopsQueryBuilder();
        if (is_array($fields) && count($fields)) {
            if (!in_array("o." . $this->handler->keyName, $fields)) {
                $fields[] = "o." . $this->handler->keyName;
            }
            $first = true;
            foreach ($fields as $field) {
                if ($first) {
                    $first = false;
                    $qb->select($field);
                } else {
                    $qb->addSelect($field);
                }
            }
        } else {
            $qb ->select('o.*')
                ->addSelect('l.*');
        }
        $qb ->from($this->handler->table, 'o')
            ->leftJoin(
                'o',
                $this->handler->table_link,
                'l',
                "o.{$this->handler->field_object} = l.{$this->handler->field_link}"
            );
        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $qb = $criteria->renderQb($qb);
        }
        $result = $qb->execute();
        $ret = array();
        if ($asObject) {
            while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
                $object = $this->handler->create(false);
                $object->assignVars($myrow);
                $ret[$myrow[$this->handler->keyName]] = $object;
                unset($object);
            }
        } else {
            $object = $this->handler->create(false);
            while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
                $object->assignVars($myrow);
                $ret[$myrow[$this->handler->keyName]] = $object->getValues();
            }
            unset($object);
        }
        return $ret;
    }

    /**
     * Count of objects matching a condition
     *
     * @param CriteriaElement|null $criteria criteria to match
     *
     * @return false|int count of objects
     */
    public function getCountByLink(CriteriaElement $criteria = null)
    {
        if (!$this->validateLinks()) {
            return false;
        }

        $qb = $this->handler->db2->createXoopsQueryBuilder();

        $qb ->select("COUNT(DISTINCT o.{$this->handler->keyName})")
            ->from($this->handler->table, 'o')
            ->leftJoin(
                'o',
                $this->handler->table_link,
                'l',
                "o.{$this->handler->field_object} = l.{$this->handler->field_link}"
            );

        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $criteria->renderQb($qb);
        }

        $result = $qb->execute();
        return $result->fetchColumn(0);
    }

    /**
     * array of count of objects matching a condition of, groupby linked object keyname
     *
     * @param CriteriaElement $criteria criteria to match
     *
     * @return false|int count of objects
     */
    public function getCountsByLink(CriteriaElement $criteria = null)
    {
        if (!$this->validateLinks()) {
            return false;
        }

        $qb = $this->handler->db2->createXoopsQueryBuilder();

        $qb ->select("l.{$this->handler->field_link}")
            ->addSelect('COUNT(*)')
            ->from($this->handler->table, 'o')
            ->leftJoin(
                'o',
                $this->handler->table_link,
                'l',
                "o.{$this->handler->field_object} = l.{$this->handler->field_link}"
            );

        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $criteria->renderQb($qb);
        }

        $qb ->groupBy("l.{$this->handler->field_link}");

        $result = $qb->execute();

        $ret = array();
        while (list($id, $count) = $result->fetch(\PDO::FETCH_NUM)) {
            $ret[$id] = $count;
        }
        return $ret;
    }

    /**
     * update objects matching a condition against linked objects
     *
     * @param array                $data     array of key => value
     * @param CriteriaElement|null $criteria criteria to match
     *
     * @return false|int count of objects
     *
     * @todo UPDATE ... LEFT JOIN is not portable
     * Note Alain91 : multi tables update is not allowed in Doctrine
     */
    public function updateByLink(array $data, CriteriaElement $criteria = null)
    {
        if (!$this->validateLinks()) {
            return false;
        }
        if (empty($data) || empty($criteria)) { // avoid update all records
            return false;
        }

        $set = array();
        foreach ($data as $key => $val) {
            $set[] = "o.{$key}=" . $this->handler->db2->quote($val);
        }
        $sql = " UPDATE {$this->handler->table} AS o" . " SET " . implode(", ", $set)
            . " LEFT JOIN {$this->handler->table_link} AS l "
            . "ON o.{$this->handler->field_object} = l.{$this->handler->field_link}";
        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $sql .= " " . $criteria->renderWhere();
        }

        return $this->handler->db2->executeUpdate($sql);
    }

    /**
     * Delete objects matching a condition against linked objects
     *
     * @param CriteriaElement|null $criteria criteria to match
     *
     * @return false|int count of objects
     *
     * @todo DELETE ... LEFT JOIN is not portable
     * Note Alain91 : multi tables delete is not allowed in Doctrine
     */
    public function deleteByLink(CriteriaElement $criteria = null)
    {
        if (!$this->validateLinks()) {
            return false;
        }
        if (empty($criteria)) { //avoid delete all records
            return false;
        }

        $sql = "DELETE FROM {$this->handler->table} AS o "
            . "LEFT JOIN {$this->handler->table_link} AS l "
            . "ON o.{$this->handler->field_object} = l.{$this->handler->field_link}";
        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $sql .= " " . $criteria->renderWhere();
        }

        return $this->handler->db2->executeUpdate($sql);
    }
}


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
17		/**
18		* Object joint handler class.
19		*
20		* @category Xoops\Core\Kernel\Model\Joint
21		* @package Xoops\Core\Kernel
22		* @author Taiwen Jiang <[email protected]>
23		* @copyright 2000-2015 XOOPS Project (http://xoops.org)
24		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
25		* @link http://xoops.org
26		* @since 2.3.0
27		*
28		* Usage of methods provided by XoopsModelJoint:
29		*
30		* Step #1: set linked table and joint fields through XoopsPersistableObjectHandler:
31		* $handler->table_link = $handler->db2->prefix("the_linked_table");
32		* full name of the linked table that is used for the query
33		* $handler->field_link = "the_linked_field";
34		* name of field in linked table that will be used to link the linked table
35		* with current table
36		* $handler->field_object = "the_object_field";
37		* name of field in current table that will be used to link the linked table
38		* with current table; linked field name will be used if the field name is
39		* not set
40		* Step #2: fetch data
41		*/
42		class Joint extends XoopsModelAbstract
43		{
44		/**
45		* Validate information for the linkage
46		*
47		* @return bool
48		*/
49	10	private function validateLinks()
50		{
51	10	if (empty($this->handler->table_link) \|\| empty($this->handler->field_link)) {
52		trigger_error("The linked table is not set yet.", E_USER_WARNING);
53		return false;
54		}
55	10	if (empty($this->handler->field_object)) {
56		$this->handler->field_object = $this->handler->field_link;
57		}
58	10	return true;
59		}
60
61		/**
62		* get a list of objects matching a condition joint with another related object
63		*
64		* @param CriteriaElement\|null $criteria criteria to match
65		* @param array $fields variables to fetch
66		* @param bool $asObject flag indicating as object, otherwise as array
67		* @param string $field_link field of linked object for JOIN;
68		* deprecated, for backward compatibility only
69		* @param string $field_object field of current object for JOIN;
70		* deprecated, for backward compatibility only
71		*
72		* @return false\|array array as requested by $asObject
73		*/
74	2	public function getByLink(
75		CriteriaElement $criteria = null,
76		$fields = null,
77		$asObject = true,
78		$field_link = null,
79		$field_object = null
80		) {
81	2	if (!empty($field_link)) {
82		$this->handler->field_link = $field_link;
83		}
84	2	if (!empty($field_object)) {
85		$this->handler->field_object = $field_object;
86		}
87	2	if (!$this->validateLinks()) {
88		return false;
89		}
90
91	2	$qb = $this->handler->db2->createXoopsQueryBuilder();
92	2	if (is_array($fields) && count($fields)) {
93		if (!in_array("o." . $this->handler->keyName, $fields)) {
94		$fields[] = "o." . $this->handler->keyName;
95		}
96		$first = true;
97		foreach ($fields as $field) {
98		if ($first) {
99		$first = false;
100		$qb->select($field);
101		} else {
102		$qb->addSelect($field);
103		}
104		}
105		} else {
106	2	$qb ->select('o.*')
107	2	->addSelect('l.*');
108		}
109	2	$qb ->from($this->handler->table, 'o')
110	2	->leftJoin(
111	2	'o',
112	2	$this->handler->table_link,
113	2	'l',
114	2	"o.{$this->handler->field_object} = l.{$this->handler->field_link}"
115		);
116	2	if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
117		$qb = $criteria->renderQb($qb);
118		}
119	2	$result = $qb->execute();
120	2	$ret = array();
121	2	if ($asObject) {
122	2	while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
123	2	$object = $this->handler->create(false);
124	2	$object->assignVars($myrow);
125	2	$ret[$myrow[$this->handler->keyName]] = $object;
126	2	unset($object);
127		}
128		} else {
129		$object = $this->handler->create(false);
130		while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
131		$object->assignVars($myrow);
132		$ret[$myrow[$this->handler->keyName]] = $object->getValues();
133		}
134		unset($object);
135		}
136	2	return $ret;
137		}
138
139		/**
140		* Count of objects matching a condition
141		*
142		* @param CriteriaElement\|null $criteria criteria to match
143		*
144		* @return false\|int count of objects
145		*/
146	2	public function getCountByLink(CriteriaElement $criteria = null)
147		{
148	2	if (!$this->validateLinks()) {
149		return false;
150		}
151
152	2	$qb = $this->handler->db2->createXoopsQueryBuilder();
153
154	2	$qb ->select("COUNT(DISTINCT o.{$this->handler->keyName})")
155	2	->from($this->handler->table, 'o')
156	2	->leftJoin(
157	2	'o',
158	2	$this->handler->table_link,
159	2	'l',
160	2	"o.{$this->handler->field_object} = l.{$this->handler->field_link}"
161		);
162
163	2	if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
164		$criteria->renderQb($qb);
165		}
166
167	2	$result = $qb->execute();
168	2	return $result->fetchColumn(0);
169		}
170
171		/**
172		* array of count of objects matching a condition of, groupby linked object keyname
173		*
174		* @param CriteriaElement $criteria criteria to match
175		*
176		* @return false\|int count of objects
177		*/
178	2	public function getCountsByLink(CriteriaElement $criteria = null)
179		{
180	2	if (!$this->validateLinks()) {
181		return false;
182		}
183
184	2	$qb = $this->handler->db2->createXoopsQueryBuilder();
185
186	2	$qb ->select("l.{$this->handler->field_link}")
187	2	->addSelect('COUNT(*)')
188	2	->from($this->handler->table, 'o')
189	2	->leftJoin(
190	2	'o',
191	2	$this->handler->table_link,
192	2	'l',
193	2	"o.{$this->handler->field_object} = l.{$this->handler->field_link}"
194		);
195
196	2	if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
197		$criteria->renderQb($qb);
198		}
199
200	2	$qb ->groupBy("l.{$this->handler->field_link}");
201
202	2	$result = $qb->execute();
203
204	2	$ret = array();
205	2	while (list($id, $count) = $result->fetch(\PDO::FETCH_NUM)) {
206	2	$ret[$id] = $count;
207		}
208	2	return $ret;
209		}
210
211		/**
212		* update objects matching a condition against linked objects
213		*
214		* @param array $data array of key => value
215		* @param CriteriaElement\|null $criteria criteria to match
216		*
217		* @return false\|int count of objects
218		*
219		* @todo UPDATE ... LEFT JOIN is not portable
220		* Note Alain91 : multi tables update is not allowed in Doctrine
221		*/
222	2	public function updateByLink(array $data, CriteriaElement $criteria = null)
223		{
224	2	if (!$this->validateLinks()) {
225		return false;
226		}
227	2	if (empty($data) \|\| empty($criteria)) { // avoid update all records
228	1	return false;
229		}
230
231	1	$set = array();
232	1	foreach ($data as $key => $val) {
233	1	$set[] = "o.{$key}=" . $this->handler->db2->quote($val);
234		}
235	1	$sql = " UPDATE {$this->handler->table} AS o" . " SET " . implode(", ", $set)
236	1	. " LEFT JOIN {$this->handler->table_link} AS l "
237	1	. "ON o.{$this->handler->field_object} = l.{$this->handler->field_link}";
238	1	if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
239	1	$sql .= " " . $criteria->renderWhere();
240		}
241
242	1	return $this->handler->db2->executeUpdate($sql);
243		}
244
245		/**
246		* Delete objects matching a condition against linked objects
247		*
248		* @param CriteriaElement\|null $criteria criteria to match
249		*
250		* @return false\|int count of objects
251		*
252		* @todo DELETE ... LEFT JOIN is not portable
253		* Note Alain91 : multi tables delete is not allowed in Doctrine
254		*/
255	2	public function deleteByLink(CriteriaElement $criteria = null)
256		{
257	2	if (!$this->validateLinks()) {
258		return false;
259		}
260	2	if (empty($criteria)) { //avoid delete all records
261	1	return false;
262		}
263
264	1	$sql = "DELETE FROM {$this->handler->table} AS o "
265	1	. "LEFT JOIN {$this->handler->table_link} AS l "
266	1	. "ON o.{$this->handler->field_object} = l.{$this->handler->field_link}";
267	1	if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
268	1	$sql .= " " . $criteria->renderWhere();
269		}
270
271	1	return $this->handler->db2->executeUpdate($sql);
272		}
273		}
274

XOOPS / XoopsCore

Pull Request — master (#563)

Joint::updateByLink() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like