diff options
Diffstat (limited to 'lib/classes/restapi/renderer')
| -rw-r--r-- | lib/classes/restapi/renderer/DebugRenderer.php | 57 | ||||
| -rw-r--r-- | lib/classes/restapi/renderer/DefaultRenderer.php | 74 | ||||
| -rw-r--r-- | lib/classes/restapi/renderer/JSONRenderer.php | 35 |
3 files changed, 0 insertions, 166 deletions
diff --git a/lib/classes/restapi/renderer/DebugRenderer.php b/lib/classes/restapi/renderer/DebugRenderer.php deleted file mode 100644 index afd56f6..0000000 --- a/lib/classes/restapi/renderer/DebugRenderer.php +++ /dev/null @@ -1,57 +0,0 @@ -<?php -namespace RESTAPI\Renderer; - -/** - * Debug content renderer. - * - * @author Jan-Hendrik Willms <tleilax+studip@gmail.com> - * @author <mlunzena@uos.de> - * @license GPL 2 or later - * @since Stud.IP 3.0 - * @deprecated Since Stud.IP 5.0. Will be removed in Stud.IP 6.0. - */ -class DebugRenderer extends DefaultRenderer -{ - /** - * Returns an associated content type. - */ - public function contentType() - { - return 'text/plain'; - } - - /** - * Returns an associated extension. - */ - public function extension() - { - return '.debug'; - } - - /** - * Response transformation function. - * - * @param \RESTAPI\Response $response the response to transform - */ - public function render($response) - { - if (!isset($response['Content-Type'])) { - $response['Content-Type'] = $this->contentType() . ';charset=utf-8'; - } - - $debug = function ($label, $data) { - echo str_pad('', 78, '=') . PHP_EOL; - echo str_pad('- ' . $label, 77, ' ') . '-' . PHP_EOL; - echo str_pad('', 78, '=') . PHP_EOL; - var_export($data); - echo PHP_EOL; - }; - - ob_start(); - $debug('Response Status', $response->status); - $debug('Response Header', $response->headers); - $debug('Response Body', $response->body); - $debug('Request', $GLOBALS['_' . $_SERVER['REQUEST_METHOD']]); - $response->body = ob_get_clean(); - } -} diff --git a/lib/classes/restapi/renderer/DefaultRenderer.php b/lib/classes/restapi/renderer/DefaultRenderer.php deleted file mode 100644 index 836ba36..0000000 --- a/lib/classes/restapi/renderer/DefaultRenderer.php +++ /dev/null @@ -1,74 +0,0 @@ -<?php -namespace RESTAPI\Renderer; - -/** - * Default base content renderer class (outputs text/plain). - * - * Content renderers are output filters that can reshape data before it - * is sent to the client. - * Each content renderer is associated with a certain content type and a - * certain file extension. This is neccessary for content negotiation. - * - * @author Jan-Hendrik Willms <tleilax+studip@gmail.com> - * @author <mlunzena@uos.de> - * @license GPL 2 or later - * @since Stud.IP 3.0 - * @deprecated Since Stud.IP 5.0. Will be removed in Stud.IP 6.0. - */ -class DefaultRenderer -{ - /** - * Returns an associated content type. - * - * @return String Content/mime type for this renderer - */ - public function contentType() - { - return 'text/plain'; - } - - /** - * Returns an associated extension. - * - * @return String Associated extension for this renderer. - */ - public function extension() - { - return ''; - } - - /** - * Response transformation function. - * - * @param \RESTAPI\Response $response the response to transform - */ - public function render($response) - { - if (!isset($response['Content-Type'])) { - $response['Content-Type'] = $this->contentType() . ';charset=utf-8'; - } - } - - /** - * Detects whether the renderer should respond to either a certain - * filename (tests by extension) or to a certain media range. - * - * @param String $filename Filename to test against - * @param mixed $media_range Media range to test against (optional, - * defaults to request's accept header if set) - * @return bool Returns whether the renderer should respond - */ - public function shouldRespondTo($filename, $media_range = null) - { - // If no media range is passed, evalute http header "Accept" - if ($media_range === null && isset($_SERVER['ACCEPT'])) { - $media_ranges = explode(';', $_SERVER['ACCEPT']); - $media_range = reset($media_ranges); - } - - // Test if either the filename has the appropriate extension or - // if the client accepts the content type - return ($this->extension() && fnmatch('*' . $this->extension(), $filename)) - || ($media_range && fnmatch($media_range, $this->contentType())); - } -} diff --git a/lib/classes/restapi/renderer/JSONRenderer.php b/lib/classes/restapi/renderer/JSONRenderer.php deleted file mode 100644 index 9c6e449..0000000 --- a/lib/classes/restapi/renderer/JSONRenderer.php +++ /dev/null @@ -1,35 +0,0 @@ -<?php -namespace RESTAPI\Renderer; - -/** - * Content renderer for json content. - * - * @author Jan-Hendrik Willms <tleilax+studip@gmail.com> - * @author <mlunzena@uos.de> - * @license GPL 2 or later - * @since Stud.IP 3.0 - * @deprecated Since Stud.IP 5.0. Will be removed in Stud.IP 6.0. - */ -class JSONRenderer extends DefaultRenderer -{ - public function contentType() - { - return 'application/json'; - } - - public function extension() - { - return '.json'; - } - - public function render($response) - { - if (!isset($response['Content-Type'])) { - $response['Content-Type'] = $this->contentType() . ';charset=utf-8'; - } - - if (isset($response->body)) { - $response->body = json_encode($response->body); - } - } -} |
