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.

XoopsObjectHandler

XoopsGroupPermHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
See: XoopsGroupPerm
Located at ernel/groupperm.php

Methods summary
`public`	# `__construct( XoopsDatabase $db )` called from child classes only called from child classes only Parameters `$db` reference to the `XoopsDatabase` object Overrides `XoopsObjectHandler::__construct()`
`public boolean`	# `create( boolean $isNew = true )` Create a new `XoopsGroupPerm` Create a new `XoopsGroupPerm` Parameters `$isNew` Returns boolean $isNew Flag the object as "new"? Overrides `XoopsObjectHandler::create()`
`public XoopsGroupPerm`	# `get( integer $id )` Retrieve a group permission Retrieve a group permission Parameters `$id` ID Returns `XoopsGroupPerm` `XoopsGroupPerm`, FALSE on fail Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $perm )` Store a `XoopsGroupPerm` Store a `XoopsGroupPerm` Parameters `$perm` a XoopsGroupPerm object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $perm )` Delete a `XoopsGroupPerm` Delete a `XoopsGroupPerm` Parameters `$perm` a XoopsGroupPerm object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` Retrieve multiple `XoopsGroupPerm`s Retrieve multiple `XoopsGroupPerm`s Parameters `$criteria` `CriteriaElement` `$id_as_key` Use IDs as array keys? Returns array Array of `XoopsGroupPerm`s
`public integer`	# `getCount( CriteriaElement $criteria = null )` Count some `XoopsGroupPerm`s Count some `XoopsGroupPerm`s Parameters `$criteria` `CriteriaElement` Returns integer
`public boolean`	# `deleteAll( CriteriaElement $criteria = null )` Delete all permissions by a certain criteria Delete all permissions by a certain criteria Parameters `$criteria` `CriteriaElement` Returns boolean TRUE on success
`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 $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` $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 $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` $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 XoopsObjectHandler
`XoopsObjectHandler()`

Properties summary
`public string`	`$table` This should be here, since this really should be a XoopsPersistableObjectHandler Here, we fake it for future compatibility This should be here, since this really should be a XoopsPersistableObjectHandler Here, we fake it for future compatibility	#

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsGroupPermHandler

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns