OAuth Class Reference

Inheritance diagram for OAuth:

Collaboration diagram for OAuth:

Public Member Functions
	__construct ($id=null)
	grantAccess ($user_id=null)
	revokeAccess ($user_id=null)
Public Member Functions inherited from Base
	__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	getServer ()
static	getOAuthId ($user_id)
Static Public Member Functions inherited from Base
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	find ($id)
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 ($name, $arguments)

Protected Member Functions
	before_store ()
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)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)

Static Protected Member Functions
static	configure ($config=[])
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])
static	config ($key)

Additional Inherited Members
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Attributes inherited from Base
	$user = null
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = []
	$serialized_fields = []
	$alias_fields = []
	$i18n_fields = []
	$additional_fields = []
	$relations = []
	$has_many = []
	$has_one = []
	$belongs_to = []
	$has_and_belongs_to_many = []
	$registered_callbacks = []
	$known_slots = []
	$notification_map = []
	$additional_data = []
	$getter_setter_map = []
Static Protected Attributes inherited from Base
static	$known_types = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Detailed Description

OAuth consumer for the rest api

Author

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

Since

Stud.IP 3.0

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

SimpleORMap constructor, registers neccessary callbacks.

Reimplemented from SimpleORMap.

Here is the call graph for this function:

Member Function Documentation

before_store()

before_store ( )

protected

"Before store" trigger. Creates a clone of the consumer in the tables for the vendor oauth library.

Here is the call graph for this function:

configure()

static configure (   $config = [] )

staticprotected

Configures the model.

Parameters

array

$config

Configuration array

Reimplemented from Base.

detect()

static detect (   $request_type = null )

static

Detects whether the request is authenticated via OAuth.

Parameters

mixed

$request_type

Type of request (optional; defaults to any)

Returns

mixed Instance of self if authentication was detected, false otherwise

Reimplemented from Base.

Here is the call graph for this function:

getOAuthId()

static getOAuthId (   $user_id )

static

Maps a user to an oauth id. This is neccessary due to the fact that the oauth lib works with different ids than Stud.IP.

Parameters

String

$user_id

Id of the user to get an oauth id for

Returns

String The mapped oauth id

Here is the call graph for this function:

Here is the caller graph for this function:

getServer()

static getServer ( )

static

Returns a singleton instance of the oauth server.

Returns

OAuthServer The server object

Here is the caller graph for this function:

grantAccess()

grantAccess

(

$user_id = null

)

Grant oauth access for a user.

Parameters

mixed

$user_id

Specific user id or null to default to the injected user

Exceptions

Exception

If no valid user is present

Here is the call graph for this function:

revokeAccess()

revokeAccess

(

$user_id = null

)

Revoke oauth access from a user.

Parameters

mixed

$user_id

Specific user id or null to default to the injected user

Exceptions

Exception

If no valid user is present

Here is the call graph for this function:

---

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

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