Elgg\WidgetDefinition Class Reference

WidgetDefinition. More...

Public Member Functions
	__construct ($id)
	WidgetDefinition constructor. More...
	__get ($name)
	Magic getter to return the deprecated attribute 'handler'. More...

Static Public Member Functions
static	factory (array $options)
	Create an WidgetDefinition from an associative array. More...

Public Attributes
	$id
	$name
	$description
	$context
	$multiple

Detailed Description

WidgetDefinition.

Helper class for defining a widget

Definition at line 10 of file WidgetDefinition.php.

Constructor & Destructor Documentation

Elgg\WidgetDefinition::__construct

(

$id

)

WidgetDefinition constructor.

Parameters

string

$id

Identifier of the widget

Definition at line 42 of file WidgetDefinition.php.

Member Function Documentation

Elgg\WidgetDefinition::__get

(

$name

)

Magic getter to return the deprecated attribute 'handler'.

Parameters

string

$name

attribute to get

Returns

mixed

Definition at line 104 of file WidgetDefinition.php.

static Elgg\WidgetDefinition::factory ( array  $options )

static

Create an WidgetDefinition from an associative array.

Required key is id.

Parameters

array

$options

Option array of key value pairs

id => STR Widget identifier (required) name => STR Name of the widget description => STR Description of the widget context => ARRAY contexts in which the widget is available multiple => BOOL can the widget be added multiple times

Exceptions

InvalidParameterException

Returns

Definition at line 64 of file WidgetDefinition.php.

Member Data Documentation

Elgg\WidgetDefinition::$context

Definition at line 30 of file WidgetDefinition.php.

Elgg\WidgetDefinition::$description

Definition at line 25 of file WidgetDefinition.php.

Elgg\WidgetDefinition::$id

Definition at line 15 of file WidgetDefinition.php.

Elgg\WidgetDefinition::$multiple

Definition at line 35 of file WidgetDefinition.php.

Elgg\WidgetDefinition::$name

Definition at line 20 of file WidgetDefinition.php.

---

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

• engine/classes/Elgg/WidgetDefinition.php