Group
class Group extends ConcreteObject implements ObjectInterface, JsonSerializable (View source)
Properties
$error | from ConcreteObject | ||
$gID | |||
$gIsBadge | |||
$gName |
Methods
No description
No description
No description
No description
No description
No description
No description
No description
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
No description
No description
No description
No description
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
Creates a new user group.
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
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
getPermissionObjectIdentifier()
No description
getPermissionResponseClassName()
No description
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
No description
export($node)
No description
getGroupMembers()
No description
getGroupMemberIDs()
No description
getGroupMembersNum()
No description
delete()
deprecated
deprecated
No description
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
getOverrideGroupTypeSettings()
No description
bool
sendJoinRequest()
No description
GroupJoinRequest[]
getJoinRequests()
No description
setOverrideGroupTypeSettings($gOverrideGroupTypeSettings)
No description
int
getGroupTypeId()
No description
bool|GroupType
getGroupType()
No description
int
getDefaultRoleId()
No description
GroupRole
getDefaultRole()
No description
bool
setDefaultRole(GroupRole $role)
No description
File|bool
getThumbnailImage()
No description
removeThumbnailImage()
No description
bool
setThumbnailImage(File $file)
No description
isPetitionForPublicEntry()
No description
setPetitionForPublicEntry($gPetitionForPublicEntry)
No description
bool
hasUserManagerPermissions(User $user)
No description
GroupRole[]
getRoles()
No description
bool
addRole(GroupRole $role)
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.
mixed
isGroupBadge()
deprecated
deprecated
No description
mixed
getGroupBadgeDescription()
deprecated
deprecated
No description
mixed
getGroupBadgeCommunityPointValue()
deprecated
deprecated
No description
mixed
getGroupBadgeImageID()
deprecated
deprecated
No description
getAuthorID()
No description
isGroupAutomated()
No description
checkGroupAutomationOnRegister()
No description
checkGroupAutomationOnLogin()
No description
checkGroupAutomationOnJobRun()
No description
getGroupAutomationController()
No description
getGroupAutomationControllerClass()
No description
bool
getGroupBadgeImageObject()
deprecated
deprecated
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)
deprecated
deprecated
Creates a new user group.
static Group
addBeneathFolder(string $gName, string $gDescription, GroupFolder $parentFolder = false, $pkg = null)
Creates a new user group.
This is deprecated; use the AddGroupCommand and the command bus.
static
getBadges()
deprecated
deprecated
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()
deprecated
deprecated
No description
clearAutomationOptions()
No description
removeGroupExpiration()
No description
setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue)
deprecated
deprecated
No description
setAutomationOptions($gCheckAutomationOnRegister, $gCheckAutomationOnLogin, $gCheckAutomationOnJobRun)
No description
setGroupExpirationByDateTime($datetime, $action)
No description
setGroupExpirationByInterval($days, $hours, $minutes, $action)
No description
static
exportTranslations()
No description
static Group
getByID(string $gID)
deprecated
deprecated
Takes the numeric id of a group and returns a group object.
static Group
getByName(string $gName)
deprecated
deprecated
Takes the name of a group and returns a group object.
static Group
getByPath(string $gPath)
deprecated
deprecated
No description
mixed|void
jsonSerialize()
No description