Class Permission

Methods to help manage permissions within a module

Xmf\Module\Helper\Permission

Namespace: Xmf\Module\Helper
Package: Xmf
Category: Xmf\Module\Helper\Permission
Copyright: 2011-2016 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at lass/libraries/vendor/xoops/xmf/src/Xmf/Module/Helper/Permission.php

Methods summary
`public`	# `init( )` Initialize parent::__construct calls this after verifying module object. Initialize parent::__construct calls this after verifying module object.
`public boolean`	# `checkPermission( string $gperm_name, integer $gperm_itemid, boolean $trueifadmin = true )` Check if the user has permission for an item Check if the user has permission for an item Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check `$trueifadmin` true to always return true for admin groups Returns boolean true if user has access, false if not
`public`	# `checkPermissionRedirect( string $gperm_name, integer $gperm_itemid, string $url, integer $time = 3, string $message = '', boolean $trueifadmin = true )` Redirect to a url if user does not have permission for an item Redirect to a url if user does not have permission for an item Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check `$url` module relative url to redirect to `$time` time in seconds to delay `$message` message to display with redirect `$trueifadmin` true to always return true for admin groups
`public array`	# `getGroupsForItem( string $gperm_name, integer $gperm_itemid )` Get array of groups with named permission to an item Get array of groups with named permission to an item Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check Returns array groups with permission for item
`public boolean`	# `savePermissionForItem( string $gperm_name, integer $gperm_itemid, array $groups )` Save group permissions for an item Save group permissions for an item Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check `$groups` group ids to grant permission to Returns boolean true if no errors
`public boolean`	# `deletePermissionForItem( string\|string[] $gperm_name, integer $gperm_itemid )` Delete all permissions for an item and a specific name or array of names Delete all permissions for an item and a specific name or array of names Parameters `$gperm_name` name(s) of the permission to delete `$gperm_itemid` id of the object to check Returns boolean true if no errors
`public object`	# `getGroupSelectFormForItem( string $gperm_name, integer $gperm_itemid, string $caption, string $name = null, boolean $include_anon = false, integer $size = 5, boolean $multiple = true )` Generate a XoopsFormElement to select groups to grant permission to a specific gperm_name and gperm_item. Field will be preset with existing permissions. Generate a XoopsFormElement to select groups to grant permission to a specific gperm_name and gperm_item. Field will be preset with existing permissions. Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check `$caption` caption for form field `$name` name/id of form field `$include_anon` true to include anonymous group `$size` size of list `$multiple` true to allow multiple selections Returns object XoopsFormSelectGroup
`public string`	# `defaultFieldName( string $gperm_name, integer $gperm_itemid )` Generate a default name for a XoopsFormElement based on module, gperm_name and gperm_itemid Generate a default name for a XoopsFormElement based on module, gperm_name and gperm_itemid Parameters `$gperm_name` name of the permission to test `$gperm_itemid` id of the object to check Returns string
`protected integer\|int[]`	# `getUserGroups( )` Get any groups associated with the current user Get any groups associated with the current user Returns integer\|int[] group id(s)

Methods inherited from Xmf\Module\Helper\AbstractHelper
`__construct(), addLog(), setDebug()`

Properties summary
`protected integer`	`$mid`	#
`protected string`	`$dirname`	#
`protected XoopsGrouppermHandler`	`$permissionHandler`	#

Properties inherited from Xmf\Module\Helper\AbstractHelper
`$debug, $module`

Namespaces

Classes

Class Permission

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns