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; |
|
|
|
|
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; |
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') |
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
|
|
|
|
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/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 beforeOtherDir/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: