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.

int|null
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

array
getParentNodes()

No description

getChildGroups()

No description

Group|null
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(int $days, int $hours, int $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|null
getByPath(string $gPath) deprecated

No description

mixed|void
jsonSerialize()

No description

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

at line 44
getPermissionObjectIdentifier()

No description

at line 49
getPermissionResponseClassName()

No description

at line 54
getPermissionAssignmentClassName()

No description

at line 59
getPermissionObjectKeyCategoryHandle()

No description

at line 64
export($node)

No description

Parameters

$node

at line 73
getGroupMembers()

No description

at line 82
getGroupMemberIDs()

No description

at line 91
getGroupMembersNum()

No description

at line 103
delete() deprecated

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

No description

at line 110
rescanGroupPath()

No description

at line 135
rescanGroupPathRecursive()

No description

at line 151
inGroup()

No description

at line 163
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 191
int|null getGroupID()

No description

Return Value

int|null

at line 196
getOverrideGroupTypeSettings()

No description

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

No description

Parameters

User $user
GroupRole $userRole

Return Value

bool

at line 241
bool sendJoinRequest()

No description

Return Value

bool

Exceptions

Exception

at line 280
GroupJoinRequest[] getJoinRequests()

No description

Return Value

GroupJoinRequest[]

at line 300
setOverrideGroupTypeSettings($gOverrideGroupTypeSettings)

No description

Parameters

$gOverrideGroupTypeSettings

at line 320
int getGroupTypeId()

No description

Return Value

int

at line 328
bool|GroupType getGroupType()

No description

Return Value

bool|GroupType

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

No description

Parameters

GroupType $groupType

Return Value

bool|GroupType

at line 360
int getDefaultRoleId()

No description

Return Value

int

at line 368
GroupRole getDefaultRole()

No description

Return Value

GroupRole

at line 385
bool setDefaultRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

at line 405
File|bool getThumbnailImage()

No description

Return Value

File|bool

at line 419
removeThumbnailImage()

No description

at line 438
bool setThumbnailImage(File $file)

No description

Parameters

File $file

Return Value

bool

at line 455
isPetitionForPublicEntry()

No description

at line 464
setPetitionForPublicEntry($gPetitionForPublicEntry)

No description

Parameters

$gPetitionForPublicEntry

at line 485
bool hasUserManagerPermissions(User $user)

No description

Parameters

User $user

Return Value

bool

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

No description

Parameters

User $user

Return Value

GroupRole|null

at line 522
GroupRole[] getRoles()

No description

Return Value

GroupRole[]

at line 535
bool addRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

at line 550
getGroupName()

No description

at line 555
getGroupPath()

No description

at line 560
getParentGroups()

No description

at line 576
array getParentNodes()

No description

Return Value

array

at line 589
getChildGroups()

No description

at line 612
Group|null getParentGroup()

No description

Return Value

Group|null

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

No description

Parameters

$includeHTML
$includePath

at line 643
getGroupDescription()

No description

at line 653
string getGroupStartDate()

Gets the group start date.

Return Value

string

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

at line 663
string getGroupEndDate()

Gets the group end date.

Return Value

string

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

at line 672
mixed isGroupBadge() deprecated

deprecated

No description

Return Value

mixed

at line 681
mixed getGroupBadgeDescription() deprecated

deprecated

No description

Return Value

mixed

at line 690
mixed getGroupBadgeCommunityPointValue() deprecated

deprecated

No description

Return Value

mixed

at line 699
mixed getGroupBadgeImageID() deprecated

deprecated

No description

Return Value

mixed

at line 704
getAuthorID()

No description

at line 709
isGroupAutomated()

No description

at line 714
checkGroupAutomationOnRegister()

No description

at line 719
checkGroupAutomationOnLogin()

No description

at line 724
checkGroupAutomationOnJobRun()

No description

at line 729
getGroupAutomationController()

No description

at line 741
getGroupAutomationControllerClass()

No description

at line 756
bool getGroupBadgeImageObject() deprecated

deprecated

No description

Return Value

bool

at line 769
isGroupExpirationEnabled()

No description

at line 774
getGroupExpirationMethod()

No description

at line 779
getGroupExpirationDateTime()

No description

at line 784
getGroupExpirationAction()

No description

at line 789
getGroupExpirationInterval()

No description

at line 794
getGroupExpirationIntervalDays()

No description

at line 799
getGroupExpirationIntervalHours()

No description

at line 804
getGroupExpirationIntervalMinutes()

No description

at line 809
isUserExpired(User $u)

No description

Parameters

User $u

at line 829
getPackageID()

No description

at line 834
getPackageHandle()

No description

at line 839
update($gName, $gDescription)

No description

Parameters

$gName
$gDescription

at line 866
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 890
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 909
static getBadges() deprecated

deprecated

No description

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

No description

Parameters

$column
$excludeUser

at line 944
static getAutomatedOnRegisterGroupControllers($u = false)

No description

Parameters

$u

at line 949
static getAutomatedOnLoginGroupControllers($u = false)

No description

Parameters

$u

at line 954
static getAutomatedOnJobRunGroupControllers()

No description

at line 962
clearBadgeOptions() deprecated

deprecated

No description

at line 971
clearAutomationOptions()

No description

at line 980
removeGroupExpiration()

No description

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

deprecated

No description

Parameters

$gBadgeFID
$gBadgeDescription
$gBadgeCommunityPointValue

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

No description

Parameters

$gCheckAutomationOnRegister
$gCheckAutomationOnLogin
$gCheckAutomationOnJobRun

at line 1022
setGroupExpirationByDateTime($datetime, $action)

No description

Parameters

$datetime
$action

at line 1031
setGroupExpirationByInterval(int $days, int $hours, int $minutes, $action)

No description

Parameters

int $days
int $hours
int $minutes
$action

at line 1041
static exportTranslations()

No description

at line 1065
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 1080
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 1093
static Group|null getByPath(string $gPath) deprecated

deprecated This is deprecated, user the grouprepository instead.

No description

Parameters

string $gPath

The group path

Return Value

Group|null

at line 1103
mixed|void jsonSerialize()

No description

Return Value

mixed|void