vB_Library_Eventhighlight
extends vB_Library
in package
vB_Library_Page
Tags
Table of Contents
Methods
- __construct() : mixed
- Constructor
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- deleteEventHighlight() : array<string|int, mixed>
- Deletes an event highlight
- getContentInstance() : mixed
- getEventHighlightAdmin() : array<string|int, mixed>
- Returns the specified event highlight for administration purposes.
- getEventHighlightsAdmin() : array<string|int, mixed>
- Returns the full listing of event highlights for administration purposes.
- getEventHighlightsUser() : array<string|int, mixed>
- Returns the listing of event highlights for the currently logged in user
- getEventHighlightViewInfo() : array<string|int, mixed>
- Returns the view information to display all event highlights
- 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.
- saveEventHighlight() : array<string|int, mixed>
- Saves (creates or updates) an event highlight
- saveEventHighlightDisplayOrder() : array<string|int, mixed>
- Saves event highlight display order for multiple event highlights
- saveEventHighlightPermissions() : array<string|int, mixed>
- Saves event highlight permissions for one event highlight
Methods
__construct()
Constructor
public
__construct() : mixed
__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
deleteEventHighlight()
Deletes an event highlight
public
deleteEventHighlight(mixed $eventhighlightid) : array<string|int, mixed>
Parameters
- $eventhighlightid : mixed
Return values
array<string|int, mixed> —Success array
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getEventHighlightAdmin()
Returns the specified event highlight for administration purposes.
public
getEventHighlightAdmin(mixed $eventhighlightid[, mixed $withPermissions = false ]) : array<string|int, mixed>
Parameters
- $eventhighlightid : mixed
- $withPermissions : mixed = false
Return values
array<string|int, mixed> —Event highlight information
getEventHighlightsAdmin()
Returns the full listing of event highlights for administration purposes.
public
getEventHighlightsAdmin([mixed $eventhighlightids = array() ][, mixed $withPermissions = false ]) : array<string|int, mixed>
Parameters
- $eventhighlightids : mixed = array()
- $withPermissions : mixed = false
Return values
array<string|int, mixed> —Full listing of event highlights
getEventHighlightsUser()
Returns the listing of event highlights for the currently logged in user
public
getEventHighlightsUser() : array<string|int, mixed>
Return values
array<string|int, mixed> —Listing of available event highlights
getEventHighlightViewInfo()
Returns the view information to display all event highlights
public
getEventHighlightViewInfo() : array<string|int, mixed>
Return values
array<string|int, mixed> —View information for all event highlights (permissions only affect being able to apply an event highlight to a node)
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
saveEventHighlight()
Saves (creates or updates) an event highlight
public
saveEventHighlight(mixed $data) : array<string|int, mixed>
Parameters
- $data : mixed
Return values
array<string|int, mixed> —Event highlight information
saveEventHighlightDisplayOrder()
Saves event highlight display order for multiple event highlights
public
saveEventHighlightDisplayOrder(mixed $displayOrder) : array<string|int, mixed>
Parameters
- $displayOrder : mixed
Return values
array<string|int, mixed> —Success array
saveEventHighlightPermissions()
Saves event highlight permissions for one event highlight
public
saveEventHighlightPermissions(mixed $eventhighlightid, mixed $denybydefault, mixed $denyusergroups) : array<string|int, mixed>
Parameters
- $eventhighlightid : mixed
- $denybydefault : mixed
- $denyusergroups : mixed
Return values
array<string|int, mixed> —Success array