vB_Library_Usergroup
extends vB_Library
in package
vB_Library_Usergroup
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- buildDatastore() : mixed
- Rebuilds the usergroup datastore cache from the database
- clearCache() : mixed
- fetchUsergroupByID() : mixed
- fetchUsergroupList() : array<string|int, mixed>
- Returns a list of all user groups.
- getCache() : mixed
- Get the usergroup cache. Will rebuild the datastore if it is missing.
- getContentInstance() : mixed
- getGroupsWithPerm() : mixed
- getMemberlistGroups() : mixed
- getMultipleGroupIds() : array<string|int, mixed>
- Returns the usergroupids for multiple specified SYSGROUPID constants
- getSuperModGroups() : mixed
- Returns all of the user groups with ismoderator set
- getUsergroupBySystemID() : array<string|int, mixed>|false
- Fetch usergroup information by its SystemID
- instance() : static
- Returns singleton instance of self.
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
buildDatastore()
Rebuilds the usergroup datastore cache from the database
public
buildDatastore() : mixed
clearCache()
public
static clearCache() : mixed
fetchUsergroupByID()
public
fetchUsergroupByID(mixed $usergroupid) : mixed
Parameters
- $usergroupid : mixed
fetchUsergroupList()
Returns a list of all user groups.
public
fetchUsergroupList() : array<string|int, mixed>
Return values
array<string|int, mixed>getCache()
Get the usergroup cache. Will rebuild the datastore if it is missing.
public
getCache() : mixed
This is mostly public to allow the API class to call it.
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getGroupsWithPerm()
public
getGroupsWithPerm(mixed $permgroup, mixed $permname) : mixed
Parameters
- $permgroup : mixed
- $permname : mixed
getMemberlistGroups()
public
getMemberlistGroups() : mixed
getMultipleGroupIds()
Returns the usergroupids for multiple specified SYSGROUPID constants
public
getMultipleGroupIds(array<string|int, mixed> $groups) : array<string|int, mixed>
Parameters
- $groups : array<string|int, mixed>
-
-- int, the systemIDs to look up the db ids from
Return values
array<string|int, mixed> —-- usergroup ids -- NOTE: The usergroups in the return array are in the same order as in the input array. Some callers depend on this behavior.
getSuperModGroups()
Returns all of the user groups with ismoderator set
public
getSuperModGroups() : mixed
@return array usergroupids for each usergroup
getUsergroupBySystemID()
Fetch usergroup information by its SystemID
public
getUsergroupBySystemID(int $systemgroupid) : array<string|int, mixed>|false
Parameters
- $systemgroupid : int
Tags
Return values
array<string|int, mixed>|false —Usergroup information -- returns usergroup array or false if it doesn't exist
instance()
Returns singleton instance of self.
public
static instance(mixed $class) : static
Parameters
- $class : mixed
Return values
static —- Reference to singleton instance of the requested library class
monitorWords()
Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
public
monitorWords(mixed $text, mixed $type, mixed $nodeid[, mixed $userid = null ][, mixed $insertNotifications = true ][, mixed $currentuserid = 0 ]) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0