class GetApiRelationship

deprecated in beta 15, removed in beta 16

Get an API serializer relationship.

This event is fired when a relationship is to be included on an API document. If a handler wishes to fulfil the given relationship, then it should return an instance of Tobscure\JsonApi\Relationship.

Properties

AbstractSerializer $serializer
string $relationship
mixed $model

Methods

__construct(AbstractSerializer $serializer, string $relationship, mixed $model)

No description

bool
isRelationship(string $serializer, string $relationship)

No description

Details

__construct(AbstractSerializer $serializer, string $relationship, mixed $model)

Parameters

AbstractSerializer $serializer
string $relationship
mixed $model

bool isRelationship(string $serializer, string $relationship)

Parameters

string $serializer
string $relationship

Return Value

bool