Inheritance diagram for LatestFilesWidget:

Collaboration diagram for LatestFilesWidget:

Public Member Functions
	getName ()

	getDescription ()

	mayBeDuplicated ()

	mayBeRemoved ()

	getConfigurationTemplate (Element $element, Response $response)

	saveConfiguration (Element $element, Response $response)

Public Member Functions inherited from BaseWidget
	suitableForRange (\Range $range, $scope=null)

	getContent (\Range $range, $scope)

	getActions (\Range $range, $scope)

	getConfigurationTemplate (Element $element, Response $response)

	saveConfiguration (Element $element, Response $response)

	getListTemplate (Element $element, Response $response)

	getRangeLabel (\FolderType $folder)

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
	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)

Data Fields
const	DEFAULT_LIMIT = 3

Data Fields inherited from Widget
const	EXECUTION_BASE_URL = 'dispatch.php/widgets/execute'

Protected Member Functions
	getFilesAndFolders (\Range $range, $scope)

	hasConfiguration ()

	getDefaultOptions ()

Protected Member Functions inherited from BaseWidget
	getFilesAndFolders (\Range $range, $scope)

	createConfigurationAction ()

	hasConfiguration ()

	getVariables (\Range $range, $scope)

	getDefaultOptions ()

	getFilesController ()

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)

	getTableScheme ()

	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)

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	findByObject (SimpleORMap $object)

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)

Static Public Attributes inherited from SimpleORMap
static	$schemes = null

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

static	configure ($config=array())

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

	$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 widget shows the latest files a user may see.

@license GPL2 or any later version

Since: Stud.IP 4.1

Member Function Documentation

◆ getConfigurationTemplate()

getConfigurationTemplate	(	Element	$element,
		Response	$response
	)

{If this widget has a config action, this method returns the the template to be shown.

Parameters

Element	$element	the widget element whose `config` action shall be shown
Response	$response	a response object given to all widget actions

Returns: mixed Content of the response (might be a string or a flexi template)

@SuppressWarnings(PHPMD.UnusedFormalParameter)}

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Reimplemented from BaseWidget.

Here is the call graph for this function:

◆ getDefaultOptions()

getDefaultOptions ( )

protected

{All widget have options. This method may be overridden to defines default option values.

See also: Widget::setOptions; Widget::getOptions

Returns: array an array of default option values

}

Reimplemented from BaseWidget.

◆ getDescription()

getDescription ( )

{Returns the description of the widget.

Returns: string

}

Implements WidgetInterface.

◆ getFilesAndFolders()

getFilesAndFolders	(	\Range	$range,
			$scope
	)

protected

{Retrieve a list of files and their folders of a range to be displayed in the widget element. Similar to FileManager::getFolderFilesRecursive.

Parameters

Range	$range	The range whose files and folders shall be retrieved
mixed	$scope	Optional scope which was given to BaseWidget::getContent

Returns: mixed[] a mixed array containing instances of FolderType in 'folders' and instances of FileRef in 'files'

}

@SuppressWarnings(PHPMD.UnusedFormalParameter) @SuppressWarnings(PHPMD.Superglobals)

Reimplemented from BaseWidget.

◆ getName()

getName ( )

{Return the name of the widget.

Returns: string

}

Implements WidgetInterface.

◆ hasConfiguration()

hasConfiguration ( )

protected

{If an element of a widget needs a configuration icon in its header bar, this method should return true.

Returns: bool return true if the widget needs a configuration page or false if it does not

}

Reimplemented from BaseWidget.

◆ mayBeDuplicated()

mayBeDuplicated ( )

This is a singleton widget - use at most once per container.

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

Returns: bool

}

Reimplemented from Widget.

◆ mayBeRemoved()

mayBeRemoved ( )

This is a singleton widget - use at most once per container.

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

Returns: bool

}

Reimplemented from Widget.

◆ saveConfiguration()

saveConfiguration	(	Element	$element,
		Response	$response
	)

{If this widget has a config action, this method may store the configuration.

Parameters

Element	$element	the widget element whose `config` action was performed
Response	$response	a response object given to all widget actions

Returns: mixed Content of the response (might be a string or a flexi template)

@SuppressWarnings(PHPMD.UnusedFormalParameter)}

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Reimplemented from BaseWidget.

Here is the call graph for this function:

Field Documentation

◆ DEFAULT_LIMIT

const DEFAULT_LIMIT = 3

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

app/widgets/files_dashboard/LatestFilesWidget.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getConfigurationTemplate()

◆ getDefaultOptions()

◆ getDescription()

◆ getFilesAndFolders()

◆ getName()

◆ hasConfiguration()

◆ mayBeDuplicated()

◆ mayBeRemoved()

◆ saveConfiguration()

Field Documentation

◆ DEFAULT_LIMIT