Docs For Class XoopsGroupPermHandler

Class: XoopsGroupPermHandler

Class Details

[line 85]
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.

Tags:

author:	Kazumi Ono <onokazu@xoops.org>
copyright:	copyright (c) 2000-2003 XOOPS.org
see:	XoopsGroupPerm

Class Methods

method addRight [line 344]

bool addRight(
string
$gperm_name, int
$gperm_itemid, int
$gperm_groupid, [int
$gperm_modid = 1])

Add a permission

Tags:

return:

TRUE jf success

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

[ Top ]

method checkRight [line 305]

bool checkRight(
string
$gperm_name, int
$gperm_itemid, int/array
$gperm_groupid, [int
$gperm_modid = 1])

Check permission

Tags:

return:

TRUE if permission is enabled

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

[ Top ]

method create [line 93]

bool &create(
[
$isNew = true])

Create a new XoopsGroupPerm

Tags:

return:

Flag the object as "new"?

Overrides XoopsObjectHandler::create() (creates a new object)

Parameters:

$isNew

[ Top ]

method delete [line 170]

bool delete(
object
&$perm)

Delete a XoopsGroupPerm

Tags:

return:

TRUE on success

Overrides XoopsObjectHandler::delete() (delete obejct from database)

Parameters:

object

&$perm

[ Top ]

method deleteAll [line 245]

bool deleteAll(
[object
$criteria = null])

Delete all permissions by a certain criteria

Tags:

return:

TRUE on success

Parameters:

object

$criteria

CriteriaElement

[ Top ]

method deleteByGroup [line 264]

bool deleteByGroup(
int
$gperm_groupid, [int
$gperm_modid = null])

Delete all module specific permissions assigned for a group

Tags:

return:

TRUE on success

Parameters:

int	$gperm_groupid	ID of a group
int	$gperm_modid	ID of a module

[ Top ]

method deleteByModule [line 282]

bool deleteByModule(
int
$gperm_modid, [string
$gperm_name = null], [int
$gperm_itemid = null])

Delete all module specific permissions

Tags:

return:

TRUE on success

Parameters:

int	$gperm_modid	ID of a module
string	$gperm_name	Name of a module permission
int	$gperm_itemid	ID of a module item

[ Top ]

method get [line 109]

object {@link &get(
int
$id)

Retrieve a group permission

Tags:

return:

XoopsGroupPerm}, FALSE on fail

Overrides XoopsObjectHandler::get() (gets a value object)

Parameters:

int

$id

[ Top ]

method getCount [line 224]

int getCount(
[object
$criteria = null])

Count some XoopsGroupPerms

Parameters:

object

$criteria

CriteriaElement

[ Top ]

method getGroupIds [line 393]

array getGroupIds(
string
$gperm_name, int
$gperm_itemid, [int
$gperm_modid = 1])

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

Tags:

return:

array of group IDs

Parameters:

string	$gperm_name	Name of permission
int	$gperm_itemid	ID of an item
int	$gperm_modid	ID of a module

[ Top ]

method getItemIds [line 363]

array getItemIds(
string
$gperm_name, int/array
$gperm_groupid, [int
$gperm_modid = 1])

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

Tags:

return:

array of item IDs

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

[ Top ]

method getObjects [line 190]

array getObjects(
[object
$criteria = null], [bool
$id_as_key = false])

Retrieve multiple XoopsGroupPerms

Tags:

return:

Array of XoopsGroupPerms

Parameters:

object	$criteria	CriteriaElement
bool	$id_as_key	Use IDs as array keys?

[ Top ]

method insert [line 133]

bool insert(
object
&$perm)

Store a XoopsGroupPerm

Tags:

return:

TRUE on success

Overrides XoopsObjectHandler::insert() (insert/update object)

Parameters:

object

&$perm

XoopsGroupPerm object

[ Top ]

Class: XoopsGroupPermHandler

Class Overview

Author(s):

Copyright:

Methods

Inherited Variables

Class: XoopsObjectHandler

Inherited Methods

Class: XoopsObjectHandler

Class Details

Tags:

Class Methods

method addRight [line 344]

Tags:

Parameters:

method checkRight [line 305]

Tags:

Parameters:

method create [line 93]

Tags:

Parameters:

method delete [line 170]

Tags:

Parameters:

method deleteAll [line 245]

Tags:

Parameters:

method deleteByGroup [line 264]

Tags:

Parameters:

method deleteByModule [line 282]

Tags:

Parameters:

method get [line 109]

Tags:

Parameters:

method getCount [line 224]

Parameters:

method getGroupIds [line 393]

Tags:

Parameters:

method getItemIds [line 363]

Tags:

Parameters:

method getObjects [line 190]

Tags:

Parameters:

method insert [line 133]

Tags:

Parameters: