Error::setDetail() - Code Metrics - Inspection of "Daily Inspection: Close #206" - neomerx/json-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (52c9f6)

unknown

created 2018-03-31 00:21 UTC

Error::setDetail() A

↳ Parent: Error

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php namespace Neomerx\JsonApi\Document;

/**
 * Copyright 2015-2018 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Neomerx\JsonApi\Contracts\Document\DocumentInterface;
use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
use Neomerx\JsonApi\Contracts\Document\LinkInterface;

/**
 * @package Neomerx\JsonApi
 *
 * @SuppressWarnings(PHPMD.StaticAccess)
 */
class Error implements ErrorInterface
{
    /**
     * @var int|string|null
     */
    private $idx;

    /**
     * @var null|array<string,\Neomerx\JsonApi\Contracts\Schema\LinkInterface>
     */
    private $links;

    /**
     * @var string|null
     */
    private $status;

    /**
     * @var string|null
     */
    private $code;

    /**
     * @var string|null
     */
    private $title;

    /**
     * @var string|null
     */
    private $detail;

    /**
     * @var array|null
     */
    private $source;

    /**
     * @var mixed|null
     */
    private $meta;

    /**
     * @param int|string|null    $idx
     * @param LinkInterface|null $aboutLink
     * @param string|null        $status
     * @param string|null        $code
     * @param string|null        $title
     * @param string|null        $detail
     * @param array|null         $source
     * @param mixed|null         $meta
     */
    public function __construct(
        $idx = null,
        LinkInterface $aboutLink = null,
        string $status = null,
        string $code = null,
        string $title = null,
        string $detail = null,
        array $source = null,
        $meta = null
    ) {
        $this
            ->setId($idx)
            ->setLink(DocumentInterface::KEYWORD_ERRORS_ABOUT, $aboutLink)
            ->setStatus($status)
            ->setCode($code)
            ->setTitle($title)
            ->setDetail($detail)
            ->setSource($source)
            ->setMeta($meta);
    }

    /**
     * @inheritdoc
     */
    public function getId()
    {
        return $this->idx;
    }

    /**
     * @param string|int|null $idx
     *
     * @return self
     */
    public function setId($idx): self
    {
        assert($idx === null || is_int($idx) === true || is_string($idx) === true);

        $this->idx = $idx;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getLinks(): ?array
    {
        return $this->links;
    }

    /**
     * @param string             $name
     * @param LinkInterface|null $link
     *
     * @return self
     */
    public function setLink(string $name, ?LinkInterface $link): self
    {
        if ($link !== null) {
            $this->links[$name] = $link;
        } else {
            unset($this->links[$name]);
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getStatus(): ?string
    {
        return $this->status;
    }

    /**
     * @param string|null $status
     *
     * @return self
     */
    public function setStatus(?string $status): self
    {
        $this->status = $status;

        return $this;
    }

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

    /**
     * @param string|null $code
     *
     * @return self
     */
    public function setCode(?string $code): self
    {
        $this->code = $code;

        return $this;
    }

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

    /**
     * @param null|string $title
     *
     * @return self
     */
    public function setTitle(?string $title): self
    {
        $this->title = $title;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getDetail(): ?string
    {
        return $this->detail;
    }

    /**
     * @param null|string $detail
     *
     * @return self
     */
    public function setDetail(?string $detail): self
    {
        $this->detail = $detail;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getSource(): ?array
    {
        return $this->source;
    }

    /**
     * @param array|null $source
     *
     * @return self
     */
    public function setSource(?array $source): self
    {
        $this->source = $source;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getMeta()
    {
        return $this->meta;
    }

    /**
     * @param mixed|null $meta
     *
     * @return self
     */
    public function setMeta($meta): self
    {
        $this->meta = $meta;

        return $this;
    }
}


1		<?php namespace Neomerx\JsonApi\Document;
2
3		/**
4		* Copyright 2015-2018 [email protected]
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		use Neomerx\JsonApi\Contracts\Document\DocumentInterface;
20		use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
21		use Neomerx\JsonApi\Contracts\Document\LinkInterface;
22
23		/**
24		* @package Neomerx\JsonApi
25		*
26		* @SuppressWarnings(PHPMD.StaticAccess)
27		*/
28		class Error implements ErrorInterface
29		{
30		/**
31		* @var int\|string\|null
32		*/
33		private $idx;
34
35		/**
36		* @var null\|array<string,\Neomerx\JsonApi\Contracts\Schema\LinkInterface>
37		*/
38		private $links;
39
40		/**
41		* @var string\|null
42		*/
43		private $status;
44
45		/**
46		* @var string\|null
47		*/
48		private $code;
49
50		/**
51		* @var string\|null
52		*/
53		private $title;
54
55		/**
56		* @var string\|null
57		*/
58		private $detail;
59
60		/**
61		* @var array\|null
62		*/
63		private $source;
64
65		/**
66		* @var mixed\|null
67		*/
68		private $meta;
69
70		/**
71		* @param int\|string\|null $idx
72		* @param LinkInterface\|null $aboutLink
73		* @param string\|null $status
74		* @param string\|null $code
75		* @param string\|null $title
76		* @param string\|null $detail
77		* @param array\|null $source
78		* @param mixed\|null $meta
79		*/
80	33	public function __construct(
81		$idx = null,
82		LinkInterface $aboutLink = null,
83		string $status = null,
84		string $code = null,
85		string $title = null,
86		string $detail = null,
87		array $source = null,
88		$meta = null
89		) {
90		$this
91	33	->setId($idx)
92	33	->setLink(DocumentInterface::KEYWORD_ERRORS_ABOUT, $aboutLink)
93	33	->setStatus($status)
94	33	->setCode($code)
95	33	->setTitle($title)
96	33	->setDetail($detail)
97	33	->setSource($source)
98	33	->setMeta($meta);
99	33	}
100
101		/**
102		* @inheritdoc
103		*/
104	9	public function getId()
105		{
106	9	return $this->idx;
107		}
108
109		/**
110		* @param string\|int\|null $idx
111		*
112		* @return self
113		*/
114	33	public function setId($idx): self
115		{
116	33	assert($idx === null \|\| is_int($idx) === true \|\| is_string($idx) === true);
117
118	33	$this->idx = $idx;
119
120	33	return $this;
121		}
122
123		/**
124		* @inheritdoc
125		*/
126	9	public function getLinks(): ?array
127		{
128	9	return $this->links;
129		}
130
131		/**
132		* @param string $name
133		* @param LinkInterface\|null $link
134		*
135		* @return self
136		*/
137	33	public function setLink(string $name, ?LinkInterface $link): self
138		{
139	33	if ($link !== null) {
140	7	$this->links[$name] = $link;
141		} else {
142	26	unset($this->links[$name]);
143		}
144
145	33	return $this;
146		}
147
148		/**
149		* @inheritdoc
150		*/
151	9	public function getStatus(): ?string
152		{
153	9	return $this->status;
154		}
155
156		/**
157		* @param string\|null $status
158		*
159		* @return self
160		*/
161	33	public function setStatus(?string $status): self
162		{
163	33	$this->status = $status;
164
165	33	return $this;
166		}
167
168		/**
169		* @inheritdoc
170		*/
171	9	public function getCode(): ?string
172		{
173	9	return $this->code;
174		}
175
176		/**
177		* @param string\|null $code
178		*
179		* @return self
180		*/
181	33	public function setCode(?string $code): self
182		{
183	33	$this->code = $code;
184
185	33	return $this;
186		}
187
188		/**
189		* @inheritdoc
190		*/
191	10	public function getTitle(): ?string
192		{
193	10	return $this->title;
194		}
195
196		/**
197		* @param null\|string $title
198		*
199		* @return self
200		*/
201	33	public function setTitle(?string $title): self
202		{
203	33	$this->title = $title;
204
205	33	return $this;
206		}
207
208		/**
209		* @inheritdoc
210		*/
211	9	public function getDetail(): ?string
212		{
213	9	return $this->detail;
214		}
215
216		/**
217		* @param null\|string $detail
218		*
219		* @return self
220		*/
221	33	public function setDetail(?string $detail): self
222		{
223	33	$this->detail = $detail;
224
225	33	return $this;
226		}
227
228		/**
229		* @inheritdoc
230		*/
231	19	public function getSource(): ?array
232		{
233	19	return $this->source;
234		}
235
236		/**
237		* @param array\|null $source
238		*
239		* @return self
240		*/
241	33	public function setSource(?array $source): self
242		{
243	33	$this->source = $source;
244
245	33	return $this;
246		}
247
248		/**
249		* @inheritdoc
250		*/
251	9	public function getMeta()
252		{
253	9	return $this->meta;
254		}
255
256		/**
257		* @param mixed\|null $meta
258		*
259		* @return self
260		*/
261	33	public function setMeta($meta): self
262		{
263	33	$this->meta = $meta;
264
265	33	return $this;
266		}
267		}
268

neomerx / json-api

Branch — master (52c9f6)

Error::setDetail() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like