ContentTermsOfUse Class Reference

Inheritance diagram for ContentTermsOfUse:

Public Member Functions
	cbCheckDefault ()
	validate ()
	isDownloadable ($context_id, $context_type, $allow_owner=true, $user_id=null)
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 ()

Static Public Member Functions
static	findAll ()
static	find ($id)
static	findOrBuild ($id)
static	findDefault ()
static	getConditions ()
static	describeCondition ($condition)
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)

Data Fields
const	DOWNLOAD_CONDITION_NONE = 0
const	DOWNLOAD_CONDITION_CLOSED_GROUPS = 1
const	DOWNLOAD_CONDITION_OWNER_ONLY = 2
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

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

cbCheckDefault()

cbCheckDefault

(

)

configure()

static configure (   $config = [] )

staticprotected

Parameters

array

$config

describeCondition()

static describeCondition (   $condition )

static

Returns the textual representation of a condition.

Parameters

int

$condition

Returns

string

find()

static find (   $id )

static

Parameters

$id

string

Returns

ContentTermsOfUse

findAll()

static findAll ( )

static

Returns

ContentTermsOfUse[]

findDefault()

static findDefault ( )

static

Returns

ContentTermsOfUse

findOrBuild()

static findOrBuild (   $id )

static

Parameters

$id

string

Returns

ContentTermsOfUse

getConditions()

static getConditions ( )

static

Returns a list of all valid conditions.

Returns

array

isDownloadable()

isDownloadable	(		$context_id,
			$context_type,
			$allow_owner = true,
			$user_id = null
	)

Determines if a user is permitted to download a file.

Depening on the value of the download_condition attribute a decision is made regarding the permission of the given user to download a file, given by one of its associated FileRef objects.

The folder condition can have the values 0, 1 and 2.

• 0 means that there are no conditions for downloading, therefore the file is downloadable by anyone.
• 1 means that the file is only downloadable inside a closed group. Such a group can be a course or study group with closed admission. In this case this method checks if the user is a member of the course or study group.
• 2 means that the file is only downloadable for the owner. The user's ID must therefore match the user_id attribute of the FileRef object.

validate()

validate

(

)

Validates this entry

Returns

array with error messages, if it's empty everyhting is fine

Field Documentation

DOWNLOAD_CONDITION_CLOSED_GROUPS

const DOWNLOAD_CONDITION_CLOSED_GROUPS = 1

DOWNLOAD_CONDITION_NONE

const DOWNLOAD_CONDITION_NONE = 0

DOWNLOAD_CONDITION_OWNER_ONLY

const DOWNLOAD_CONDITION_OWNER_ONLY = 2

---

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

• lib/models/ContentTermsOfUse.php