Class XoopsMembershipHandler

XOOPS membership handler class. (Singleton)

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

XoopsObjectHandler

XoopsMembershipHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/group.php

Methods summary
`public`	# `__construct( XoopsDatabase $db )` called from child classes only called from child classes only Parameters `$db` reference to the `XoopsDatabase` object Overrides `XoopsObjectHandler::__construct()`
`public XoopsMembership`	# `create( boolean $isNew = true )` create a new membership create a new membership Parameters `$isNew` should the new object be set to "new"? Returns `XoopsMembership` XoopsMembership Overrides `XoopsObjectHandler::create()`
`public mixed`	# `get( integer $id )` retrieve a membership retrieve a membership Parameters `$id` ID of the membership to get Returns mixed reference to the object if successful, else FALSE Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $mship )` inserts a membership in the database inserts a membership in the database Parameters `$mship` a XoopsMembership object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $mship )` delete a membership from the database delete a membership from the database Parameters `$mship` a XoopsMembership object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` retrieve memberships from the database retrieve memberships from the database Parameters `$criteria` `CriteriaElement` conditions to meet `$id_as_key` should the ID be used as the array's key? Returns array array of references
`public integer`	# `getCount( CriteriaElement $criteria = null )` count how many memberships meet the conditions count how many memberships meet the conditions Parameters `$criteria` `CriteriaElement` conditions to meet Returns integer
`public boolean`	# `deleteAll( CriteriaElement $criteria = null )` delete all memberships meeting the conditions delete all memberships meeting the conditions Parameters `$criteria` `CriteriaElement` with conditions to meet Returns boolean
`public array`	# `getGroupsByUser( integer $uid )` retrieve groups for a user retrieve groups for a user Parameters `$uid` ID of the user Returns array array of groups the user belongs to
`public array`	# `getUsersByGroup( integer $groupid, integer $limit = 0, integer $start = 0 )` retrieve users belonging to a group retrieve users belonging to a group Parameters `$groupid` ID of the group `$limit` number of entries to return `$start` offset of first entry to return Returns array array of users belonging to the group

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler()`

Properties summary
`public string`	`$table` This should be here, since this really should be a XoopsPersistableObjectHandler Here, we fake it for future compatibility This should be here, since this really should be a XoopsPersistableObjectHandler Here, we fake it for future compatibility	#

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsMembershipHandler

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns