Sitemap::jsonSerialize() - Code Metrics - Inspection of "Merge pull request #12 from ARCANEDEV/patch-2" - ARCANEDEV/LaravelSitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 086d51...184cf7 )

by ARCANEDEV

created 2017-07-13 17:04 UTC

Sitemap::jsonSerialize() A

↳ Parent: Sitemap

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\Sitemap as SitemapContract;
use Illuminate\Support\Collection;
use Arcanedev\LaravelSitemap\Contracts\Entities\Url as UrlContract;

/**
 * Class     Sitemap
 *
 * @package  Arcanedev\LaravelSitemap\Entities
 * @author   ARCANEDEV <[email protected]>
 */
class Sitemap implements SitemapContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

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

    /** @var  \Illuminate\Support\Collection */
    protected $urls;

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

    /**
     * Sitemap constructor.
     */
    public function __construct()
    {
        $this->urls = new Collection;
    }

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

    /**
     * Set the sitemap path.
     *
     * @param  string  $path
     *
     * @return self
     */
    public function setPath($path)
    {
        $this->path = $path;

        return $this;
    }

    /**
     * Get the sitemap path.
     *
     * @return string|null
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Get the sitemap's URLs.
     *
     * @return \Illuminate\Support\Collection
     */
    public function getUrls()
    {
        return $this->urls;
    }

    /**
     * Set the URLs Collection.
     *
     * @param  \Illuminate\Support\Collection  $urls
     *
     * @return self
     */
    public function setUrls(Collection $urls)
    {
        $this->urls = $urls;

        return $this;
    }

    /**
     * Get a URL instance by its loc.
     *
     * @param  string      $loc
     * @param  mixed|null  $default
     *
     * @return \Arcanedev\LaravelSitemap\Entities\Url|null
     */
    public function getUrl($loc, $default = null)
    {
        return $this->getUrls()->get($loc, $default);
    }

    /**
     * Add a sitemap URL to the collection.
     *
     * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Url  $url
     *
     * @return $this
     */
    public function add(UrlContract $url)
    {
        $this->urls->put($url->getLoc(), $url);

        return $this;
    }

    /**
     * Add many urls to the collection.
     *
     * @param  array|\Illuminate\Support\Collection  $urls
     *
     * @return self
     */
    public function addMany($urls)
    {
        foreach ($urls as $url) { $this->add($url); }

        return $this;
    }

    /**
     * Create and Add a sitemap URL to the collection.
     *
     * @param  string    $loc
     * @param  callable  $callback
     *
     * @return self
     */
    public function create($loc, callable $callback)
    {
        return $this->add(tap(Url::make($loc), $callback));
    }

    /**
     * Check if the url exists in the sitemap items.
     *
     * @param  string  $url
     *
     * @return bool
     */
    public function has($url)
    {
        return $this->urls->has($url);
    }

    /**
     * Get the urls' count.
     *
     * @return int
     */
    public function count()
    {
        return $this->urls->count();
    }

    /**
     * Get the collection of items as a plain array.
     *
     * @return array
     */
    public function toArray()
    {
        return $this->getUrls()->values()->toArray();
    }

    /**
     * Get the sitemap and its urls 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();
    }

    /**
     * Check if the number of URLs is exceeded.
     *
     * @return bool
     */
    public function isExceeded()
    {
        return $this->count() > $this->getMaxSize();
    }

    /**
     * Chunk the sitemap to multiple chunks.
     *
     * @return \Illuminate\Support\Collection
     */
    public function chunk()
    {
        return $this->urls->chunk($this->getMaxSize())->mapWithKeys(function ($item, $index) {
            $pathInfo = pathinfo($this->getPath());
            $index    = $index + 1;
            $path     = $pathInfo['dirname'].'/'.$pathInfo['filename'].'-'.$index.'.'.$pathInfo['extension'];

            return [$index => (new Sitemap)->setPath($path)->setUrls($item)];
        });
    }

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

    protected function getMaxSize()
    {
        return config('sitemap.urls-max-size', 50000);
    }
}


1		<?php namespace Arcanedev\LaravelSitemap\Entities;
2
3		use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap as SitemapContract;
4		use Illuminate\Support\Collection;
5		use Arcanedev\LaravelSitemap\Contracts\Entities\Url as UrlContract;
6
7		/**
8		* Class Sitemap
9		*
10		* @package Arcanedev\LaravelSitemap\Entities
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class Sitemap implements SitemapContract
14		{
15		/* -----------------------------------------------------------------
16		\| Properties
17		\| -----------------------------------------------------------------
18		*/
19
20		/** @var string\|null */
21		protected $path;
22
23		/** @var \Illuminate\Support\Collection */
24		protected $urls;
25
26		/* -----------------------------------------------------------------
27		\| Constructor
28		\| -----------------------------------------------------------------
29		*/
30
31		/**
32		* Sitemap constructor.
33		*/
34	54	public function __construct()
35		{
36	54	$this->urls = new Collection;
37	54	}
38
39		/* -----------------------------------------------------------------
40		\| Main Methods
41		\| -----------------------------------------------------------------
42		*/
43
44		/**
45		* Set the sitemap path.
46		*
47		* @param string $path
48		*
49		* @return self
50		*/
51	32	public function setPath($path)
52		{
53	32	$this->path = $path;
54
55	32	return $this;
56		}
57
58		/**
59		* Get the sitemap path.
60		*
61		* @return string\|null
62		*/
63	14	public function getPath()
64		{
65	14	return $this->path;
66		}
67
68		/**
69		* Get the sitemap's URLs.
70		*
71		* @return \Illuminate\Support\Collection
72		*/
73	36	public function getUrls()
74		{
75	36	return $this->urls;
76		}
77
78		/**
79		* Set the URLs Collection.
80		*
81		* @param \Illuminate\Support\Collection $urls
82		*
83		* @return self
84		*/
85	6	public function setUrls(Collection $urls)
86		{
87	6	$this->urls = $urls;
88
89	6	return $this;
90		}
91
92		/**
93		* Get a URL instance by its loc.
94		*
95		* @param string $loc
96		* @param mixed\|null $default
97		*
98		* @return \Arcanedev\LaravelSitemap\Entities\Url\|null
99		*/
100	2	public function getUrl($loc, $default = null)
101		{
102	2	return $this->getUrls()->get($loc, $default);
103		}
104
105		/**
106		* Add a sitemap URL to the collection.
107		*
108		* @param \Arcanedev\LaravelSitemap\Contracts\Entities\Url $url
109		*
110		* @return $this
111		*/
112	48	public function add(UrlContract $url)
113		{
114	48	$this->urls->put($url->getLoc(), $url);
115
116	48	return $this;
117		}
118
119		/**
120		* Add many urls to the collection.
121		*
122		* @param array\|\Illuminate\Support\Collection $urls
123		*
124		* @return self
125		*/
126	2	public function addMany($urls)
127		{
128	2	foreach ($urls as $url) { $this->add($url); }
129
130	2	return $this;
131		}
132
133		/**
134		* Create and Add a sitemap URL to the collection.
135		*
136		* @param string $loc
137		* @param callable $callback
138		*
139		* @return self
140		*/
141	30	public function create($loc, callable $callback)
142		{
143	30	return $this->add(tap(Url::make($loc), $callback));
144		}
145
146		/**
147		* Check if the url exists in the sitemap items.
148		*
149		* @param string $url
150		*
151		* @return bool
152		*/
153	4	public function has($url)
154		{
155	4	return $this->urls->has($url);
156		}
157
158		/**
159		* Get the urls' count.
160		*
161		* @return int
162		*/
163	34	public function count()
164		{
165	34	return $this->urls->count();
166		}
167
168		/**
169		* Get the collection of items as a plain array.
170		*
171		* @return array
172		*/
173	12	public function toArray()
174		{
175	12	return $this->getUrls()->values()->toArray();
176		}
177
178		/**
179		* Get the sitemap and its urls as JSON.
180		*
181		* @param int $options
182		*
183		* @return string
184		*/
185	2	public function toJson($options = 0)
186		{
187	2	return json_encode($this->jsonSerialize(), $options);
188		}
189
190		/**
191		* Convert the object into something JSON serializable.
192		*
193		* @return array
194		*/
195	2	public function jsonSerialize()
196		{
197	2	return $this->toArray();
198		}
199
200		/**
201		* Check if the number of URLs is exceeded.
202		*
203		* @return bool
204		*/
205	22	public function isExceeded()
206		{
207	22	return $this->count() > $this->getMaxSize();
208		}
209
210		/**
211		* Chunk the sitemap to multiple chunks.
212		*
213		* @return \Illuminate\Support\Collection
214		*/
215		public function chunk()
216		{
217	4	return $this->urls->chunk($this->getMaxSize())->mapWithKeys(function ($item, $index) {
218	4	$pathInfo = pathinfo($this->getPath());
219	4	$index = $index + 1;
220	4	$path = $pathInfo['dirname'].'/'.$pathInfo['filename'].'-'.$index.'.'.$pathInfo['extension'];
221
222	4	return [$index => (new Sitemap)->setPath($path)->setUrls($item)];
223	4	});
224		}
225
226		/* -----------------------------------------------------------------
227		\| Other Methods
228		\| -----------------------------------------------------------------
229		*/
230
231	22	protected function getMaxSize()
232		{
233	22	return config('sitemap.urls-max-size', 50000);
234		}
235		}
236

ARCANEDEV / LaravelSitemap

Push — master ( 086d51...184cf7 )

Sitemap::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like