WidgetHelper Class Reference

Collaboration diagram for WidgetHelper:

Static Public Member Functions
static	setActiveWidget ($activeWidget)
static	getWidgetPosition ($pluginid)
static	storeNewPositions ($widget, $position, $column)
static	addInitialPositions ($col, $ids, $range_id)
static	storeInitialPositions ($col, $ids, $perm)
static	getInitialPositions ($perm)
static	setAsInitialPositions ($range_id, $group)
static	setInitialPositions ()
static	getUserWidgets ($id, $col=0)
static	addWidgetUserConfig ($id, $pluginName, $confArray)
static	getWidgetUserConfig ($id, $pluginName)
static	removeWidget ($id, $pluginName, $range_id)
static	addWidget ($id, $range_id)
static	getWidgetName ($id)
static	getWidget ($pluginid)
static	getAvailableWidgets ($user_id=null)
static	hasWidget ($user_id, $widget)

Member Function Documentation

addInitialPositions()

static addInitialPositions (   $col,   $ids,   $range_id  )

static

addInitialPositons - adds the global widget default settings to an user setting

Parameters

string	$col
array	$ids	of widgets
string	$range_id

Returns

void

Here is the call graph for this function:

addWidget()

static addWidget (   $id,   $range_id  )

static

addWidget - adds a widget for a given user

Parameters

string	$id	- widget_id
string	$range_id	e.g. user_id

Returns

bool|int false on error, id of inserted widget otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

addWidgetUserConfig()

static addWidgetUserConfig (   $id,   $pluginName,   $confArray  )

static

addWidgetUserConfig - creates user_config entry for widget newly added by a user

Parameters

string	$id	- user_id
string	$pluginName
array	$confArray

Returns

void

Here is the call graph for this function:

getAvailableWidgets()

static getAvailableWidgets (   $user_id = null )

static

getAvailableWidgets - fetches all widgets that are not already in use.

Parameters

string

$user_id

the user to check

Returns

array All available widgets.

Here is the call graph for this function:

Here is the caller graph for this function:

getInitialPositions()

static getInitialPositions (   $perm )

static

Here is the call graph for this function:

Here is the caller graph for this function:

getUserWidgets()

static getUserWidgets (   $id,   $col = 0  )

static

getUserWidgets - retrieves the widget settings for a given user

Parameters

string

$id

Returns

array $widgets

Here is the call graph for this function:

Here is the caller graph for this function:

getWidget()

static getWidget (   $pluginid )

static

getWidget - retrieves an instance of a given widget / portal plugin

Parameters

string

$pluginid

Returns

object widget

Here is the call graph for this function:

getWidgetName()

static getWidgetName (   $id )

static

getWidgetName - retrieves the name of a given widget

Parameters

string

$id

- widget_id

Returns

string widget_name

Here is the call graph for this function:

Here is the caller graph for this function:

getWidgetPosition()

static getWidgetPosition (   $pluginid )

static

Returns the position in the two column layout on the Startpage If no position is stored in UserConfig, the widget will be displayed on the right side.

Parameters

string

$pluginid

Returns

the position as array matrix

Here is the call graph for this function:

getWidgetUserConfig()

static getWidgetUserConfig (   $id,   $pluginName  )

static

getWidgetUserConfig - retrieves user_config entry for widget newly added by a user

Parameters

string	$id	user_id
string	$pluginName

Returns

object UserConfig

Here is the call graph for this function:

hasWidget()

static hasWidget (   $user_id,   $widget  )

static

hasWidget - returns whether has a certain widget activated

Parameters

string	$user_id	Id of the user
mixed	$widget	Id or name of the widget (you may omit the 'Widget' in the name)

Returns

bool indicating whether the widget is activated

Here is the call graph for this function:

Here is the caller graph for this function:

removeWidget()

static removeWidget (   $id,   $pluginName,   $range_id  )

static

removeWidget - removes a widget for a user

Parameters

string	$id	- widget_id
string	$pluginName
string	$range_id	e.g. user_id

Returns

bool success

Here is the call graph for this function:

Here is the caller graph for this function:

setActiveWidget()

static setActiveWidget (   $activeWidget )

static

Set the last active Widget

Parameters

string

$activeWidget

Here is the caller graph for this function:

setAsInitialPositions()

static setAsInitialPositions (   $range_id,   $group  )

static

Sets the current setting of a user as the default for a usergroup

Parameters

string	$range_id	The range id of the user that defines the setting
string	$group	The usergroup

Here is the call graph for this function:

setInitialPositions()

static setInitialPositions ( )

static

setInitialPositions - copies the default to the logged on user

Here is the call graph for this function:

Here is the caller graph for this function:

storeInitialPositions()

static storeInitialPositions (   $col,   $ids,   $perm  )

static

storeInitialPositions - stores the global widget default for a given perm

Parameters

string	$col
array	$ids	of widgets
string	$perm

Returns

boolean success

Here is the call graph for this function:

Here is the caller graph for this function:

storeNewPositions()

static storeNewPositions (   $widget,   $position,   $column  )

static

storeNewPositions - stores new Widget positions for a given user

Parameters

array

ids of widgets to be stored

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• lib/classes/WidgetHelper.php