ErrorDoc::getTitle() - Code Metrics - Inspection of "Add sources" - yoanm/php-jsonrpc-server-doc-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — feature/init (#3)

by Yo

created 2018-05-13 15:06 UTC

ErrorDoc::getTitle() A

↳ Parent: ErrorDoc

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace Yoanm\JsonRpcServerDoc\Model;

use Yoanm\JsonRpcServerDoc\Model\Type\TypeDoc;

/**
 * Class ErrorDoc
 */
class ErrorDoc
{
    /** @var string */
    private $title;
    /** @var string */
    private $identifier;
    /** @var int */
    private $code;
    /** @var string|null */
    private $message;
    /** @var null|TypeDoc */
    private $dataDoc = null;

    /**
     * @param string       $title
     * @param int          $code
     * @param string|null  $message
     * @param TypeDoc|null $dataDoc
     * @param string|null  $identifier
     */
    public function __construct(
        string $title,
        int $code,
        string $message = null,
        TypeDoc $dataDoc = null,
        string $identifier = null
    ) {
        $this->title = $title;
        $this->code = $code;
        $this->message = $message;
        $this->dataDoc = $dataDoc;
        $this->setIdentifier($identifier ?? $title.((string)$code));
    }

    /**
     * @param string $identifier
     *
     * @return ErrorDoc
     */
    public function setIdentifier(string $identifier) : ErrorDoc
    {
        // Sanitize Identifier => remove space and slashes
        $this->identifier = strtr(
            ucwords(strtr(
                $identifier,
                ['_' => ' ', '/' => ' ', '.' => '_ ', '\\' => '_ ']
            )),
            [' ' => '']
        );

        return $this;
    }

    /**
     * @param TypeDoc $dataDoc
     *
     * @return ErrorDoc
     */
    public function setDataDoc(TypeDoc $dataDoc) : ErrorDoc
    {
        $this->dataDoc = $dataDoc;

        return $this;
    }

    /**
     * @return string
     */
    public function getTitle() : string
    {
        return $this->title;
    }

    /**
     * @return int
     */
    public function getCode() : int
    {
        return $this->code;
    }

    /**
     * @return null|string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * @return TypeDoc|null
     */
    public function getDataDoc()
    {
        return $this->dataDoc;
    }

    /**
     * @return string
     */
    public function getIdentifier() : string
    {
        return $this->identifier;
    }
}


1			<?php
2			namespace Yoanm\JsonRpcServerDoc\Model;
3
4			use Yoanm\JsonRpcServerDoc\Model\Type\TypeDoc;
5
6			/**
7			* Class ErrorDoc
8			*/
9			class ErrorDoc
10			{
11			/** @var string */
12			private $title;
13			/** @var string */
14			private $identifier;
15			/** @var int */
16			private $code;
17			/** @var string\|null */
18			private $message;
19			/** @var null\|TypeDoc */
20			private $dataDoc = null;
21
22			/**
23			* @param string $title
24			* @param int $code
25			* @param string\|null $message
26			* @param TypeDoc\|null $dataDoc
27			* @param string\|null $identifier
28			*/
29			public function __construct(
30			string $title,
31			int $code,
32			string $message = null,
33			TypeDoc $dataDoc = null,
34			string $identifier = null
35			) {
36			$this->title = $title;
37			$this->code = $code;
38			$this->message = $message;
39			$this->dataDoc = $dataDoc;
40			$this->setIdentifier($identifier ?? $title.((string)$code));
41			}
42
43			/**
44			* @param string $identifier
45			*
46			* @return ErrorDoc
47			*/
48			public function setIdentifier(string $identifier) : ErrorDoc
49			{
50			// Sanitize Identifier => remove space and slashes
51			$this->identifier = strtr(
52			ucwords(strtr(
53			$identifier,
54			['_' => ' ', '/' => ' ', '.' => '_ ', '\\' => '_ ']
55			)),
56			[' ' => '']
57			);
58
59			return $this;
60			}
61
62			/**
63			* @param TypeDoc $dataDoc
64			*
65			* @return ErrorDoc
66			*/
67			public function setDataDoc(TypeDoc $dataDoc) : ErrorDoc
68			{
69			$this->dataDoc = $dataDoc;
70
71			return $this;
72			}
73
74			/**
75			* @return string
76			*/
77			public function getTitle() : string
78			{
79			return $this->title;
80			}
81
82			/**
83			* @return int
84			*/
85			public function getCode() : int
86			{
87			return $this->code;
88			}
89
90			/**
91			* @return null\|string
92			*/
93			public function getMessage()
94			{
95			return $this->message;
96			}
97
98			/**
99			* @return TypeDoc\|null
100			*/
101			public function getDataDoc()
102			{
103			return $this->dataDoc;
104			}
105
106			/**
107			* @return string
108			*/
109			public function getIdentifier() : string
110			{
111			return $this->identifier;
112			}
113			}
114

yoanm / php-jsonrpc-server-doc-sdk

Pull Request — feature/init (#3)

ErrorDoc::getTitle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like