SitemapManager::store() - Code Metrics - Inspection of "Rewriting the package" - ARCANEDEV/LaravelSitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

by ARCANEDEV

created 2017-07-12 13:26 UTC

SitemapManager::store() D

↳ Parent: Project

Complexity

Conditions	16
Paths	28

Size

Total Lines	81
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	272

Importance

Changes

Metric	Value
cc	16
eloc	37
nc	28
nop	4
dl	0
loc	81
rs	4.9906
c	0
b	0
f	0
ccs	0
cts	39
cp	0
crap	272

How to fix Long Method Complexity

<?php namespace Arcanedev\LaravelSitemap;

use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap as SitemapContract;
use Arcanedev\LaravelSitemap\Contracts\SitemapManager as SitemapManagerContract;
use Arcanedev\LaravelSitemap\Entities\Sitemap;
use DOMDocument;
use Illuminate\Support\Collection;

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

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

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

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

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

    /**
     * Create and add a sitemap to the collection.
     *
     * @param  string    $name
     * @param  callable  $callback
     *
     * @return self
     */
    public function create($name, callable $callback)
    {
        return $this->add($name, tap((new Sitemap)->setPath($name), $callback));
    }

    /**
     * Add a sitemap to the collection.
     *
     * @param  string                                                $name
     * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap  $sitemap
     *
     * @return self
     */
    public function add($name, SitemapContract $sitemap)
    {
        $this->sitemaps->put($name, $sitemap);

        return $this;
    }

    /**
     * Get the sitemaps collection.
     *
     * @return \Illuminate\Support\Collection
     */
    public function all()
    {
        return $this->sitemaps;
    }

    /**
     * Get a sitemap instance.
     *
     * @param  string      $name
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function get($name, $default = null)
    {
        return $this->sitemaps->get($name, $default);
    }

    /**
     * Check if a sitemap exists.
     *
     * @param  string  $name
     *
     * @return bool
     */
    public function has($name)
    {
        return $this->sitemaps->has($name);
    }

    /**
     * Remove a sitemap from the collection by key.
     *
     * @param  string|array  $names
     *
     * @return self
     */
    public function forget($names)
    {
        $this->sitemaps->forget($names);

        return $this;
    }

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

    /**
     * Render the sitemaps.
     *
     * @param  string  $name
     *
     * @return string|null
     */
    public function render($name = null)
    {
        if ($this->sitemaps->isEmpty())
            return null;

        if (is_null($name)) {
            return $this->count() === 1
                ? $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->sitemaps->first()])
                : $this->renderIndex();
        }
        elseif ($this->has($name))
            return $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->get($name)]);

        return null;
    }

    /**
     * Render the sitemap index.
     *
     * @return string
     */
    public function renderIndex()
    {
        return $this->renderView('sitemap::sitemap-index.xml', ['sitemaps' => $this->sitemaps]);
    }

    /**
     * Save the sitemaps.
     *
     * @param  string       $path
     * @param  string|null  $name
     *
     * @return self
     */
    public function save($path, $name = null)
    {
        if ($this->sitemaps->isNotEmpty()) {
            file_put_contents($path, $this->render($name));
        }

        return $this;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

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

    /**
     * Get the collection of sitemaps 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
     | -----------------------------------------------------------------
     */

    /**
     * Render the view.
     *
     * @param  string  $view
     * @param  array   $data
     *
     * @return string
     */
    public function renderView($view, array $data)
    {
        return tap(new DOMDocument('1.0'), function (DOMDocument $document) use ($view, $data) {
            $document->preserveWhiteSpace = false;
            $document->formatOutput = true;
            $document->loadXML(view($view, $data)->render());
        })->saveXML();
    }
}


1		<?php namespace Arcanedev\LaravelSitemap;
2
3		use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap as SitemapContract;
4		use Arcanedev\LaravelSitemap\Contracts\SitemapManager as SitemapManagerContract;
5		use Arcanedev\LaravelSitemap\Entities\Sitemap;
6		use DOMDocument;
7		use Illuminate\Support\Collection;
8
9		/**
10		* Class SitemapManager
11		*
12		* @package Arcanedev\LaravelSitemap
13		* @author ARCANEDEV <[email protected]>
14		*/
15		class SitemapManager implements SitemapManagerContract
16		{
17		/* -----------------------------------------------------------------
18		\| Properties
19		\| -----------------------------------------------------------------
20		*/
21
22		/** @var \Illuminate\Support\Collection */
23		protected $sitemaps;
24
25		/* -----------------------------------------------------------------
26		\| Constructor
27		\| -----------------------------------------------------------------
28		*/
29
30		/**
31		* SitemapManager constructor.
32		*/
33	26	public function __construct()
34		{
35	26	$this->sitemaps = new Collection;
36	26	}
37
38		/* -----------------------------------------------------------------
39		\| Main Methods
40		\| -----------------------------------------------------------------
41		*/
42
43		/**
44		* Create and add a sitemap to the collection.
45		*
46		* @param string $name
47		* @param callable $callback
48		*
49		* @return self
50		*/
51	2	public function create($name, callable $callback)
52		{
53	2	return $this->add($name, tap((new Sitemap)->setPath($name), $callback));
54		}
55
56		/**
57		* Add a sitemap to the collection.
58		*
59		* @param string $name
60		* @param \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap $sitemap
61		*
62		* @return self
63		*/
64	20	public function add($name, SitemapContract $sitemap)
65		{
66	20	$this->sitemaps->put($name, $sitemap);
67
68	20	return $this;
69		}
70
71		/**
72		* Get the sitemaps collection.
73		*
74		* @return \Illuminate\Support\Collection
75		*/
76	10	public function all()
77		{
78	10	return $this->sitemaps;
79		}
80
81		/**
82		* Get a sitemap instance.
83		*
84		* @param string $name
85		* @param mixed\|null $default
86		*
87		* @return mixed
88		*/
89	10	public function get($name, $default = null)
90		{
91	10	return $this->sitemaps->get($name, $default);
92		}
93
94		/**
95		* Check if a sitemap exists.
96		*
97		* @param string $name
98		*
99		* @return bool
100		*/
101	8	public function has($name)
102		{
103	8	return $this->sitemaps->has($name);
104		}
105
106		/**
107		* Remove a sitemap from the collection by key.
108		*
109		* @param string\|array $names
110		*
111		* @return self
112		*/
113	2	public function forget($names)
114		{
115	2	$this->sitemaps->forget($names);
116
117	2	return $this;
118		}
119
120		/**
121		* Get the sitemaps count.
122		*
123		* @return int
124		*/
125	14	public function count()
126		{
127	14	return $this->sitemaps->count();
128		}
129
130		/**
131		* Render the sitemaps.
132		*
133		* @param string $name
134		*
135		* @return string\|null
136		*/
137	10	public function render($name = null)
138		{
139	10	if ($this->sitemaps->isEmpty())
140	2	return null;
141
142	8	if (is_null($name)) {
143	6	return $this->count() === 1
144	2	? $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->sitemaps->first()])
145	6	: $this->renderIndex();
146		}
147	6	elseif ($this->has($name))
148	6	return $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->get($name)]);
149
150	2	return null;
151		}
152
153		/**
154		* Render the sitemap index.
155		*
156		* @return string
157		*/
158	4	public function renderIndex()
159		{
160	4	return $this->renderView('sitemap::sitemap-index.xml', ['sitemaps' => $this->sitemaps]);
161		}
162
163		/**
164		* Save the sitemaps.
165		*
166		* @param string $path
167		* @param string\|null $name
168		*
169		* @return self
170		*/
171	6	public function save($path, $name = null)
172		{
173	6	if ($this->sitemaps->isNotEmpty()) {
174	6	file_put_contents($path, $this->render($name));
175		}
176
177	6	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-07-12 11:16 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Arcanedev\LaravelSitemap\SitemapManager`) is incompatible with the return type declared by the interface `Arcanedev\LaravelSitemap...ts\SitemapManager::save` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
178		}
179
180		/**
181		* Get the collection of items as a plain array.
182		*
183		* @return array
184		*/
185	4	public function toArray()
186		{
187	4	return $this->all()->toArray();
188		}
189
190		/**
191		* Get the collection of sitemaps as JSON.
192		*
193		* @param int $options
194		*
195		* @return string
196		*/
197	2	public function toJson($options = 0)
198		{
199	2	return json_encode($this->jsonSerialize(), $options);
200		}
201
202		/**
203		* Convert the object into something JSON serializable.
204		*
205		* @return array
206		*/
207	2	public function jsonSerialize()
208		{
209	2	return $this->toArray();
210		}
211
212		/* -----------------------------------------------------------------
213		\| Other Methods
214		\| -----------------------------------------------------------------
215		*/
216
217		/**
218		* Render the view.
219		*
220		* @param string $view
221		* @param array $data
222		*
223		* @return string
224		*/
225		public function renderView($view, array $data)
226		{
227	8	return tap(new DOMDocument('1.0'), function (DOMDocument $document) use ($view, $data) {
228	8	$document->preserveWhiteSpace = false;
229	8	$document->formatOutput = true;
230	8	$document->loadXML(view($view, $data)->render());
231	8	})->saveXML();
232		}
233		}
234

ARCANEDEV / LaravelSitemap

Pull Request — master (#9)

SitemapManager::store() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like