Issues in SitemapIndex.php - All Issues - Inspection of "Merge pull request #169 from spatie/robots-txt" - spatie/laravel-sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4bb569...381ee2 )

by Brent

created 2018-05-08 13:25 UTC

src/SitemapIndex.php (3 issues)

Labels

Bug 3

Severity

Major 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Spatie\Sitemap;

use Spatie\Sitemap\Tags\Tag;
use Spatie\Sitemap\Tags\Sitemap;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

class SitemapIndex
{
    /** @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;
    }
}


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 Show Similar Issues like this 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
8			class SitemapIndex
9			{
10			/** @var array */
11			protected $tags = [];
12
13			/**
14			* @return static
15			*/
16			public static function create()
17			{
18			return new static();
19			}
20
21			/**
22			* @param string\|\Spatie\Sitemap\Tags\Tag $tag
23			*
24			* @return $this
25			*/
26			public function add($tag)
27			{
28			if (is_string($tag)) {
29			$tag = Sitemap::create($tag);
30			}
31
32			$this->tags[] = $tag;
33
34			return $this;
35			}
36
37			/**
38			* Get sitemap tag.
39			*
40			* @param string $url
41			*
42			* @return \Spatie\Sitemap\Tags\Sitemap\|null
43			*/
44			public function getSitemap(string $url)
45			{
46			return collect($this->tags)->first(function (Tag $tag) use ($url) {
47			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 Show Similar Issues like this 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...
48			});
49			}
50
51			/**
52			* Check if there is the provided sitemap in the index.
53			*
54			* @param string $url
55			*
56			* @return bool
57			*/
58			public function hasSitemap(string $url): bool
59			{
60			return (bool) $this->getSitemap($url);
61			}
62
63			/**
64			* Get the inflated template content.
65			*
66			* @return string
67			*/
68			public function render(): string
69			{
70			$tags = $this->tags;
71
72			return view('laravel-sitemap::sitemapIndex/index')
			0 ignored issues – show Bug introduced 2017-01-31 16:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
73			->with(compact('tags'))
74			->render();
75			}
76
77			/**
78			* @param string $path
79			*
80			* @return $this
81			*/
82			public function writeToFile(string $path)
83			{
84			file_put_contents($path, $this->render());
85
86			return $this;
87			}
88			}
89

spatie / laravel-sitemap

Push — master ( 4bb569...381ee2 )

src/SitemapIndex.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like