Group
class Group extends Object implements ObjectInterface (View source)
Properties
| $error | from Object | ||
| $ctID | |||
| $permissionSet | |||
| private | $permissions |
Methods
No description
No description
No description
No description
No description
No description
No description
No description
No description
Deletes a group.
No description
No description
No description
Get the date/time when a user entered this group.
No description
No description
No description
No description
No description
No description
No description
No description
Gets the group start date.
Gets the group end date.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Creates a new user group.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
in
Object at line 10
loadError($error)
No description
in
Object at line 15
isError()
No description
in
Object at line 25
getError()
No description
in
Object at line 30
setPropertiesFromArray($arr)
No description
in
Object at line 37
static
camelcase($file)
No description
in
Object at line 42
static
uncamelcase($string)
No description
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 protected
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