Base Class Reference

Inheritance diagram for Base:

Public Member Functions
	__construct ($id=null, $user=null)
	getPermissions ()
	setUser ($user)
	hasUser ()
	getUser ()
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)
	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	detect ($request_type=null)
static	addType ($type, $class)
static	removeType ($type)
static	find ($id)
static	findAll ()
static	create ($type)
static	detectConsumer ($type=null, $request_type=null)
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	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 ($name, $arguments)

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)

Protected Attributes
	$user = null
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []

Static Protected Attributes
static	$known_types = []
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

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)

Detailed Description

Base consumer class for the rest api

Consumers provide means for authenticating a user and the access permissions for routes are bound to specific consumers.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL 2 or later

Since

Stud.IP 3.0

Constructor & Destructor Documentation

__construct	(		$id = null,
			$user = null
	)

Extended SimpleORMap constructor. A certain user can be injected upon creation.

Parameters

mixed	$id	Id of the consumer or null to create a new one
mixed	$user	Either a user object or id to inject to the consumer or null if no user should be injected

Member Function Documentation

static addType (   $type,   $class  )

static

Add a consumer type to the list of consumer types

Parameters

String	$type	Name of the type
String	$class	Associated consumer class

static configure (   $config = [] )

staticprotected

Configures the model.

Parameters

array

$config

Configuration array

static create (   $type )

static

Creates a new consumer of the given type.

Parameters

String

$type

Name of the type

Returns

Consumer object of the given (derived from consumer base type)

Exceptions

\Exception

if type is invalid

static detect (   $request_type = null )

staticabstract

Each consumer type has to implement a detect feature which should extract crucial information from the request and return an instance of itself if the consumer detects a valid signature it can respond to.

Parameters

mixed

$request_type

Type of request (optional; defaults to any)

Returns

mixed Detected consumer object or false

static detectConsumer (   $type = null,   $request_type = null  )

static

This method is used to detect a consumer (of a specific type) by executing the detect method on all known consumer types.

Parameters

mixed	$type	Name of the type (optional; defaults to all types)
mixed	$request_type	Type of request (optional; defaults to any)

Returns

mixed Either the detected consumer or false if no consumer was detected

Exceptions

\Exception

if type is invalid

static find (   $id )

static

Overloaded find method. Will return a concrete specialized consumer object of the associated type.

Parameters

String

$id

Id of the consumer

Returns

Associated consumer object (derived from consumer base type)

Exceptions

\Exception

if either consumer id or consumer type is invalid

static findAll ( )

static

Returns a list of all known consumers.

Returns

array List of all known consumers (as specialized consumer objects)

getPermissions

(

)

Retrieve the api permissions associated with this consumer.

Returns

Permission object for this consumer

getUser

(

)

Return the injected user.

Parameters

mixed

User object or false if no user was injected

hasUser

(

)

Returns whether the consumer has an injected user or not.

Returns

bool True if a valid user is found, false otherwise

static removeType (   $type )

static

Removes a consumer type from the list of consumer types

Parameters

String

$type

Name of the type

setUser

(

$user

)

Inject a user to this consumer. Injecting in this context refers to "having a user authenticated by this consumer".

Parameters

mixed

$user

Either a user object or a user id

Returns

Returns instance of self to allow chaining

Field Documentation

$known_types = []

staticprotected

Stores all known consumer types

$user = null

protected

Contains user information

---

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

• lib/classes/restapi/consumer/Base.php