vB_Library_Widget
extends vB_Library
in package
vB_Library_Widget
Tags
Table of Contents
- $instance : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- cleanFilterNodes() : mixed
- clearCache() : mixed
- deleteWidgetInstances() : false|int
- Deletes multiple widget instances
- filterNodes() : array<string|int, mixed>
- Takes an array of integer nodeids, current page nodeid, and the "ChannelIncludeExclude" type module config value, and filters the nodeids.
- getContentInstance() : mixed
- 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.
- __construct() : mixed
- getLibraryClassNameInternal() : mixed
- removeWidgetInstanceFromParentConfigs() : mixed
Properties
$instance
protected
static mixed
$instance
= array()
Methods
__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 —cleanFilterNodes()
public
cleanFilterNodes(mixed $filterNodes[, mixed $currentChannel = null ]) : mixed
Parameters
- $filterNodes : mixed
- $currentChannel : mixed = null
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
mixed —deleteWidgetInstances()
Deletes multiple widget instances
public
deleteWidgetInstances(array<string|int, mixed> $widgetInstanceIds[, mixed $updateParents = false ]) : false|int
Parameters
- $widgetInstanceIds : array<string|int, mixed>
- $updateParents : mixed = false
Return values
false|int —False or 0 on failure, number of rows deleted on success
filterNodes()
Takes an array of integer nodeids, current page nodeid, and the "ChannelIncludeExclude" type module config value, and filters the nodeids.
public
filterNodes(array<string|int, mixed> $nodeids, array<string|int, mixed> $filterNodes[, int $currentNodeid = null ]) : array<string|int, mixed>
Warning 1: the keys of the nodeids array will NOT be preserved. Warning 2: This function does NOT check any view permissions on the nodeids.
Parameters
- $nodeids : array<string|int, mixed>
-
Array of nodeids that will be filtered. Keys will NOT be preserved.
- $filterNodes : array<string|int, mixed>
-
Value of "ChannelIncludeExclude" type config, typically sent in from templates e.g. via widgetConfig.module_filter_nodes . array('include'|'exclude' => array( 'all'|'current'|nodeid, nodeid2, ... ))
- $currentNodeid : int = null
-
Current page's nodeid, typically sent in from templates via page.nodeid .
Return values
array<string|int, mixed> —A subset of $nodeids that has been filtered using $filterNodes
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
Return values
mixed —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 —__construct()
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —removeWidgetInstanceFromParentConfigs()
private
removeWidgetInstanceFromParentConfigs(mixed $widgetInstanceIds) : mixed
Parameters
- $widgetInstanceIds : mixed