AbstractClientRequest::verifyRequestData() - Code Metrics - Inspection of "AbstractClientRequest" - webservco/api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 55ced3...b98498 )

by Radu

created 2018-10-30 17:00 UTC

AbstractClientRequest::verifyRequestData() B

↳ Parent: AbstractClientRequest

Complexity

Conditions	10
Paths	14

Size

Total Lines	35
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	22
nc	14
nop	0
dl	0
loc	35
rs	7.6666
c	0
b	0
f	0

How to fix Complexity

<?php
namespace WebServCo\Api;

use WebServCo\Api\JsonApi\Structure;
use WebServCo\Framework\Exceptions\HttpException;

abstract class AbstractClientRequest
{
    protected $allowMultipleDataObjects;
    protected $request;
    protected $processRequestData;
    protected $requestData;

    const MSG_TPL_INVALID = 'Invalid data: %s';
    const MSG_TPL_REQUIRED = 'Missing required data: %s';

    public function __construct(
        \WebServCo\Framework\Interfaces\RequestInterface $request
    ) {
        $this->allowMultipleDataObjects = false;
        $this->request = $request;
        $requestMethod = $this->request->getMethod();
        if (in_array($requestMethod, [\WebServCo\Framework\Http::METHOD_POST])) {
            $this->processRequestData = true;
            $this->requestData = json_decode($this->request->getBody(), true);
        }
    }

    protected function verify()
    {
        $this->verifyContentType();
        if ($this->processRequestData) {
            $this->verifyRequestData();
        }
        return true;
    }

    protected function verifyContentType()
    {
        $contentType = $this->request->getContentType();
        $parts = explode(';', $contentType);
        if ($parts[0] != Structure::CONTENT_TYPE) {
            throw new \WebServCo\Framework\Exceptions\UnsupportedMediaTypeException('Unsupported content type');
        }
        return true;
    }

    protected function verifyRequestData()
    {
        if (!is_array($this->requestData)) {
            throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'root object'));
        }
        foreach (['jsonapi', 'data'] as $item) {
            if (!isset($this->requestData[$item])) {
                throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, $item));
            }
        }
        if (!isset($this->requestData['jsonapi']['version'])) {
            throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, 'jsonapi.version'));
        }
        if ($this->requestData['jsonapi']['version'] != Structure::VERSION) {
            throw new HttpException(
                sprintf('Unsupported JSON API version: %s', $this->requestData['jsonapi']['version'])
            );
        }
        if (!is_array($this->requestData['data'])) {
            throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'data'));
        }
        $key = key($this->requestData['data']);
        if (0 === $key) { //multiple data objects
            if (!$this->allowMultipleDataObjects) {
                throw new HttpException('Multiple data objects not allowed for this endpoint');
            }
            foreach ($this->requestData['data'] as $item) {
                $this->verifyData($item);
            }
        } else { // single data object
            $this->verifyData($this->requestData['data']);
        }
        $this->verifyMeta();

        return true;
    }

    protected function verifyData($data)
    {
        foreach (['type', 'attributes'] as $item) {
            if (!isset($data[$item])) {
                throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, sprintf('data.%s', $item)));
            }
        }
        if (empty($data['type'])) {
            throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, 'data.type'));
        }
        if (!is_array($data['attributes'])) {
            throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'data.attributes'));
        }

        return true;
    }

    protected function verifyMeta()
    {
        if (isset($this->requestData['meta'])) { // meta is optional
            if (!is_array($this->requestData['meta'])) {
                throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'meta'));
            }
        }
    }
}


1			<?php
2			namespace WebServCo\Api;
3
4			use WebServCo\Api\JsonApi\Structure;
5			use WebServCo\Framework\Exceptions\HttpException;
6
7			abstract class AbstractClientRequest
8			{
9			protected $allowMultipleDataObjects;
10			protected $request;
11			protected $processRequestData;
12			protected $requestData;
13
14			const MSG_TPL_INVALID = 'Invalid data: %s';
15			const MSG_TPL_REQUIRED = 'Missing required data: %s';
16
17			public function __construct(
18			\WebServCo\Framework\Interfaces\RequestInterface $request
19			) {
20			$this->allowMultipleDataObjects = false;
21			$this->request = $request;
22			$requestMethod = $this->request->getMethod();
23			if (in_array($requestMethod, [\WebServCo\Framework\Http::METHOD_POST])) {
24			$this->processRequestData = true;
25			$this->requestData = json_decode($this->request->getBody(), true);
26			}
27			}
28
29			protected function verify()
30			{
31			$this->verifyContentType();
32			if ($this->processRequestData) {
33			$this->verifyRequestData();
34			}
35			return true;
36			}
37
38			protected function verifyContentType()
39			{
40			$contentType = $this->request->getContentType();
41			$parts = explode(';', $contentType);
42			if ($parts[0] != Structure::CONTENT_TYPE) {
43			throw new \WebServCo\Framework\Exceptions\UnsupportedMediaTypeException('Unsupported content type');
44			}
45			return true;
46			}
47
48			protected function verifyRequestData()
49			{
50			if (!is_array($this->requestData)) {
51			throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'root object'));
52			}
53			foreach (['jsonapi', 'data'] as $item) {
54			if (!isset($this->requestData[$item])) {
55			throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, $item));
56			}
57			}
58			if (!isset($this->requestData['jsonapi']['version'])) {
59			throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, 'jsonapi.version'));
60			}
61			if ($this->requestData['jsonapi']['version'] != Structure::VERSION) {
62			throw new HttpException(
63			sprintf('Unsupported JSON API version: %s', $this->requestData['jsonapi']['version'])
64			);
65			}
66			if (!is_array($this->requestData['data'])) {
67			throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'data'));
68			}
69			$key = key($this->requestData['data']);
70			if (0 === $key) { //multiple data objects
71			if (!$this->allowMultipleDataObjects) {
72			throw new HttpException('Multiple data objects not allowed for this endpoint');
73			}
74			foreach ($this->requestData['data'] as $item) {
75			$this->verifyData($item);
76			}
77			} else { // single data object
78			$this->verifyData($this->requestData['data']);
79			}
80			$this->verifyMeta();
81
82			return true;
83			}
84
85			protected function verifyData($data)
86			{
87			foreach (['type', 'attributes'] as $item) {
88			if (!isset($data[$item])) {
89			throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, sprintf('data.%s', $item)));
90			}
91			}
92			if (empty($data['type'])) {
93			throw new HttpException(sprintf(self::MSG_TPL_REQUIRED, 'data.type'));
94			}
95			if (!is_array($data['attributes'])) {
96			throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'data.attributes'));
97			}
98
99			return true;
100			}
101
102			protected function verifyMeta()
103			{
104			if (isset($this->requestData['meta'])) { // meta is optional
105			if (!is_array($this->requestData['meta'])) {
106			throw new HttpException(sprintf(self::MSG_TPL_INVALID, 'meta'));
107			}
108			}
109			}
110			}
111

webservco / api

Push — master ( 55ced3...b98498 )

AbstractClientRequest::verifyRequestData() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like