vB_Library_Eventhighlight
extends vB_Library
in package
vB_Library_Page
Tags
Table of Contents
- $assertor : mixed
- Database assertor
- $instance : mixed
- __construct() : mixed
- Constructor
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- 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() : vB_PageCache
- 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
- addName() : array<string|int, mixed>
- Adds the event highlight name to the passed event highlight info array based on the passed language id.
- addNames() : array<string|int, mixed>
- Adds the event highlight name to all the events the passed event array based on the passed language id.
- addPermissions() : array<string|int, mixed>
- Adds event highlight permissions to all the events in the passed event array
- afterUpdate() : mixed
- Handles any operations, such as cache updates, that need to happen after any of the event highlight data is updated or added.
- getEventHighlightInternal() : array<string|int, mixed>
- Returns the specified event highlight without regard for currently logged in user or currently selected display language.
- getEventHighlightsInternal() : array<string|int, mixed>
- Returns all event highlights without regard for currently logged in user or currently selected display language.
- getLibraryClassNameInternal() : mixed
- getNameVarname() : string
- Returns the phrase varname for the event highlight name based on the passed event highlight id.
Properties
$assertor
Database assertor
protected
mixed
$assertor
=
ull
$instance
protected
static mixed
$instance
= array()
Methods
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
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
Return values
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) : vB_PageCache
Parameters
- $class : mixed
Return values
vB_PageCache —- Reference to singleton instance of the cache handler
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) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed
Return values
mixed —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
addName()
Adds the event highlight name to the passed event highlight info array based on the passed language id.
protected
addName(mixed $eventhighlight, mixed $languageid) : array<string|int, mixed>
Parameters
- $eventhighlight : mixed
- $languageid : mixed
Return values
array<string|int, mixed> —Event highlight array with 'name' added.
addNames()
Adds the event highlight name to all the events the passed event array based on the passed language id.
protected
addNames(mixed $eventhighlights, mixed $languageid) : array<string|int, mixed>
Parameters
- $eventhighlights : mixed
- $languageid : mixed
Return values
array<string|int, mixed> —Array of event highlights, each with 'name' added.
addPermissions()
Adds event highlight permissions to all the events in the passed event array
protected
addPermissions(mixed $eventhighlights) : array<string|int, mixed>
Parameters
- $eventhighlights : mixed
Return values
array<string|int, mixed> —Array of event highlights, each with the 'permissions' element added.
afterUpdate()
Handles any operations, such as cache updates, that need to happen after any of the event highlight data is updated or added.
protected
afterUpdate() : mixed
Return values
mixed —getEventHighlightInternal()
Returns the specified event highlight without regard for currently logged in user or currently selected display language.
protected
getEventHighlightInternal(mixed $eventhighlightid[, mixed $withPermissions = false ]) : array<string|int, mixed>
Parameters
- $eventhighlightid : mixed
- $withPermissions : mixed = false
Return values
array<string|int, mixed> —Event highlight information
getEventHighlightsInternal()
Returns all event highlights without regard for currently logged in user or currently selected display language.
protected
getEventHighlightsInternal([mixed $eventhighlightids = array() ][, mixed $withPermissions = false ][, mixed $usePreferredLanguage = false ][, mixed $skipNames = false ][, mixed $skipSort = false ]) : array<string|int, mixed>
Parameters
- $eventhighlightids : mixed = array()
- $withPermissions : mixed = false
- $usePreferredLanguage : mixed = false
- $skipNames : mixed = false
- $skipSort : mixed = false
Return values
array<string|int, mixed> —Array of event highlight information
getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —getNameVarname()
Returns the phrase varname for the event highlight name based on the passed event highlight id.
protected
getNameVarname(mixed $eventhighlightid) : string
Parameters
- $eventhighlightid : mixed
Return values
string —Phrase varname