AbstractSerializer  

abstract class AbstractSerializer extends AbstractSerializer

Properties

protected $request
protected $actor
static protected $container
static protected array<string,callable[]> $attributeMutators
static protected array<string,array<string,callable>> $customRelations

Methods

ServerRequestInterface
getRequest()

No description

void
setRequest(ServerRequestInterface $request)

No description

User
getActor()

No description

array
getAttributes(mixed $model, array $fields = null)

No description

array
getDefaultAttributes(object|array $model)

<p>Get the default set of serialized attributes for a model.</p>

string|null
formatDate(DateTime $date = null)

No description

getRelationship($model, $name)

No description

Relationship|null
getCustomRelationship(object|array $model, string $name)

<p>Get a custom relationship.</p>

Relationship|null
hasOne(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null)

<p>Get a relationship builder for a has-one relationship.</p>

Relationship|null
hasMany(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null)

<p>Get a relationship builder for a has-many relationship.</p>

Relationship|null
buildRelationship(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null, bool $many = false)

No description

mixed
getRelationshipData(object|array $model, string $relation)

No description

SerializerInterface
resolveSerializer(SerializerInterface|Closure|string $serializer, object|array $model, mixed $data)

No description

object
resolveSerializerClass(string $class)

No description

static Container
getContainer()

No description

static void
setContainer(Container $container)

No description

static void
addAttributeMutator(string $serializerClass, callable $callback)

No description

static void
setRelationship(string $serializerClass, string $relation, callable $callback)

No description

Details

at line 43
ServerRequestInterface getRequest()

Return Value

ServerRequestInterface

at line 48
void setRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

void

at line 54
User getActor()

Return Value

User

at line 59
array getAttributes(mixed $model, array $fields = null)

Parameters

mixed $model
array $fields

Return Value

array

at line 84
abstract protected array getDefaultAttributes(object|array $model)

<p>Get the default set of serialized attributes for a model.</p>

Parameters

object|array $model

Return Value

array

at line 86
string|null formatDate(DateTime $date = null)

Parameters

DateTime $date

Return Value

string|null

at line 91
getRelationship($model, $name)

Parameters

$model
$name

at line 103
protected Relationship|null getCustomRelationship(object|array $model, string $name)

<p>Get a custom relationship.</p>

Parameters

object|array $model
string $name

Return Value

Relationship|null

at line 127
Relationship|null hasOne(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null)

<p>Get a relationship builder for a has-one relationship.</p>

Parameters

object|array $model
SerializerInterface|Closure|string $serializer
string $relation

Return Value

Relationship|null

at line 135
Relationship|null hasMany(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null)

<p>Get a relationship builder for a has-many relationship.</p>

Parameters

object|array $model
SerializerInterface|Closure|string $serializer
string $relation

Return Value

Relationship|null

at line 140
protected Relationship|null buildRelationship(object|array $model, SerializerInterface|Closure|string $serializer, string $relation = null, bool $many = false)

Parameters

object|array $model
SerializerInterface|Closure|string $serializer
string $relation
bool $many

Return Value

Relationship|null

at line 163
protected mixed getRelationshipData(object|array $model, string $relation)

Parameters

object|array $model
string $relation

Return Value

mixed

at line 175
protected SerializerInterface resolveSerializer(SerializerInterface|Closure|string $serializer, object|array $model, mixed $data)

Parameters

SerializerInterface|Closure|string $serializer
object|array $model
mixed $data

Return Value

SerializerInterface

Exceptions

InvalidArgumentException

at line 193
protected object resolveSerializerClass(string $class)

Parameters

string $class

Return Value

object

at line 202
static Container getContainer()

Return Value

Container

at line 210
static void setContainer(Container $container)

Parameters

Container $container

Return Value

void

at line 218
static void addAttributeMutator(string $serializerClass, callable $callback)

Parameters

string $serializerClass
callable $callback

Return Value

void

at line 230
static void setRelationship(string $serializerClass, string $relation, callable $callback)

Parameters

string $serializerClass
string $relation
callable $callback

Return Value

void