class Group extends ConcreteObject implements ObjectInterface (View source)

Properties

$error from ConcreteObject
$ctID
$permissionSet
private $permissions

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

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

getGroupBadgeImageID()

No description

isGroupAutomated()

No description

checkGroupAutomationOnLogin()

No description

checkGroupAutomationOnJobRun()

No description

getGroupAutomationController()

No description

getGroupBadgeImageObject()

No description

isGroupExpirationEnabled()

No description

getGroupExpirationMethod()

No description

getGroupExpirationDateTime()

No description

getGroupExpirationAction()

No description

getGroupExpirationInterval()

No description

isUserExpired(User $u)

No description

getPackageID()

No description

getPackageHandle()

No description

update($gName, $gDescription)

No description

static Group
add($gName, $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 
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

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

getPermissionObjectIdentifier()

getPermissionResponseClassName()

getPermissionAssignmentClassName()

getPermissionObjectKeyCategoryHandle()

static Group getByID(string $gID)

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

Parameters

string $gID

Return Value

Group

static Group getByName(string $gName)

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

Parameters

string $gName

Return Value

Group

static Group getByPath(string $gPath)

Parameters

string $gPath The group path

Return Value

Group

export($node)

Parameters

$node

getGroupMembers()

getGroupMemberIDs()

setPermissionsForObject($obj)

Parameters

$obj

getGroupMembersNum()

delete()

Deletes a group.

rescanGroupPath()

rescanGroupPathRecursive()

inGroup()

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

getGroupID()

getGroupName()

getGroupPath()

getParentGroups()

getChildGroups()

getParentGroup()

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

Parameters

$includeHTML
$includePath

getGroupDescription()

string getGroupStartDate()

Gets the group start date.

Return Value

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

string getGroupEndDate()

Gets the group end date.

Return Value

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

isGroupBadge()

getGroupBadgeDescription()

getGroupBadgeCommunityPointValue()

getGroupBadgeImageID()

isGroupAutomated()

checkGroupAutomationOnRegister()

checkGroupAutomationOnLogin()

checkGroupAutomationOnJobRun()

getGroupAutomationController()

getGroupAutomationControllerClass()

getGroupBadgeImageObject()

isGroupExpirationEnabled()

getGroupExpirationMethod()

getGroupExpirationDateTime()

getGroupExpirationAction()

getGroupExpirationInterval()

getGroupExpirationIntervalDays()

getGroupExpirationIntervalHours()

getGroupExpirationIntervalMinutes()

isUserExpired(User $u)

Parameters

User $u

getPackageID()

getPackageHandle()

update($gName, $gDescription)

Parameters

$gName
$gDescription

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

Creates a new user group.

Parameters

$gName
$gDescription
$parentGroup
$pkg
$gID

Return Value

Group

static getBadges()

static protected getAutomationControllers($column, $excludeUser = false)

Parameters

$column
$excludeUser

static getAutomatedOnRegisterGroupControllers($u = false)

Parameters

$u

static getAutomatedOnLoginGroupControllers($u = false)

Parameters

$u

static getAutomatedOnJobRunGroupControllers()

clearBadgeOptions()

clearAutomationOptions()

removeGroupExpiration()

setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue)

Parameters

$gBadgeFID
$gBadgeDescription
$gBadgeCommunityPointValue

setAutomationOptions($gCheckAutomationOnRegister, $gCheckAutomationOnLogin, $gCheckAutomationOnJobRun)

Parameters

$gCheckAutomationOnRegister
$gCheckAutomationOnLogin
$gCheckAutomationOnJobRun

setGroupExpirationByDateTime($datetime, $action)

Parameters

$datetime
$action

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

Parameters

$days
$hours
$minutes
$action

static exportTranslations()