https://github.com/bkwld/sitemap-from-routes
Generate a sitemap directly from your Laravel routes/web.php.
https://github.com/bkwld/sitemap-from-routes
Last synced: over 1 year ago
JSON representation
Generate a sitemap directly from your Laravel routes/web.php.
- Host: GitHub
- URL: https://github.com/bkwld/sitemap-from-routes
- Owner: BKWLD
- Created: 2017-09-08T12:53:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-08T16:50:12.000Z (almost 9 years ago)
- Last Synced: 2025-03-05T10:02:05.621Z (over 1 year ago)
- Language: PHP
- Size: 6.84 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sitemap from Routes
Generate a sitemap directly from your Laravel routes/web.php using [roumen/sitemap](https://github.com/Laravelium/laravel-sitemap).
```php
Sitemap::add(Route::get('news', 'News@index'));
Sitemap::add('news/{article}', 'News@show'));
```
This works because, during install, you change the Route facade to point to a class of this package that adds a the fluent `sitemap` to Laravel `Route` instances. The `sitemap` method looks at the uri of the route and unpacks any model bindings it finds, fetching all public instances of those models and adding them to the sitemap.
## Installation
1. Run `require add bkwld/sitemap-from-routes`
2. Install [roumen/sitemap](https://github.com/Laravelium/laravel-sitemap) assets: `php artisan vendor:publish --provider="Roumen\Sitemap\SitemapServiceProvider"`
3. Add a route for the sitemap to your routes file: `Route::get('sitemap', '\Bkwld\SitemapFromRoutes\Controller@index')`.
#### Laravel < 5.5
1. Add to `config.app` providers: `Bkwld\SitemapFromRoutes\ServiceProvider::class`
2. Add to `config.app` aliases: `'Sitemap' => Bkwld\SitemapFromRoutes\Facades::class`
## Usage
Call `sitemap()` from any routes you want to add to the sitemap. For example:
```php
Sitemap::add('news', 'News@index'));
Sitemap::add('news/{article}', 'News@show')->name('article'));
```
Dynamic route parameters must be named the same as the models they should resolve. So, in the above example, you must have an `App\Article` model.
By default, all instances of a model are added to the sitemap by substituting the id of the model into the uri. Thus, the example route would generate `news/1`, `news/2`, and so on.
#### Customize the query
To customize which model instances should be added to the sitemap, specify a `forSitemap` scope on your model. You would do this to only add public records to the sitemap, for instance.
```
namespace App;
class Article {
public function scopeForSitemap($query)
{
$query->where('public', 1);
}
}
```
#### Customize the URL
To customize the URL that is added to the sitemap for model instances, specify a `sitemapUrl` accessor on your model. You would do this if you use slugs in your URLs.
```
namespace App;
class Article {
public function getSitemapUrlAttribute()
{
return route('article', $this->slug);
}
}
```