Sitemap::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

Sitemap::toResponse() A

↳ Parent: Sitemap

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\Url;
use Illuminate\Support\Facades\Response;
use Illuminate\Contracts\Support\Responsable;

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

    public static function create(): self
    {
        return new static();
    }

    /**
     * @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 = collect($this->tags)->unique('url');

        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'))
            ->render();
    }

    public function writeToFile(string $path): self
    {
        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\Url;
7			use Illuminate\Support\Facades\Response;
8			use Illuminate\Contracts\Support\Responsable;
9
10			class Sitemap implements Responsable
11			{
12			/** @var array */
13			protected $tags = [];
14
15			public static function create(): self
16			{
17			return new static();
18			}
19
20			/**
21			* @param string\|\Spatie\Sitemap\Tags\Tag $tag
22			*
23			* @return $this
24			*/
25			public function add($tag): self
26			{
27			if (is_string($tag)) {
28			$tag = Url::create($tag);
29			}
30
31			if (! in_array($tag, $this->tags)) {
32			$this->tags[] = $tag;
33			}
34
35			return $this;
36			}
37
38			public function getTags(): array
39			{
40			return $this->tags;
41			}
42
43			public function getUrl(string $url): ?Url
44			{
45			return collect($this->tags)->first(function (Tag $tag) use ($url) {
46			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...
47			});
48			}
49
50			public function hasUrl(string $url): bool
51			{
52			return (bool) $this->getUrl($url);
53			}
54
55			public function render(): string
56			{
57			sort($this->tags);
58
59			$tags = collect($this->tags)->unique('url');
60
61			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...
62			->with(compact('tags'))
63			->render();
64			}
65
66			public function writeToFile(string $path): self
67			{
68			file_put_contents($path, $this->render());
69
70			return $this;
71			}
72
73			/**
74			* Create an HTTP response that represents the object.
75			*
76			* @param \Illuminate\Http\Request $request
77			* @return \Symfony\Component\HttpFoundation\Response
78			*/
79			public function toResponse($request)
80			{
81			return Response::make($this->render(), 200, [
82			'Content-Type' => 'text/xml',
83			]);
84			}
85			}
86

spatie / laravel-sitemap

Pull Request — master (#268)

Sitemap::toResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like