SerializationMiddleware::getFormatFromHeader() - Code Metrics - Inspection of "Add support for 'JSON Spreadsheet'" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#85)

by Patrick

created 2018-03-15 05:04 UTC

SerializationMiddleware::getFormatFromHeader() A

↳ Parent: SerializationMiddleware

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	9
nc	3
nop	1
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0

<?php
namespace Http\Rest;

use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

require 'vendor/autoload.php';

class SerializationMiddleware
{
    protected $format = null;

    private function getFormatFromHeader($request)
    {
        $mimeType = $request->getHeaderLine('Accept');
        switch($mimeType)
        {
            case 'text/csv':
                return 'csv';
            case 'text/x-vCard':
                return 'vcard';
            default:
                return 'json';
        }
    }

    private function getParamFromArrayIfSet($array, $param, $default = null)
    {
        if(isset($array[$param]))
        {
            return $array[$param];
        }
        return $default;
    }

    private function getFormat($request, $response)
    {
        $params = $request->getQueryParams();
        $this->format = $this->getParamFromArrayIfSet($params, 'fmt');
        if($this->format === null)
        {
            $this->format = $this->getParamFromArrayIfSet($params, '$format');
            if($this->format === null)
            {
                $this->format = $this->getFormatFromHeader($request);
            }
            else if($this->format === 'json')
            {
                //OData json is different from notmal json
                $this->format = 'odata-json';
            }
        }
        if(strstr($this->format, 'odata.streaming=true'))
        {
            return $response->withStatus(406);
        }
        return $response;
    }

    protected function reserializeBody($response, $serializer)
    {
        $body = $response->getBody();
        $body->rewind();
        $data = json_decode($body->getContents());
        $serializer = new $serializer();
        $res = $serializer->serializeData($this->format, $data);
        $response = $response->withBody(new \Slim\Http\Body(fopen('php://temp', 'r+')));
        $response->getBody()->write($res);
        return $response->withHeader('Content-Type', $this->format);
    }

    public function __invoke($request, $response, $next)
    {
        $response = $this->getFormat($request, $response);
        if($response->getStatusCode() !== 200)
        {
            return $response;
        }
        $request = $request->withAttribute('format', $this->format);
        $response = $next($request, $response);
        if($response->getHeaderLine('Content-Type') !== 'application/json;charset=utf-8')
        {
            //The underlying API call gave us back a different content type. Just pass that on...
            return $response;
        }
        switch($this->format)
        {
            case 'application/json':
            case 'application/x-javascript':
            case 'text/javascript':
            case 'text/x-javascript':
            case 'text/x-json':
            case 'json':
                return $response;
            case 'json-ss':
            case 'json-ss-dt':
                return $this->reserializeBody($response, '\Serialize\JsonSpreadSheet');
            case 'data-table':

                //This is a special case for json...
                $body = $response->getBody();
                $body->rewind();
                $data = json_decode($body->getContents());
                return $response->withJson(array('data'=>$data));
            case 'odata-json':

                //This is a special case for json...
                $body = $response->getBody();
                $body->rewind();
                $data = json_decode($body->getContents());
                return $response->withJson(array('value'=>$data));
            case 'xml':
            case 'application/xml':
            case 'text/xml':
                return $this->reserializeBody($response, '\Serialize\XMLSerializer');
            case 'csv':
            case 'text/csv':
                return $this->reserializeBody($response, '\Serialize\CSVSerializer');
            case 'xlsx':
            case 'xls':
            case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
            case 'application/vnd.ms-excel':
                return $this->reserializeBody($response, '\Serialize\ExcelSerializer');
            case 'yaml':
            case 'application/x-yaml':
            case 'text/x-yaml':
                return $this->reserializeBody($response, '\Serialize\YAMLSerializer');
            default:
                print_r($this->format); die();
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }
        return $response;
    }
}


1		<?php
2		namespace Http\Rest;
3
4		use \Psr\Http\Message\ServerRequestInterface as Request;
5		use \Psr\Http\Message\ResponseInterface as Response;
6
7		require 'vendor/autoload.php';
8
9		class SerializationMiddleware
10		{
11		protected $format = null;
12
13		private function getFormatFromHeader($request)
14		{
15		$mimeType = $request->getHeaderLine('Accept');
16		switch($mimeType)
17		{
18		case 'text/csv':
19		return 'csv';
20		case 'text/x-vCard':
21		return 'vcard';
22		default:
23		return 'json';
24		}
25		}
26
27		private function getParamFromArrayIfSet($array, $param, $default = null)
28		{
29		if(isset($array[$param]))
30		{
31		return $array[$param];
32		}
33		return $default;
34		}
35
36		private function getFormat($request, $response)
37		{
38		$params = $request->getQueryParams();
39		$this->format = $this->getParamFromArrayIfSet($params, 'fmt');
40		if($this->format === null)
41		{
42		$this->format = $this->getParamFromArrayIfSet($params, '$format');
43		if($this->format === null)
44		{
45		$this->format = $this->getFormatFromHeader($request);
46		}
47		else if($this->format === 'json')
48		{
49		//OData json is different from notmal json
50		$this->format = 'odata-json';
51		}
52		}
53		if(strstr($this->format, 'odata.streaming=true'))
54		{
55		return $response->withStatus(406);
56		}
57		return $response;
58		}
59
60		protected function reserializeBody($response, $serializer)
61		{
62		$body = $response->getBody();
63		$body->rewind();
64		$data = json_decode($body->getContents());
65		$serializer = new $serializer();
66		$res = $serializer->serializeData($this->format, $data);
67		$response = $response->withBody(new \Slim\Http\Body(fopen('php://temp', 'r+')));
68		$response->getBody()->write($res);
69		return $response->withHeader('Content-Type', $this->format);
70		}
71
72		public function __invoke($request, $response, $next)
73		{
74		$response = $this->getFormat($request, $response);
75		if($response->getStatusCode() !== 200)
76		{
77		return $response;
78		}
79		$request = $request->withAttribute('format', $this->format);
80		$response = $next($request, $response);
81		if($response->getHeaderLine('Content-Type') !== 'application/json;charset=utf-8')
82		{
83		//The underlying API call gave us back a different content type. Just pass that on...
84		return $response;
85		}
86		switch($this->format)
87		{
88		case 'application/json':
89		case 'application/x-javascript':
90		case 'text/javascript':
91		case 'text/x-javascript':
92		case 'text/x-json':
93		case 'json':
94		return $response;
95		case 'json-ss':
96		case 'json-ss-dt':
97		return $this->reserializeBody($response, '\Serialize\JsonSpreadSheet');
98	View Code Duplication	case 'data-table':
		0 ignored issues – show Duplication introduced 2018-03-15 05:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		//This is a special case for json...
100		$body = $response->getBody();
101		$body->rewind();
102		$data = json_decode($body->getContents());
103		return $response->withJson(array('data'=>$data));
104	View Code Duplication	case 'odata-json':
		0 ignored issues – show Duplication introduced 2018-02-16 16:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
105		//This is a special case for json...
106		$body = $response->getBody();
107		$body->rewind();
108		$data = json_decode($body->getContents());
109		return $response->withJson(array('value'=>$data));
110		case 'xml':
111		case 'application/xml':
112		case 'text/xml':
113		return $this->reserializeBody($response, '\Serialize\XMLSerializer');
114		case 'csv':
115		case 'text/csv':
116		return $this->reserializeBody($response, '\Serialize\CSVSerializer');
117		case 'xlsx':
118		case 'xls':
119		case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
120		case 'application/vnd.ms-excel':
121		return $this->reserializeBody($response, '\Serialize\ExcelSerializer');
122		case 'yaml':
123		case 'application/x-yaml':
124		case 'text/x-yaml':
125		return $this->reserializeBody($response, '\Serialize\YAMLSerializer');
126		default:
127		print_r($this->format); die();
128		break;
		0 ignored issues – show Unused Code introduced 2017-06-07 21:43 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
129		}
130		return $response;
131		}
132		}
133

BurningFlipside / CommonCode

Pull Request — develop (#85)

SerializationMiddleware::getFormatFromHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like