ElggWidget Class Reference

Inheritance diagram for ElggWidget:

List of all members.

Public Member Functions
	get ($name)
	Override entity get and sets in order to save data to private data store.
	set ($name, $value)
	Override entity get and sets in order to save data to private data store.
	setContext ($context)
	Set the widget context.
	getContext ()
	Get the widget context.
	getTitle ()
	Get the title of the widget.
	move ($column, $rank)
	Move the widget.
	saveSettings ($params)
	Saves the widget's settings.
Protected Member Functions
	initializeAttributes ()
	Set subtype to widget.

---

Detailed Description

Definition at line 16 of file ElggWidget.php.

---

Member Function Documentation

ElggWidget::get

(

$

name

)

Override entity get and sets in order to save data to private data store.

Parameters:

string

$name Name

Returns:

mixed

Reimplemented from ElggEntity.

Definition at line 36 of file ElggWidget.php.

ElggWidget::getContext

(

)

Get the widget context.

Returns:

string

Since:

1.8.0

Definition at line 92 of file ElggWidget.php.

ElggWidget::getTitle

(

)

Get the title of the widget.

Returns:

string

Since:

1.8.0

Definition at line 102 of file ElggWidget.php.

ElggWidget::initializeAttributes

(

)

[protected]

Set subtype to widget.

Returns:

void

Reimplemented from ElggObject.

Definition at line 23 of file ElggWidget.php.

ElggWidget::move	(	$	column,
		$	rank
	)

Move the widget.

Parameters:

	int	$column The widget column
	int	$rank Zero-based rank from the top of the column

Returns:

void

Since:

1.8.0

Definition at line 119 of file ElggWidget.php.

ElggWidget::saveSettings

(

$

params

)

Saves the widget's settings.

Plugins can override the save mechanism using the plugin hook: 'widget_settings', <widget handler="" identifier>="">. The widget and the parameters are passed. The plugin hook handler should return true to indicate that it has successfully saved the settings.

Warning:

The values in the parameter array cannot be arrays

Parameters:

array

$params An array of name => value parameters

Returns:

bool

Since:

1.8.0

Definition at line 211 of file ElggWidget.php.

ElggWidget::set	(	$	name,
		$	value
	)

Override entity get and sets in order to save data to private data store.

Parameters:

	string	$name Name
	string	$value Value

Returns:

bool

Reimplemented from ElggEntity.

Definition at line 60 of file ElggWidget.php.

ElggWidget::setContext

(

$

context

)

Set the widget context.

Parameters:

string

$context The widget context

Returns:

bool

Since:

1.8.0

Definition at line 82 of file ElggWidget.php.

---

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

• engine/classes/ElggWidget.php