PHP Класс Flarum\Event\GetApiRelationship

This event is fired when a relationship is to be included on an API document. If a handler wishes to control the given relationship, then it should return an instance of Tobscure\JsonApi\Relationship\BuilderInterface.
См. также: AbstractSerializer::hasOne()
См. также: AbstractSerializer::hasMany()
См. также: https://github.com/tobscure/json-api
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$model mixed
$relationship string
$serializer Flarum\Api\Serializer\AbstractSerializer

Открытые методы

Метод Описание
__construct ( AbstractSerializer $serializer, string $relationship, mixed $model )
isRelationship ( string $serializer, string $relationship ) : boolean

Описание методов

__construct() публичный метод

public __construct ( AbstractSerializer $serializer, string $relationship, mixed $model )
$serializer Flarum\Api\Serializer\AbstractSerializer
$relationship string
$model mixed

isRelationship() публичный метод

public isRelationship ( string $serializer, string $relationship ) : boolean
$serializer string
$relationship string
Результат boolean

Описание свойств

$model публичное свойство

public mixed $model
Результат mixed

$relationship публичное свойство

public string $relationship
Результат string

$serializer публичное свойство

public AbstractSerializer,Flarum\Api\Serializer $serializer
Результат Flarum\Api\Serializer\AbstractSerializer