Référence de la classe XoopsMembershipHandler

Graphe d'héritage de XoopsMembershipHandler:

Graphe de collaboration de XoopsMembershipHandler:

Fonctions membres publiques
	__construct (XoopsDatabase $db)
	create ($isNew=true)
	get ($id)
	insert (XoopsObject $mship)
	delete (XoopsObject $mship)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
	deleteAll (CriteriaElement $criteria=null)
	getGroupsByUser ($uid)
	getUsersByGroup ($groupid, $limit=0, $start=0)
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

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

create()

create

(

$isNew = true

)

create a new membership

Paramètres

bool

$isNew

should the new object be set to "new"?

Renvoie

XoopsMembership XoopsMembership

delete()

delete

(

XoopsObject

$mship

)

delete a membership from the database

Paramètres

XoopsObject | XoopsMembership

$mship

a XoopsMembership object

Renvoie

bool true on success, otherwise false

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

deleteAll()

deleteAll

(

CriteriaElement

$criteria = null

)

delete all memberships meeting the conditions

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement with conditions to meet

Renvoie

bool

get()

get

(

$id

)

retrieve a membership

Paramètres

int

$id

ID of the membership to get

Renvoie

mixed reference to the object if successful, else FALSE

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

getCount()

getCount

(

CriteriaElement

$criteria = null

)

count how many memberships meet the conditions

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement conditions to meet

Renvoie

int

getGroupsByUser()

getGroupsByUser

(

$uid

)

retrieve groups for a user

Paramètres

int

$uid

ID of the user

getObjects()

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

retrieve memberships from the database

Paramètres

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement conditions to meet
bool	$id_as_key	should the ID be used as the array's key?

Renvoie

array array of references

getUsersByGroup()

getUsersByGroup	(		$groupid,
			$limit = 0,
			$start = 0
	)

retrieve users belonging to a group

Paramètres

int	$groupid	ID of the group
int	$limit	number of entries to return
int	$start	offset of first entry to return

insert()

insert

(

XoopsObject

$mship

)

inserts a membership in the database

Paramètres

XoopsObject | XoopsMembership

$mship

a XoopsMembership object

Renvoie

bool true on success, otherwise false

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

Voici le graphe d'appel pour 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/group.php