XoopsGroupPermHandler Class Reference

Inheritance diagram for XoopsGroupPermHandler:

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, $bypass_admincheck=false)
	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)
&	getCriteria ($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid=1)
Public Member Functions inherited from XoopsObjectHandler
	__construct (&$db)
&	create ()

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

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 onoka.nosp@m.zu@x.nosp@m.oops..nosp@m.org

Copyright

copyright (c) 2000-2003 XOOPS.org

Definition at line 108 of file groupperm.php.

Member Function Documentation

addRight()

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 if success

Definition at line 385 of file groupperm.php.

checkRight()

checkRight	(		$gperm_name,
			$gperm_itemid,
			$gperm_groupid,
			$gperm_modid = 1,
			$bypass_admincheck = false )

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
bool	$bypass_admincheck	Do not XOOPS_GROUP_ADMIN check if true.

Returns

bool TRUE if permission is enabled

Definition at line 357 of file groupperm.php.

create()

& create

(

$isNew = true

)

Create a new XoopsGroupPerm

Parameters

bool

$isNew

Returns

\XoopsGroupPerm $isNew Flag the object as "new"?

Definition at line 117 of file groupperm.php.

delete()

delete

(

&

$perm

)

Delete a XoopsGroupPerm

Parameters

object

&$perm

Returns

bool TRUE on success

Reimplemented from XoopsObjectHandler.

Definition at line 202 of file groupperm.php.

deleteAll()

deleteAll

(

$criteria = null

)

Delete all permissions by a certain criteria

Parameters

object

$criteria

CriteriaElement

Returns

bool TRUE on success

Definition at line 279 of file groupperm.php.

deleteBasicPermission()

deleteBasicPermission

(

$gperm_groupid

)

#- Delete

Parameters

$gperm_groupid

Definition at line 334 of file groupperm.php.

deleteByGroup()

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

Definition at line 299 of file groupperm.php.

deleteByModule()

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

Definition at line 317 of file groupperm.php.

get()

& get

(

$id

)

Retrieve a group permission

Parameters

int

$id

ID

Returns

object XoopsGroupPerm, FALSE on fail

Reimplemented from XoopsObjectHandler.

Definition at line 133 of file groupperm.php.

getCount()

getCount

(

$criteria = null

)

Count some XoopsGroupPerms

Parameters

object

$criteria

CriteriaElement

Returns

int

Definition at line 257 of file groupperm.php.

getCriteria()

& getCriteria	(		$gperm_name,
			$gperm_itemid,
			$gperm_groupid,
			$gperm_modid = 1 )

Generate a criteria from given params

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

\CriteriaCompo

Definition at line 475 of file groupperm.php.

getGroupIds()

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

Definition at line 452 of file groupperm.php.

getItemIds()

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

Definition at line 430 of file groupperm.php.

getObjects()

& 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

Definition at line 222 of file groupperm.php.

insert()

insert

(

&

$perm

)

Store a XoopsGroupPerm

Parameters

object

&$perm

XoopsGroupPerm object

Returns

bool TRUE on success

Reimplemented from XoopsObjectHandler.

Definition at line 158 of file groupperm.php.

removeRight()

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

Definition at line 415 of file groupperm.php.

---

The documentation for this class was generated from the following file:

• html/kernel/groupperm.php