class vB_Library_Widget extends vB_Library

vB_Library_Widget

Traits

Properties

static protected $instance from vB_Library

Methods

__sleep()

No description

__wakeup()

No description

__construct()

No description

static vB_PageCache
instance($class)

Returns singleton instance of self.

static 
getLibraryClassNameInternal($controller)

No description

static 
getContentInstance($contenttypeid)

No description

static 
clearCache()

No description

false|int
deleteWidgetInstances(array $widgetInstanceIds, $updateParents = false)

Deletes multiple widget instances

array
filterNodes(array $nodeids, array $filterNodes, int $currentNodeid = null)

Takes an array of integer nodeids, current page nodeid, and the "ChannelIncludeExclude" type module config value, and filters the nodeids.

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Library at line 25
protected __construct()

in vB_Library at line 35
static vB_PageCache instance($class)

Returns singleton instance of self.

Parameters

$class

Return Value

vB_PageCache
  • Reference to singleton instance of the cache handler

in vB_Library at line 52
static protected getLibraryClassNameInternal($controller)

Parameters

$controller

in vB_Library at line 91
static getContentInstance($contenttypeid)

Parameters

$contenttypeid

in vB_Library at line 99
static clearCache()

at line 28
false|int deleteWidgetInstances(array $widgetInstanceIds, $updateParents = false)

Deletes multiple widget instances

Parameters

array $widgetInstanceIds
$updateParents

Return Value

false|int False or 0 on failure, number of rows deleted on success

at line 300
array filterNodes(array $nodeids, array $filterNodes, int $currentNodeid = null)

Takes an array of integer nodeids, current page nodeid, and the "ChannelIncludeExclude" type module config value, and filters the nodeids.

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

array $nodeids Array of nodeids that will be filtered. Keys will NOT be preserved.
array $filterNodes 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, ... ))
int $currentNodeid Current page's nodeid, typically sent in from templates via page.nodeid .

Return Value

array A subset of $nodeids that has been filtered using $filterNodes