SitemapIndex::toResponse() - Code Metrics - Inspection of "Implement Responsable contract" - spatie/laravel-sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#268)

by Dwight

created 2019-09-24 11:14 UTC

SitemapIndex::toResponse() A

↳ Parent: SitemapIndex

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Spatie\Sitemap;

use Spatie\Sitemap\Tags\Tag;
use Spatie\Sitemap\Tags\Sitemap;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Illuminate\Support\Facades\Response;
use Illuminate\Contracts\Support\Responsable;

class SitemapIndex implements Responsable
{
    /** @var array */
    protected $tags = [];

    /**
     * @return static
     */
    public static function create()
    {
        return new static();
    }

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

        $this->tags[] = $tag;

        return $this;
    }

    /**
     * Get sitemap tag.
     *
     * @param string $url
     *
     * @return \Spatie\Sitemap\Tags\Sitemap|null
     */
    public function getSitemap(string $url)
    {
        return collect($this->tags)->first(function (Tag $tag) use ($url) {
            return $tag->getType() === 'sitemap' && $tag->url === $url;

        });
    }

    /**
     * Check if there is the provided sitemap in the index.
     *
     * @param string $url
     *
     * @return bool
     */
    public function hasSitemap(string $url): bool
    {
        return (bool) $this->getSitemap($url);
    }

    /**
     * Get the inflated template content.
     *
     * @return string
     */
    public function render(): string
    {
        $tags = $this->tags;

        return view('laravel-sitemap::sitemapIndex/index')
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'))
            ->render();
    }

    /**
     * @param string $path
     *
     * @return $this
     */
    public function writeToFile(string $path)
    {
        file_put_contents($path, $this->render());

        return $this;
    }

    /**
     * Create an HTTP response that represents the object.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function toResponse($request)
    {
        return Response::make($this->render(), 200, [
            'Content-Type' => 'text/xml',
        ]);
    }
}


1			<?php
2
3			namespace Spatie\Sitemap;
4
5			use Spatie\Sitemap\Tags\Tag;
6			use Spatie\Sitemap\Tags\Sitemap;
			0 ignored issues – show Bug introduced 2017-01-31 16:10 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Spatie\Sitemap\Sitemap`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7			use Illuminate\Support\Facades\Response;
8			use Illuminate\Contracts\Support\Responsable;
9
10			class SitemapIndex implements Responsable
11			{
12			/** @var array */
13			protected $tags = [];
14
15			/**
16			* @return static
17			*/
18			public static function create()
19			{
20			return new static();
21			}
22
23			/**
24			* @param string\|\Spatie\Sitemap\Tags\Tag $tag
25			*
26			* @return $this
27			*/
28			public function add($tag)
29			{
30			if (is_string($tag)) {
31			$tag = Sitemap::create($tag);
32			}
33
34			$this->tags[] = $tag;
35
36			return $this;
37			}
38
39			/**
40			* Get sitemap tag.
41			*
42			* @param string $url
43			*
44			* @return \Spatie\Sitemap\Tags\Sitemap\|null
45			*/
46			public function getSitemap(string $url)
47			{
48			return collect($this->tags)->first(function (Tag $tag) use ($url) {
49			return $tag->getType() === 'sitemap' && $tag->url === $url;
			0 ignored issues – show Bug introduced 2017-01-31 16:10 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...
50			});
51			}
52
53			/**
54			* Check if there is the provided sitemap in the index.
55			*
56			* @param string $url
57			*
58			* @return bool
59			*/
60			public function hasSitemap(string $url): bool
61			{
62			return (bool) $this->getSitemap($url);
63			}
64
65			/**
66			* Get the inflated template content.
67			*
68			* @return string
69			*/
70			public function render(): string
71			{
72			$tags = $this->tags;
73
74			return view('laravel-sitemap::sitemapIndex/index')
			0 ignored issues – show Bug introduced 2017-01-31 16:10 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...
75			->with(compact('tags'))
76			->render();
77			}
78
79			/**
80			* @param string $path
81			*
82			* @return $this
83			*/
84			public function writeToFile(string $path)
85			{
86			file_put_contents($path, $this->render());
87
88			return $this;
89			}
90
91			/**
92			* Create an HTTP response that represents the object.
93			*
94			* @param \Illuminate\Http\Request $request
95			* @return \Symfony\Component\HttpFoundation\Response
96			*/
97			public function toResponse($request)
98			{
99			return Response::make($this->render(), 200, [
100			'Content-Type' => 'text/xml',
101			]);
102			}
103			}
104

spatie / laravel-sitemap

Pull Request — master (#268)

SitemapIndex::toResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like