Inheritance diagram for Widget:

Collaboration diagram for Widget:

Public Member Functions
	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
	suitableForRange (Range $range, $scope=null)

	getId ()

	getName ()

	getDescription ()

	getTitle ()

	getContent (Range $range, $scope)

	connectWithElement (Element $element)

	getElement ()

	url_for ($to, $parameters=[])

	setOptions (array $options=[])

	getOptions ()

	hasLayout ()

	mayBeRemoved ()

	mayBeDuplicated ()

	getActions (Range $range, $scope)

Static Public Member Functions
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
const	EXECUTION_BASE_URL = 'dispatch.php/widgets/execute'

Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())

static	config ($key)

Additional Inherited Members
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)

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 an abstract widget.

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

Since: Stud.IP 4.1

Member Function Documentation

◆ configure()

static configure ( $config = [] )

staticprotected

Configures the model.

Parameters

array $config Configuration array

Reimplemented from SimpleORMap.

◆ connectWithElement()

connectWithElement ( Element $element )

Connect this widget with an actual element of a container.

Parameters

Element $element Element to connect with

Implements WidgetInterface.

◆ create()

static create	(		$id,
		Range	$range_to_check = `null`
	)

static

Creates a widget by id.

Parameters

int	$id	Id of the widgtet
mixed	$range	Optional range to check suitability for

Returns: Widget subclass

Exceptions

Exception when widget is not enabled and $allow_disabled is false

Here is the call graph for this function:

◆ findAll()

static findAll ( )

static

Return all available widgets.

Returns: array of widget instances

◆ getActions()

getActions	(	Range	$range,
			$scope
	)

Returns a list of possible widget actions.

Returns: array of WidgetAction

Implements WidgetInterface.

Reimplemented in LegacyWidget.

◆ getElement()

getElement ( )

Returns the connected element of this widget.

Returns: Element or null if no element has been set.

Implements WidgetInterface.

◆ getOptions()

getOptions ( )

Returns the options for this widget instance. This might and should be overwritten by a subclass.

Returns: mixed

Implements WidgetInterface.

Here is the caller graph for this function:

◆ getTemplate()

getTemplate	(		$name,
		array	$variables = `[]`
	)

Opens and returns a template. Optionally, variables can be assigned.

Parameters

string	$name	Name of the template
array	$variables	Optional initial variables

Returns: Flexi_Template

Here is the caller graph for this function:

◆ getTitle()

getTitle ( )

Returns the title of the widgets. Defaults to specified name.

Returns: string

Implements WidgetInterface.

Reimplemented in MyPublicFilesWidget, and LegacyWidget.

Here is the caller graph for this function:

◆ 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.

Reimplemented in LegacyWidget.

◆ listForRange()

static listForRange	(	Range	$range,
			$scope = `null`
	)

static

Lists all available widgets for a certain range.

Parameters

Range	$range	Range to list widgets for
mixed	$scope	Optional scope to test for

Returns: array of widgets

Todo:: Permission check

Here is the call graph for this function:

◆ mayBeDuplicated()

mayBeDuplicated ( )

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

Returns: bool

Implements WidgetInterface.

Reimplemented in LatestFilesWidget, MyPublicFilesWidget, and LegacyWidget.

◆ mayBeRemoved()

mayBeRemoved ( )

Returns whether this widget instance may be removed from a container.

Returns: bool

Implements WidgetInterface.

Reimplemented in LatestFilesWidget, and MyPublicFilesWidget.

◆ registerWidget()

static registerWidget ( Widget $widget )

static

Registers a widget for use.

Parameters

Widget $widget Widget to register

Returns: Widget subclass (copy of given widget)

Here is the call graph for this function:

◆ setOptions()

setOptions ( array $options = [] )

Sets the defined options for this widget instance. This method is usually only called when a widget container is loaded and the elements are initialized.

Parameters

array $options

Implements WidgetInterface.

Here is the caller graph for this function:

◆ suitableForRange()

suitableForRange	(	Range	$range,
			$scope = `null`
	)

Returns whether this widget is suitable for the given range and scope.

Parameters

Range	$range	Range to check
mixed	$scope	Scope to check (may be null)

Returns: bool indicating whether this widget is suitable

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.

Reimplemented in LegacyWidget.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ EXECUTION_BASE_URL

const EXECUTION_BASE_URL = 'dispatch.php/widgets/execute'

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

lib/models/Widgets/Widget.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ configure()

◆ connectWithElement()

◆ create()

◆ findAll()

◆ getActions()

◆ getElement()

◆ getOptions()

◆ getTemplate()

◆ getTitle()

◆ hasLayout()

◆ listForRange()

◆ mayBeDuplicated()

◆ mayBeRemoved()

◆ registerWidget()

◆ setOptions()

◆ suitableForRange()

◆ url_for()

Field Documentation

◆ EXECUTION_BASE_URL