Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
JsonApi\Routes Namespace Reference

Namespaces

 Blubber
 
 ConfigValues
 
 Consultations
 
 CourseMemberships
 
 Courses
 
 Courseware
 
 Events
 
 Feedback
 
 Files
 
 Forum
 
 InstituteMemberships
 
 Institutes
 
 Messages
 
 News
 
 Schedule
 
 Studip
 
 StudyAreas
 
 Users
 
 Wiki
 

Data Structures

class  ActivityStreamShow
 
class  DiscoveryIndex
 
class  RelationshipsController
 
class  SemestersIndex
 
class  SemestersShow
 

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

JsonApi\Routes\canShowActivityStream ( \User  $observer,
string  $userId 
)
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
$requestRequest der eingehende Request
Returns
mixed gibt den JSON-kodierten Wert in geeignetem PHP-Typ zurück (siehe json_decode)
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$requestder Request, der das resource document enthält
any$databeliebige Daten, die an validateResourceDocument durchgereicht werden
Returns
array das dekodierte resource document als PHP-Array
Exceptions
UnprocessableEntityExceptionfalls bei der Validierung ein Fehler auftrat
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$jsondas dekodierte JSON des resource document als PHP-Array
any$databeliebige Daten, die an validate übergeben wurden
Returns
mixed im Fehlerfall ein String, der den Fehler beschreibt; ansonsten nichts bzw. null
JsonApi\Routes\validateResourceLinkage (   $json,
  $path,
  $type,
  $toManyRelation = false,
  $mayBeEmpty = false 
)
protected
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
$jsonarray das JSON-Array
$pathstring der Pfad in das JSON-Array
$optionalTypemixed 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

trait ValidationTrait
Initial value:
{
use ArrayHelperTrait