1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-13 22:54:25 +01:00
invoiceninja/app/Http/Controllers/BaseAPIController.php
2015-11-27 14:55:28 +02:00

133 lines
3.7 KiB
PHP

<?php namespace App\Http\Controllers;
use Session;
use Utils;
use Response;
use Request;
use League\Fractal;
use League\Fractal\Manager;
use League\Fractal\Resource\Item;
use League\Fractal\Resource\Collection;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use App\Ninja\Serializers\ArraySerializer;
use League\Fractal\Serializer\JsonApiSerializer;
/**
* @SWG\Swagger(
* schemes={"http","https"},
* host="ninja.dev",
* basePath="/api/v1",
* @SWG\Info(
* version="1.0.0",
* title="Invoice Ninja API",
* description="An open-source invoicing and time-tracking app built with Laravel",
* termsOfService="",
* @SWG\Contact(
* email="contact@invoiceninja.com"
* ),
* @SWG\License(
* name="Attribution Assurance License",
* url="https://raw.githubusercontent.com/invoiceninja/invoiceninja/master/LICENSE"
* )
* ),
* @SWG\ExternalDocumentation(
* description="Find out more about Invoice Ninja",
* url="https://www.invoiceninja.com"
* ),
* @SWG\SecurityScheme(
* securityDefinition="api_key",
* type="apiKey",
* in="header",
* name="TOKEN"
* )
* )
*/
class BaseAPIController extends Controller
{
protected $manager;
protected $serializer;
public function __construct()
{
$this->manager = new Manager();
if ($include = Request::get('include')) {
$this->manager->parseIncludes($include);
}
$this->serializer = Request::get('serializer') ?: API_SERIALIZER_ARRAY;
if ($this->serializer === API_SERIALIZER_JSON) {
$this->manager->setSerializer(new JsonApiSerializer());
} else {
$this->manager->setSerializer(new ArraySerializer());
}
}
protected function createItem($data, $transformer, $entityType)
{
if ($this->serializer && $this->serializer != API_SERIALIZER_JSON) {
$entityType = null;
}
$resource = new Item($data, $transformer, $entityType);
return $this->manager->createData($resource)->toArray();
}
protected function createCollection($data, $transformer, $entityType, $paginator = false)
{
if ($this->serializer && $this->serializer != API_SERIALIZER_JSON) {
$entityType = null;
}
$resource = new Collection($data, $transformer, $entityType);
if ($paginator) {
$resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
}
return $this->manager->createData($resource)->toArray();
}
protected function response($response)
{
$index = Request::get('index') ?: 'data';
$meta = isset($response['meta']) ? $response['meta'] : null;
$response = [
$index => $response
];
if ($meta) {
$response['meta'] = $meta;
unset($response[$index]['meta']);
}
$response = json_encode($response, JSON_PRETTY_PRINT);
$headers = Utils::getApiHeaders();
return Response::make($response, 200, $headers);
}
protected function getIncluded()
{
$data = ['user'];
$included = Request::get('include');
$included = explode(',', $included);
foreach ($included as $include) {
if ($include == 'invoices') {
$data[] = 'invoices.invoice_items';
$data[] = 'invoices.user';
} elseif ($include == 'clients') {
$data[] = 'clients.contacts';
$data[] = 'clients.user';
} elseif ($include) {
$data[] = $include;
}
}
return $data;
}
}