Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dwightwatson/sitemap
Google sitemap builder for Laravel
https://github.com/dwightwatson/sitemap
laravel php sitemap
Last synced: 25 days ago
JSON representation
Google sitemap builder for Laravel
- Host: GitHub
- URL: https://github.com/dwightwatson/sitemap
- Owner: dwightwatson
- License: mit
- Created: 2014-01-31T02:56:03.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T11:24:40.000Z (5 months ago)
- Last Synced: 2024-09-29T20:21:19.090Z (about 1 month ago)
- Topics: laravel, php, sitemap
- Language: PHP
- Homepage:
- Size: 170 KB
- Stars: 269
- Watchers: 13
- Forks: 43
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Sitemap for Laravel
===================
[](https://travis-ci.org/dwightwatson/sitemap)
[](https://packagist.org/packages/watson/sitemap)
[](https://packagist.org/packages/watson/sitemap)
[](https://packagist.org/packages/watson/sitemap)
[](https://packagist.org/packages/watson/sitemap)
Sitemap is a package built specifically for Laravel that will help you generate XML sitemaps for Google. Based on [laravel-sitemap](https://github.com/RoumenDamianoff/laravel-sitemap) this package operates in a slightly different way to better fit the needs of our project. A facade is used to access the sitemap class and we have added the ability to produce sitemap indexes as well as sitemaps. Furthermore, it's tested.
Read more about sitemaps and how to use them efficiently on [Google Webmaster Tools](https://support.google.com/webmasters/answer/156184?hl=en).
## Installation
```sh
composer require watson/sitemap
```
## Usage
### Creating sitemap indexes
If you have a large number of links (50,000+) you will want to break your sitemaps out into seperate sitemaps with a sitemap index linking them all. You add sitemap indexes using `Sitemap::addSitemap($location, $lastModified)` and then you return the sitemap index with `Sitemap::renderSitemapIndex()`. The `$lastModified` variable will be parsed and converted to the right format for a sitemap.
Here is an example controller that produces a sitemap index.
```php
namespace App\Http\Controllers;
use Sitemap;
class SitemapsController extends Controller
{
public function index()
{
// Get a general sitemap.
Sitemap::addSitemap('/sitemaps/general');
// You can use the route helpers too.
Sitemap::addSitemap(route('sitemaps.posts'));
// Return the sitemap to the client.
return Sitemap::index();
}
}
```
Simply route to this as you usually would, `Route::get('sitemap', 'SitemapsController@index');`.
### Creating sitemaps
Similarly to sitemap indexes, you just add tags for each item in your sitemap using `Sitemap::addTag($location, $lastModified, $changeFrequency, $priority)`. You can return the sitemap with `Sitemap::renderSitemap()`. Again, the `$lastModified` variable will be parsed and convered to the right format for the sitemap.
If you'd like to just get the raw XML, simply call `Sitemap::xml()`.
Here is an example controller that produces a sitemap for blog posts.
```php
namespace App\Http\Controllers;
use Post;
use Sitemap;
class SitemapsController extends Controller
{
public function posts()
{
$posts = Post::all();
foreach ($posts as $post) {
Sitemap::addTag(route('posts.show', $post), $post->updated_at, 'daily', '0.8');
}
return Sitemap::render();
}
}
```
If you just want to pass a model's `updated_at` timestamp as the last modified parameter, you can simply pass the model as the second parameter and the sitemap will use that attribute automatically.
**If you're pulling a lot of records from your database you might want to consider restricting the amount of data you're getting by using the `select()` method. You can also use the `chunk()` method to only load a certain number of records at any one time as to not run out of memory.**
### Image sitemaps
You can use Google image extensions for sitemaps to give Google more information about the images available on your pages. [Read the specification](https://support.google.com/webmasters/answer/178636?hl=en)
Images are associated with page and you can use up to 1000 images per page.
Here is an example of adding image tag to usual page tag.
```php
namespace App\Http\Controllers;
use Page;
use Sitemap;
class SitemapsController extends Controller
{
public function pages()
{
$pages = Page::all();
foreach ($pages as $page) {
$tag = Sitemap::addTag(route('pages.show', $page), $page->updated_at, 'daily', '0.8');
foreach ($page->images as $image) {
$tag->addImage($image->url, $image->caption);
}
}
return Sitemap::render();
}
}
```
Here is the full list of arguments to add an image to a tag.
```php
$tag->addImage($location, $caption, $geoLocation, $title, $licenceUrl);
```
## Configuration
To publish the configuration file for the sitemap package, simply run this Artisan command:
```sh
php artisan config:publish watson/sitemap
php artisan vendor:publish --provider="Watson\Sitemap\SitemapServiceProvider"
```
Then take a look in `config/sitemap.php` to see what is available.
### Caching
By default, caching is disabled. If you would like to enable caching, simply set `cache_enabled` in the configuration file to `true`. You can then specify how long you would like your views to be cached for. Keep in mind that when enabled, caching will affect each and every request made to the sitemap package.
### Multilingual tags
If you'd like to use a mutlilingual tag, simply pass an instance of one to the `addTag` method. Below is a crude example of how you would pass alternate tag locations for different languages.
```php
Sitemap::addTag(new \Watson\Sitemap\Tags\MultilingualTag(
$location,
$lastModified,
$changeFrequency,
$priority,
[
'en' => $location . '?lang=en',
'fr' => $location . '?lang=fr'
]
));
```