Documentation

RelNotFoundException extends Exception
in package

Raised when trying to get a link or an embedded resource by a non-existing relation type (Rel).

Table of Contents

$availableRels  : mixed
$missingRel  : mixed
__construct()  : mixed
getAvailableRels()  : array<string|int, mixed>
Returns the list of available relation types available in the _links or _embedded property the given Rel was missing in.
getMissingRel()  : Rel

Properties

Methods

__construct()

public __construct(string|Rel $missingRel, array<string|int, mixed> $availableRels) : mixed
Parameters
$missingRel : string|Rel

The missing relation type

$availableRels : array<string|int, mixed>

The list of available relation types

Return values
mixed

getAvailableRels()

Returns the list of available relation types available in the _links or _embedded property the given Rel was missing in.

public getAvailableRels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMissingRel()

public getMissingRel() : Rel
Return values
Rel

the missing relation type

Search results