StructuralElement Class Reference

Inheritance diagram for StructuralElement:

Public Member Functions
	cbBeforeDelete ()
	getImage ()
	setImage ($image)
	getRangeId ()
	isRootNode ()
	isTask ()
	canEdit ($user)
	canRead ($user)
	canVisit ($user)
	hasEditingPermission (User $user, Unit $unit=null)
	countChildren ()
	findAncestors ()
	findUnit ()
	findDescendants (User $user=null)
	countContainers ()
	getImageUrl ()
	copyToRange (User $user, string $rangeId, string $rangeType, string $purpose='', bool $duplicate=false)
	copy (User $user, StructuralElement $parent, string $purpose='', string $recursiveId='', bool $duplicate=false)
	merge (User $user, StructuralElement $target)
	link (User $user, StructuralElement $parent)
	pdfExport ($user, bool $with_children=false)
	createChildrenFromCourseTopics ()
	getRangeCourseId ()
	getRangeName ()
	getRangeIcon ($role)
	getRangeUrl ()
	isRangeAccessible (string $user_id=null)
	getFeedbackElement ()
	isTaskVisible ()
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	getCoursewareUser (string $userId)
static	getCoursewareCourse (string $courseId)
static	getSharedCoursewareUser (string $root_id)
static	findProjects (string $userId, string $purpose='all')
static	findUsersBookmarksByRange (User $user, \Range $range)
static	exportUserData (\StoredUserData $storage)
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	setMariadbDefaultColumnFix (bool $state=true)
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 = []
string	$i18n_class = I18NString::class
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
static	$mariadb_column_default_fix = false

Member Function Documentation

canEdit()

canEdit

(

$user

)

Parameters

User

$user

the user to validate

Returns

bool true if the user may edit this instance

(PHPMD.Superglobals)

canRead()

canRead

(

$user

)

Parameters

mixed

$user

the user to validate

Returns

bool true if the user may read this instance

(PHPMD.Superglobals)

canVisit()

canVisit

(

$user

)

cbBeforeDelete()

cbBeforeDelete

(

)

configure()

static configure (   $config = [] )

staticprotected

copy()

copy	(	User	$user,
		StructuralElement	$parent,
		string	$purpose = '',
		string	$recursiveId = '',
		bool	$duplicate = false
	)

Copies this instance as a child into another structural element.

Parameters

User	$user	this user will be the owner of the copy
StructuralElement	$parent	the target where to copy this instance
string	$purpose	the purpose of copying this instance
string	$recursiveId	the optional mapping id for copying child structural elements upon recursive call to this function

Returns

StructuralElement the copy of this instance

copyToRange()

copyToRange	(	User	$user,
		string	$rangeId,
		string	$rangeType,
		string	$purpose = '',
		bool	$duplicate = false
	)

Copies this instance into another course oder users contents.

Parameters

User	$user	this user will be the owner of the copy
\Range	$parent	the target where to copy this instance

Returns

StructuralElement the copy of this instance

countChildren()

countChildren

(

)

Return the number of children of this instance.

Returns

int the number of children

countContainers()

countContainers

(

)

Counts and returns the number of containers in this structural element.

Returns

int the number of containers of this structural element

createChildrenFromCourseTopics()

createChildrenFromCourseTopics

(

)

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

findAncestors()

findAncestors

(

)

Returns the list of all ancestors traversing up to the root.

Returns

array a list of all ancestors of this instance up to the root

findDescendants()

findDescendants

(

User

$user = null

)

Returns the list of all descendants of this instance in depth-first search order.

Parameters

?User

$user the user whose bookmarked structural elements will be returned

Returns

StructuralElement[] a list of all descendants

findProjects()

static findProjects ( string  $userId, string  $purpose = 'all'  )

static

Returns all projects of a user and a given purpose.

Parameters

string	$userId	the ID of the user
string	$purpose	a string containing the purpose of the projects

Returns

StructuralElement[] a list of projects

findUnit()

findUnit

(

)

findUsersBookmarksByRange()

static findUsersBookmarksByRange ( User  $user, \Range  $range  )

static

Returns all structural elements that a user bookmarked in a range.

Parameters

User	$user	the user whose bookmarked structural elements will be returned
\Range	$range	the range in which the user bookmarked structural elements

Returns

array a list of bookmarked structural elements

getCoursewareCourse()

static getCoursewareCourse ( string  $courseId )

static

Returns the root element of a courseware instance for a course.

Parameters

string

$courseId

the course's id to return the root element for

Returns

?StructuralElement null, if there is none, the root StructuralElement if there is one

getCoursewareUser()

static getCoursewareUser ( string  $userId )

static

Returns the root element of a courseware instance for a user.

Parameters

string

$userId

the user's id to return the root element for

Returns

?StructuralElement null, if there is none, the root StructuralElement if there is one

getFeedbackElement()

getFeedbackElement

(

)

getImage()

getImage

(

)

Returns

null||

getImageUrl()

getImageUrl

(

)

Returns the URL of the image associated to this structural element.

Returns

string|null the image URL, if it exists

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.

getRangeId()

getRangeId

(

)

Returns the ID of the associated range.

Returns

string the id of the range

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.

getSharedCoursewareUser()

static getSharedCoursewareUser ( string  $root_id )

static

hasEditingPermission()

hasEditingPermission	(	User	$user,
		Unit	$unit = null
	)

Parameters

\User | \Seminar_User

$user

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.

isRootNode()

isRootNode

(

)

Returns

bool true, if this object is the root of a courseware, false otherwise

isTask()

isTask

(

)

Returns

bool true, if this object purpose is task, false otherwise

isTaskVisible()

isTaskVisible

(

)

link()

link	(	User	$user,
		StructuralElement	$parent
	)

merge()

merge	(	User	$user,
		StructuralElement	$target
	)

pdfExport()

pdfExport	(		$user,
		bool	$with_children = false
	)

setImage()

setImage

(

$image

)

Parameters

$image

null||

---

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

• lib/models/Courseware/StructuralElement.php