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

Group

class Group extends ConcreteObject implements ObjectInterface, JsonSerializable (View source)

Properties

$error from  ConcreteObject
$gID
$gIsBadge
$gName

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

export($node)

No description

getGroupMembers()

No description

getGroupMemberIDs()

No description

getGroupMembersNum()

No description

delete() 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
changeUserRole(User $user, GroupRole $userRole)

No description

bool
sendJoinRequest()

No description

GroupJoinRequest[]
getJoinRequests()

No description

setOverrideGroupTypeSettings($gOverrideGroupTypeSettings)

No description

int
getGroupTypeId()

No description

bool|GroupType
getGroupType()

No description

bool|GroupType
setGroupType(GroupType $groupType)

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|null
getUserRole(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

No description

mixed
getGroupBadgeDescription() deprecated

No description

mixed
getGroupBadgeCommunityPointValue() deprecated

No description

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

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

Creates a new user group.

static Group
addBeneathFolder(string $gName, string $gDescription, GroupFolder $parentFolder = false, $pkg = null)

Creates a new user group.

static 
getBadges() deprecated

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

No description

clearAutomationOptions()

No description

removeGroupExpiration()

No description

setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue) 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

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

static Group
getByName(string $gName) deprecated

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

static Group
getByPath(string $gPath) deprecated

No description

mixed|void
jsonSerialize()

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

No description

at line 48
getPermissionResponseClassName()

No description

at line 53
getPermissionAssignmentClassName()

No description

at line 58
getPermissionObjectKeyCategoryHandle()

No description

at line 63
export($node)

No description

Parameters

$node

at line 72
getGroupMembers()

No description

at line 81
getGroupMemberIDs()

No description

at line 90
getGroupMembersNum()

No description

at line 102
delete() deprecated

deprecated Deletes a group. This is deprecated – use the DeleteGroupCommand and the command bus.

No description

at line 109
rescanGroupPath()

No description

at line 134
rescanGroupPathRecursive()

No description

at line 150
inGroup()

No description

at line 162
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 187
getGroupID()

No description

at line 192
getOverrideGroupTypeSettings()

No description

at line 202
bool changeUserRole(User $user, GroupRole $userRole)

No description

Parameters

User $user
GroupRole $userRole

Return Value

bool

at line 236
bool sendJoinRequest()

No description

Return Value

bool

Exceptions

Exception

at line 274
GroupJoinRequest[] getJoinRequests()

No description

Return Value

GroupJoinRequest[]

at line 294
setOverrideGroupTypeSettings($gOverrideGroupTypeSettings)

No description

Parameters

$gOverrideGroupTypeSettings

at line 314
int getGroupTypeId()

No description

Return Value

int

at line 322
bool|GroupType getGroupType()

No description

Return Value

bool|GroupType

at line 334
bool|GroupType setGroupType(GroupType $groupType)

No description

Parameters

GroupType $groupType

Return Value

bool|GroupType

at line 354
int getDefaultRoleId()

No description

Return Value

int

at line 362
GroupRole getDefaultRole()

No description

Return Value

GroupRole

at line 379
bool setDefaultRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

at line 399
File|bool getThumbnailImage()

No description

Return Value

File|bool

at line 413
removeThumbnailImage()

No description

at line 432
bool setThumbnailImage(File $file)

No description

Parameters

File $file

Return Value

bool

at line 449
isPetitionForPublicEntry()

No description

at line 458
setPetitionForPublicEntry($gPetitionForPublicEntry)

No description

Parameters

$gPetitionForPublicEntry

at line 479
bool hasUserManagerPermissions(User $user)

No description

Parameters

User $user

Return Value

bool

at line 498
GroupRole|null getUserRole(User $user)

No description

Parameters

User $user

Return Value

GroupRole|null

at line 516
GroupRole[] getRoles()

No description

Return Value

GroupRole[]

at line 529
bool addRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

at line 544
getGroupName()

No description

at line 549
getGroupPath()

No description

at line 554
getParentGroups()

No description

at line 574
getChildGroups()

No description

at line 594
getParentGroup()

No description

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

No description

Parameters

$includeHTML
$includePath

at line 627
getGroupDescription()

No description

at line 637
string getGroupStartDate()

Gets the group start date.

Return Value

string

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

at line 647
string getGroupEndDate()

Gets the group end date.

Return Value

string

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

at line 656
mixed isGroupBadge() deprecated

deprecated

No description

Return Value

mixed

at line 665
mixed getGroupBadgeDescription() deprecated

deprecated

No description

Return Value

mixed

at line 674
mixed getGroupBadgeCommunityPointValue() deprecated

deprecated

No description

Return Value

mixed

at line 683
mixed getGroupBadgeImageID() deprecated

deprecated

No description

Return Value

mixed

at line 688
getAuthorID()

No description

at line 693
isGroupAutomated()

No description

at line 698
checkGroupAutomationOnRegister()

No description

at line 703
checkGroupAutomationOnLogin()

No description

at line 708
checkGroupAutomationOnJobRun()

No description

at line 713
getGroupAutomationController()

No description

at line 725
getGroupAutomationControllerClass()

No description

at line 740
bool getGroupBadgeImageObject() deprecated

deprecated

No description

Return Value

bool

at line 753
isGroupExpirationEnabled()

No description

at line 758
getGroupExpirationMethod()

No description

at line 763
getGroupExpirationDateTime()

No description

at line 768
getGroupExpirationAction()

No description

at line 773
getGroupExpirationInterval()

No description

at line 778
getGroupExpirationIntervalDays()

No description

at line 783
getGroupExpirationIntervalHours()

No description

at line 788
getGroupExpirationIntervalMinutes()

No description

at line 793
isUserExpired(User $u)

No description

Parameters

User $u

at line 813
getPackageID()

No description

at line 818
getPackageHandle()

No description

at line 823
update($gName, $gDescription)

No description

Parameters

$gName
$gDescription

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

deprecated This is deprecated; use the AddGroupCommand and the command bus.

Creates a new user group.

Parameters

string $gName
string $gDescription
$parentGroup
$pkg

Return Value

Group

at line 873
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.

Parameters

string $gName
string $gDescription
GroupFolder $parentFolder
$pkg

Return Value

Group

at line 892
static getBadges() deprecated

deprecated

No description

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

No description

Parameters

$column
$excludeUser

at line 927
static getAutomatedOnRegisterGroupControllers($u = false)

No description

Parameters

$u

at line 932
static getAutomatedOnLoginGroupControllers($u = false)

No description

Parameters

$u

at line 937
static getAutomatedOnJobRunGroupControllers()

No description

at line 945
clearBadgeOptions() deprecated

deprecated

No description

at line 954
clearAutomationOptions()

No description

at line 963
removeGroupExpiration()

No description

at line 978
setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue) deprecated

deprecated

No description

Parameters

$gBadgeFID
$gBadgeDescription
$gBadgeCommunityPointValue

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

No description

Parameters

$gCheckAutomationOnRegister
$gCheckAutomationOnLogin
$gCheckAutomationOnJobRun

at line 1005
setGroupExpirationByDateTime($datetime, $action)

No description

Parameters

$datetime
$action

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

No description

Parameters

$days
$hours
$minutes
$action

at line 1024
static exportTranslations()

No description

at line 1048
static Group getByID(string $gID) deprecated

deprecated This is deprecated, user the grouprepository instead.

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

Parameters

string $gID

Return Value

Group

at line 1063
static Group getByName(string $gName) deprecated

deprecated This is deprecated, user the grouprepository instead.

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

Parameters

string $gName

Return Value

Group

at line 1076
static Group getByPath(string $gPath) deprecated

deprecated This is deprecated, user the grouprepository instead.

No description

Parameters

string $gPath

The group path

Return Value

Group

at line 1086
mixed|void jsonSerialize()

No description

Return Value

mixed|void