ProfileProfileHandler::get() - Code Metrics - Inspection of "Bug in ProfileProfileHandler::get()" - XOOPS/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#169)

by Richard

created 2016-07-28 17:44 UTC

ProfileProfileHandler::get() A

↳ Parent: ProfileProfileHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	5
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	9
rs	9.6666

<?php
/**
 * 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]>
 */

// defined('XOOPS_ROOT_PATH') || exit("XOOPS root path not defined");

/**
 * @package             kernel
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 */
class ProfileProfile extends XoopsObject
{
    /**
     * @param $fields
     */
    public function __construct($fields)
    {
        $this->initVar('profile_id', XOBJ_DTYPE_INT, null, true);
        $this->init($fields);
    }

    /**
     * Initiate variables
     * @param array $fields field information array of {@link XoopsProfileField} objects
     */
    public function init($fields)
    {
        if (is_array($fields) && count($fields) > 0) {
            foreach (array_keys($fields) as $key) {
                $this->initVar($key, $fields[$key]->getVar('field_valuetype'), $fields[$key]->getVar('field_default', 'n'), $fields[$key]->getVar('field_required'), $fields[$key]->getVar('field_maxlength'));
            }
        }
    }
}

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

{
    /**
     * holds reference to {@link profileFieldHandler} object
     */
    public $_fHandler;

    /**
     * Array of {@link XoopsProfileField} objects
     * @var array
     */
    public $_fields = array();

    /**
     * @param null|XoopsDatabase $db
     */
    public function __construct(XoopsDatabase $db)
    {
        parent::__construct($db, 'profile_profile', 'profileprofile', 'profile_id');
        $this->_fHandler = xoops_getModuleHandler('field', 'profile');
    }

    /**
     * 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 === true) {
            $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 integer|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 ProfileField} object
     *
     * @param bool $isNew
     *
     * @return ProfileField
     */
    public function createField($isNew = true)
    {
        $return = $this->_fHandler->create($isNew);


        return $return;
    }

    /**
     * Load field information
     *
     * @return array
     */
    public function loadFields()
    {
        if (count($this->_fields) == 0) {
            $this->_fields = $this->_fHandler->loadFields();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        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);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Insert a field in the database
     *
     * @param ProfileField $field
     * @param bool         $force
     *
     * @return bool
     */
    public function insertField(ProfileField $field, $force = false)
    {
        return $this->_fHandler->insert($field, $force);

    }

    /**
     * Delete a field from the database
     *
     * @param ProfileField $field
     * @param bool         $force
     *
     * @return bool
     */
    public function deleteField(ProfileField $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
     *
     * @internal param int $categoryid ID of the category to add it to
     * @internal param int $type valuetype of the field
     * @internal param int $moduleid ID of the module, this field belongs to
     * @return string
     */
    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', array());
        }
        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|ProfileProfile $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 (count($obj->vars) == 0) {
            return true;
        }

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

    /**
     * Get array of standard variable names (user table)
     *
     * @return array
     */
    public function getUserVars()
    {
        return $this->_fHandler->getUserVars();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * 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 = array(), $groups = null)
    {
        $uservars = $this->getUserVars();

        $searchvars_user    = array_intersect($searchvars, $uservars);
        $searchvars_profile = array_diff($searchvars, $uservars);
        $sv                 = array('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) && is_subclass_of($criteria, '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 array(array(), array(), 0);
        }
        $user_handler = xoops_getHandler('user');
        $uservars     = $this->getUserVars();
        $users        = array();
        $profiles     = array();
        while ($myrow = $this->db->fetchArray($result)) {
            $profile = $this->create(false);
            $user    = $user_handler->create(false);

            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);
            list($count) = $this->db->fetchRow($result);
        }

        return array($users, $profiles, (int)$count);
    }
}


Pull Request — master (#169)

ProfileProfileHandler::get() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Extended User Profile
4			*
5			* You may not change or alter any portion of this comment or credits
6			* of supporting developers from this source code or any supporting source code
7			* which is considered copyrighted (c) material of the original comment or credit authors.
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*
12			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
13			* @license GNU GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
14			* @package profile
15			* @since 2.3.0
16			* @author Jan Pedersen
17			* @author Taiwen Jiang <[email protected]>
18			*/
19
20			// defined('XOOPS_ROOT_PATH') \|\| exit("XOOPS root path not defined");
21
22			/**
23			* @package kernel
24			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
25			*/
26			class ProfileProfile extends XoopsObject
27			{
28			/**
29			* @param $fields
30			*/
31			public function __construct($fields)
32			{
33			$this->initVar('profile_id', XOBJ_DTYPE_INT, null, true);
34			$this->init($fields);
35			}
36
37			/**
38			* Initiate variables
39			* @param array $fields field information array of {@link XoopsProfileField} objects
40			*/
41			public function init($fields)
42			{
43			if (is_array($fields) && count($fields) > 0) {
44			foreach (array_keys($fields) as $key) {
45			$this->initVar($key, $fields[$key]->getVar('field_valuetype'), $fields[$key]->getVar('field_default', 'n'), $fields[$key]->getVar('field_required'), $fields[$key]->getVar('field_maxlength'));
46			}
47			}
48			}
49			}
50
51			/**
52			* @package kernel
53			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
54			*/
55			class ProfileProfileHandler extends XoopsPersistableObjectHandler
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-07 05:16 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
56			{
57			/**
58			* holds reference to {@link profileFieldHandler} object
59			*/
60			public $_fHandler;
61
62			/**
63			* Array of {@link XoopsProfileField} objects
64			* @var array
65			*/
66			public $_fields = array();
67
68			/**
69			* @param null\|XoopsDatabase $db
70			*/
71			public function __construct(XoopsDatabase $db)
72			{
73			parent::__construct($db, 'profile_profile', 'profileprofile', 'profile_id');
74			$this->_fHandler = xoops_getModuleHandler('field', 'profile');
75			}
76
77			/**
78			* create a new {@link ProfileProfile}
79			*
80			* @param bool $isNew Flag the new objects as "new"?
81			*
82			* @return object {@link ProfileProfile}
83			*/
84			public function create($isNew = true)
85			{
86			$obj = new $this->className($this->loadFields());
87			$obj->handler = $this;
88			if ($isNew === true) {
89			$obj->setNew();
90			}
91
92			return $obj;
93			}
94
95			/**
96			* Get a ProfileProfile object for a user id.
97			*
98			* We will create an empty profile if none exists. This behavior allows user objects
99			* created outside of profile to be edited correctly in the profile module.
100			*
101			* @param integer\|null $uid
102			* @param string[]\|null $fields array of field names to fetch, null for all
103			*
104			* @return object {@link ProfileProfile}
105			*
106			* @internal This was get($uid, $createOnFailure = true). No callers found using the extra parameter.
107			* @internal Modified to match parent signature.
108			*/
109			public function get($uid = null, $fields = null)
110			{
111			$obj = parent::get($uid, $fields);
112			if (!is_object($obj)) {
113			$obj = $this->create();
114			}
115
116			return $obj;
117			}
118
119			/**
120			* Create new {@link ProfileField} object
121			*
122			* @param bool $isNew
123			*
124			* @return ProfileField
125			*/
126			public function createField($isNew = true)
127			{
128			$return = $this->_fHandler->create($isNew);
			0 ignored issues – show Unused Code introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report The call to `XoopsObjectHandler::create()` has too many arguments starting with `$isNew`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
129
130			return $return;
131			}
132
133			/**
134			* Load field information
135			*
136			* @return array
137			*/
138			public function loadFields()
139			{
140			if (count($this->_fields) == 0) {
141			$this->_fields = $this->_fHandler->loadFields();
			0 ignored issues – show Bug introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `XoopsObjectHandler` as the method `loadFields()` does only exist in the following sub-classes of `XoopsObjectHandler`: `ProfileFieldHandler`, `ProfileProfileHandler`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
142			}
143
144			return $this->_fields;
145			}
146
147			/**
148			* Fetch fields
149			*
150			* @param CriteriaElement $criteria {@link CriteriaElement} object
151			* @param bool $id_as_key return array with field IDs as key?
152			* @param bool $as_object return array of objects?
153			*
154			* @return array
155			**/
156			public function getFields(CriteriaElement $criteria, $id_as_key = true, $as_object = true)
157			{
158			return $this->_fHandler->getObjects($criteria, $id_as_key, $as_object);
			0 ignored issues – show Bug introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `XoopsObjectHandler` as the method `getObjects()` does only exist in the following sub-classes of `XoopsObjectHandler`: `ArtObjectHandler`, `PmMessageHandler`, `ProfileCategoryHandler`, `ProfileFieldHandler`, `ProfileProfileHandler`, `ProfileRegstepHandler`, `ProfileVisibilityHandler`, `SystemAvatarHandler`, `SystemBannerHandler`, `SystemBannerclientHandler`, `SystemBannerfinishHandler`, `SystemBlockHandler`, `SystemBlockLinkModuleHandler`, `SystemGroupHandler`, `SystemUsersHandler`, `XoopsAvatarHandler`, `XoopsBlockHandler`, `XoopsCacheModelHandler`, `XoopsCommentHandler`, `XoopsConfigCategoryHandler`, `XoopsConfigItemHandler`, `XoopsConfigOptionHandler`, `XoopsGroupHandler`, `XoopsGroupPermHandler`, `XoopsImageHandler`, `XoopsImagecategoryHandler`, `XoopsImagesetHandler`, `XoopsImagesetimgHandler`, `XoopsMembershipHandler`, `XoopsModuleHandler`, `XoopsNotificationHandler`, `XoopsPersistableObjectHandler`, `XoopsPrivmessageHandler`, `XoopsTplfileHandler`, `XoopsTplsetHandler`, `XoopsUserHandler`, `systemsmiliesHandler`, `systemuserrankHandler`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
159			}
160
161			/**
162			* Insert a field in the database
163			*
164			* @param ProfileField $field
165			* @param bool $force
166			*
167			* @return bool
168			*/
169			public function insertField(ProfileField $field, $force = false)
170			{
171			return $this->_fHandler->insert($field, $force);
			0 ignored issues – show Unused Code introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report The call to `XoopsObjectHandler::insert()` has too many arguments starting with `$force`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
172			}
173
174			/**
175			* Delete a field from the database
176			*
177			* @param ProfileField $field
178			* @param bool $force
179			*
180			* @return bool
181			*/
182			public function deleteField(ProfileField $field, $force = false)
183			{
184			return $this->_fHandler->delete($field, $force);
			0 ignored issues – show Unused Code introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report The call to `XoopsObjectHandler::delete()` has too many arguments starting with `$force`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
185			}
186
187			/**
188			* Save a new field in the database
189			*
190			* @param array $vars array of variables, taken from $module->loadInfo('profile')['field']
191			* @param int $weight
192			*
193			* @internal param int $categoryid ID of the category to add it to
194			* @internal param int $type valuetype of the field
195			* @internal param int $moduleid ID of the module, this field belongs to
196			* @return string
197			*/
198			public function saveField($vars, $weight = 0)
199			{
200			$field = $this->createField();
201			$field->setVar('field_name', $vars['name']);
202			$field->setVar('field_valuetype', $vars['valuetype']);
203			$field->setVar('field_type', $vars['type']);
204			$field->setVar('field_weight', $weight);
205			if (isset($vars['title'])) {
206			$field->setVar('field_title', $vars['title']);
207			}
208			if (isset($vars['description'])) {
209			$field->setVar('field_description', $vars['description']);
210			}
211			if (isset($vars['required'])) {
212			$field->setVar('field_required', $vars['required']); //0 = no, 1 = yes
213			}
214			if (isset($vars['maxlength'])) {
215			$field->setVar('field_maxlength', $vars['maxlength']);
216			}
217			if (isset($vars['default'])) {
218			$field->setVar('field_default', $vars['default']);
219			}
220			if (isset($vars['notnull'])) {
221			$field->setVar('field_notnull', $vars['notnull']);
222			}
223			if (isset($vars['show'])) {
224			$field->setVar('field_show', $vars['show']);
225			}
226			if (isset($vars['edit'])) {
227			$field->setVar('field_edit', $vars['edit']);
228			}
229			if (isset($vars['config'])) {
230			$field->setVar('field_config', $vars['config']);
231			}
232			if (isset($vars['options'])) {
233			$field->setVar('field_options', $vars['options']);
234			} else {
235			$field->setVar('field_options', array());
236			}
237			if ($this->insertField($field)) {
238			$msg = '  Field <strong>' . $vars['name'] . '</strong> added to the database';
239			} else {
240			$msg = '  <span class="red">ERROR: Could not insert field <strong>' . $vars['name'] . '</strong> into the database. ' . implode(' ', $field->getErrors()) . $this->db->error() . '</span>';
241			}
242			unset($field);
243
244			return $msg;
245			}
246
247			/**
248			* insert a new object in the database
249			*
250			* @param XoopsObject\|ProfileProfile $obj reference to the object
251			* @param bool $force whether to force the query execution despite security settings
252			*
253			* @return bool FALSE if failed, TRUE if already present and unchanged or successful
254			*/
255			public function insert(XoopsObject $obj, $force = false)
256			{
257			if (!($obj instanceof $this->className)) {
258			return false;
259			}
260			$uservars = $this->getUserVars();
261			foreach ($uservars as $var) {
262			unset($obj->vars[$var]);
263			}
264			if (count($obj->vars) == 0) {
265			return true;
266			}
267
268			return parent::insert($obj, $force);
269			}
270
271			/**
272			* Get array of standard variable names (user table)
273			*
274			* @return array
275			*/
276			public function getUserVars()
277			{
278			return $this->_fHandler->getUserVars();
			0 ignored issues – show Bug introduced 2016-07-01 15:10 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `XoopsObjectHandler` as the method `getUserVars()` does only exist in the following sub-classes of `XoopsObjectHandler`: `ProfileFieldHandler`, `ProfileProfileHandler`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
279			}
280
281			/**
282			* Search profiles and users
283			*
284			* @param CriteriaElement $criteria CriteriaElement
285			* @param array $searchvars Fields to be fetched
286			* @param array $groups for Usergroups is selected (only admin!)
287			*
288			* @return array
289			*/
290			public function search(CriteriaElement $criteria, $searchvars = array(), $groups = null)
291			{
292			$uservars = $this->getUserVars();
293
294			$searchvars_user = array_intersect($searchvars, $uservars);
295			$searchvars_profile = array_diff($searchvars, $uservars);
296			$sv = array('u.uid, u.uname, u.email, u.user_viewemail');
297			if (!empty($searchvars_user)) {
298			$sv[0] .= ',u.' . implode(', u.', $searchvars_user);
299			}
300			if (!empty($searchvars_profile)) {
301			$sv[] = 'p.' . implode(', p.', $searchvars_profile);
302			}
303
304			$sql_select = 'SELECT ' . (empty($searchvars) ? 'u., p.' : implode(', ', $sv));
305			$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');
306			$sql_clause = ' WHERE 1=1';
307			$sql_order = '';
308
309			$limit = $start = 0;
310			if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
311			$sql_clause .= ' AND ' . $criteria->render();
312			if ($criteria->getSort() !== '') {
313			$sql_order = ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
314			}
315			$limit = $criteria->getLimit();
316			$start = $criteria->getStart();
317			}
318
319			if (!empty($groups)) {
320			$sql_clause .= ' AND g.groupid IN (' . implode(', ', $groups) . ')';
321			}
322
323			$sql_users = $sql_select . $sql_from . $sql_clause . $sql_order;
324			$result = $this->db->query($sql_users, $limit, $start);
325
326			if (!$result) {
327			return array(array(), array(), 0);
328			}
329			$user_handler = xoops_getHandler('user');
330			$uservars = $this->getUserVars();
331			$users = array();
332			$profiles = array();
333			while ($myrow = $this->db->fetchArray($result)) {
334			$profile = $this->create(false);
335			$user = $user_handler->create(false);
336
337			foreach ($myrow as $name => $value) {
338			if (in_array($name, $uservars)) {
339			$user->assignVar($name, $value);
340			} else {
341			$profile->assignVar($name, $value);
342			}
343			}
344			$profiles[$myrow['uid']] = $profile;
345			$users[$myrow['uid']] = $user;
346			}
347
348			$count = count($users);
349			if ((!empty($limit) && $count >= $limit) \|\| !empty($start)) {
350			$sql_count = 'SELECT COUNT(*)' . $sql_from . $sql_clause;
351			$result = $this->db->query($sql_count);
352			list($count) = $this->db->fetchRow($result);
353			}
354
355			return array($users, $profiles, (int)$count);
356			}
357			}
358

XOOPS / XoopsCore25

Pull Request — master (#169)

ProfileProfileHandler::get() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like