Class icms_member_group_membership_Handler

Group membership handler class. (Singleton)

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

icms_member_group_membership_Handler

Package: Member\GroupMembership
Category: ICMS
Copyright: http://www.impresscms.org/ The ImpressCMS Project
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at member/group/membership/Handler.php

Methods summary
`public object &`	# `create( boolean $isNew = true )` create a new membership create a new membership Parameters `$isNew` should the new object be set to "new"? Returns object icms_member_group_membership_Object `icms_member_group_membership_Object` See icms_core_ObjectHandler#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 See icms_core_ObjectHandler#get($int_id)
`public boolean`	# `insert( object & $mship )` inserts a membership in the database inserts a membership in the database Parameters `$mship` reference to the membership object Returns boolean TRUE if already in DB or successful, FALSE if failed See icms_core_ObjectHandler#insert($object)
`public boolean`	# `delete( object & $mship )` delete a membership from the database delete a membership from the database Parameters `$mship` reference to the membership object Returns boolean FALSE if failed See icms_core_ObjectHandler#delete($object)
`public array`	# `getObjects( object $criteria = null, boolean $id_as_key = false )` retrieve memberships from the database retrieve memberships from the database Parameters `$criteria` `icms_db_criteria_Element` conditions to meet `$id_as_key` should the ID be used as the array's key? Returns array array of references
`public integer`	# `getCount( object $criteria = null )` count how many memberships meet the conditions count how many memberships meet the conditions Parameters `$criteria` `icms_db_criteria_Element` conditions to meet Returns integer
`public boolean`	# `deleteAll( object $criteria = null )` delete all memberships meeting the conditions delete all memberships meeting the conditions Parameters `$criteria` `icms_db_criteria_Element` with conditions to meet Returns boolean
`public array`	# `getGroupsByUser( integer $uid, boolean $asobject,… )` retrieve groups for a user retrieve groups for a user Parameters `$uid` ID of the user `$asobject`,… should the groups be returned as `icms_member_group_Object` objects? FALSE returns associative array. Returns array array of groups the user belongs to
`public array`	# `getUsersByGroup( integer $groupid, boolean $limit = 0, integer $start = 0, integer $start,… )` retrieve users belonging to a group retrieve users belonging to a group Parameters `$groupid` ID of the group `$limit` $asobject return users as icms_user_Object objects? FALSE will return arrays `$start` $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 icms_core_ObjectHandler
`__construct()`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_member_group_membership_Handler

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns