OERHost Class Reference

Inheritance diagram for OERHost:

Public Member Functions
	isMe ()
	fetchPublicKey ()
	askKnownHosts ()
	fetchRemoteSearch ($text=null, $tag=null)
	pushDataToEndpoint ($endpoint, $data)
	fetchItemData (OERMaterial $material)
	getFrontImageURL (OERMaterial $material)
	isReviewable ()
	getAuthorsForMaterial (OERMaterial $material)
	getDownloadURLForMaterial (OERMaterial $material)
Public Member Functions inherited from OERIdentity
	createSignature ($text)
	verifySignature ($text, $signature)
	cbCreateKeysIfNecessary ()
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	thisOne ()
static	findAll ()
static	URIExists ($uri)
static	findBySQL ($sql, $params=[])
static	find ($id)
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	OER_HEADER_PUBLIC_KEY_HASH = "Publickey-Hash"
const	OER_HEADER_SIGNATURE = "RSA-Signature-Base64"
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from OERIdentity
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 OERIdentity
	createKeys ()
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

askKnownHosts()

askKnownHosts

(

)

Ask this host for all hosts that it knows. This is a request to the other host.

configure()

static configure (   $config = [] )

staticprotected

configures this class

Parameters

array

$config

fetchItemData()

fetchItemData

(

OERMaterial

$material

)

Fetches all information of an item from that host. This is a request.

Parameters

string

$foreign_material_id

: foreign id of that oer-material

Returns

array|null : data of that material or null on error.

fetchPublicKey()

fetchPublicKey

(

)

Fetches the public key from an OERHost. Makes a request to the other host.

fetchRemoteSearch()

fetchRemoteSearch	(		$text = null,
			$tag = null
	)

Executes a search request on the host.

Parameters

string | null	$text	: the search string
string | null	$tag	: a tag to search for

find()

static find (   $id )

static

findAll()

static findAll ( )

static

Fetches and returns all known hosts from database.

Returns

array of all OERHost objects

findBySQL()

static findBySQL (   $sql,   $params = []  )

static

getAuthorsForMaterial()

getAuthorsForMaterial

(

OERMaterial

$material

)

getDownloadURLForMaterial()

getDownloadURLForMaterial

(

OERMaterial

$material

)

getFrontImageURL()

getFrontImageURL

(

OERMaterial

$material

)

isMe()

isMe

(

)

Checks if this object is the OERHost of this Stud.IP.

Returns

bool

isReviewable()

isReviewable

(

)

pushDataToEndpoint()

pushDataToEndpoint	(		$endpoint,
			$data
	)

Pushes some data to the foreign OERHost.

Parameters

string	$endpoint	: part behind the host-url like "push_data"
array	$data	: the data to be pushed as an associative array

Returns

bool|CurlHandle|resource

thisOne()

static thisOne ( )

static

Fetches the OERHost of this Stud.IP. If none existed before it will be created and the object returnd.

Returns

OERHost

URIExists()

static URIExists (   $uri )

static

Field Documentation

OER_HEADER_PUBLIC_KEY_HASH

const OER_HEADER_PUBLIC_KEY_HASH = "Publickey-Hash"

OER_HEADER_SIGNATURE

const OER_HEADER_SIGNATURE = "RSA-Signature-Base64"

---

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

• lib/models/OERHost.php