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

Properties

$error from  ConcreteObject
$gID
$gIsBadge
$gName

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

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

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

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

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

checkGroupAutomationOnLogin()

No description

checkGroupAutomationOnJobRun()

No description

getGroupAutomationController()

No description

bool
getGroupBadgeImageObject() deprecated

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

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

export($node)

No description

Parameters

$node

getGroupMembers()

No description

getGroupMemberIDs()

No description

getGroupMembersNum()

No description

delete() deprecated

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

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.

Parameters

object|int $user

the user ID or an object with a getUserID method

Return Value

string|null

int|null getGroupID()

No description

Return Value

int|null

getOverrideGroupTypeSettings()

No description

bool changeUserRole(User $user, GroupRole $userRole)

No description

Parameters

User $user
GroupRole $userRole

Return Value

bool

bool sendJoinRequest()

No description

Return Value

bool

Exceptions

Exception

GroupJoinRequest[] getJoinRequests()

No description

Return Value

GroupJoinRequest[]

setOverrideGroupTypeSettings($gOverrideGroupTypeSettings)

No description

Parameters

$gOverrideGroupTypeSettings

int getGroupTypeId()

No description

Return Value

int

bool|GroupType getGroupType()

No description

Return Value

bool|GroupType

bool|GroupType setGroupType(GroupType $groupType)

No description

Parameters

GroupType $groupType

Return Value

bool|GroupType

int getDefaultRoleId()

No description

Return Value

int

GroupRole getDefaultRole()

No description

Return Value

GroupRole

bool setDefaultRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

File|bool getThumbnailImage()

No description

Return Value

File|bool

removeThumbnailImage()

No description

bool setThumbnailImage(File $file)

No description

Parameters

File $file

Return Value

bool

isPetitionForPublicEntry()

No description

setPetitionForPublicEntry($gPetitionForPublicEntry)

No description

Parameters

$gPetitionForPublicEntry

bool hasUserManagerPermissions(User $user)

No description

Parameters

User $user

Return Value

bool

GroupRole|null getUserRole(User $user)

No description

Parameters

User $user

Return Value

GroupRole|null

GroupRole[] getRoles()

No description

Return Value

GroupRole[]

bool addRole(GroupRole $role)

No description

Parameters

GroupRole $role

Return Value

bool

getGroupName()

No description

getGroupPath()

No description

getParentGroups()

No description

array getParentNodes()

No description

Return Value

array

getChildGroups()

No description

Group|null getParentGroup()

No description

Return Value

Group|null

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

mixed isGroupBadge() deprecated

deprecated

No description

Return Value

mixed

mixed getGroupBadgeDescription() deprecated

deprecated

No description

Return Value

mixed

mixed getGroupBadgeCommunityPointValue() deprecated

deprecated

No description

Return Value

mixed

mixed getGroupBadgeImageID() deprecated

deprecated

No description

Return Value

mixed

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

Return Value

bool

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

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

static getBadges() deprecated

deprecated

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

deprecated

No description

clearAutomationOptions()

No description

removeGroupExpiration()

No description

setBadgeOptions($gBadgeFID, $gBadgeDescription, $gBadgeCommunityPointValue) deprecated

deprecated

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(int $days, int $hours, int $minutes, $action)

No description

Parameters

int $days
int $hours
int $minutes
$action

static exportTranslations()

No description

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

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

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

mixed|void jsonSerialize()

No description

Return Value

mixed|void