OERMaterial Class Reference

Inheritance diagram for OERMaterial:

Public Member Functions
	cbDeleteFile ()
	cbHashURI ()
	getAuthors ()
	getTopics ()
	setTopics ($tags)
	getFilePath ()
	getDownloadUrl ()
	getFrontImageFilePath ()
	getLogoURL ()
	getIcon (string $role=Icon::ROLE_CLICKABLE)
	isFolder ()
	hasValidPreviewUrl ()
	isImage ()
	isVideo ()
	isAudio ()
	isPDF ()
	isPDFInlineDisplayable ()
	isPresentation ()
	isStudipQuestionnaire ()
	addTag ($tag_name)
	pushDataToIndexServers ($delete=false)
	uploadToTwillo ()
	deleteFromTwillo ()
	fetchData ()
	setUsers ($data)
	calculateRating ()
	isMine ()
	notifyFollowersAboutNewMaterial ()
	autoDetectCategory ()
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	findMine ($user_id=null)
static	findByTag ($tag_name)
static	findByText ($text)
static	findByTagHash ($tag_hash)
static	getFileDataPath ()
static	getImageFileDataPath ()
static	fetchRemoteSearch ($text, $tag=false)
static	embedOERMaterial ($markup, $matches, $contents)
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)

Protected Member Functions
	getFileEnding ()
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)

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

addTag()

addTag

(

$tag_name

)

autoDetectCategory()

autoDetectCategory

(

)

calculateRating()

calculateRating

(

)

cbDeleteFile()

cbDeleteFile

(

)

cbHashURI()

cbHashURI

(

)

configure()

static configure (   $config = [] )

staticprotected

deleteFromTwillo()

deleteFromTwillo

(

)

Removes this material from twillo.de if able.

embedOERMaterial()

static embedOERMaterial (   $markup,   $matches,   $contents  )

static

fetchData()

fetchData

(

)

fetchRemoteSearch()

static fetchRemoteSearch (   $text,   $tag = false  )

static

Searches on remote hosts for the text.

Parameters

	$text
string | false	$tag

findAll()

static findAll ( )

static

findByTag()

static findByTag (   $tag_name )

static

findByTagHash()

static findByTagHash (   $tag_hash )

static

findByText()

static findByText (   $text )

static

findMine()

static findMine (   $user_id = null )

static

getAuthors()

getAuthors

(

)

getDownloadUrl()

getDownloadUrl

(

)

getFileDataPath()

static getFileDataPath ( )

static

getFileEnding()

getFileEnding ( )

protected

getFilePath()

getFilePath

(

)

getFrontImageFilePath()

getFrontImageFilePath

(

)

getIcon()

getIcon

(

string

$role = Icon::ROLE_CLICKABLE

)

Returns an appropriate icon for the material.

Parameters

string

$role

Returns

Icon

getImageFileDataPath()

static getImageFileDataPath ( )

static

getLogoURL()

getLogoURL

(

)

getTopics()

getTopics

(

)

hasValidPreviewUrl()

hasValidPreviewUrl

(

)

Checks the URL scheme of the preview URL (player_url). HTTP, HTTPS, Gopher and Gemini are supported schemes.

Returns

bool True, if the URL scheme matches the allowced ones, false otherwise.

isAudio()

isAudio

(

)

isFolder()

isFolder

(

)

isImage()

isImage

(

)

isMine()

isMine

(

)

isPDF()

isPDF

(

)

isPDFInlineDisplayable()

isPDFInlineDisplayable

(

)

isPresentation()

isPresentation

(

)

isStudipQuestionnaire()

isStudipQuestionnaire

(

)

isVideo()

isVideo

(

)

notifyFollowersAboutNewMaterial()

notifyFollowersAboutNewMaterial

(

)

pushDataToIndexServers()

pushDataToIndexServers

(

$delete = false

)

setTopics()

setTopics

(

$tags

)

setUsers()

setUsers

(

$data

)

uploadToTwillo()

uploadToTwillo

(

)

Uploads this material to twillo.de. This is not actually an upload but rather a link with metadata.

Returns

bool|string : true on success, on failure a text-string as error-message

---

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

• lib/models/OERMaterial.php