Class ElggWidget

ElggWidget

Stores metadata in private settings rather than as ElggMetadata

ElggData implements Loggable, Iterator, ArrayAccess, Exportable

ElggEntity implements Notable, Locatable, Importable

ElggObject

ElggWidget

Package: Elgg\Core\Widgets
Located at ElggWidget.php

Methods summary
`protected`	# `initializeAttributes( )` Set subtype to widget. Set subtype to widget. Overrides `ElggObject::initializeAttributes()`
`public mixed`	# `get( string $name )` Override entity get and sets in order to save data to private data store. Override entity get and sets in order to save data to private data store. Parameters `$name` `string` $name Name Returns `mixed` Overrides `ElggEntity::get()`
`public boolean`	# `set( string $name, string $value )` Override entity get and sets in order to save data to private data store. Override entity get and sets in order to save data to private data store. Parameters `$name` `string` $name Name `$value` `string` $value Value Returns `boolean` Overrides `ElggEntity::set()`
`public boolean`	# `setContext( string $context )` Set the widget context Set the widget context Parameters `$context` `string` $context The widget context Returns `boolean` Since 1.8.0
`public string`	# `getContext( )` Get the widget context Get the widget context Returns `string` Since 1.8.0
`public string`	# `getTitle( )` Get the title of the widget Get the title of the widget Returns `string` Since 1.8.0
`public`	# `move( integer $column, integer $rank )` Move the widget Move the widget Parameters `$column` `integer` $column The widget column `$rank` `integer` $rank Zero-based rank from the top of the column Since 1.8.0
`public boolean`	# `saveSettings( array $params )` Saves the widget's settings 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. Parameters `$params` `array` $params An array of name => value parameters Returns `boolean` Since 1.8.0 Warning The values in the parameter array cannot be arrays

Methods inherited from ElggObject
`__construct(), addToSite(), canComment(), getExportableValues(), getSites(), load(), save()`

Methods inherited from ElggEntity
__clone(), __unset(), addRelationship(), annotate(), canAnnotate(), canEdit(), canEditMetadata(), canWriteToContainer(), countAnnotations(), countComments(), countEntitiesFromRelationship(), delete(), deleteAnnotations(), deleteMetadata(), deleteOwnedAnnotations(), deleteOwnedMetadata(), deleteRelationships(), disable(), disableAnnotations(), disableMetadata(), enable(), enableAnnotations(), enableMetadata(), export(), getAccessID(), getAnnotations(), getAnnotationsAvg(), getAnnotationsMax(), getAnnotationsMin(), getAnnotationsSum(), getCalendarEndTime(), getCalendarStartTime(), getContainerEntity(), getContainerGUID(), getEntitiesFromRelationship(), getGUID(), getIconURL(), getLatitude(), getLocation(), getLongitude(), getMetaData(), getObjectFromID(), getOwnerEntity(), getOwnerGUID(), getPrivateSetting(), getSubtype(), getSystemLogID(), getTags(), getTimeUpdated(), getType(), getURL(), getVolatileData(), import(), isEnabled(), isFullyLoaded(), removePrivateSetting(), removeRelationship(), setCalendarTimeAndDuration(), setContainerGUID(), setLatLong(), setLocation(), setMetaData(), setPrivateSetting(), setURL(), setVolatileData()

Methods inherited from ElggData
`__get(), __isset(), __set(), current(), getClassName(), getTimeCreated(), key(), next(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), rewind(), valid()`

Properties inherited from ElggEntity
`$icon_override, $temp_annotations, $temp_metadata, $temp_private_settings, $url_override, $volatile`

Properties inherited from ElggData
`$attributes, $valid`

Magic properties summary
`public read-only string`	`$handler`	# internal, do not use internal, do not use
`public read-only string`	`$column`	# internal, do not use internal, do not use
`public read-only string`	`$order`	# internal, do not use internal, do not use
`public read-only string`	`$context`	# internal, do not use internal, do not use

Magic properties inherited from ElggObject
`$description, $tags, $title`

Magic properties inherited from ElggEntity
`$access_id, $container_guid, $enabled, $guid, $owner_guid, $site_guid, $subtype, $time_created, $time_updated, $type`

Packages

Classes

Class ElggWidget

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Warning