This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_Group

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_Group

Direct known subclasses

Group

Package: Utilities
Located at core/models/groups.php

Methods summary

public static
# getByID( $gID )
public static
# getByName( $gName )
public
# getGroupMembers( $type = null )
public
public
# getGroupMembersNum( $type = null )
public
# delete( )

Deletes a group

public
# inGroup( )
public
public
public
public
public string
# getGroupDisplayName( string $format = 'html' )

Returns the display name for this group (localized and escaped accordingly to $format)

public
public string
# getGroupDisplayDescription( string $format = 'html' )

Returns the display description for this group (localized and escaped accordingly to $format)

public string
# getGroupStartDate( string $type = 'system' )

Gets the group start date if user is specified, returns in the current user's timezone

public string
# getGroupEndDate( string $type = 'system' )

Gets the group end date if user is specified, returns in the current user's timezone

public
public
public
public
public
public
public
public
# update( $gName, $gDescription )
public static Group
# add( string $gName, string $gDescription, $gID = null )

Creates a new user group.

public
public
# setGroupExpirationByDateTime( $datetime, $action )
public
# setGroupExpirationByInterval( $days, $hours, $minutes, $action )

Properties summary

public $ctID
#
public $permissionSet
#

Properties inherited from Concrete5_Library_Object

$error