SitemapIndex::writeToDisk() - Code Metrics - Inspection of "add writeToDisk() logic (#283)" - spatie/laravel-sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f303da...fa41a0 )

by Freek

created 2020-01-20 12:55 UTC

SitemapIndex::writeToDisk() 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	2

<?php

namespace Spatie\Sitemap;

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

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;
    }

    public function writeToDisk(string $disk, string $path): self
    {
        Storage::disk($disk)->put($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 Illuminate\Contracts\Support\Responsable;
6			use Illuminate\Support\Facades\Response;
7			use Illuminate\Support\Facades\Storage;
8			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...
9			use Spatie\Sitemap\Tags\Tag;
10
11			class SitemapIndex implements Responsable
12			{
13			/** @var array */
14			protected $tags = [];
15
16			/**
17			* @return static
18			*/
19			public static function create()
20			{
21			return new static();
22			}
23
24			/**
25			* @param string\|\Spatie\Sitemap\Tags\Tag $tag
26			*
27			* @return $this
28			*/
29			public function add($tag)
30			{
31			if (is_string($tag)) {
32			$tag = Sitemap::create($tag);
33			}
34
35			$this->tags[] = $tag;
36
37			return $this;
38			}
39
40			/**
41			* Get sitemap tag.
42			*
43			* @param string $url
44			*
45			* @return \Spatie\Sitemap\Tags\Sitemap\|null
46			*/
47			public function getSitemap(string $url)
48			{
49			return collect($this->tags)->first(function (Tag $tag) use ($url) {
50			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...
51			});
52			}
53
54			/**
55			* Check if there is the provided sitemap in the index.
56			*
57			* @param string $url
58			*
59			* @return bool
60			*/
61			public function hasSitemap(string $url): bool
62			{
63			return (bool) $this->getSitemap($url);
64			}
65
66			/**
67			* Get the inflated template content.
68			*
69			* @return string
70			*/
71			public function render(): string
72			{
73			$tags = $this->tags;
74
75			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...
76			->with(compact('tags'))
77			->render();
78			}
79
80			/**
81			* @param string $path
82			*
83			* @return $this
84			*/
85			public function writeToFile(string $path)
86			{
87			file_put_contents($path, $this->render());
88
89			return $this;
90			}
91
92			public function writeToDisk(string $disk, string $path): self
93			{
94			Storage::disk($disk)->put($path, $this->render());
95
96			return $this;
97			}
98
99			/**
100			* Create an HTTP response that represents the object.
101			*
102			* @param \Illuminate\Http\Request $request
103			* @return \Symfony\Component\HttpFoundation\Response
104			*/
105			public function toResponse($request)
106			{
107			return Response::make($this->render(), 200, [
108			'Content-Type' => 'text/xml',
109			]);
110			}
111			}
112

spatie / laravel-sitemap

Push — master ( f303da...fa41a0 )

SitemapIndex::writeToDisk() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like