PHP Class Flarum\Event\PrepareApiAttributes

This event is fired when a serialize is constructing an array of resource attributes for API output.
Afficher le fichier Open project: flarum/core Class Usage Examples

Méthodes publiques

Свойство Type Description
$actor Flarum\Core\User
$attributes array The serialized attributes of the resource.
$model object The model being serialized.
$serializer Flarum\Api\Serializer\AbstractSerializer The class doing the serializing.

Méthodes publiques

Méthode Description
__construct ( AbstractSerializer $serializer, object | array $model, array &$attributes )
formatDate ( DateTime $date = null ) : string | null
isSerializer ( string $serializer ) : boolean

Method Details

__construct() public méthode

public __construct ( AbstractSerializer $serializer, object | array $model, array &$attributes )
$serializer Flarum\Api\Serializer\AbstractSerializer The class doing the serializing.
$model object | array The model being serialized.
$attributes array The serialized attributes of the resource.

formatDate() public méthode

public formatDate ( DateTime $date = null ) : string | null
$date DateTime
Résultat string | null

isSerializer() public méthode

public isSerializer ( string $serializer ) : boolean
$serializer string
Résultat boolean

Property Details

$actor public_oe property

public User,Flarum\Core $actor
Résultat Flarum\Core\User

$attributes public_oe property

The serialized attributes of the resource.
public array $attributes
Résultat array

$model public_oe property

The model being serialized.
public object $model
Résultat object

$serializer public_oe property

The class doing the serializing.
public AbstractSerializer,Flarum\Api\Serializer $serializer
Résultat Flarum\Api\Serializer\AbstractSerializer