Class icms_member_groupperm_Handler

Group permission handler class.

This class is responsible for providing data access mechanisms to the data source of group permission class objects.

icms_member_groupperm_Handler

Package: Member\GroupPermission
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
See: icms_member_groupperm_Object
Located at member/groupperm/Handler.php

Methods summary
`public boolean &`	# `create( $isNew = true )` Create a new `icms_member_groupperm_Object` Create a new `icms_member_groupperm_Object` Returns boolean $isNew Flag the object as "new"?
`public object &`	# `get( integer $id )` Retrieve a group permission Retrieve a group permission Parameters `$id` ID Returns object `icms_member_groupperm_Object`, FALSE on fail
`public boolean`	# `insert( object & $perm )` Store a `icms_member_groupperm_Object` Store a `icms_member_groupperm_Object` Parameters `$perm` $perm `icms_member_groupperm_Object` object Returns boolean TRUE on success
`public boolean`	# `delete( object & $perm )` Delete a `icms_member_groupperm_Object` Delete a `icms_member_groupperm_Object` Parameters `$perm` $perm Returns boolean TRUE on success
`public array`	# `getObjects( object $criteria = null, boolean $id_as_key = false )` Retrieve multiple `icms_member_groupperm_Object`s Retrieve multiple `icms_member_groupperm_Object`s Parameters `$criteria` `icms_db_criteria_Element` `$id_as_key` Use IDs as array keys? Returns array Array of `icms_member_groupperm_Object`s
`public integer`	# `getCount( object $criteria = null )` Count some `icms_member_groupperm_Object`s Count some `icms_member_groupperm_Object`s Parameters `$criteria` `icms_db_criteria_Element` Returns integer
`public boolean`	# `deleteAll( object $criteria = null )` Delete all permissions by a certain criteria Delete all permissions by a certain criteria Parameters `$criteria` `icms_db_criteria_Element` 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, int/array $gperm_groupid, integer $gperm_modid = 1, boolean $webmasterAlwaysTrue = 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 `$webmasterAlwaysTrue` If true, then Webmasters will always return true, if false, a real check will be made 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, int/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 icms_core_ObjectHandler
`__construct()`

Properties summary
`public static`	`$_cachedRights`	#

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_member_groupperm_Handler

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns