Error::setAboutLink() - Code Metrics - nilportugues/json-api - Measure and Improve Code Quality continuously with Scrutinizer

Error::setAboutLink() A
last analyzed 2016-05-09 15:54 UTC

↳ Parent: Error

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	2
eloc	4
nc	2
nop	1

<?php
/**
 * Author: Nil Portugués Calderó <[email protected]>
 * Date: 11/20/15
 * Time: 7:22 PM.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\Api\JsonApi\Server\Errors;

/**
 * Class ErrorBag.
 */
class Error implements \JsonSerializable
{
    /**
     * @var string
     */
    protected $id;
    /**
     * @var array
     */
    protected $links = [];
    /**
     * @var int
     */
    protected $status;
    /**
     * @var string
     */
    protected $code;
    /**
     * @var string
     */
    protected $title;
    /**
     * @var string
     */
    protected $detail;
    /**
     * @var array
     */
    protected $source = [];
    /**
     * @var mixed
     */
    protected $meta;

    /**
     * @param string $title
     * @param string $message
     * @param string $code
     */
    public function __construct($title, $message, $code = '')
    {
        $this->setTitle($title);
        $this->setDetail($message);
        $this->setCode($code);
    }

    /**
     * @param string $key
     * @param string $value
     *
     * @throws \InvalidArgumentException
     */
    public function setSource($key, $value)
    {
        if ($key !== 'pointer' && $key !== 'parameter') {
            throw new \InvalidArgumentException('Key must be "pointer" or "parameter".');
        }
        $this->source = [(string) $key => (string) $value];
    }

    /**
     * A unique identifier for this particular occurrence of the problem.
     *
     * @param $id
     */
    public function setId($id)
    {
        $this->id = $id;
    }

    /**
     * @return int
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * The HTTP status code applicable to this problem, expressed as a string value.
     *
     * @param $status
     *
     * @throws \InvalidArgumentException
     */
    public function setStatus($status)
    {
        $validStatus = [
            100,
            101,
            102,
            200,
            201,
            202,
            203,
            204,
            205,
            206,
            207,
            208,
            300,
            301,
            302,
            303,
            304,
            305,
            306,
            307,
            400,
            401,
            402,
            403,
            404,
            405,
            406,
            407,
            408,
            409,
            410,
            411,
            412,
            413,
            414,
            415,
            416,
            417,
            418,
            422,
            423,
            424,
            425,
            426,
            428,
            429,
            431,
            500,
            501,
            502,
            503,
            504,
            505,
            506,
            507,
            508,
            511,
        ];

        if (false === in_array($status, $validStatus, false)) {
            throw new \InvalidArgumentException(sprintf(
                'Provided status does not match a valid HTTP Status Code.',
                $status
            ));
        }
        $this->status = (int) $status;
    }

    /**
     * A short, human-readable summary of the problem that SHOULD NOT change from occurrence to
     * occurrence of the problem, except for purposes of localization.
     *
     * @param string $title
     *
     * @throws \InvalidArgumentException
     */
    protected function setTitle($title)
    {
        if (0 === strlen(trim($title))) {
            throw new \InvalidArgumentException('Provided title cannot be empty');
        }

        $this->title = (string) $title;
    }

    /**
     * A human-readable explanation specific to this occurrence of the problem.
     *
     * @param $detail
     *
     * @throws \InvalidArgumentException
     */
    protected function setDetail($detail)
    {
        if (0 === strlen(trim($detail))) {
            throw new \InvalidArgumentException('Provided error message cannot be empty');
        }

        $this->detail = (string) $detail;
    }

    /**
     * An application-specific error code, expressed as a string value.
     *
     * @param string $code
     */
    public function setCode($code)
    {
        $this->code = (string) $code;
    }

    /**
     * A link that leads to further details about this particular occurrence of the problem.
     *
     * @param string $link
     *
     * @throws \InvalidArgumentException
     */
    public function setAboutLink($link)
    {
        if (false === filter_var($link, FILTER_VALIDATE_URL)) {
            throw new \InvalidArgumentException(sprintf('Provided link %s is not a valid resource', $link));
        }

        $this->links['about']['href'] = (string) $link;
    }

    /**
     * A meta object containing non-standard meta-information about the error.
     *
     * @param mixed $meta
     */
    public function setMeta($meta)
    {
        $this->meta = $meta;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return array_filter(
            [
                'id' => $this->id,
                'links' => $this->links,
                'status' => $this->status,
                'code' => $this->code,
                'title' => $this->title,
                'detail' => $this->detail,
                'source' => $this->source,
                'meta' => $this->meta,
            ]
        );
    }
}


1			<?php
2			/**
3			* Author: Nil Portugués Calderó <[email protected]>
4			* Date: 11/20/15
5			* Time: 7:22 PM.
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace NilPortugues\Api\JsonApi\Server\Errors;
11
12			/**
13			* Class ErrorBag.
14			*/
15			class Error implements \JsonSerializable
16			{
17			/**
18			* @var string
19			*/
20			protected $id;
21			/**
22			* @var array
23			*/
24			protected $links = [];
25			/**
26			* @var int
27			*/
28			protected $status;
29			/**
30			* @var string
31			*/
32			protected $code;
33			/**
34			* @var string
35			*/
36			protected $title;
37			/**
38			* @var string
39			*/
40			protected $detail;
41			/**
42			* @var array
43			*/
44			protected $source = [];
45			/**
46			* @var mixed
47			*/
48			protected $meta;
49
50			/**
51			* @param string $title
52			* @param string $message
53			* @param string $code
54			*/
55			public function __construct($title, $message, $code = '')
56			{
57			$this->setTitle($title);
58			$this->setDetail($message);
59			$this->setCode($code);
60			}
61
62			/**
63			* @param string $key
64			* @param string $value
65			*
66			* @throws \InvalidArgumentException
67			*/
68			public function setSource($key, $value)
69			{
70			if ($key !== 'pointer' && $key !== 'parameter') {
71			throw new \InvalidArgumentException('Key must be "pointer" or "parameter".');
72			}
73			$this->source = [(string) $key => (string) $value];
74			}
75
76			/**
77			* A unique identifier for this particular occurrence of the problem.
78			*
79			* @param $id
80			*/
81			public function setId($id)
82			{
83			$this->id = $id;
84			}
85
86			/**
87			* @return int
88			*/
89			public function getStatus()
90			{
91			return $this->status;
92			}
93
94			/**
95			* The HTTP status code applicable to this problem, expressed as a string value.
96			*
97			* @param $status
98			*
99			* @throws \InvalidArgumentException
100			*/
101			public function setStatus($status)
102			{
103			$validStatus = [
104			100,
105			101,
106			102,
107			200,
108			201,
109			202,
110			203,
111			204,
112			205,
113			206,
114			207,
115			208,
116			300,
117			301,
118			302,
119			303,
120			304,
121			305,
122			306,
123			307,
124			400,
125			401,
126			402,
127			403,
128			404,
129			405,
130			406,
131			407,
132			408,
133			409,
134			410,
135			411,
136			412,
137			413,
138			414,
139			415,
140			416,
141			417,
142			418,
143			422,
144			423,
145			424,
146			425,
147			426,
148			428,
149			429,
150			431,
151			500,
152			501,
153			502,
154			503,
155			504,
156			505,
157			506,
158			507,
159			508,
160			511,
161			];
162
163			if (false === in_array($status, $validStatus, false)) {
164			throw new \InvalidArgumentException(sprintf(
165			'Provided status does not match a valid HTTP Status Code.',
166			$status
167			));
168			}
169			$this->status = (int) $status;
170			}
171
172			/**
173			* A short, human-readable summary of the problem that SHOULD NOT change from occurrence to
174			* occurrence of the problem, except for purposes of localization.
175			*
176			* @param string $title
177			*
178			* @throws \InvalidArgumentException
179			*/
180			protected function setTitle($title)
181			{
182			if (0 === strlen(trim($title))) {
183			throw new \InvalidArgumentException('Provided title cannot be empty');
184			}
185
186			$this->title = (string) $title;
187			}
188
189			/**
190			* A human-readable explanation specific to this occurrence of the problem.
191			*
192			* @param $detail
193			*
194			* @throws \InvalidArgumentException
195			*/
196			protected function setDetail($detail)
197			{
198			if (0 === strlen(trim($detail))) {
199			throw new \InvalidArgumentException('Provided error message cannot be empty');
200			}
201
202			$this->detail = (string) $detail;
203			}
204
205			/**
206			* An application-specific error code, expressed as a string value.
207			*
208			* @param string $code
209			*/
210			public function setCode($code)
211			{
212			$this->code = (string) $code;
213			}
214
215			/**
216			* A link that leads to further details about this particular occurrence of the problem.
217			*
218			* @param string $link
219			*
220			* @throws \InvalidArgumentException
221			*/
222			public function setAboutLink($link)
223			{
224			if (false === filter_var($link, FILTER_VALIDATE_URL)) {
225			throw new \InvalidArgumentException(sprintf('Provided link %s is not a valid resource', $link));
226			}
227
228			$this->links['about']['href'] = (string) $link;
229			}
230
231			/**
232			* A meta object containing non-standard meta-information about the error.
233			*
234			* @param mixed $meta
235			*/
236			public function setMeta($meta)
237			{
238			$this->meta = $meta;
239			}
240
241			/**
242			* {@inheritdoc}
243			*/
244			public function jsonSerialize()
245			{
246			return array_filter(
247			[
248			'id' => $this->id,
249			'links' => $this->links,
250			'status' => $this->status,
251			'code' => $this->code,
252			'title' => $this->title,
253			'detail' => $this->detail,
254			'source' => $this->source,
255			'meta' => $this->meta,
256			]
257			);
258			}
259			}
260

nilportugues / json-api

Error::setAboutLink() A last analyzed 2016-05-09 15:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Error::setAboutLink() A
last analyzed 2016-05-09 15:54 UTC