[ Index ]

PHP Cross Reference of Xoops v2.3.1

[Global whois Lookup]    [Ranchi, Jharkhand, India website]     [Hindi Magazine]     [Desi Community website in tristate area]    [B 4 Bollywood]    [Internet nation of India]

title

Body

[close]

/kernel/ -> group.php (summary)

(no description)

File Size: 459 lines (16 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 4 classes

XoopsGroup:: (1 method):
  XoopsGroup()

XoopsGroupHandler:: (5 methods):
  create()
  get()
  insert()
  delete()
  getObjects()

XoopsMembership:: (1 method):
  XoopsMembership()

XoopsMembershipHandler:: (9 methods):
  create()
  get()
  insert()
  delete()
  getObjects()
  getCount()
  deleteAll()
  getGroupsByUser()
  getUsersByGroup()


Class: XoopsGroup  - X-Ref

a group of users

XoopsGroup()   X-Ref
constructor


Class: XoopsGroupHandler  - X-Ref

XOOPS group handler class.
This class is responsible for providing data access mechanisms to the data source
of XOOPS group class objects.

create($isNew = true)   X-Ref
create a new {@link XoopsGroup} object

param: bool $isNew mark the new object as "new"?
return: object XoopsGroup reference to the new object

get($id)   X-Ref
retrieve a specific group

param: int $id ID of the group to get
return: object XoopsGroup reference to the group object, FALSE if failed

insert(&$group)   X-Ref
insert a group into the database

param: object reference to the group object
return: mixed ID of the group if inserted, FALSE if failed, TRUE if already present and unchanged.

delete(&$group)   X-Ref
remove a group from the database

param: object $group reference to the group to be removed
return: bool FALSE if failed

getObjects($criteria = null, $id_as_key = false)   X-Ref
retrieve groups from the database

param: object $criteria {@link CriteriaElement} with conditions for the groups
param: bool $id_as_key should the groups' IDs be used as keys for the associative array?
return: mixed Array of groups

Class: XoopsMembership  - X-Ref

membership of a user in a group

XoopsMembership()   X-Ref
constructor


Class: XoopsMembershipHandler  - X-Ref

XOOPS membership handler class. (Singleton)

This class is responsible for providing data access mechanisms to the data source
of XOOPS group membership class objects.

create($isNew = true)   X-Ref
create a new membership

param: bool $isNew should the new object be set to "new"?
return: object XoopsMembership

get($id)   X-Ref
retrieve a membership

param: int $id ID of the membership to get
return: mixed reference to the object if successful, else FALSE

insert(&$mship)   X-Ref
inserts a membership in the database

param: object $mship reference to the membership object
return: bool TRUE if already in DB or successful, FALSE if failed

delete(&$mship)   X-Ref
delete a membership from the database

param: object $mship reference to the membership object
return: bool FALSE if failed

getObjects($criteria = null, $id_as_key = false)   X-Ref
retrieve memberships from the database

param: object $criteria {@link CriteriaElement} conditions to meet
param: bool $id_as_key should the ID be used as the array's key?
return: array array of references

getCount($criteria = null)   X-Ref
count how many memberships meet the conditions

param: object $criteria {@link CriteriaElement} conditions to meet
return: int

deleteAll($criteria = null)   X-Ref
delete all memberships meeting the conditions

param: object $criteria {@link CriteriaElement} with conditions to meet
return: bool

getGroupsByUser($uid)   X-Ref
retrieve groups for a user

param: int $uid ID of the user
param: bool $asobject should the groups be returned as {@link XoopsGroup}
return: array array of groups the user belongs to

getUsersByGroup($groupid, $limit=0, $start=0)   X-Ref
retrieve users belonging to a group

param: int $groupid ID of the group
param: bool $asobject return users as {@link XoopsUser} objects?
param: int $limit number of entries to return
param: int $start offset of first entry to return
return: array array of users belonging to the group



[ Xoops]     [PhpNuke]     [PostNuke]     [Joomla]    [Drupal]    [E107]    [NucleusCms]
[Php-Fusion]     [PhpBB]     [WordPress]     [Typo3]
Generated: Mon Oct 27 11:51:45 2008
Open Source related documentation for developers.