class Group extends Object implements ObjectInterface (View source)

Properties

$error from  Object
$ctID
$permissionSet
private $permissions

Methods

loadError($error)

No description

from  Object
isError()

No description

from  Object
getError()

No description

from  Object
setPropertiesFromArray($arr)

No description

from  Object
static 
camelcase($file)

No description

from  Object
static 
uncamelcase($string)

No description

from  Object
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(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 
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)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

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.

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)

No description

Parameters

string $gPath

The group path

Return Value

Group

export($node)

No description

Parameters

$node

getGroupMembers()

No description

getGroupMemberIDs()

No description

setPermissionsForObject($obj)

No description

Parameters

$obj

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.

Parameters

object|int $user

the user ID or an object with a getUserID method

Return Value

string|null

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

Parameters

$includeHTML
$includePath

getGroupDescription()

No description

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()

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

Parameters

User $u

getPackageID()

No description

getPackageHandle()

No description

update($gName, $gDescription)

No description

Parameters

$gName
$gDescription

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

static getBadges()

No description

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

No description

Parameters

$column
$excludeUser

static getAutomatedOnRegisterGroupControllers($u = false)

No description

Parameters

$u

static getAutomatedOnLoginGroupControllers($u = false)

No description

Parameters

$u

static getAutomatedOnJobRunGroupControllers()

No description

clearBadgeOptions()

No description

clearAutomationOptions()

No description

removeGroupExpiration()

No description

setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue)

No description

Parameters

$gBadgeFID
$gBadgeDescription
$gBadgeCommunityPointValue

setAutomationOptions($gCheckAutomationOnRegister, $gCheckAutomationOnLogin, $gCheckAutomationOnJobRun)

No description

Parameters

$gCheckAutomationOnRegister
$gCheckAutomationOnLogin
$gCheckAutomationOnJobRun

setGroupExpirationByDateTime($datetime, $action)

No description

Parameters

$datetime
$action

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

No description

Parameters

$days
$hours
$minutes
$action

static exportTranslations()

No description