AbstractFormatter - Code Metrics - Inspection of "Make AbstractFormatter use new Payload status code..." - equip/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

by Matthew

created 2016-02-11 22:49 UTC

AbstractFormatter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	10
c	1
b	0
f	0
lcom	1
cbo	2
dl	0
loc	74
ccs	19
cts	19
cp	1
rs	10

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	accepts()	8	1
	type()	1	?
	body()	1	?
B	status()	21	8

<?php
namespace Equip\Formatter;

use Equip\Adr\PayloadInterface;
use Lukasoppermann\Httpstatus\Httpstatus;

abstract class AbstractFormatter
{
    /**
     * @var Httpstatus
     */
    private $http_status;

    /**
     * @param Httpstatus $http_status
     */
    public function __construct(Httpstatus $http_status)
    {
        $this->http_status = $http_status;
    }

    /**
     * Get the content types this formatter can satisfy.
     *
     * @return array
     */
    public static function accepts()
    {
        throw new \RuntimeException(sprintf(
            '%s::%s() must be defined to declare accepted content types',
            static::class,
            __FUNCTION__
        ));
    }

    /**
     * Get the content type of the response body.
     *
     * @return string
     */
    abstract protected function type();

    /**
     * Get the response body from the payload.
     *
     * @param PayloadInterface $payload
     *
     * @return string
     */
    abstract protected function body(PayloadInterface $payload);

    /**
     * Get the response status from the payload.
     *
     * @param PayloadInterface $payload
     *
     * @return integer

     */
    public function status(PayloadInterface $payload)
    {
        $status = $payload->getStatus();

        // Legacy logic
        // @todo Remove this in 2.0
        if (is_int($status)) {
            if ($status >= PayloadInterface::OK && $status < PayloadInterface::ERROR) {

                return 200;
            }
            if ($status >= PayloadInterface::ERROR && $status < PayloadInterface::INVALID) {

                return 500;
            }
            if ($status >= PayloadInterface::INVALID && $status < PayloadInterface::UNKNOWN) {

                return 400;
            }
            return 520;
        }

        return $this->http_status->getStatusCode($status);
    }
}


1		<?php
2		namespace Equip\Formatter;
3
4		use Equip\Adr\PayloadInterface;
5		use Lukasoppermann\Httpstatus\Httpstatus;
6
7		abstract class AbstractFormatter
8		{
9		/**
10		* @var Httpstatus
11		*/
12		private $http_status;
13
14		/**
15		* @param Httpstatus $http_status
16		*/
17	17	public function __construct(Httpstatus $http_status)
18		{
19	17	$this->http_status = $http_status;
20	17	}
21
22		/**
23		* Get the content types this formatter can satisfy.
24		*
25		* @return array
26		*/
27	1	public static function accepts()
28		{
29	1	throw new \RuntimeException(sprintf(
30	1	'%s::%s() must be defined to declare accepted content types',
31	1	static::class,
32		__FUNCTION__
33	1	));
34		}
35
36		/**
37		* Get the content type of the response body.
38		*
39		* @return string
40		*/
41		abstract protected function type();
42
43		/**
44		* Get the response body from the payload.
45		*
46		* @param PayloadInterface $payload
47		*
48		* @return string
49		*/
50		abstract protected function body(PayloadInterface $payload);
51
52		/**
53		* Get the response status from the payload.
54		*
55		* @param PayloadInterface $payload
56		*
57		* @return integer
		1 ignored issue – show Documentation introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report Should the return type not be `integer\|string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
58		*/
59	17	public function status(PayloadInterface $payload)
60		{
61	17	$status = $payload->getStatus();
62
63		// Legacy logic
64		// @todo Remove this in 2.0
65	17	if (is_int($status)) {
66	6	if ($status >= PayloadInterface::OK && $status < PayloadInterface::ERROR) {
		2 ignored issues – show Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::OK` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history... Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::ERROR` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
67	3	return 200;
68		}
69	3	if ($status >= PayloadInterface::ERROR && $status < PayloadInterface::INVALID) {
		2 ignored issues – show Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::ERROR` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history... Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::INVALID` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
70	1	return 500;
71		}
72	2	if ($status >= PayloadInterface::INVALID && $status < PayloadInterface::UNKNOWN) {
		2 ignored issues – show Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::INVALID` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history... Deprecated Code introduced 2016-02-11 22:52 UTC by Report Bug Copy Issue Report The constant `Equip\Adr\PayloadInterface::UNKNOWN` has been deprecated with message: 1.1.0 This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
73	1	return 400;
74		}
75	1	return 520;
76		}
77
78	11	return $this->http_status->getStatusCode($status);
79		}
80		}
81

equip / framework

Pull Request — master (#9)

AbstractFormatter A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like