mirror of
https://github.com/flarum/framework.git
synced 2025-05-21 22:36:01 +08:00
a426fa6560
- An API action handles a Flarum\Api\Request, which is a simple object containing an array of params, the actor, and optionally an HTTP request object - Most API actions use SerializeAction as a base, which parses request input according to the JSON-API spec (creates a JsonApiRequest object), runs the child class method to get data, then serializes it and assigns it to a JsonApiResponse (standard HTTP response with a Tobscure\JsonApi\Document as content) - The JSON-API request input parsing is subject to restrictions as defined by public static properties on the action (i.e. extensible) - Also the actor is given to the serializer instance now, instead of being a static property
91 lines
2.8 KiB
PHP
91 lines
2.8 KiB
PHP
<?php namespace Flarum\Api\Serializers;
|
|
|
|
use Tobscure\JsonApi\SerializerAbstract;
|
|
use Flarum\Api\Events\SerializeAttributes;
|
|
use Flarum\Api\Events\SerializeRelationship;
|
|
use Flarum\Support\Actor;
|
|
use Closure;
|
|
|
|
/**
|
|
* A base serializer to call Flarum events at common serialization points.
|
|
*/
|
|
abstract class BaseSerializer extends SerializerAbstract
|
|
{
|
|
protected $actor;
|
|
|
|
public function __construct(Actor $actor, $include = null, $link = null)
|
|
{
|
|
parent::__construct($include, $link);
|
|
|
|
$this->actor = $actor;
|
|
}
|
|
|
|
/**
|
|
* Fire an event to allow custom serialization of attributes.
|
|
*
|
|
* @param mixed $model The model to serialize.
|
|
* @param array $attributes Attributes that have already been serialized.
|
|
* @return array
|
|
*/
|
|
protected function extendAttributes($model, &$attributes = [])
|
|
{
|
|
event(new SerializeAttributes($this, $model, $attributes));
|
|
|
|
return $attributes;
|
|
}
|
|
|
|
protected function relationship($serializer, $relation = null, $many = false)
|
|
{
|
|
// Get the relationship name from the stack trace.
|
|
if (is_null($relation)) {
|
|
list(, , $caller) = debug_backtrace(false, 3);
|
|
$relation = $caller['function'];
|
|
}
|
|
|
|
return function ($model, $include, $links) use ($serializer, $many, $relation) {
|
|
if ($relation instanceof Closure) {
|
|
$data = $relation($model, $include);
|
|
} else {
|
|
if ($include) {
|
|
$data = $model->$relation;
|
|
} elseif ($many) {
|
|
$relationIds = $relation.'_ids';
|
|
$data = $model->$relationIds ?: $model->relation()->get(['id'])->fetch('id')->all();
|
|
} else {
|
|
$relationId = $relation.'_id';
|
|
$data = $model->$relationId;
|
|
}
|
|
}
|
|
|
|
if (is_array($serializer)) {
|
|
$class = get_class(is_object($data) ? $data : $model->$relation()->getRelated());
|
|
$serializer = $serializer[$class];
|
|
}
|
|
$serializer = new $serializer($this->actor, $links);
|
|
return $many ? $serializer->collection($data) : $serializer->resource($data);
|
|
};
|
|
}
|
|
|
|
public function hasOne($serializer, $relation = null)
|
|
{
|
|
return $this->relationship($serializer, $relation);
|
|
}
|
|
|
|
public function hasMany($serializer, $relation = null)
|
|
{
|
|
return $this->relationship($serializer, $relation, true);
|
|
}
|
|
|
|
/**
|
|
* Fire an event to allow for custom links and includes.
|
|
*
|
|
* @param string $name
|
|
* @param array $arguments
|
|
* @return void
|
|
*/
|
|
public function __call($name, $arguments)
|
|
{
|
|
return event(new SerializeRelationship($this, $name), null, true);
|
|
}
|
|
}
|