Référence de la classe XoopsGroupPermHandler

Graphe d'héritage de XoopsGroupPermHandler:

Graphe de collaboration de XoopsGroupPermHandler:

Fonctions membres publiques
	__construct (XoopsDatabase $db)
	create ($isNew=true)
	get ($id)
	insert (XoopsObject $perm)
	delete (XoopsObject $perm)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
	deleteAll (CriteriaElement $criteria=null)
	deleteByGroup ($gperm_groupid, $gperm_modid=null)
	deleteByModule ($gperm_modid, $gperm_name=null, $gperm_itemid=null)
	checkRight ($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid=1, $trueifadmin=true)
	addRight ($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)
Fonctions membres publiques hérités de XoopsObjectHandler
	XoopsObjectHandler ($db)
	create ()

Champs de données
	$table
Champs de données hérités de XoopsObjectHandler
	$db

Description détaillée

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.

Voir également

XoopsGroupPerm

Auteur

Kazumi Ono onoka.nosp@m.zu@x.nosp@m.oops..nosp@m.org

Copyright

(c) 2000-2016 XOOPS Project (www.xoops.org)

Documentation des constructeurs et destructeur

__construct()

__construct

(

XoopsDatabase

$db

)

called from child classes only

Paramètres

XoopsDatabase

$db

reference to the XoopsDatabase object @access protected

Réimplémentée à partir de XoopsObjectHandler.

Documentation des fonctions membres

addRight()

addRight	(		$gperm_name,
			$gperm_itemid,
			$gperm_groupid,
			$gperm_modid = 1
	)

Add a permission

Paramètres

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

Renvoie

bool TRUE if success

Voici le graphe d'appel pour cette fonction :

checkRight()

checkRight	(		$gperm_name,
			$gperm_itemid,
			$gperm_groupid,
			$gperm_modid = 1,
			$trueifadmin = true
	)

Check permission

Paramètres

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	$trueifadmin	Returns true for admin groups

Renvoie

bool TRUE if permission is enabled

Voici le graphe d'appel pour cette fonction :

create()

create

(

$isNew = true

)

Create a new XoopsGroupPerm

Paramètres

bool

$isNew

Renvoie

bool $isNew Flag the object as "new"?

delete()

delete

(

XoopsObject

$perm

)

Delete a XoopsGroupPerm

Paramètres

XoopsObject | XoopsGroupPerm

$perm

a XoopsGroupPerm object

Renvoie

bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

deleteAll()

deleteAll

(

CriteriaElement

$criteria = null

)

Delete all permissions by a certain criteria

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Renvoie

bool TRUE on success

Voici le graphe des appelants de cette fonction :

deleteByGroup()

deleteByGroup	(		$gperm_groupid,
			$gperm_modid = null
	)

Delete all module specific permissions assigned for a group

Paramètres

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

Renvoie

bool TRUE on success

Voici le graphe d'appel pour cette fonction :

deleteByModule()

deleteByModule	(		$gperm_modid,
			$gperm_name = null,
			$gperm_itemid = null
	)

Delete all module specific permissions

Paramètres

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

Renvoie

bool TRUE on success

Voici le graphe d'appel pour cette fonction :

get()

get

(

$id

)

Retrieve a group permission

Paramètres

int

$id

ID

Renvoie

XoopsGroupPerm XoopsGroupPerm, FALSE on fail

Réimplémentée à partir de XoopsObjectHandler.

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count some XoopsGroupPerms

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Renvoie

int

Voici le graphe des appelants de cette fonction :

getGroupIds()

getGroupIds	(		$gperm_name,
			$gperm_itemid,
			$gperm_modid = 1
	)

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

Paramètres

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

Renvoie

array array of group IDs

Voici le graphe d'appel pour cette fonction :

getItemIds()

getItemIds	(		$gperm_name,
			$gperm_groupid,
			$gperm_modid = 1
	)

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

Paramètres

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

Renvoie

array array of item IDs

Voici le graphe d'appel pour cette fonction :

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

Retrieve multiple XoopsGroupPerms

Paramètres

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement
bool	$id_as_key	Use IDs as array keys?

Renvoie

array Array of XoopsGroupPerms

Voici le graphe des appelants de cette fonction :

insert()

insert

(

XoopsObject

$perm

)

Store a XoopsGroupPerm

Paramètres

XoopsObject | XoopsGroupPerm

$perm

a XoopsGroupPerm object

Renvoie

bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des champs

$table

$table

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/kernel/groupperm.php