110 lines
2.6 KiB
PHP
110 lines
2.6 KiB
PHP
<?php
|
|
|
|
namespace Benzine\Controllers;
|
|
|
|
use Benzine\Exceptions\FilterDecodeException;
|
|
use Benzine\Controllers\Filters\Filter;
|
|
use Slim\Psr7\Request;
|
|
use Slim\Psr7\Response;
|
|
|
|
abstract class Controller
|
|
{
|
|
/** @var Service */
|
|
protected $service;
|
|
/** @var bool */
|
|
protected $apiExplorerEnabled = true;
|
|
|
|
public function __construct()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @return Service
|
|
*/
|
|
public function getService()
|
|
{
|
|
return $this->service;
|
|
}
|
|
|
|
/**
|
|
* @param Service $service
|
|
*/
|
|
public function setService($service): self
|
|
{
|
|
$this->service = $service;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isApiExplorerEnabled(): self
|
|
{
|
|
return $this->apiExplorerEnabled;
|
|
}
|
|
|
|
public function setApiExplorerEnabled(bool $apiExplorerEnabled): self
|
|
{
|
|
$this->apiExplorerEnabled = $apiExplorerEnabled;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function xmlResponse(\SimpleXMLElement $root, Request $request, Response $response): Response
|
|
{
|
|
$response = $response->withBody($root->asXML());
|
|
|
|
return $response->withHeader('Content-type', 'text/xml');
|
|
}
|
|
|
|
public function jsonResponse($json, Request $request, Response $response): Response
|
|
{
|
|
return $response->withJson($json);
|
|
}
|
|
|
|
public function jsonResponseException(\Exception $e, Request $request, Response $response): Response
|
|
{
|
|
return $this->jsonResponse(
|
|
[
|
|
'Status' => 'Fail',
|
|
'Reason' => $e->getMessage(),
|
|
],
|
|
$request,
|
|
$response
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Decide if a request has a filter attached to it.
|
|
*
|
|
* @throws FilterDecodeException
|
|
*/
|
|
protected function requestHasFilters(Request $request, Response $response): bool
|
|
{
|
|
if ($request->hasHeader('Filter')) {
|
|
$filterText = trim($request->getHeader('Filter')[0]);
|
|
if (!empty($filterText)) {
|
|
$decode = json_decode($filterText);
|
|
if (null !== $decode) {
|
|
return true;
|
|
}
|
|
|
|
throw new FilterDecodeException('Could not decode given Filter. Reason: Not JSON. Given: "'.$filterText.'"');
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Parse filters header into filter objects.
|
|
*/
|
|
protected function parseFilters(Request $request, Response $response): Filter
|
|
{
|
|
$filter = new Filter();
|
|
$filter->parseFromHeader(json_decode($request->getHeader('Filter')[0], true));
|
|
|
|
return $filter;
|
|
}
|
|
}
|