Unit Class Reference

Inheritance diagram for Unit:

Public Member Functions
	cbBeforeDelete ()
	canRead (\User $user)
	canEdit (\User $user)
	copy (\User $user, string $rangeId, string $rangeType, array $modified=null)
	updatePositionsAfterDelete ()
	hasRootLayout ()
	findOrCreateFirstElement ()
	getRangeCourseId ()
	getRangeName ()
	getRangeIcon ($role)
	getRangeUrl ()
	isRangeAccessible (string $user_id=null)
	getFeedbackElement ()
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)
	isRelation ($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 FeedbackRange
	getId ()

Static Public Member Functions
static	findCoursesUnits (\Course $course)
static	findUsersUnits (\User $user)
static	exportUserData (\StoredUserData $storage)
static	getNewPosition ($range_id)
static	updatePositions ($range, $positions)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	exists ($id)
static	countBySql ($sql='1', $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic (string $name, array $arguments)
Static Public Member Functions inherited from PrivacyObject
static	exportUserData (StoredUserData $storage)

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	db_table ()
static	db_fields ()
static	pk ()
static	default_values ()
static	serialized_fields ()
static	alias_fields ()
static	i18n_fields ()
static	additional_fields ()
static	has_many ()
static	has_one ()
static	belongs_to ()
static	has_and_belongs_to_many ()
static	registered_callbacks ()
static	known_slots ()
static	notification_map ()
static	getter_setter_map ()
static	configure ($config=[])
static	config ($key)
static	registerCallback ($types, $cb)
static	unregisterCallback ($types, $cb)

Additional Inherited Members
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
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)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
static	$performs_batch_operation = false

Member Function Documentation

canEdit()

canEdit

(

\User

$user

)

canRead()

canRead

(

\User

$user

)

cbBeforeDelete()

cbBeforeDelete

(

)

configure()

static configure (   $config = [] )

staticprotected

copy()

copy	(	\User	$user,
		string	$rangeId,
		string	$rangeType,
		array	$modified = null
	)

exportUserData()

static exportUserData ( \StoredUserData  $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData

$storage

object to store data into

findCoursesUnits()

static findCoursesUnits ( \Course  $course )

static

findOrCreateFirstElement()

findOrCreateFirstElement

(

)

findUsersUnits()

static findUsersUnits ( \User  $user )

static

getFeedbackElement()

getFeedbackElement

(

)

getNewPosition()

static getNewPosition (   $range_id )

static

getRangeCourseId()

getRangeCourseId

(

)

Returns the course id of FeedbackRange object instance

Returns

string course_id

Implements FeedbackRange.

getRangeIcon()

getRangeIcon

(

$role

)

Returns the icon object that shall be used with the FeedbackRange object instance.

Parameters

string

$role

role of icon

Returns

Icon icon for the FeedbackRange object instance.

Implements FeedbackRange.

getRangeName()

getRangeName

(

)

Returns a human-friendly representation of the FeedbackRange object instance's name.

Returns

string A human-friendly name for the FeedbackRange object instance.

Implements FeedbackRange.

getRangeUrl()

getRangeUrl

(

)

Returns the URL of FeedbackRange view, where the object instance is visible together with the related feedback element(s).

Returns

string Path that is usable with the url_for and link_for methods.

Implements FeedbackRange.

hasRootLayout()

hasRootLayout

(

)

isRangeAccessible()

isRangeAccessible

(

string

$user_id = null

)

Returns the accessebility of FeedbackRange object instance for current active user

Parameters

string

$user_id

optional; use this ID instead of $GLOBALS['user']->id

Returns

bool range object accessebility

Implements FeedbackRange.

updatePositions()

static updatePositions (   $range,   $positions  )

static

updatePositionsAfterDelete()

updatePositionsAfterDelete

(

)

---

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

• lib/models/Courseware/Unit.php