XoopsGroupPermHandler Class Reference

List of all members.

Public Member Functions

create ($isNew=true)
get ($id)
 insert (&$perm)
 delete (&$perm)
getObjects ($criteria=null, $id_as_key=false)
 getCount ($criteria=null)
 deleteAll ($criteria=null)
 deleteByGroup ($gperm_groupid, $gperm_modid=null)
 deleteByModule ($gperm_modid, $gperm_name=null, $gperm_itemid=null)
 deleteBasicPermission ($gperm_groupid)
 checkRight ($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid=1)
 addRight ($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid=1)
 removeRight ($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid=1)
 getItemIds ($gperm_name, $gperm_groupid, $gperm_modid=1)
 getGroupIds ($gperm_name, $gperm_itemid, $gperm_modid=1)

Detailed Description

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.

See also:
XoopsGroupPerm
Author:
Kazumi Ono <onokazu@xoops.org> copyright (c) 2000-2003 XOOPS.org


Member Function Documentation

& XoopsGroupPermHandler::create ( isNew = true  ) 

Create a new XoopsGroupPerm

Returns:
bool $isNew Flag the object as "new"?

& XoopsGroupPermHandler::get ( id  ) 

Retrieve a group permission

Parameters:
int $id ID
Returns:
object XoopsGroupPerm, FALSE on fail

XoopsGroupPermHandler::insert ( &$  perm  ) 

Store a XoopsGroupPerm

Parameters:
object &$perm XoopsGroupPerm object
Returns:
bool TRUE on success

XoopsGroupPermHandler::delete ( &$  perm  ) 

Delete a XoopsGroupPerm

Parameters:
object &$perm
Returns:
bool TRUE on success

& XoopsGroupPermHandler::getObjects ( criteria = null,
id_as_key = false 
)

Retrieve multiple XoopsGroupPerms

Parameters:
object $criteria CriteriaElement
bool $id_as_key Use IDs as array keys?
Returns:
array Array of XoopsGroupPerms

XoopsGroupPermHandler::getCount ( criteria = null  ) 

Count some XoopsGroupPerms

Parameters:
object $criteria CriteriaElement
Returns:
int

XoopsGroupPermHandler::deleteAll ( criteria = null  ) 

Delete all permissions by a certain criteria

Parameters:
object $criteria CriteriaElement
Returns:
bool TRUE on success

XoopsGroupPermHandler::deleteByGroup ( gperm_groupid,
gperm_modid = null 
)

Delete all module specific permissions assigned for a group

Parameters:
int $gperm_groupid ID of a group
int $gperm_modid ID of a module
Returns:
bool TRUE on success

XoopsGroupPermHandler::deleteByModule ( gperm_modid,
gperm_name = null,
gperm_itemid = null 
)

Delete all module specific permissions

Parameters:
int $gperm_modid ID of a module
string $gperm_name Name of a module permission
int $gperm_itemid ID of a module item
Returns:
bool TRUE on success

XoopsGroupPermHandler::deleteBasicPermission ( gperm_groupid  ) 

Delete

XoopsGroupPermHandler::checkRight ( gperm_name,
gperm_itemid,
gperm_groupid,
gperm_modid = 1 
)

Check permission

Parameters:
string $gperm_name Name of permission
int $gperm_itemid ID of an item
int/array $gperm_groupid A group ID or an array of group IDs
int $gperm_modid ID of a module
Returns:
bool TRUE if permission is enabled

XoopsGroupPermHandler::addRight ( gperm_name,
gperm_itemid,
gperm_groupid,
gperm_modid = 1 
)

Add a permission

Parameters:
string $gperm_name Name of permission
int $gperm_itemid ID of an item
int $gperm_groupid ID of a group
int $gperm_modid ID of a module
Returns:
bool TRUE jf success

XoopsGroupPermHandler::removeRight ( gperm_name,
gperm_itemid,
gperm_groupid,
gperm_modid = 1 
)

Remove a permission

Parameters:
string $gperm_name Name of permission
int $gperm_itemid ID of an item
int $gperm_groupid ID of a group
int $gperm_modid ID of a module
Returns:
bool TRUE jf success

XoopsGroupPermHandler::getItemIds ( gperm_name,
gperm_groupid,
gperm_modid = 1 
)

Get all item IDs that a group is assigned a specific permission

Parameters:
string $gperm_name Name of permission
int/array $gperm_groupid A group ID or an array of group IDs
int $gperm_modid ID of a module
Returns:
array array of item IDs

XoopsGroupPermHandler::getGroupIds ( gperm_name,
gperm_itemid,
gperm_modid = 1 
)

Get all group IDs assigned a specific permission for a particular item

Parameters:
string $gperm_name Name of permission
int $gperm_itemid ID of an item
int $gperm_modid ID of a module
Returns:
array array of group IDs


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:25 2006 for XOOPS Cube Legacy by  doxygen 1.5.1