UserSerializer  

class UserSerializer extends BasicUserSerializer

Properties

protected Request $request from AbstractSerializer
protected User $actor from AbstractSerializer
static protected Dispatcher $dispatcher from AbstractSerializer
static protected Container $container from AbstractSerializer
protected $type {@inheritdoc} from BasicUserSerializer

Methods

Request
getRequest()

No description

from AbstractSerializer
setRequest(ServerRequestInterface $request)

No description

from AbstractSerializer
User
getActor()

No description

from AbstractSerializer
getAttributes($model, array $fields = null)

{@inheritdoc}

from AbstractSerializer
array
getDefaultAttributes(User $user)

No description

string|null
formatDate(DateTime $date = null)

No description

from AbstractSerializer
getRelationship($model, $name)

{@inheritdoc}

from AbstractSerializer
Relationship|null
getCustomRelationship(mixed $model, string $name)

Get a custom relationship.

from AbstractSerializer
Relationship
hasOne(mixed $model, string|Closure|SerializerInterface $serializer, string|Closure|null $relation = null)

Get a relationship builder for a has-one relationship.

from AbstractSerializer
Relationship
hasMany(mixed $model, string|Closure|SerializerInterface $serializer, string|null $relation = null)

Get a relationship builder for a has-many relationship.

from AbstractSerializer
Relationship
buildRelationship(mixed $model, string|Closure|SerializerInterface $serializer, string|null $relation = null, bool $many = false)

No description

from AbstractSerializer
mixed
getRelationshipData(mixed $model, string $relation)

No description

from AbstractSerializer
SerializerInterface
resolveSerializer(mixed $serializer, mixed $model, mixed $data)

No description

from AbstractSerializer
object
resolveSerializerClass(string $class)

No description

from AbstractSerializer
static Dispatcher
getEventDispatcher()

No description

from AbstractSerializer
static 
setEventDispatcher(Dispatcher $dispatcher)

No description

from AbstractSerializer
static Container
getContainer()

No description

from AbstractSerializer
static 
setContainer(Container $container)

No description

from AbstractSerializer
Relationship
groups($user)

No description

from BasicUserSerializer

Details

in AbstractSerializer at line 53
Request getRequest()

Return Value

Request

in AbstractSerializer at line 61
setRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

in AbstractSerializer at line 70
User getActor()

Return Value

User

in AbstractSerializer at line 78
getAttributes($model, array $fields = null)

{@inheritdoc}

Parameters

$model
array $fields

at line 18
protected array getDefaultAttributes(User $user)

Parameters

User $user

Return Value

array

in AbstractSerializer at line 105
protected string|null formatDate(DateTime $date = null)

Parameters

DateTime $date

Return Value

string|null

in AbstractSerializer at line 115
getRelationship($model, $name)

{@inheritdoc}

Parameters

$model
$name

in AbstractSerializer at line 131
protected Relationship|null getCustomRelationship(mixed $model, string $name)

Get a custom relationship.

Parameters

mixed $model
string $name

Return Value

Relationship|null

in AbstractSerializer at line 154
Relationship hasOne(mixed $model, string|Closure|SerializerInterface $serializer, string|Closure|null $relation = null)

Get a relationship builder for a has-one relationship.

Parameters

mixed $model
string|Closure|SerializerInterface $serializer
string|Closure|null $relation

Return Value

Relationship

in AbstractSerializer at line 167
Relationship hasMany(mixed $model, string|Closure|SerializerInterface $serializer, string|null $relation = null)

Get a relationship builder for a has-many relationship.

Parameters

mixed $model
string|Closure|SerializerInterface $serializer
string|null $relation

Return Value

Relationship

in AbstractSerializer at line 179
protected Relationship buildRelationship(mixed $model, string|Closure|SerializerInterface $serializer, string|null $relation = null, bool $many = false)

Parameters

mixed $model
string|Closure|SerializerInterface $serializer
string|null $relation
bool $many

Return Value

Relationship

in AbstractSerializer at line 205
protected mixed getRelationshipData(mixed $model, string $relation)

Parameters

mixed $model
string $relation

Return Value

mixed

in AbstractSerializer at line 221
protected SerializerInterface resolveSerializer(mixed $serializer, mixed $model, mixed $data)

Parameters

mixed $serializer
mixed $model
mixed $data

Return Value

SerializerInterface

Exceptions

InvalidArgumentException

in AbstractSerializer at line 243
protected object resolveSerializerClass(string $class)

Parameters

string $class

Return Value

object

in AbstractSerializer at line 255
static Dispatcher getEventDispatcher()

Return Value

Dispatcher

in AbstractSerializer at line 263
static setEventDispatcher(Dispatcher $dispatcher)

Parameters

Dispatcher $dispatcher

in AbstractSerializer at line 271
static Container getContainer()

Return Value

Container

in AbstractSerializer at line 279
static setContainer(Container $container)

Parameters

Container $container

in BasicUserSerializer at line 46
protected Relationship groups($user)

Parameters

$user

Return Value

Relationship