Issues in ProfileHandler.php - New Issues - Inspection of "updates" - XoopsModules25x/suico - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#81)

by Michael

created 2020-04-29 03:32 UTC

class/ProfileHandler.php (1 issue)

Labels

Bug 1

Severity

Minor 1

<?php

declare(strict_types=1);

namespace XoopsModules\Yogurt;

/**
 * Extended User Profile
 *
 * 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 (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package             profile
 * @since               2.3.0
 * @author              Jan Pedersen
 * @author              Taiwen Jiang <[email protected]>
 */

/**
 * @package             kernel
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 */

use XoopsModules\Yogurt;

/**
 * Class ProfileHandler
 * @package XoopsModules\Yogurt
 */
class ProfileHandler extends \XoopsPersistableObjectHandler
{
    /**
     * holds reference to {@link profileFieldHandler} object
     */

    public $_fHandler;

    /**
     * Array of {@link XoopsYogurt\Field} objects
     * @var array
     */

    public $_fields = [];

    /**
     * @param \XoopsDatabase $db
     */

    public function __construct(\XoopsDatabase $db)
    {
        parent::__construct($db, 'yogurt_profile', Profile::class, 'profile_id');

        $this->_fHandler = \XoopsModules\Yogurt\Helper::getInstance()->getHandler('Field');
    }

    /**
     * create a new {@link ProfileProfile}
     *
     * @param bool $isNew Flag the new objects as "new"?
     *
     * @return object {@link ProfileProfile}
     */

    public function create($isNew = true)
    {
        $obj = new $this->className($this->loadFields());

        $obj->handler = $this;

        if ($isNew) {
            $obj->setNew();
        }

        return $obj;
    }

    /**
     * Get a ProfileProfile object for a user id.
     *
     * We will create an empty profile if none exists. This behavior allows user objects
     * created outside of profile to be edited correctly in the profile module.
     *
     * @param int|null      $uid
     * @param string[]|null $fields array of field names to fetch, null for all
     *
     * @return object {@link ProfileProfile}
     *
     * @internal This was get($uid, $createOnFailure = true). No callers found using the extra parameter.
     * @internal Modified to match parent signature.
     */

    public function get($uid = null, $fields = null)
    {
        $obj = parent::get($uid, $fields);

        if (!\is_object($obj)) {
            $obj = $this->create();
        }

        return $obj;
    }

    /**
     * Create new {@link Yogurt\Field} object
     *
     * @param bool $isNew
     *
     * @return Yogurt\Field
     */

    public function createField($isNew = true)
    {
        $return = $this->_fHandler->create($isNew);

        return $return;
    }

    /**
     * Load field information
     *
     * @return array
     */

    public function loadFields()
    {
        if (0 == \count($this->_fields)) {
            $this->_fields = $this->_fHandler->loadFields();
        }

        return $this->_fields;
    }

    /**
     * Fetch fields
     *
     * @param \CriteriaElement $criteria  {@link CriteriaElement} object
     * @param bool             $id_as_key return array with field IDs as key?
     * @param bool             $as_object return array of objects?
     *
     * @return array
     */

    public function getFields(\CriteriaElement $criteria, $id_as_key = true, $as_object = true)
    {
        return $this->_fHandler->getObjects($criteria, $id_as_key, $as_object);
    }

    /**
     * Insert a field in the database
     *
     * @param \XoopsModules\Yogurt\Field $field
     * @param bool                       $force
     *
     * @return bool
     */

    public function insertField(Yogurt\Field $field, $force = false)
    {
        return $this->_fHandler->insert($field, $force);
    }

    /**
     * Delete a field from the database
     *
     * @param \XoopsModules\Yogurt\Field $field
     * @param bool                       $force
     *
     * @return bool
     */

    public function deleteField(Yogurt\Field $field, $force = false)
    {
        return $this->_fHandler->delete($field, $force);
    }

    /**
     * Save a new field in the database
     *
     * @param array $vars array of variables, taken from $module->loadInfo('profile')['field']
     * @param int   $weight
     *
     * @return string
     * @internal param int $type valuetype of the field
     * @internal param int $moduleid ID of the module, this field belongs to
     * @internal param int $categoryid ID of the category to add it to
     */

    public function saveField($vars, $weight = 0)
    {
        $field = $this->createField();

        $field->setVar('field_name', $vars['name']);

        $field->setVar('field_valuetype', $vars['valuetype']);

        $field->setVar('field_type', $vars['type']);

        $field->setVar('field_weight', $weight);

        if (isset($vars['title'])) {
            $field->setVar('field_title', $vars['title']);
        }

        if (isset($vars['description'])) {
            $field->setVar('field_description', $vars['description']);
        }

        if (isset($vars['required'])) {
            $field->setVar('field_required', $vars['required']); //0 = no, 1 = yes
        }

        if (isset($vars['maxlength'])) {
            $field->setVar('field_maxlength', $vars['maxlength']);
        }

        if (isset($vars['default'])) {
            $field->setVar('field_default', $vars['default']);
        }

        if (isset($vars['notnull'])) {
            $field->setVar('field_notnull', $vars['notnull']);
        }

        if (isset($vars['show'])) {
            $field->setVar('field_show', $vars['show']);
        }

        if (isset($vars['edit'])) {
            $field->setVar('field_edit', $vars['edit']);
        }

        if (isset($vars['config'])) {
            $field->setVar('field_config', $vars['config']);
        }

        if (isset($vars['options'])) {
            $field->setVar('field_options', $vars['options']);
        } else {
            $field->setVar('field_options', []);
        }

        if ($this->insertField($field)) {
            $msg = '&nbsp;&nbsp;Field <strong>' . $vars['name'] . '</strong> added to the database';
        } else {
            $msg = '&nbsp;&nbsp;<span class="red">ERROR: Could not insert field <strong>' . $vars['name'] . '</strong> into the database. ' . \implode(' ', $field->getErrors()) . $this->db->error() . '</span>';
        }

        unset($field);

        return $msg;
    }

    /**
     * insert a new object in the database
     *
     * @param \XoopsObject $obj   reference to the object
     * @param bool         $force whether to force the query execution despite security settings
     *
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

    public function insert(\XoopsObject $obj, $force = false)
    {
        if (!($obj instanceof $this->className)) {
            return false;
        }

        $uservars = $this->getUserVars();

        foreach ($uservars as $var) {
            unset($obj->vars[$var]);
        }

        if (0 == \count($obj->vars)) {
            return true;
        }

        return parent::insert($obj, $force);
    }

    /**
     * Get array of standard variable names (user table)
     *
     * @return array
     */

    public function getUserVars()
    {
        return $this->_fHandler->getUserVars();
    }

    /**
     * Search profiles and users
     *
     * @param \CriteriaElement $criteria   CriteriaElement
     * @param array            $searchvars Fields to be fetched
     * @param array            $groups     for Usergroups is selected (only admin!)
     *
     * @return array
     */

    public function search(\CriteriaElement $criteria, $searchvars = [], $groups = null)
    {
        $uservars = $this->getUserVars();

        $searchvars_user = \array_intersect($searchvars, $uservars);

        $searchvars_profile = \array_diff($searchvars, $uservars);

        $sv = ['u.uid, u.uname, u.email, u.user_viewemail'];

        if (!empty($searchvars_user)) {
            $sv[0] .= ',u.' . \implode(', u.', $searchvars_user);
        }

        if (!empty($searchvars_profile)) {
            $sv[] = 'p.' . \implode(', p.', $searchvars_profile);
        }

        $sql_select = 'SELECT ' . (empty($searchvars) ? 'u.*, p.*' : \implode(', ', $sv));

        $sql_from = ' FROM ' . $this->db->prefix('users') . ' AS u LEFT JOIN ' . $this->table . ' AS p ON u.uid=p.profile_id' . (empty($groups) ? '' : ' LEFT JOIN ' . $this->db->prefix('groups_users_link') . ' AS g ON u.uid=g.uid');

        $sql_clause = ' WHERE 1=1';

        $sql_order = '';

        $limit = $start = 0;

        if (isset($criteria) && $criteria instanceof \CriteriaElement) {
            $sql_clause .= ' AND ' . $criteria->render();

            if ('' !== $criteria->getSort()) {
                $sql_order = ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
            }

            $limit = $criteria->getLimit();

            $start = $criteria->getStart();
        }

        if (!empty($groups)) {
            $sql_clause .= ' AND g.groupid IN (' . \implode(', ', $groups) . ')';
        }

        $sql_users = $sql_select . $sql_from . $sql_clause . $sql_order;

        $result = $this->db->query($sql_users, $limit, $start);

        if (!$result) {
            return [[], [], 0];
        }

        $userHandler = \xoops_getHandler('user');

        $uservars = $this->getUserVars();

        $users = [];

        $profiles = [];

        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $profile = $this->create(false);

            $user = $userHandler->create(false);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

            foreach ($myrow as $name => $value) {
                if (\in_array($name, $uservars)) {
                    $user->assignVar($name, $value);
                } else {
                    $profile->assignVar($name, $value);
                }
            }

            $profiles[$myrow['uid']] = $profile;

            $users[$myrow['uid']] = $user;
        }

        $count = \count($users);

        if ((!empty($limit) && $count >= $limit) || !empty($start)) {
            $sql_count = 'SELECT COUNT(*)' . $sql_from . $sql_clause;

            $result = $this->db->query($sql_count);

            [$count] = $this->db->fetchRow($result);
        }

        return [$users, $profiles, (int)$count];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace XoopsModules\Yogurt;
6
7			/**
8			* Extended User Profile
9			*
10			* You may not change or alter any portion of this comment or credits
11			* of supporting developers from this source code or any supporting source code
12			* which is considered copyrighted (c) material of the original comment or credit authors.
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16			*
17			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
18			* @license GNU GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
19			* @package profile
20			* @since 2.3.0
21			* @author Jan Pedersen
22			* @author Taiwen Jiang <[email protected]>
23			*/
24
25			/**
26			* @package kernel
27			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
28			*/
29
30			use XoopsModules\Yogurt;
31
32			/**
33			* Class ProfileHandler
34			* @package XoopsModules\Yogurt
35			*/
36			class ProfileHandler extends \XoopsPersistableObjectHandler
37			{
38			/**
39			* holds reference to {@link profileFieldHandler} object
40			*/
41
42			public $_fHandler;
43
44			/**
45			* Array of {@link XoopsYogurt\Field} objects
46			* @var array
47			*/
48
49			public $_fields = [];
50
51			/**
52			* @param \XoopsDatabase $db
53			*/
54
55			public function __construct(\XoopsDatabase $db)
56			{
57			parent::__construct($db, 'yogurt_profile', Profile::class, 'profile_id');
58
59			$this->_fHandler = \XoopsModules\Yogurt\Helper::getInstance()->getHandler('Field');
60			}
61
62			/**
63			* create a new {@link ProfileProfile}
64			*
65			* @param bool $isNew Flag the new objects as "new"?
66			*
67			* @return object {@link ProfileProfile}
68			*/
69
70			public function create($isNew = true)
71			{
72			$obj = new $this->className($this->loadFields());
73
74			$obj->handler = $this;
75
76			if ($isNew) {
77			$obj->setNew();
78			}
79
80			return $obj;
81			}
82
83			/**
84			* Get a ProfileProfile object for a user id.
85			*
86			* We will create an empty profile if none exists. This behavior allows user objects
87			* created outside of profile to be edited correctly in the profile module.
88			*
89			* @param int\|null $uid
90			* @param string[]\|null $fields array of field names to fetch, null for all
91			*
92			* @return object {@link ProfileProfile}
93			*
94			* @internal This was get($uid, $createOnFailure = true). No callers found using the extra parameter.
95			* @internal Modified to match parent signature.
96			*/
97
98			public function get($uid = null, $fields = null)
99			{
100			$obj = parent::get($uid, $fields);
101
102			if (!\is_object($obj)) {
103			$obj = $this->create();
104			}
105
106			return $obj;
107			}
108
109			/**
110			* Create new {@link Yogurt\Field} object
111			*
112			* @param bool $isNew
113			*
114			* @return Yogurt\Field
115			*/
116
117			public function createField($isNew = true)
118			{
119			$return = $this->_fHandler->create($isNew);
120
121			return $return;
122			}
123
124			/**
125			* Load field information
126			*
127			* @return array
128			*/
129
130			public function loadFields()
131			{
132			if (0 == \count($this->_fields)) {
133			$this->_fields = $this->_fHandler->loadFields();
134			}
135
136			return $this->_fields;
137			}
138
139			/**
140			* Fetch fields
141			*
142			* @param \CriteriaElement $criteria {@link CriteriaElement} object
143			* @param bool $id_as_key return array with field IDs as key?
144			* @param bool $as_object return array of objects?
145			*
146			* @return array
147			*/
148
149			public function getFields(\CriteriaElement $criteria, $id_as_key = true, $as_object = true)
150			{
151			return $this->_fHandler->getObjects($criteria, $id_as_key, $as_object);
152			}
153
154			/**
155			* Insert a field in the database
156			*
157			* @param \XoopsModules\Yogurt\Field $field
158			* @param bool $force
159			*
160			* @return bool
161			*/
162
163			public function insertField(Yogurt\Field $field, $force = false)
164			{
165			return $this->_fHandler->insert($field, $force);
166			}
167
168			/**
169			* Delete a field from the database
170			*
171			* @param \XoopsModules\Yogurt\Field $field
172			* @param bool $force
173			*
174			* @return bool
175			*/
176
177			public function deleteField(Yogurt\Field $field, $force = false)
178			{
179			return $this->_fHandler->delete($field, $force);
180			}
181
182			/**
183			* Save a new field in the database
184			*
185			* @param array $vars array of variables, taken from $module->loadInfo('profile')['field']
186			* @param int $weight
187			*
188			* @return string
189			* @internal param int $type valuetype of the field
190			* @internal param int $moduleid ID of the module, this field belongs to
191			* @internal param int $categoryid ID of the category to add it to
192			*/
193
194			public function saveField($vars, $weight = 0)
195			{
196			$field = $this->createField();
197
198			$field->setVar('field_name', $vars['name']);
199
200			$field->setVar('field_valuetype', $vars['valuetype']);
201
202			$field->setVar('field_type', $vars['type']);
203
204			$field->setVar('field_weight', $weight);
205
206			if (isset($vars['title'])) {
207			$field->setVar('field_title', $vars['title']);
208			}
209
210			if (isset($vars['description'])) {
211			$field->setVar('field_description', $vars['description']);
212			}
213
214			if (isset($vars['required'])) {
215			$field->setVar('field_required', $vars['required']); //0 = no, 1 = yes
216			}
217
218			if (isset($vars['maxlength'])) {
219			$field->setVar('field_maxlength', $vars['maxlength']);
220			}
221
222			if (isset($vars['default'])) {
223			$field->setVar('field_default', $vars['default']);
224			}
225
226			if (isset($vars['notnull'])) {
227			$field->setVar('field_notnull', $vars['notnull']);
228			}
229
230			if (isset($vars['show'])) {
231			$field->setVar('field_show', $vars['show']);
232			}
233
234			if (isset($vars['edit'])) {
235			$field->setVar('field_edit', $vars['edit']);
236			}
237
238			if (isset($vars['config'])) {
239			$field->setVar('field_config', $vars['config']);
240			}
241
242			if (isset($vars['options'])) {
243			$field->setVar('field_options', $vars['options']);
244			} else {
245			$field->setVar('field_options', []);
246			}
247
248			if ($this->insertField($field)) {
249			$msg = '  Field <strong>' . $vars['name'] . '</strong> added to the database';
250			} else {
251			$msg = '  <span class="red">ERROR: Could not insert field <strong>' . $vars['name'] . '</strong> into the database. ' . \implode(' ', $field->getErrors()) . $this->db->error() . '</span>';
252			}
253
254			unset($field);
255
256			return $msg;
257			}
258
259			/**
260			* insert a new object in the database
261			*
262			* @param \XoopsObject $obj reference to the object
263			* @param bool $force whether to force the query execution despite security settings
264			*
265			* @return bool FALSE if failed, TRUE if already present and unchanged or successful
266			*/
267
268			public function insert(\XoopsObject $obj, $force = false)
269			{
270			if (!($obj instanceof $this->className)) {
271			return false;
272			}
273
274			$uservars = $this->getUserVars();
275
276			foreach ($uservars as $var) {
277			unset($obj->vars[$var]);
278			}
279
280			if (0 == \count($obj->vars)) {
281			return true;
282			}
283
284			return parent::insert($obj, $force);
285			}
286
287			/**
288			* Get array of standard variable names (user table)
289			*
290			* @return array
291			*/
292
293			public function getUserVars()
294			{
295			return $this->_fHandler->getUserVars();
296			}
297
298			/**
299			* Search profiles and users
300			*
301			* @param \CriteriaElement $criteria CriteriaElement
302			* @param array $searchvars Fields to be fetched
303			* @param array $groups for Usergroups is selected (only admin!)
304			*
305			* @return array
306			*/
307
308			public function search(\CriteriaElement $criteria, $searchvars = [], $groups = null)
309			{
310			$uservars = $this->getUserVars();
311
312			$searchvars_user = \array_intersect($searchvars, $uservars);
313
314			$searchvars_profile = \array_diff($searchvars, $uservars);
315
316			$sv = ['u.uid, u.uname, u.email, u.user_viewemail'];
317
318			if (!empty($searchvars_user)) {
319			$sv[0] .= ',u.' . \implode(', u.', $searchvars_user);
320			}
321
322			if (!empty($searchvars_profile)) {
323			$sv[] = 'p.' . \implode(', p.', $searchvars_profile);
324			}
325
326			$sql_select = 'SELECT ' . (empty($searchvars) ? 'u., p.' : \implode(', ', $sv));
327
328			$sql_from = ' FROM ' . $this->db->prefix('users') . ' AS u LEFT JOIN ' . $this->table . ' AS p ON u.uid=p.profile_id' . (empty($groups) ? '' : ' LEFT JOIN ' . $this->db->prefix('groups_users_link') . ' AS g ON u.uid=g.uid');
329
330			$sql_clause = ' WHERE 1=1';
331
332			$sql_order = '';
333
334			$limit = $start = 0;
335
336			if (isset($criteria) && $criteria instanceof \CriteriaElement) {
337			$sql_clause .= ' AND ' . $criteria->render();
338
339			if ('' !== $criteria->getSort()) {
340			$sql_order = ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
341			}
342
343			$limit = $criteria->getLimit();
344
345			$start = $criteria->getStart();
346			}
347
348			if (!empty($groups)) {
349			$sql_clause .= ' AND g.groupid IN (' . \implode(', ', $groups) . ')';
350			}
351
352			$sql_users = $sql_select . $sql_from . $sql_clause . $sql_order;
353
354			$result = $this->db->query($sql_users, $limit, $start);
355
356			if (!$result) {
357			return [[], [], 0];
358			}
359
360			$userHandler = \xoops_getHandler('user');
361
362			$uservars = $this->getUserVars();
363
364			$users = [];
365
366			$profiles = [];
367
368			while (false !== ($myrow = $this->db->fetchArray($result))) {
369			$profile = $this->create(false);
370
371			$user = $userHandler->create(false);
			0 ignored issues – show Bug introduced 2020-04-29 02:31 UTC by Report Bug Copy Issue Report Show Similar Issues like this Are you sure the assignment to `$user` is correct as `$userHandler->create(false)` targeting `XoopsObjectHandler::create()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
372
373			foreach ($myrow as $name => $value) {
374			if (\in_array($name, $uservars)) {
375			$user->assignVar($name, $value);
376			} else {
377			$profile->assignVar($name, $value);
378			}
379			}
380
381			$profiles[$myrow['uid']] = $profile;
382
383			$users[$myrow['uid']] = $user;
384			}
385
386			$count = \count($users);
387
388			if ((!empty($limit) && $count >= $limit) \|\| !empty($start)) {
389			$sql_count = 'SELECT COUNT(*)' . $sql_from . $sql_clause;
390
391			$result = $this->db->query($sql_count);
392
393			[$count] = $this->db->fetchRow($result);
394			}
395
396			return [$users, $profiles, (int)$count];
397			}
398			}
399

XoopsModules25x / suico

Pull Request — master (#81)

class/ProfileHandler.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like