vB_Library_Icon
extends vB_Library
in package
vB_Library_Language
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- getContentInstance() : mixed
- getIconTypeInfo() : mixed
- 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.
- setCategoryPermissions() : mixed
- Set the the permissions for usergroups on an Icon category.
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
clearCache()
public
static clearCache() : mixed
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getIconTypeInfo()
public
getIconTypeInfo(string $type) : mixed
Parameters
- $type : string
-
-- one of avatar, icon, or smilie
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
Tags
setCategoryPermissions()
Set the the permissions for usergroups on an Icon category.
public
setCategoryPermissions(int $categoryid, array<string|int, mixed> $permissions) : mixed
This is only valid for avatars (not currently implemented) and post icons. Attempting to update a smilie category will throw an error.
Parameters
- $categoryid : int
-
-- the icon category to update
- $permissions : array<string|int, mixed>
-
-- [$usergroupid => (bool)] map of the permissions to set. Usergroups not in the array will not be affected.