LegacyWidget Class Reference

Inheritance diagram for LegacyWidget:

Collaboration diagram for LegacyWidget:

Public Member Functions
	__construct ($id, StudIPPlugin $plugin)
	getDescription ()
	getName ()
	getTitle ()
	getActions (Range $range, $scope)
	getContent (Range $range, $scope)
	mayBeDuplicated ()
	hasLayout ()
	url_for ($to, $parameters=[])
Public Member Functions inherited from Widget
	suitableForRange (Range $range, $scope=null)
	connectWithElement (Element $element)
	getElement ()
	url_for ($to, $parameters=[])
	getTitle ()
	setOptions (array $options=[])
	getOptions ()
	hasLayout ()
	mayBeRemoved ()
	mayBeDuplicated ()
	getActions (Range $range, $scope)
	getTemplate ($name, array $variables=[])
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()
Public Member Functions inherited from WidgetInterface
	getId ()

Additional Inherited Members
Static Public Member Functions inherited from Widget
static	create ($id, Range $range_to_check=null)
static	findAll ()
static	registerWidget (Widget $widget)
static	listForRange (Range $range, $scope=null)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=array())
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=array())
static	findOneBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=array())
static	findMany ($pks=array(), $order='', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)
Data Fields inherited from Widget
const	EXECUTION_BASE_URL = 'dispatch.php/widgets/execute'
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)
Static Protected Member Functions inherited from Widget
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())
static	config ($key)
Protected Attributes inherited from SimpleORMap
	$content = array()
	$content_db = array()
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$serialized_fields = array()
	$alias_fields = array()
	$i18n_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks = array()
	$known_slots = array()
	$notification_map = array()
	$additional_data = array()
	$getter_setter_map = array()
Static Protected Attributes inherited from SimpleORMap
static	$config = array()
static	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')

Detailed Description

This model represents a widget element that is positioned in a container and contains a widget plus additional settings/options.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version

Since

Stud.IP 4.1

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
		StudIPPlugin	$plugin
	)

Constructs this legacy widget and connects it with the according Stud.IP plugin.

Parameters

mixed	$id	Id of the widget
StudIPPlugin	$plugin	Stud.IP plugin that represents the legacy widget

Member Function Documentation

getActions()

getActions	(	Range	$range,
			$scope
	)

Returns the actions for this widget. The actions are mapped from the icons attribute of the Stud.IP plugin's "icons" attribute which was formerly used to create the actions in the upper right corner of a widget (position is still the same, just the handling has changed).

Parameters

Range	$range	Range to get the actions for
string	$scope	Scope to get the actions for

Implements WidgetInterface.

Here is the call graph for this function:

getContent()

getContent	(	Range	$range,
			$scope
	)

Return the content of the widget. The content is the rendered template which is returned from the Stud.IP plugin.

Parameters

Range	$range	Range to get the content for
string	$scope	Scope to get the content for

Returns

string

Implements WidgetInterface.

Here is the call graph for this function:

getDescription()

getDescription

(

)

Returns the description of this widget. The description is taken from the manifest of the Stud.IP plugin.

Returns

string

Implements WidgetInterface.

getName()

getName

(

)

Returns the name of this widget. The name is the name of the Stud.IP plugin.

Returns

string

Implements WidgetInterface.

getTitle()

getTitle

(

)

Returns the title of the widget which is either a self defined title or the name of the Stud.IP plugin.

Returns

string

Implements WidgetInterface.

hasLayout()

hasLayout

(

)

Returns whether the widget should have a layout or not.

Returns

bool

Todo:

Really neccessary? Seems to got lost in development

Implements WidgetInterface.

mayBeDuplicated()

mayBeDuplicated

(

)

Returns whether this widget instance may be duplicated or used more than once in a container.

Returns

bool

Implements WidgetInterface.

url_for()

url_for	(		$to,
			$parameters = []
	)

Returns a url for an action that is related to this widget. This method is variadic in such a way that you may pass as many strings as you like which will be concatenated to a valid url chunk. Only if the last passed parameter is an array, it will be used as the parameters for the generated url.

Parameters

String	$to	URL chunk to generate complete url for
array	$parameters	Additional url parameters

Implements WidgetInterface.

Here is the call graph for this function:

---

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

• lib/models/Widgets/LegacyWidget.php