Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_member_group_Handler
  • icms_member_group_membership_Object
  • icms_member_group_Object
  • Overview
  • Package
  • Class

Class icms_member_group_Handler

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

icms_core_ObjectHandler
Extended by icms_member_group_Handler
Package: Member\Group
Category: ICMS
Copyright: http://www.impresscms.org/ The ImpressCMS Project
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at member/group/Handler.php
Methods summary
public object &
# create( boolean $isNew = true )

create a new icms_member_group_Object object

create a new icms_member_group_Object object

Parameters

$isNew
mark the new object as "new"?

Returns

object
icms_member_group_Object icms_member_group_Object reference to the new object

See

icms_core_ObjectHandler#create()
public object &
# get( integer $id )

retrieve a specific group

retrieve a specific group

Parameters

$id
ID of the group to get

Returns

object
icms_member_group_Object icms_member_group_Object reference to the group object, FALSE if failed

See

icms_core_ObjectHandler#get($int_id)
public mixed
# insert( object & $group )

insert a group into the database

insert a group into the database

Parameters

$group
to the group object

Returns

mixed
ID of the group if inserted, FALSE if failed, TRUE if already present and unchanged.

See

icms_core_ObjectHandler#insert($object)
public boolean
# delete( object & $group )

remove a group from the database

remove a group from the database

Parameters

$group
reference to the group to be removed

Returns

boolean
FALSE if failed

See

icms_core_ObjectHandler#delete($object)
public mixed
# getObjects( object $criteria = null, boolean $id_as_key = false )

retrieve groups from the database

retrieve groups from the database

Parameters

$criteria
icms_db_criteria_Element with conditions for the groups
$id_as_key
should the groups' IDs be used as keys for the associative array?

Returns

mixed
Array of groups
Methods inherited from icms_core_ObjectHandler
__construct()
Properties inherited from icms_core_ObjectHandler
$db
API documentation generated by ApiGen