Sitemap::__construct() - Code Metrics - Inspection of "feature #162" - spatie/laravel-sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#166)

by Grummfy

created 2018-05-04 22:38 UTC

Sitemap::__construct() A

↳ Parent: Sitemap

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Spatie\Sitemap;

use Spatie\Sitemap\Tags\Tag;
use Spatie\Sitemap\Tags\Url;

class Sitemap
{
    /** @var array */
    protected $tags = [];

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

    public static function create(): self
    {
        return new static(config('sitemap.sitemap_xsl'));
    }

    public function __construct(string $sitemapXsl)
    {
        $this->sitemapXsl = $sitemapXsl;
        return $this;

    }

    /**
     * @param string|\Spatie\Sitemap\Tags\Tag $tag
     *
     * @return $this
     */
    public function add($tag): self
    {
        if (is_string($tag)) {
            $tag = Url::create($tag);
        }

        if (! in_array($tag, $this->tags)) {
            $this->tags[] = $tag;
        }

        return $this;
    }

    public function getTags(): array
    {
        return $this->tags;
    }

    public function getUrl(string $url): ?Url
    {
        return collect($this->tags)->first(function (Tag $tag) use ($url) {
            return $tag->getType() === 'url' && $tag->url === $url;

        });
    }

    public function hasUrl(string $url): bool
    {
        return (bool) $this->getUrl($url);
    }

    public function render(): string
    {
        sort($this->tags);

        $tags = $this->tags;
        $sitemapXsl = $this->sitemapXsl;

        return view('laravel-sitemap::sitemap')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with(compact('tags', 'sitemapXsl'))
            ->render();
    }

    public function writeToFile(string $path): self
    {
        file_put_contents($path, $this->render());

        return $this;
    }
}


1			<?php
2
3			namespace Spatie\Sitemap;
4
5			use Spatie\Sitemap\Tags\Tag;
6			use Spatie\Sitemap\Tags\Url;
7
8			class Sitemap
9			{
10			/** @var array */
11			protected $tags = [];
12
13			/** @var string */
14			protected $sitemapXsl;
15
16			public static function create(): self
17			{
18			return new static(config('sitemap.sitemap_xsl'));
19			}
20
21			public function __construct(string $sitemapXsl)
22			{
23			$this->sitemapXsl = $sitemapXsl;
24			return $this;
			0 ignored issues – show Bug introduced 2018-05-04 22:40 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
25			}
26
27			/**
28			* @param string\|\Spatie\Sitemap\Tags\Tag $tag
29			*
30			* @return $this
31			*/
32			public function add($tag): self
33			{
34			if (is_string($tag)) {
35			$tag = Url::create($tag);
36			}
37
38			if (! in_array($tag, $this->tags)) {
39			$this->tags[] = $tag;
40			}
41
42			return $this;
43			}
44
45			public function getTags(): array
46			{
47			return $this->tags;
48			}
49
50			public function getUrl(string $url): ?Url
51			{
52			return collect($this->tags)->first(function (Tag $tag) use ($url) {
53			return $tag->getType() === 'url' && $tag->url === $url;
			0 ignored issues – show Bug introduced 2016-12-01 13:21 UTC by Report Bug Copy Issue Report The property `url` does not seem to exist in `Spatie\Sitemap\Tags\Tag`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
54			});
55			}
56
57			public function hasUrl(string $url): bool
58			{
59			return (bool) $this->getUrl($url);
60			}
61
62			public function render(): string
63			{
64			sort($this->tags);
65
66			$tags = $this->tags;
67			$sitemapXsl = $this->sitemapXsl;
68
69			return view('laravel-sitemap::sitemap')
			0 ignored issues – show Bug introduced 2016-08-15 18:13 UTC by Report Bug Copy Issue Report The method `with` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
70			->with(compact('tags', 'sitemapXsl'))
71			->render();
72			}
73
74			public function writeToFile(string $path): self
75			{
76			file_put_contents($path, $this->render());
77
78			return $this;
79			}
80			}
81

spatie / laravel-sitemap

Pull Request — master (#166)

Sitemap::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like