Permission::getItemIds() - Code Metrics - Inspection of "Merge pull request #1227 from geekwright/xmf-1-2-2..." - XOOPS/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4eb2ef...afb161 )

by Richard

created 2022-04-17 02:48 UTC

Permission::getItemIds() A

↳ Parent: Permission

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	2
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?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 Xmf\Module\Helper;

use Xmf\Module\Helper;

/**
 * Methods to help manage permissions within a module
 *
 * @category  Xmf\Module\Helper\Permission
 * @package   Xmf
 * @author    trabis <[email protected]>
 * @author    Richard Griffith <[email protected]>
 * @copyright 2011-2018 XOOPS Project (https://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      https://xoops.org
 */
class Permission extends AbstractHelper
{
    /**
     * @var int
     */
    protected $mid;

    /**
     * @var string
     */
    protected $dirname;

    /**
     * @var \XoopsGrouppermHandler
     */
    protected $permissionHandler;

    /**
     * Initialize parent::__construct calls this after verifying module object.
     *
     * @return void
     */
    public function init()
    {
        $this->mid = $this->module->getVar('mid');
        $this->dirname = $this->module->getVar('dirname');
        /* @var $this->permissionHandler XoopsGroupPermHandler */
        $this->permissionHandler = xoops_getHandler('groupperm');

    }

    /**
     * Check if the user has permission for an item
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     * @param bool   $trueifadmin  true to always return true for admin groups
     *
     * @return bool   true if user has access, false if not
     **/
    public function checkPermission($gperm_name, $gperm_itemid, $trueifadmin = true)
    {
        $gperm_itemid = (int) $gperm_itemid;
        $gperm_groupid = $this->getUserGroups();

        return $this->permissionHandler->checkRight(
            $gperm_name,
            $gperm_itemid,
            $gperm_groupid,
            $this->mid,
            (bool) $trueifadmin
        );
    }

    /**
     * Get all item IDs for which a group (or set of groups) has a specific permission
     * Return an array of items for which the specified groups have the named permission
     *
     * @param string $gperm_name  Name of permission
     * @param int|array $gperm_groupid A group ID or an array of group IDs
     *
     * @return array array of item IDs
     */
    public function getItemIds($gperm_name, $gperm_groupid)
    {
        return $this->permissionHandler->getItemIds(
            $gperm_name,
            $gperm_groupid,
            $this->mid
        );
    }

    /**
     * Redirect to a url if user does not have permission for an item
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     * @param string $url          module relative url to redirect to
     * @param int    $time         time in seconds to delay
     * @param string $message      message to display with redirect
     * @param bool   $trueifadmin  true to always return true for admin groups
     *
     * @return void
     **/
    public function checkPermissionRedirect(
        $gperm_name,
        $gperm_itemid,
        $url,
        $time = 3,
        $message = '',
        $trueifadmin = true
    ) {
        $gperm_itemid = (int) $gperm_itemid;
        $gperm_groupid = $this->getUserGroups();
        $permission = $this->permissionHandler->checkRight(
            $gperm_name,
            $gperm_itemid,
            $gperm_groupid,
            $this->mid,
            (bool) $trueifadmin
        );
        if (!$permission) {
            $helper = Helper::getHelper($this->dirname);
            $helper->redirect($url, $time, $message);
        }
    }

    /**
     * Get array of groups with named permission to an item
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     *
     * @return array  groups with permission for item
     **/
    public function getGroupsForItem($gperm_name, $gperm_itemid)
    {
        $gperm_itemid = (int) $gperm_itemid;
        return $this->permissionHandler->getGroupIds($gperm_name, $gperm_itemid, $this->mid);
    }

    /**
     * Save group permissions for an item
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     * @param array  $groups       group ids to grant permission to
     *
     * @return bool   true if no errors
     **/
    public function savePermissionForItem($gperm_name, $gperm_itemid, $groups)
    {
        $gperm_itemid = (int) $gperm_itemid;
        foreach ($groups as $index => $group) {
            $groups[$index] = (int) $group;
        }

        $result = true;

        // First, delete any existing permissions for this name and id
        $this->deletePermissionForItem($gperm_name, $gperm_itemid);

        // Save the new permissions
        if (count($groups) > 0) {
            foreach ($groups as $group_id) {
                $this->permissionHandler->addRight(
                    $gperm_name,
                    $gperm_itemid,
                    $group_id,
                    $this->mid
                );
            }
        }

        return $result;
    }

    /**
     * Delete all permissions for an item and a specific name or array of names
     *
     * @param string|string[] $gperm_name   name(s) of the permission to delete
     * @param int             $gperm_itemid id of the object to check
     *
     * @return bool   true if no errors
     */
    public function deletePermissionForItem($gperm_name, $gperm_itemid)
    {
        $gperm_itemid = (int) $gperm_itemid;
        if (!is_array($gperm_name)) {
            $gperm_name = (array) $gperm_name;
        }
        $return = true;
        foreach ($gperm_name as $pname) {
            $return = $return && $this->permissionHandler->deleteByModule($this->mid, $pname, $gperm_itemid);
        }
        return $return;
    }

    /**
     * Generate a XoopsFormElement to select groups to grant permission
     * to a specific gperm_name and gperm_item. Field will be preset
     * with existing permissions.
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     * @param string $caption      caption for form field
     * @param string $name         name/id of form field
     * @param bool   $include_anon true to include anonymous group
     * @param int    $size         size of list
     * @param bool   $multiple     true to allow multiple selections
     *
     * @return object XoopsFormSelectGroup
     */
    public function getGroupSelectFormForItem(
        $gperm_name,
        $gperm_itemid,
        $caption,
        $name = null,
        $include_anon = false,
        $size = 5,
        $multiple = true
    ) {
        if (!class_exists('XoopsFormSelectGroup', true)) {
            include_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
        }
        if (empty($name)) {
            $name = $this->defaultFieldName($gperm_name, $gperm_itemid);
        }
        $gperm_itemid = (int) $gperm_itemid;
        $value = $this->getGroupsForItem($gperm_name, $gperm_itemid);
        $element = new \XoopsFormSelectGroup(
            $caption,
            $name,
            $include_anon,
            $value,
            $size,
            $multiple
        );

        return $element;
    }

    /**
     * Generate a default name for a XoopsFormElement based on
     * module, gperm_name and gperm_itemid
     *
     * @param string $gperm_name   name of the permission to test
     * @param int    $gperm_itemid id of the object to check
     *
     * @return string
     */
    public function defaultFieldName($gperm_name, $gperm_itemid)
    {
        $gperm_itemid = (int) $gperm_itemid;
        $name = $this->module->getVar('dirname') . '_' .
            $gperm_name . '_' . $gperm_itemid;

        return $name;
    }

    /**
     * Get any groups associated with the current user
     *
     * @return int|int[] group id(s)
     */
    protected function getUserGroups()
    {
        global $xoopsUser;

        $groups = $xoopsUser ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;

        return $groups;

    }
}


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 Xmf\Module\Helper;
13
14			use Xmf\Module\Helper;
15
16			/**
17			* Methods to help manage permissions within a module
18			*
19			* @category Xmf\Module\Helper\Permission
20			* @package Xmf
21			* @author trabis <[email protected]>
22			* @author Richard Griffith <[email protected]>
23			* @copyright 2011-2018 XOOPS Project (https://xoops.org)
24			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
25			* @link https://xoops.org
26			*/
27			class Permission extends AbstractHelper
28			{
29			/**
30			* @var int
31			*/
32			protected $mid;
33
34			/**
35			* @var string
36			*/
37			protected $dirname;
38
39			/**
40			* @var \XoopsGrouppermHandler
41			*/
42			protected $permissionHandler;
43
44			/**
45			* Initialize parent::__construct calls this after verifying module object.
46			*
47			* @return void
48			*/
49			public function init()
50			{
51			$this->mid = $this->module->getVar('mid');
52			$this->dirname = $this->module->getVar('dirname');
53			/* @var $this->permissionHandler XoopsGroupPermHandler */
54			$this->permissionHandler = xoops_getHandler('groupperm');
			0 ignored issues – show Documentation Bug introduced 2018-06-11 05:57 UTC by Report Bug Copy Issue Report It seems like `xoops_getHandler('groupperm')` of type `false` is incompatible with the declared type `XoopsGrouppermHandler` of property `$permissionHandler`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
55			}
56
57			/**
58			* Check if the user has permission for an item
59			*
60			* @param string $gperm_name name of the permission to test
61			* @param int $gperm_itemid id of the object to check
62			* @param bool $trueifadmin true to always return true for admin groups
63			*
64			* @return bool true if user has access, false if not
65			**/
66			public function checkPermission($gperm_name, $gperm_itemid, $trueifadmin = true)
67			{
68			$gperm_itemid = (int) $gperm_itemid;
69			$gperm_groupid = $this->getUserGroups();
70
71			return $this->permissionHandler->checkRight(
72			$gperm_name,
73			$gperm_itemid,
74			$gperm_groupid,
75			$this->mid,
76			(bool) $trueifadmin
77			);
78			}
79
80			/**
81			* Get all item IDs for which a group (or set of groups) has a specific permission
82			* Return an array of items for which the specified groups have the named permission
83			*
84			* @param string $gperm_name Name of permission
85			* @param int\|array $gperm_groupid A group ID or an array of group IDs
86			*
87			* @return array array of item IDs
88			*/
89			public function getItemIds($gperm_name, $gperm_groupid)
90			{
91			return $this->permissionHandler->getItemIds(
92			$gperm_name,
93			$gperm_groupid,
94			$this->mid
95			);
96			}
97
98			/**
99			* Redirect to a url if user does not have permission for an item
100			*
101			* @param string $gperm_name name of the permission to test
102			* @param int $gperm_itemid id of the object to check
103			* @param string $url module relative url to redirect to
104			* @param int $time time in seconds to delay
105			* @param string $message message to display with redirect
106			* @param bool $trueifadmin true to always return true for admin groups
107			*
108			* @return void
109			**/
110			public function checkPermissionRedirect(
111			$gperm_name,
112			$gperm_itemid,
113			$url,
114			$time = 3,
115			$message = '',
116			$trueifadmin = true
117			) {
118			$gperm_itemid = (int) $gperm_itemid;
119			$gperm_groupid = $this->getUserGroups();
120			$permission = $this->permissionHandler->checkRight(
121			$gperm_name,
122			$gperm_itemid,
123			$gperm_groupid,
124			$this->mid,
125			(bool) $trueifadmin
126			);
127			if (!$permission) {
128			$helper = Helper::getHelper($this->dirname);
129			$helper->redirect($url, $time, $message);
130			}
131			}
132
133			/**
134			* Get array of groups with named permission to an item
135			*
136			* @param string $gperm_name name of the permission to test
137			* @param int $gperm_itemid id of the object to check
138			*
139			* @return array groups with permission for item
140			**/
141			public function getGroupsForItem($gperm_name, $gperm_itemid)
142			{
143			$gperm_itemid = (int) $gperm_itemid;
144			return $this->permissionHandler->getGroupIds($gperm_name, $gperm_itemid, $this->mid);
145			}
146
147			/**
148			* Save group permissions for an item
149			*
150			* @param string $gperm_name name of the permission to test
151			* @param int $gperm_itemid id of the object to check
152			* @param array $groups group ids to grant permission to
153			*
154			* @return bool true if no errors
155			**/
156			public function savePermissionForItem($gperm_name, $gperm_itemid, $groups)
157			{
158			$gperm_itemid = (int) $gperm_itemid;
159			foreach ($groups as $index => $group) {
160			$groups[$index] = (int) $group;
161			}
162
163			$result = true;
164
165			// First, delete any existing permissions for this name and id
166			$this->deletePermissionForItem($gperm_name, $gperm_itemid);
167
168			// Save the new permissions
169			if (count($groups) > 0) {
170			foreach ($groups as $group_id) {
171			$this->permissionHandler->addRight(
172			$gperm_name,
173			$gperm_itemid,
174			$group_id,
175			$this->mid
176			);
177			}
178			}
179
180			return $result;
181			}
182
183			/**
184			* Delete all permissions for an item and a specific name or array of names
185			*
186			* @param string\|string[] $gperm_name name(s) of the permission to delete
187			* @param int $gperm_itemid id of the object to check
188			*
189			* @return bool true if no errors
190			*/
191			public function deletePermissionForItem($gperm_name, $gperm_itemid)
192			{
193			$gperm_itemid = (int) $gperm_itemid;
194			if (!is_array($gperm_name)) {
195			$gperm_name = (array) $gperm_name;
196			}
197			$return = true;
198			foreach ($gperm_name as $pname) {
199			$return = $return && $this->permissionHandler->deleteByModule($this->mid, $pname, $gperm_itemid);
200			}
201			return $return;
202			}
203
204			/**
205			* Generate a XoopsFormElement to select groups to grant permission
206			* to a specific gperm_name and gperm_item. Field will be preset
207			* with existing permissions.
208			*
209			* @param string $gperm_name name of the permission to test
210			* @param int $gperm_itemid id of the object to check
211			* @param string $caption caption for form field
212			* @param string $name name/id of form field
213			* @param bool $include_anon true to include anonymous group
214			* @param int $size size of list
215			* @param bool $multiple true to allow multiple selections
216			*
217			* @return object XoopsFormSelectGroup
218			*/
219			public function getGroupSelectFormForItem(
220			$gperm_name,
221			$gperm_itemid,
222			$caption,
223			$name = null,
224			$include_anon = false,
225			$size = 5,
226			$multiple = true
227			) {
228			if (!class_exists('XoopsFormSelectGroup', true)) {
229			include_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
230			}
231			if (empty($name)) {
232			$name = $this->defaultFieldName($gperm_name, $gperm_itemid);
233			}
234			$gperm_itemid = (int) $gperm_itemid;
235			$value = $this->getGroupsForItem($gperm_name, $gperm_itemid);
236			$element = new \XoopsFormSelectGroup(
237			$caption,
238			$name,
239			$include_anon,
240			$value,
241			$size,
242			$multiple
243			);
244
245			return $element;
246			}
247
248			/**
249			* Generate a default name for a XoopsFormElement based on
250			* module, gperm_name and gperm_itemid
251			*
252			* @param string $gperm_name name of the permission to test
253			* @param int $gperm_itemid id of the object to check
254			*
255			* @return string
256			*/
257			public function defaultFieldName($gperm_name, $gperm_itemid)
258			{
259			$gperm_itemid = (int) $gperm_itemid;
260			$name = $this->module->getVar('dirname') . '_' .
261			$gperm_name . '_' . $gperm_itemid;
262
263			return $name;
264			}
265
266			/**
267			* Get any groups associated with the current user
268			*
269			* @return int\|int[] group id(s)
270			*/
271			protected function getUserGroups()
272			{
273			global $xoopsUser;
274
275			$groups = $xoopsUser ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
276
277			return $groups;
			0 ignored issues – show Bug Best Practice introduced 2018-10-28 05:59 UTC by Report Bug Copy Issue Report The expression `return $groups` also could return the type `string` which is incompatible with the documented return type `integer\|integer[]`. Loading history...
278			}
279			}
280

XOOPS / XoopsCore25

Push — master ( 4eb2ef...afb161 )

Permission::getItemIds() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like