ApiSerializer  

class ApiSerializer implements ExtenderInterface

Methods

__construct(string $serializerClass)

No description

ApiSerializer
attribute(string $name, callable|string $callback)

Add a single attribute to this serializer.

ApiSerializer
attributes(callable|string $callback)

Add to or modify the attributes array of this serializer.

ApiSerializer
hasOne(string $name, string $serializerClass)

Establish a simple hasOne relationship from this serializer to another serializer.

ApiSerializer
hasMany(string $name, string $serializerClass)

Establish a simple hasMany relationship from this serializer to another serializer.

ApiSerializer
relationship(string $name, callable|string $callback)

Add a relationship from this serializer to another serializer.

extend(Container $container, Extension $extension = null)

No description

Details

at line 28
__construct(string $serializerClass)

Parameters

string $serializerClass The ::class attribute of the serializer you are modifying. This serializer should extend from \Flarum\Api\Serializer\AbstractSerializer.

at line 49
ApiSerializer attribute(string $name, callable|string $callback)

Add a single attribute to this serializer.

Parameters

string $name
callable|string $callback The callback can be a closure or an invokable class, and should accept: - $serializer: An instance of this serializer. - $model: An instance of the model being serialized. - $attributes: An array of existing attributes. The callable should return: - The value of the attribute.

Return Value

ApiSerializer

at line 72
ApiSerializer attributes(callable|string $callback)

Add to or modify the attributes array of this serializer.

Parameters

callable|string $callback The callback can be a closure or an invokable class, and should accept: - $serializer: An instance of this serializer. - $model: An instance of the model being serialized. - $attributes: An array of existing attributes. The callable should return: - An array of additional attributes to merge with the existing array. Or a modified $attributes array.

Return Value

ApiSerializer

at line 89
ApiSerializer hasOne(string $name, string $serializerClass)

Establish a simple hasOne relationship from this serializer to another serializer.

This represents a one-to-one relationship.

Parameters

string $name
string $serializerClass

Return Value

ApiSerializer

at line 106
ApiSerializer hasMany(string $name, string $serializerClass)

Establish a simple hasMany relationship from this serializer to another serializer.

This represents a one-to-many relationship.

Parameters

string $name
string $serializerClass

Return Value

ApiSerializer

at line 129
ApiSerializer relationship(string $name, callable|string $callback)

Add a relationship from this serializer to another serializer.

Parameters

string $name
callable|string $callback The callable can be a closure or an invokable class, and should accept: - $serializer: An instance of this serializer. - $model: An instance of the model being serialized. The callable should return: - $relationship: An instance of \Tobscure\JsonApi\Relationship.

Return Value

ApiSerializer

at line 136
extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension