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

Completed

Push — master ( 8d26c4...37e57c )

by Radu

created 2020-02-24 11:40 UTC

AbstractClientRequest::verifyRequestData() B

↳ Parent: AbstractClientRequest

Complexity

Conditions	10
Paths	84

Size

Total Lines	35
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

How to fix Complexity

<?php
namespace WebServCo\Api;

use WebServCo\Api\JsonApi\Document;
use WebServCo\Api\Exceptions\ApiException;

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

    const MSG_TPL_INVALID = 'Invalid data: %s';
    const MSG_TPL_MAXIMUM_LENGTH = 'Maximum length exceeded: %s (%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 throwInvalidException($item)
    {
        throw new ApiException(sprintf(self::MSG_TPL_INVALID, $item));
    }

    protected function throwMaximumLengthException($item, $maximumLength)
    {
        throw new ApiException(sprintf(self::MSG_TPL_MAXIMUM_LENGTH, $item, $maximumLength));
    }

    protected function throwRequiredException($item)
    {
        throw new ApiException(sprintf(self::MSG_TPL_REQUIRED, $item));
    }

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

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

    protected function verifyRequestData()
    {
        if (!is_array($this->requestData)) {
            $this->throwInvalidException('root object');
        }
        foreach (['jsonapi', 'data'] as $item) {
            if (!isset($this->requestData[$item])) {
                $this->throwRequiredException($item);
            }
        }
        if (!isset($this->requestData['jsonapi']['version'])) {
            $this->throwRequiredException('jsonapi.version');
        }
        if ($this->requestData['jsonapi']['version'] != Document::VERSION) {
            throw new ApiException(
                sprintf('Unsupported JSON API version: %s', $this->requestData['jsonapi']['version'])
            );
        }
        if (!is_array($this->requestData['data'])) {
            $this->throwInvalidException('data');
        }
        $key = key($this->requestData['data']);
        if (0 === $key) { //multiple data objects
            if (!$this->allowMultipleDataObjects) {
                throw new ApiException('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])) {
                $this->throwRequiredException(sprintf('data.%s', $item));
            }
        }
        if (empty($data['type'])) {
            $this->throwRequiredException('data.type');
        }
        if (!is_array($data['attributes'])) {
            $this->throwInvalidException('data.attributes');
        }

        return true;
    }

    protected function verifyMeta()
    {
        if (isset($this->requestData['meta'])) { // meta is optional
            if (!is_array($this->requestData['meta'])) {
                $this->throwInvalidException('meta');
            }
        }
    }
}


1			<?php
2			namespace WebServCo\Api;
3
4			use WebServCo\Api\JsonApi\Document;
5			use WebServCo\Api\Exceptions\ApiException;
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_MAXIMUM_LENGTH = 'Maximum length exceeded: %s (%s)';
16			const MSG_TPL_REQUIRED = 'Missing required data: %s';
17
18			public function __construct(
19			\WebServCo\Framework\Interfaces\RequestInterface $request
20			) {
21			$this->allowMultipleDataObjects = false;
22			$this->request = $request;
23			$requestMethod = $this->request->getMethod();
24			if (in_array($requestMethod, [\WebServCo\Framework\Http\Method::POST])) {
25			$this->processRequestData = true;
26			$this->requestData = json_decode($this->request->getBody(), true);
27			}
28			}
29
30			protected function throwInvalidException($item)
31			{
32			throw new ApiException(sprintf(self::MSG_TPL_INVALID, $item));
33			}
34
35			protected function throwMaximumLengthException($item, $maximumLength)
36			{
37			throw new ApiException(sprintf(self::MSG_TPL_MAXIMUM_LENGTH, $item, $maximumLength));
38			}
39
40			protected function throwRequiredException($item)
41			{
42			throw new ApiException(sprintf(self::MSG_TPL_REQUIRED, $item));
43			}
44
45			protected function verify()
46			{
47			$this->verifyContentType();
48			if ($this->processRequestData) {
49			$this->verifyRequestData();
50			}
51			return true;
52			}
53
54			protected function verifyContentType()
55			{
56			$contentType = $this->request->getContentType();
57			$parts = explode(';', (string) $contentType);
58			if ($parts[0] != Document::CONTENT_TYPE) {
59			throw new \WebServCo\Framework\Exceptions\UnsupportedMediaTypeException(
60			sprintf('Unsupported content type: %s.', (string) $contentType)
61			);
62			}
63			return true;
64			}
65
66			protected function verifyRequestData()
67			{
68			if (!is_array($this->requestData)) {
69			$this->throwInvalidException('root object');
70			}
71			foreach (['jsonapi', 'data'] as $item) {
72			if (!isset($this->requestData[$item])) {
73			$this->throwRequiredException($item);
74			}
75			}
76			if (!isset($this->requestData['jsonapi']['version'])) {
77			$this->throwRequiredException('jsonapi.version');
78			}
79			if ($this->requestData['jsonapi']['version'] != Document::VERSION) {
80			throw new ApiException(
81			sprintf('Unsupported JSON API version: %s', $this->requestData['jsonapi']['version'])
82			);
83			}
84			if (!is_array($this->requestData['data'])) {
85			$this->throwInvalidException('data');
86			}
87			$key = key($this->requestData['data']);
88			if (0 === $key) { //multiple data objects
89			if (!$this->allowMultipleDataObjects) {
90			throw new ApiException('Multiple data objects not allowed for this endpoint');
91			}
92			foreach ($this->requestData['data'] as $item) {
93			$this->verifyData($item);
94			}
95			} else { // single data object
96			$this->verifyData($this->requestData['data']);
97			}
98			$this->verifyMeta();
99
100			return true;
101			}
102
103			protected function verifyData($data)
104			{
105			foreach (['type', 'attributes'] as $item) {
106			if (!isset($data[$item])) {
107			$this->throwRequiredException(sprintf('data.%s', $item));
108			}
109			}
110			if (empty($data['type'])) {
111			$this->throwRequiredException('data.type');
112			}
113			if (!is_array($data['attributes'])) {
114			$this->throwInvalidException('data.attributes');
115			}
116
117			return true;
118			}
119
120			protected function verifyMeta()
121			{
122			if (isset($this->requestData['meta'])) { // meta is optional
123			if (!is_array($this->requestData['meta'])) {
124			$this->throwInvalidException('meta');
125			}
126			}
127			}
128			}
129

webservco / api

Push — master ( 8d26c4...37e57c )

AbstractClientRequest::verifyRequestData() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like