ForumSerializer  

class ForumSerializer extends AbstractSerializer

Properties

protected ServerRequestInterface $request from AbstractSerializer
protected User $actor from AbstractSerializer
static protected Container $container from AbstractSerializer
static protected array<string,callable[]> $attributeMutators from AbstractSerializer
static protected array<string,array<string,callable>> $customRelations from AbstractSerializer
protected $type <p>{@inheritdoc}</p>
protected Config $config
protected SettingsRepositoryInterface $settings
protected UrlGenerator $url
protected Cloud $assetsFilesystem

Methods

ServerRequestInterface
getRequest()

No description

from AbstractSerializer
setRequest(ServerRequestInterface $request)

No description

from AbstractSerializer
User
getActor()

No description

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

<p>{@inheritdoc}</p>

from AbstractSerializer
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

from AbstractSerializer
getRelationship($model, $name)

<p>{@inheritdoc}</p>

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

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

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

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

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

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

from AbstractSerializer
Relationship|null
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 Container
getContainer()

No description

from AbstractSerializer
static 
setContainer(Container $container)

No description

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

No description

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

No description

from AbstractSerializer
__construct(Config $config, Factory $filesystemFactory, SettingsRepositoryInterface $settings, UrlGenerator $url)

No description

getId($model)

<p>{@inheritdoc}</p>

Relationship
groups($model)

No description

string|null
getLogoUrl()

No description

string|null
getFaviconUrl()

No description

string
getAssetUrl($assetPath)

No description

Relationship|null
actor($model)

No description

Details

in AbstractSerializer at line 57
ServerRequestInterface getRequest()

Return Value

ServerRequestInterface

in AbstractSerializer at line 65
setRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

in AbstractSerializer at line 74
User getActor()

Return Value

User

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

<p>{@inheritdoc}</p>

Parameters

$model
array $fields

at line 72
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

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

Parameters

DateTime $date

Return Value

string|null

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

<p>{@inheritdoc}</p>

Parameters

$model
$name

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

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

Parameters

mixed $model
string $name

Return Value

Relationship|null

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

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

Parameters

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

Return Value

Relationship

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

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

Parameters

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

Return Value

Relationship

in AbstractSerializer at line 194
protected Relationship|null 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|null

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

Parameters

mixed $model
string $relation

Return Value

mixed

in AbstractSerializer at line 238
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 260
protected object resolveSerializerClass(string $class)

Parameters

string $class

Return Value

object

in AbstractSerializer at line 272
static Container getContainer()

Return Value

Container

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

Parameters

Container $container

in AbstractSerializer at line 293
static void addAttributeMutator(string $serializerClass, callable $callback)

Parameters

string $serializerClass
callable $callback

Return Value

void

in AbstractSerializer at line 309
static void setRelationship(string $serializerClass, string $relation, callable $callback)

Parameters

string $serializerClass
string $relation
callable $callback

Return Value

void

at line 53
__construct(Config $config, Factory $filesystemFactory, SettingsRepositoryInterface $settings, UrlGenerator $url)

Parameters

Config $config
Factory $filesystemFactory
SettingsRepositoryInterface $settings
UrlGenerator $url

at line 64
getId($model)

<p>{@inheritdoc}</p>

Parameters

$model

at line 112
protected Relationship groups($model)

Parameters

$model

Return Value

Relationship

at line 120
protected string|null getLogoUrl()

Return Value

string|null

at line 130
protected string|null getFaviconUrl()

Return Value

string|null

at line 137
string getAssetUrl($assetPath)

Parameters

$assetPath

Return Value

string

at line 145
protected Relationship|null actor($model)

Parameters

$model

Return Value

Relationship|null