Base Class Reference

Inheritance diagram for Base:

Collaboration diagram for Base:

Public Member Functions
	__construct ($id=null, $user=null)
	getPermissions ()
	setUser ($user)
	hasUser ()
	getUser ()

Static Public Member Functions
static	detect ()
static	addType ($type, $class)
static	removeType ($type)
static	find ($id)
static	findAll ()
static	create ($type)
static	detectConsumer ($type=null, $request_type=null)

Protected Attributes
	$user = null

Static Protected Attributes
static	$known_types = array()

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

Here is the call graph for this function:

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 create (   $type )

static

Creates a new consumer of the given type.

Parameters

String

$type

Name of the type

Returns

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

Exceptions

Exception

if type is invalid

static detect ( )

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.

Returns

mixed Detected consumer object or false

Reimplemented in HTTP, and Studip.

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

RESTAPI Associated consumer object (derived from consumer base type)

Exceptions

Exception

if either consumer id or consumer type is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

static findAll ( )

static

Returns a list of all known consumers.

Returns

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

Here is the call graph for this function:

getPermissions

(

)

Retrieve the api permissions associated with this consumer.

Returns

RESTAPI 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

Here is the caller graph for this function:

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

RESTAPI Returns instance of self to allow chaining

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$known_types = array()

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