1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. User
  7. \
  8. Group
  9. \
  10. Group

Group

class Group extends ConcreteObject implements ObjectInterface (View source)

Properties

$error from  ConcreteObject
$ctID
$permissionSet
private $permissions

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
getPermissionObjectIdentifier()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

static Group
getByID(string $gID)

Takes the numeric id of a group and returns a group object.

static Group
getByName(string $gName)

Takes the name of a group and returns a group object.

static Group
getByPath(string $gPath)

No description

export($node)

No description

getGroupMembers()

No description

getGroupMemberIDs()

No description

setPermissionsForObject($obj)

No description

getGroupMembersNum()

No description

delete()

Deletes a group.

rescanGroupPath()

No description

rescanGroupPathRecursive()

No description

inGroup()

No description

string|null
getGroupDateTimeEntered(object|int $user)

Get the date/time when a user entered this group.

getGroupID()

No description

getGroupName()

No description

getGroupPath()

No description

getParentGroups()

No description

getChildGroups()

No description

getParentGroup()

No description

getGroupDisplayName($includeHTML = true, $includePath = true)

No description

getGroupDescription()

No description

string
getGroupStartDate()

Gets the group start date.

string
getGroupEndDate()

Gets the group end date.

isGroupBadge()

No description

getGroupBadgeDescription()

No description

getGroupBadgeCommunityPointValue()

No description

getGroupBadgeImageID()

No description

isGroupAutomated()

No description

checkGroupAutomationOnRegister()

No description

checkGroupAutomationOnLogin()

No description

checkGroupAutomationOnJobRun()

No description

getGroupAutomationController()

No description

getGroupAutomationControllerClass()

No description

getGroupBadgeImageObject()

No description

isGroupExpirationEnabled()

No description

getGroupExpirationMethod()

No description

getGroupExpirationDateTime()

No description

getGroupExpirationAction()

No description

getGroupExpirationInterval()

No description

getGroupExpirationIntervalDays()

No description

getGroupExpirationIntervalHours()

No description

getGroupExpirationIntervalMinutes()

No description

isUserExpired(User $u)

No description

getPackageID()

No description

getPackageHandle()

No description

update($gName, $gDescription)

No description

static Group
add(string $gName, string $gDescription, $parentGroup = false, $pkg = null, $gID = null)

Creates a new user group.

static 
getBadges()

No description

static 
getAutomationControllers($column, $excludeUser = false)

No description

static 
getAutomatedOnRegisterGroupControllers($u = false)

No description

static 
getAutomatedOnLoginGroupControllers($u = false)

No description

static 
getAutomatedOnJobRunGroupControllers()

No description

clearBadgeOptions()

No description

clearAutomationOptions()

No description

removeGroupExpiration()

No description

setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue)

No description

setAutomationOptions($gCheckAutomationOnRegister, $gCheckAutomationOnLogin, $gCheckAutomationOnJobRun)

No description

setGroupExpirationByDateTime($datetime, $action)

No description

setGroupExpirationByInterval($days, $hours, $minutes, $action)

No description

static 
exportTranslations()

No description

Details

in ConcreteObject at line 10
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 15
isError()

No description

in ConcreteObject at line 25
getError()

No description

in ConcreteObject at line 30
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 42
static uncamelcase($string)

No description

Parameters

$string

at line 25
getPermissionObjectIdentifier()

No description

at line 30
getPermissionResponseClassName()

No description

at line 35
getPermissionAssignmentClassName()

No description

at line 40
getPermissionObjectKeyCategoryHandle()

No description

at line 52
static Group getByID(string $gID)

Takes the numeric id of a group and returns a group object.

Parameters

string $gID

Return Value

Group

at line 77
static Group getByName(string $gName)

Takes the name of a group and returns a group object.

Parameters

string $gName

Return Value

Group

at line 94
static Group getByPath(string $gPath)

No description

Parameters

string $gPath

The group path

Return Value

Group

at line 106
export($node)

No description

Parameters

$node

at line 115
getGroupMembers()

No description

at line 124
getGroupMemberIDs()

No description

at line 133
setPermissionsForObject($obj)

No description

Parameters

$obj

at line 153
getGroupMembersNum()

No description

at line 164
delete()

Deletes a group.

at line 195
rescanGroupPath()

No description

at line 218
rescanGroupPathRecursive()

No description

at line 230
inGroup()

No description

at line 242
string|null getGroupDateTimeEntered(object|int $user)

Get the date/time when a user entered this group.

Parameters

object|int $user

the user ID or an object with a getUserID method

Return Value

string|null

at line 267
getGroupID()

No description

at line 272
getGroupName()

No description

at line 277
getGroupPath()

No description

at line 282
getParentGroups()

No description

at line 300
getChildGroups()

No description

at line 318
getParentGroup()

No description

at line 327
getGroupDisplayName($includeHTML = true, $includePath = true)

No description

Parameters

$includeHTML
$includePath

at line 351
getGroupDescription()

No description

at line 361
string getGroupStartDate()

Gets the group start date.

Return Value

string

date formated like: 2009-01-01 00:00:00

at line 371
string getGroupEndDate()

Gets the group end date.

Return Value

string

date formated like: 2009-01-01 00:00:00

at line 376
isGroupBadge()

No description

at line 381
getGroupBadgeDescription()

No description

at line 386
getGroupBadgeCommunityPointValue()

No description

at line 391
getGroupBadgeImageID()

No description

at line 396
isGroupAutomated()

No description

at line 401
checkGroupAutomationOnRegister()

No description

at line 406
checkGroupAutomationOnLogin()

No description

at line 411
checkGroupAutomationOnJobRun()

No description

at line 416
getGroupAutomationController()

No description

at line 428
getGroupAutomationControllerClass()

No description

at line 439
getGroupBadgeImageObject()

No description

at line 452
isGroupExpirationEnabled()

No description

at line 457
getGroupExpirationMethod()

No description

at line 462
getGroupExpirationDateTime()

No description

at line 467
getGroupExpirationAction()

No description

at line 472
getGroupExpirationInterval()

No description

at line 477
getGroupExpirationIntervalDays()

No description

at line 482
getGroupExpirationIntervalHours()

No description

at line 487
getGroupExpirationIntervalMinutes()

No description

at line 492
isUserExpired(User $u)

No description

Parameters

User $u

at line 512
getPackageID()

No description

at line 517
getPackageHandle()

No description

at line 522
update($gName, $gDescription)

No description

Parameters

$gName
$gDescription

at line 546
static Group add(string $gName, string $gDescription, $parentGroup = false, $pkg = null, $gID = null)

Creates a new user group.

Parameters

string $gName
string $gDescription
$parentGroup
$pkg
$gID

Return Value

Group

at line 584
static getBadges()

No description

at line 597
static protected getAutomationControllers($column, $excludeUser = false)

No description

Parameters

$column
$excludeUser

at line 619
static getAutomatedOnRegisterGroupControllers($u = false)

No description

Parameters

$u

at line 624
static getAutomatedOnLoginGroupControllers($u = false)

No description

Parameters

$u

at line 629
static getAutomatedOnJobRunGroupControllers()

No description

at line 634
clearBadgeOptions()

No description

at line 643
clearAutomationOptions()

No description

at line 652
removeGroupExpiration()

No description

at line 661
setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue)

No description

Parameters

$gBadgeFID
$gBadgeDescription
$gBadgeCommunityPointValue

at line 670
setAutomationOptions($gCheckAutomationOnRegister, $gCheckAutomationOnLogin, $gCheckAutomationOnJobRun)

No description

Parameters

$gCheckAutomationOnRegister
$gCheckAutomationOnLogin
$gCheckAutomationOnJobRun

at line 687
setGroupExpirationByDateTime($datetime, $action)

No description

Parameters

$datetime
$action

at line 696
setGroupExpirationByInterval($days, $hours, $minutes, $action)

No description

Parameters

$days
$hours
$minutes
$action

at line 706
static exportTranslations()

No description