Url::jsonSerialize() - Code Metrics - Inspection of "Merge pull request #9 from ARCANEDEV/develop" - ARCANEDEV/LaravelSitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 79bfd4...3da984 )

by ARCANEDEV

created 2017-07-13 13:18 UTC

Url::jsonSerialize() A

↳ Parent: Url

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\LaravelSitemap\Entities;

use Arcanedev\LaravelSitemap\Contracts\Entities\Url as UrlContract;
use Arcanedev\LaravelSitemap\Exceptions\SitemapException;
use ArrayAccess;
use DateTime;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

/**
 * Class     Url
 *
 * @package  Arcanedev\LaravelSitemap\Entities
 * @author   ARCANEDEV <[email protected]>
 */
class Url implements ArrayAccess, UrlContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  string  */
    protected $loc;

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

    /** @var  \DateTimeInterface */
    protected $lastModDate;

    /** @var  string */
    protected $changeFrequency;

    /** @var  float */
    protected $priority;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Url constructor.
     *
     * @param  array|string  $attributes
     */
    public function __construct($attributes)
    {
        if (is_string($attributes))
            $attributes = ['loc' => $attributes];

        $this->setLoc(Arr::get($attributes, 'loc'));
        $this->setLastMod(Arr::get($attributes, 'lastmod', new DateTime));
        $this->setChangeFreq(Arr::get($attributes, 'changefreq', ChangeFrequency::DAILY));
        $this->setPriority(Arr::get($attributes, 'priority', 0.8));
        $this->setTitle(Arr::get($attributes, 'title'));
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the url location.
     *
     * @return string
     */
    public function getLoc()
    {
        return $this->escape($this->loc);
    }

    /**
     * Get the url location (alias).
     *
     * @see getLoc()
     *
     * @return string
     */
    public function loc()
    {
        return $this->getLoc();
    }

    /**
     * Set the url location.
     *
     * @param  string  $loc
     *
     * @return self
     *
     * @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
     */
    public function setLoc($loc)
    {
        $this->loc = $this->checkLoc($loc);

        return $this;
    }

    /**
     * Get the last modification date.
     *
     * @return \DateTimeInterface
     */
    public function getLastMod()
    {
        return $this->lastModDate;
    }

    /**
     * Get the last modification date (alias).
     *
     * @see getLastMod()
     *
     * @return \DateTimeInterface
     */
    public function lastMod()
    {
        return $this->getLastMod();
    }

    /**
     * Format the url last modification.
     *
     * @param  string  $format
     *
     * @return string
     */
    public function formatLastMod($format = DateTime::ATOM)
    {
        return $this->getLastMod()->format($format);
    }

    /**
     * Set the last modification date.
     *
     * @param  string|\DateTimeInterface  $lastModDate
     * @param  string                     $format
     *
     * @return self
     */
    public function setLastMod($lastModDate, $format = 'Y-m-d H:i:s')
    {
        if (is_string($lastModDate))
            $lastModDate = DateTime::createFromFormat($format, $lastModDate);

        $this->lastModDate = $lastModDate;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * Get the change frequency.
     *
     * @return string
     */
    public function getChangeFreq()
    {
        return $this->changeFrequency;
    }

    /**
     * Get the change frequency (alias).
     *
     * @see getChangeFreq()
     *
     * @return string
     */
    public function changeFreq()
    {
        return $this->getChangeFreq();
    }

    /**
     * Set the change frequency.
     *
     * @param  string  $changeFreq
     *
     * @return self
     */
    public function setChangeFreq($changeFreq)
    {
        $this->changeFrequency = strtolower(trim($changeFreq));

        return $this;
    }

    /**
     * Get the priority.
     *
     * @return float
     */
    public function getPriority()
    {
        return $this->priority;
    }

    /**
     * Get the priority (alias).
     *
     * @see getPriority()
     *
     * @return float
     */
    public function priority()
    {
        return $this->getPriority();
    }

    /**
     * Set the priority.
     *
     * @param  float  $priority
     *
     * @return self
     *
     * @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
     */
    public function setPriority($priority)
    {
        $this->priority = $this->checkPriority($priority);

        return $this;
    }

    /**
     * Get the title.
     *
     * @return string|null
     */
    public function getTitle()
    {
        return $this->escape($this->title);
    }

    /**
     * Get the title.
     *
     * @param  string  $title
     *
     * @return self
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create a sitemap url instance.
     *
     * @param  string  $loc
     *
     * @return \Arcanedev\LaravelSitemap\Entities\Url
     */
    public static function make($loc)
    {
        return new static(compact('loc'));
    }

    /**
     * Make a URL instance with attributes.
     *
     * @param  array  $attributes
     *
     * @return \Arcanedev\LaravelSitemap\Entities\Url
     */
    public static function makeFromArray(array $attributes)
    {
        return new static($attributes);
    }

    /**
     * Get the collection of items as a plain array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'title'      => $this->getTitle(),
            'loc'        => $this->getLoc(),
            'lastmod'    => $this->formatLastMod(),
            'changefreq' => $this->getChangeFreq(),
            'priority'   => $this->getPriority(),
        ];
    }

    /**
     * Get the sitemap url as JSON.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Escape the given value.
     *
     * @param  string  $value
     *
     * @return string
     */
    protected function escape($value)
    {
        if (is_null($value))
            return $value;

        return config('sitemap.escaping', true)
            ? htmlentities($value, ENT_XML1, 'UTF-8')
            : $value;
    }

    /**
     * Determine if the given attribute exists.
     *
     * @param  mixed  $offset
     *
     * @return bool
     */
    public function offsetExists($offset)
    {
        return method_exists($this, 'get'.Str::studly($offset));
    }

    /**
     * Get the value for a given offset.
     *
     * @param  mixed  $offset
     *
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return call_user_func([$this, 'get'.Str::studly($offset)]);
    }

    /**
     * Set the value for a given offset.
     *
     * @param  mixed  $offset
     * @param  mixed  $value
     *
     * @return void
     */
    public function offsetSet($offset, $value) {} // Do nothing...

    /**
     * Unset the value for a given offset.
     *
     * @param  mixed  $offset
     *
     * @return void
     */
    public function offsetUnset($offset) {} // Do nothing...

    /**
     * Check the loc value.
     *
     * @param  string  $loc
     *
     * @return string
     *
     * @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
     */
    protected function checkLoc($loc)
    {
        if (is_null($loc) || ! is_string($loc))
            throw new SitemapException('The [loc] attribute is required and must be string value.');

        return $loc;
    }

    /**
     * Check the priority value.
     *
     * @param  float  $priority
     *
     * @return float
     *
     * @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
     */
    protected function checkPriority($priority)
    {
        if ( ! is_numeric($priority))
            throw new SitemapException("The [priority] value must be numeric.");

        $priority = round($priority, 1);

        if ($priority > 1 || $priority < 0)
            throw new SitemapException("The [priority] value must be between `0.0` and `1.0`, `{$priority}` was given.");

        return $priority;
    }
}


1		<?php namespace Arcanedev\LaravelSitemap\Entities;
2
3		use Arcanedev\LaravelSitemap\Contracts\Entities\Url as UrlContract;
4		use Arcanedev\LaravelSitemap\Exceptions\SitemapException;
5		use ArrayAccess;
6		use DateTime;
7		use Illuminate\Support\Arr;
8		use Illuminate\Support\Str;
9
10		/**
11		* Class Url
12		*
13		* @package Arcanedev\LaravelSitemap\Entities
14		* @author ARCANEDEV <[email protected]>
15		*/
16		class Url implements ArrayAccess, UrlContract
17		{
18		/* -----------------------------------------------------------------
19		\| Properties
20		\| -----------------------------------------------------------------
21		*/
22
23		/** @var string */
24		protected $loc;
25
26		/** @var string\|null */
27		protected $title;
28
29		/** @var \DateTimeInterface */
30		protected $lastModDate;
31
32		/** @var string */
33		protected $changeFrequency;
34
35		/** @var float */
36		protected $priority;
37
38		/* -----------------------------------------------------------------
39		\| Constructor
40		\| -----------------------------------------------------------------
41		*/
42
43		/**
44		* Url constructor.
45		*
46		* @param array\|string $attributes
47		*/
48	76	public function __construct($attributes)
49		{
50	76	if (is_string($attributes))
51	32	$attributes = ['loc' => $attributes];
52
53	76	$this->setLoc(Arr::get($attributes, 'loc'));
54	76	$this->setLastMod(Arr::get($attributes, 'lastmod', new DateTime));
55	76	$this->setChangeFreq(Arr::get($attributes, 'changefreq', ChangeFrequency::DAILY));
56	76	$this->setPriority(Arr::get($attributes, 'priority', 0.8));
57	76	$this->setTitle(Arr::get($attributes, 'title'));
58	76	}
59
60		/* -----------------------------------------------------------------
61		\| Getters & Setters
62		\| -----------------------------------------------------------------
63		*/
64
65		/**
66		* Get the url location.
67		*
68		* @return string
69		*/
70	58	public function getLoc()
71		{
72	58	return $this->escape($this->loc);
73		}
74
75		/**
76		* Get the url location (alias).
77		*
78		* @see getLoc()
79		*
80		* @return string
81		*/
82	14	public function loc()
83		{
84	14	return $this->getLoc();
85		}
86
87		/**
88		* Set the url location.
89		*
90		* @param string $loc
91		*
92		* @return self
93		*
94		* @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
95		*/
96	76	public function setLoc($loc)
97		{
98	76	$this->loc = $this->checkLoc($loc);
99
100	76	return $this;
101		}
102
103		/**
104		* Get the last modification date.
105		*
106		* @return \DateTimeInterface
107		*/
108	34	public function getLastMod()
109		{
110	34	return $this->lastModDate;
111		}
112
113		/**
114		* Get the last modification date (alias).
115		*
116		* @see getLastMod()
117		*
118		* @return \DateTimeInterface
119		*/
120	10	public function lastMod()
121		{
122	10	return $this->getLastMod();
123		}
124
125		/**
126		* Format the url last modification.
127		*
128		* @param string $format
129		*
130		* @return string
131		*/
132	28	public function formatLastMod($format = DateTime::ATOM)
133		{
134	28	return $this->getLastMod()->format($format);
135		}
136
137		/**
138		* Set the last modification date.
139		*
140		* @param string\|\DateTimeInterface $lastModDate
141		* @param string $format
142		*
143		* @return self
144		*/
145	76	public function setLastMod($lastModDate, $format = 'Y-m-d H:i:s')
146		{
147	76	if (is_string($lastModDate))
148	46	$lastModDate = DateTime::createFromFormat($format, $lastModDate);
149
150	76	$this->lastModDate = $lastModDate;
		0 ignored issues – show Documentation Bug introduced 2017-07-13 11:14 UTC by Report Bug Copy Issue Report It seems like `$lastModDate` can also be of type `false`. However, the property `$lastModDate` is declared as type `object<DateTimeInterface>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
151
152	76	return $this;
153		}
154
155		/**
156		* Get the change frequency.
157		*
158		* @return string
159		*/
160	32	public function getChangeFreq()
161		{
162	32	return $this->changeFrequency;
163		}
164
165		/**
166		* Get the change frequency (alias).
167		*
168		* @see getChangeFreq()
169		*
170		* @return string
171		*/
172	10	public function changeFreq()
173		{
174	10	return $this->getChangeFreq();
175		}
176
177		/**
178		* Set the change frequency.
179		*
180		* @param string $changeFreq
181		*
182		* @return self
183		*/
184	76	public function setChangeFreq($changeFreq)
185		{
186	76	$this->changeFrequency = strtolower(trim($changeFreq));
187
188	76	return $this;
189		}
190
191		/**
192		* Get the priority.
193		*
194		* @return float
195		*/
196	32	public function getPriority()
197		{
198	32	return $this->priority;
199		}
200
201		/**
202		* Get the priority (alias).
203		*
204		* @see getPriority()
205		*
206		* @return float
207		*/
208	10	public function priority()
209		{
210	10	return $this->getPriority();
211		}
212
213		/**
214		* Set the priority.
215		*
216		* @param float $priority
217		*
218		* @return self
219		*
220		* @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
221		*/
222	76	public function setPriority($priority)
223		{
224	76	$this->priority = $this->checkPriority($priority);
225
226	76	return $this;
227		}
228
229		/**
230		* Get the title.
231		*
232		* @return string\|null
233		*/
234	28	public function getTitle()
235		{
236	28	return $this->escape($this->title);
237		}
238
239		/**
240		* Get the title.
241		*
242		* @param string $title
243		*
244		* @return self
245		*/
246	76	public function setTitle($title)
247		{
248	76	$this->title = $title;
249
250	76	return $this;
251		}
252
253		/* -----------------------------------------------------------------
254		\| Main Methods
255		\| -----------------------------------------------------------------
256		*/
257
258		/**
259		* Create a sitemap url instance.
260		*
261		* @param string $loc
262		*
263		* @return \Arcanedev\LaravelSitemap\Entities\Url
264		*/
265	54	public static function make($loc)
266		{
267	54	return new static(compact('loc'));
268		}
269
270		/**
271		* Make a URL instance with attributes.
272		*
273		* @param array $attributes
274		*
275		* @return \Arcanedev\LaravelSitemap\Entities\Url
276		*/
277	4	public static function makeFromArray(array $attributes)
278		{
279	4	return new static($attributes);
280		}
281
282		/**
283		* Get the collection of items as a plain array.
284		*
285		* @return array
286		*/
287	18	public function toArray()
288		{
289		return [
290	18	'title' => $this->getTitle(),
291	18	'loc' => $this->getLoc(),
292	18	'lastmod' => $this->formatLastMod(),
293	18	'changefreq' => $this->getChangeFreq(),
294	18	'priority' => $this->getPriority(),
295		];
296		}
297
298		/**
299		* Get the sitemap url as JSON.
300		*
301		* @param int $options
302		*
303		* @return string
304		*/
305	2	public function toJson($options = 0)
306		{
307	2	return json_encode($this->jsonSerialize(), $options);
308		}
309
310		/**
311		* Convert the object into something JSON serializable.
312		*
313		* @return array
314		*/
315	2	public function jsonSerialize()
316		{
317	2	return $this->toArray();
318		}
319
320		/* -----------------------------------------------------------------
321		\| Other Methods
322		\| -----------------------------------------------------------------
323		*/
324
325		/**
326		* Escape the given value.
327		*
328		* @param string $value
329		*
330		* @return string
331		*/
332	60	protected function escape($value)
333		{
334	60	if (is_null($value))
335	16	return $value;
336
337	60	return config('sitemap.escaping', true)
338	60	? htmlentities($value, ENT_XML1, 'UTF-8')
339	60	: $value;
340		}
341
342		/**
343		* Determine if the given attribute exists.
344		*
345		* @param mixed $offset
346		*
347		* @return bool
348		*/
349	2	public function offsetExists($offset)
350		{
351	2	return method_exists($this, 'get'.Str::studly($offset));
352		}
353
354		/**
355		* Get the value for a given offset.
356		*
357		* @param mixed $offset
358		*
359		* @return mixed
360		*/
361	2	public function offsetGet($offset)
362		{
363	2	return call_user_func([$this, 'get'.Str::studly($offset)]);
364		}
365
366		/**
367		* Set the value for a given offset.
368		*
369		* @param mixed $offset
370		* @param mixed $value
371		*
372		* @return void
373		*/
374		public function offsetSet($offset, $value) {} // Do nothing...
375
376		/**
377		* Unset the value for a given offset.
378		*
379		* @param mixed $offset
380		*
381		* @return void
382		*/
383		public function offsetUnset($offset) {} // Do nothing...
384
385		/**
386		* Check the loc value.
387		*
388		* @param string $loc
389		*
390		* @return string
391		*
392		* @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
393		*/
394	76	protected function checkLoc($loc)
395		{
396	76	if (is_null($loc) \|\| ! is_string($loc))
397	4	throw new SitemapException('The [loc] attribute is required and must be string value.');
398
399	76	return $loc;
400		}
401
402		/**
403		* Check the priority value.
404		*
405		* @param float $priority
406		*
407		* @return float
408		*
409		* @throws \Arcanedev\LaravelSitemap\Exceptions\SitemapException
410		*/
411	76	protected function checkPriority($priority)
412		{
413	76	if ( ! is_numeric($priority))
414	2	throw new SitemapException("The [priority] value must be numeric.");
415
416	76	$priority = round($priority, 1);
417
418	76	if ($priority > 1 \|\| $priority < 0)
419	2	throw new SitemapException("The [priority] value must be between `0.0` and `1.0`, `{$priority}` was given.");
420
421	76	return $priority;
422		}
423		}
424

ARCANEDEV / LaravelSitemap

Push — master ( 79bfd4...3da984 )

Url::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like