JsonApi\Routes Namespace Reference

Namespaces
	Avatar
	Blubber
	Clipboards
	ConfigValues
	Consultations
	CourseMemberships
	Courses
	Courseware
	Events
	Feedback
	Files
	Forum
	Holidays
	InstituteMemberships
	Institutes
	Lti
	Messages
	News
	RangeTree
	Schedule
	StockImages
	Studip
	StudyAreas
	Tree
	Users
	Wiki

Data Structures
class	ActivityStreamShow
class	DiscoveryIndex
class	RelationshipsController
class	SemestersIndex
class	SemestersShow
class	StatusgroupShow

Functions
	canShowActivityStream (\User $observer, string $userId)
	validateResourceDocument ($json, $data)
	validate (Request $request, $data=null)
	decodeRequestBody (Request $request)
	validateResourceObject ($json, $path, $optionalType=null)
	validateResourceLinkage ($json, $path, $type, $toManyRelation=false, $mayBeEmpty=false)

Variables
trait	ValidationTrait

Function Documentation

canShowActivityStream()

JsonApi\Routes\canShowActivityStream	(	\User	$observer,
		string	$userId
	)

decodeRequestBody()

JsonApi\Routes\decodeRequestBody ( Request  $request )

protected

Dekodiert den im Body des Requests enthaltenen JSON-String und gibt einen Wert im entsprechenden PHP-Typ zurück.

Parameters

$request

Request der eingehende Request

Returns

mixed gibt den JSON-kodierten Wert in geeignetem PHP-Typ zurück (siehe json_decode)

validate()

JsonApi\Routes\validate ( Request  $request,   $data = null  )

protected

Wenn man das resource document, das im body des Requests mitgeschickt wurde, validieren möchte, ruft man in seinem JsonApiController diese Funktion auf. Diese Funktion dekodiert dann den das resource document aus dem Request und ruft dann damit die im JsonApiController implementierte Funktion validateResourceDocument auf. Hat validateResourceDocument einen Fehler gemeldet, wird eine UnprocessableEntityException geworfen; ansonsten gibt diese Funktion das dekodierte resource document als PHP-Array zurück.

Parameters

Request	$request	der Request, der das resource document enthält
any	$data	beliebige Daten, die an validateResourceDocument durchgereicht werden

Returns

array das dekodierte resource document als PHP-Array

Exceptions

UnprocessableEntityException

falls bei der Validierung ein Fehler auftrat

validateResourceDocument()

JsonApi\Routes\validateResourceDocument (   $json,   $data  )

abstractprotected

In dieser Funktion wird die tatsächliche Validierung implementiert. Man erhält das resource document bereits dekodiert als Array und kann anhand dessen die Validität prüfen.

Will man einen Fehler melden, muss die Funktion diesen als String zurückgeben. Wenn das resource document valide ist, gibt man nichts bzw. null zurück.

Parameters

array	$json	das dekodierte JSON des resource document als PHP-Array
any	$data	beliebige Daten, die an validate übergeben wurden

Returns

mixed im Fehlerfall ein String, der den Fehler beschreibt; ansonsten nichts bzw. null

validateResourceLinkage()

JsonApi\Routes\validateResourceLinkage (   $json,   $path,   $type,   $toManyRelation = false,   $mayBeEmpty = false  )

protected

validateResourceObject()

JsonApi\Routes\validateResourceObject (   $json,   $path,   $optionalType = null  )

protected

Überprüft, ob der Wert eines Pfads in einem JSON-Array ein gültiges JSON-API Resource Object ist. Optional wird auch der type des Resource Objects geprüft.

Parameters

$json	array das JSON-Array
$path	string der Pfad in das JSON-Array
$optionalType	mixed optionaler String, der den Typ des Resource Objects beschreibt

Returns

bool TRUE, wenn es sich um das gesuchte (und optional typgeprüfte) Resource Object handelt, sonst FALSE

Variable Documentation

ValidationTrait

trait ValidationTrait

Initial value:

{
    use ArrayHelperTrait