Class XoopsGroupPermHandler

XOOPS group permission handler class.

This class is responsible for providing data access mechanisms to the data source of XOOPS group permission class objects. This class is an abstract class to be implemented by child group permission classes.

Xoops\Core\Kernel\XoopsObjectHandler

Xoops\Core\Kernel\XoopsPersistableObjectHandler

Xoops\Core\Kernel\Handlers\XoopsGroupPermHandler

Direct known subclasses

PageGroupPermHandler, PublisherGroupPermHandler, XoopsGroupPermHandler

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsGroupPermHandler
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsGroupPermHandler.php

Methods summary
`public`	# `__construct( Xoops\Core\Database\Connection $db = null )` Constructor Constructor Parameters `$db` database Overrides `Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()`
`public boolean`	# `deleteByGroup( integer $gperm_groupid, integer $gperm_modid = null )` Delete all module specific permissions assigned for a group Delete all module specific permissions assigned for a group Parameters `$gperm_groupid` ID of a group `$gperm_modid` ID of a module Returns boolean TRUE on success
`public boolean`	# `deleteByModule( integer $gperm_modid, string $gperm_name = null, integer $gperm_itemid = null )` Delete all module specific permissions Delete all module specific permissions Parameters `$gperm_modid` ID of a module `$gperm_name` Name of a module permission `$gperm_itemid` ID of a module item Returns boolean TRUE on success
`public boolean`	# `checkRight( string $gperm_name, integer $gperm_itemid, integer\|array $gperm_groupid, integer $gperm_modid = 1, boolean $trueifadmin = true )` Check permission Check permission Parameters `$gperm_name` Name of permission `$gperm_itemid` ID of an item `$gperm_groupid` A group ID or an array of group IDs `$gperm_modid` ID of a module `$trueifadmin` Returns true for admin groups Returns boolean TRUE if permission is enabled
`public boolean`	# `addRight( string $gperm_name, integer $gperm_itemid, integer $gperm_groupid, integer $gperm_modid = 1 )` Add a permission Add a permission Parameters `$gperm_name` Name of permission `$gperm_itemid` ID of an item `$gperm_groupid` ID of a group `$gperm_modid` ID of a module Returns boolean TRUE if success
`public array`	# `getItemIds( string $gperm_name, integer\|array $gperm_groupid, integer $gperm_modid = 1 )` Get all item IDs that a group is assigned a specific permission Get all item IDs that a group is assigned a specific permission Parameters `$gperm_name` Name of permission `$gperm_groupid` A group ID or an array of group IDs `$gperm_modid` ID of a module Returns array array of item IDs
`public array`	# `getGroupIds( string $gperm_name, integer $gperm_itemid, integer $gperm_modid = 1 )` Get all group IDs assigned a specific permission for a particular item Get all group IDs assigned a specific permission for a particular item Parameters `$gperm_name` Name of permission `$gperm_itemid` ID of an item `$gperm_modid` ID of a module Returns array array of group IDs

Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()`

Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link`

Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
`$db2`

Namespaces

Classes

Class XoopsGroupPermHandler

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns