Update API action architecture

- 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
This commit is contained in:
Toby Zerner
2015-05-02 08:56:43 +09:30
parent 5ea864ba89
commit a426fa6560
23 changed files with 673 additions and 378 deletions

View File

@ -1,23 +1,40 @@
<?php namespace Flarum\Api\Actions\Discussions;
use Flarum\Core\Commands\DeleteDiscussionCommand;
use Flarum\Api\Actions\BaseAction;
use Flarum\Api\Actions\ApiParams;
use Flarum\Api\Actions\DeleteAction as BaseDeleteAction;
use Flarum\Api\Request;
use Illuminate\Http\Response;
use Illuminate\Contracts\Bus\Dispatcher;
class DeleteAction extends BaseAction
class DeleteAction extends BaseDeleteAction
{
/**
* Delete a discussion.
* The command bus.
*
* @return Response
* @var \Illuminate\Contracts\Bus\Dispatcher
*/
protected function run(ApiParams $params)
protected $bus;
/**
* Initialize the action.
*
* @param \Illuminate\Contracts\Bus\Dispatcher $bus
*/
public function __construct(Dispatcher $bus)
{
$discussionId = $params->get('id');
$this->bus = $bus;
}
$command = new DeleteDiscussionCommand($discussionId, $this->actor->getUser());
$this->dispatch($command, $params);
return $this->respondWithoutContent();
/**
* Delete a discussion according to input from the API request.
*
* @param \Flarum\Api\Request $request
* @return void
*/
protected function delete(Request $request, Response $response)
{
$this->bus->dispatch(
new DeleteDiscussionCommand($request->get('id'), $request->actor->getUser())
);
}
}