Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nilportugues/php-sitemap
Standalone sitemap builder 100% standards compliant.
https://github.com/nilportugues/php-sitemap
bing google php php7 search search-engine seo sitemap sitemap-files xml
Last synced: 3 days ago
JSON representation
Standalone sitemap builder 100% standards compliant.
- Host: GitHub
- URL: https://github.com/nilportugues/php-sitemap
- Owner: nilportugues
- License: mit
- Created: 2014-01-17T19:45:08.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-25T01:12:50.000Z (about 5 years ago)
- Last Synced: 2024-04-25T00:01:11.163Z (8 months ago)
- Topics: bing, google, php, php7, search, search-engine, seo, sitemap, sitemap-files, xml
- Language: PHP
- Homepage: http://nilportugues.com
- Size: 663 KB
- Stars: 48
- Watchers: 4
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Sitemap Component
=================
[](https://travis-ci.org/nilportugues/php-sitemap) [](https://coveralls.io/r/nilportugues/sitemap-component) [](https://scrutinizer-ci.com/g/nilportugues/sitemap-component/) [](https://packagist.org/packages/nilportugues/sitemap-component) [](https://packagist.org/packages/nilportugues/sitemap-component) [](https://packagist.org/packages/nilportugues/sitemap-component) [](https://insight.sensiolabs.com/projects/b065a032-4ab2-4feb-a88c-d7a8423e1cf7)
[](https://paypal.me/nilportugues)
Builds sitemaps for pages, images and media files and provides a class to submit them to search engines.
* [1.Installation](#block1)
* [2. Features](#block2)
* [3. Automatic sitemap submission](#block3)
* [4. Usage](#block4)
* [4.1. Submit to search engines](#block4.1)
* [4.2. Build a Sitemap Index](#block4.2)
* [Creation](#block4.2.1)
* [Output](#block4.2.2)
* [4.3. Build a simple Sitemap](#block4.3)
* [Creation](#block4.3.1)
* [Output](#block4.3.2)
* [4.4. Build a Sitemap with Images](#block4.4)
* [Creation](#block4.4.1)
* [Output](#block4.4.2)
* [4.5. Build a Sitemap with Videos](#block4.5)
* [Creation](#block4.5.1)
* [Output](#block4.5.2)
* [4.6. Build a Media Sitemap (mRSS feed as a Sitemap)](#block4.6)
* [Creation](#block4.6.1)
* [Output](#block4.6.2)
* [4.7 - Build a Sitemap for News](#block4.7)
* [Creation](#block4.7.1)
* [Output](#block4.7.2)
* [5. Fully tested](#block5)
* [6. Questions?](#block6)
* [7. Author](#block7)
---
## 1.Installation
The recommended way to install the Sitemap Component is through [Composer](http://getcomposer.org). Run the following command to install it:
```sh
php composer.phar require nilportugues/sitemap-component
```
---
## 2. Features
This component builds sitemaps supported by the main search engines, Google and Bing, in xml and gzip formats.
The **Sitemap Component** is able of building the following types of sitemaps:
#### Sitemap Index
A sitemap that serves as a index containing references to other sitemap.xml files.
More documentation can be found [here](https://support.google.com/webmasters/answer/71453?hl=en).
#### Basic Sitemap
Text content sitemaps, the most common type of sitemap found around the Internet.
More documentation can be found [here](https://support.google.com/webmasters/answer/183668?hl=en&ref_topic=8476).
#### Image Sitemap
Sitemap for for images. More documentation can be found [here](https://support.google.com/webmasters/answer/178636?hl=en).
#### Video Sitemap
Sitemap for for videos. More documentation can be found [here](https://support.google.com/webmasters/answer/80472?hl=en&ref_topic=10079).
#### Media Sitemap
Alternative for video sitemaps. More documentation can be found [here](https://support.google.com/webmasters/answer/183265?hl=en).
#### News Sitemap
Sitemap for news articles. More documentation can be found [here](https://support.google.com/webmasters/answer/74288?hl=en).
#### Standard compilant
The sitemap component follow 100% the standards, meaning that it follows strictly the contrains:
- A sitemap file cannot contain **50000 items per file**.
- A sitemap file cannot be larger than **50 MBytes, uncompressed**.
- An Image Sitemap file cannot contain more than **1000 images** per `` element.
---
## 3. Automatic sitemap submission
This component also provides a method to submit the generated sitemaps to the following search engines:
- Google
- Bing
---
### 4.1 - Submit to search engines
```php
true, 'bing' => true]; if everything went OK.
$status = SubmitSitemap::send('http://example.com/sitemap-index.xml');
```
### 4.2 - Build a Sitemap Index
In order to use a Sitemap Index, you need to build sitemap files first. Check out 4.3, 4.4 and 4.5.
#### Creation
```php
use NilPortugues\Sitemap\IndexSitemap;
use NilPortugues\Sitemap\Item\Index\IndexItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new IndexSitemap('path/to/folder','sitemap.index.xml');
$item = new IndexItem('http://www.example.com/sitemap.content.xml');
$item->setLastMod('2005-05-10T17:33:30+08:00'); //Optional
$sitemap->add($item);
$item = new IndexItem('http://www.example.com/sitemap.media.xml');
$item->setLastMod('2005-05-10T17:33:30+08:00');
$sitemap->add($item);
$sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
http://www.example.com/sitemap.content.xml
2005-05-10T17:33:30+08:00
http://www.example.com/sitemap.media.xml
2005-05-10T17:33:30+08:00
```
### 4.3 - Build a simple Sitemap
#### Creation
```php
use NilPortugues\Sitemap\Sitemap;
use NilPortugues\Sitemap\Item\Url\UrlItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new Sitemap('path/to/folder','sitemap.index.xml');
$item = new UrlItem('http://www.example.com/');
$item->setPriority('1.0'); //Optional
$item->setChangeFreq('daily'); //Optional
$item->setLastMod('2014-05-10T17:33:30+08:00'); //Optional
$sitemap->add($item);
$item = new UrlItem('http://www.example.com/blog');
$item->setPriority('0.9');
$item->setChangeFreq('monthly');
$item->setLastMod('2014-05-10T17:33:30+08:00');
$sitemap->add($item);
$item = new UrlItem('http://www.example.com/contact');
$item->setPriority('0.8');
$item->setChangeFreq('never');
$item->setLastMod('2014-05-10T17:33:30+08:00');
$sitemap->add($item);
$sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
http://www.example.com/
2014-05-10T17:33:30+08:00
daily
1.0
http://www.example.com/blog
2014-05-10T17:33:30+08:00
monthly
0.9
http://www.example.com/contact
2014-05-10T17:33:30+08:00
never
0.8
```
### 4.4 - Build a Sitemap with Images
#### Creation
```php
use NilPortugues\Sitemap\ImageSitemap;
use NilPortugues\Sitemap\Item\Image\ImageItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new ImageSitemap('path/to/folder','sitemap.image.xml');
$item = new ImageItem('http://www.example.com/logo.png');
$item->setTitle('Example.com logo'); //Optional
$sitemap->add($item,'http://www.example.com/');
$item = new ImageItem('http://www.example.com/main.png');
$item->setTitle('Main image'); //Optional
$sitemap->add($item,'http://www.example.com/');
$sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
http://www.example.com/
```
### 4.5 - Build a Sitemap with videos
#### Creation
```php
use NilPortugues\Sitemap\VideoSitemap;
use NilPortugues\Sitemap\Item\Video\VideoItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new VideoSitemap('path/to/folder','sitemap.video.xml');
$item = new VideoItem(
'Grilling steaks for summer', //Title
'http://www.example.com/video123.flv', //URL
'http://www.example.com/videoplayer.swf?video=123', //Player URL
'yes', //Optional
'ap=1' //Optional
);
//Optional Values
$item->setDescription('Alkis shows you how to get perfectly done steaks everytime');
$item->setThumbnailLoc('http://www.example.com/thumbs/123.jpg');
$item->setDuration(600);
$item->setExpirationDate('2009-11-05T19:20:30+08:00');
$item->setRating(4.2);
$item->setViewCount(12345);
$item->setPublicationDate('2007-11-05T19:20:30+08:00');
$item->setFamilyFriendly('yes');
$item->setRestriction('IE GB US CA', 'allow');
$item->setGalleryLoc('http://cooking.example.com', 'Cooking Videos');
$item->setPrice('0.99','EUR','rent','HD');
$item->setPrice('0.75','EUR','rent','SD');
$item->setCategory('cooking');
$item->setTag(array('action','drama','entrepreneur'));
$item->setRequiresSubscription('yes');
$item->setUploader('GrillyMcGrillerson', 'http://www.example.com/users/grillymcgrillerson');
$item->setPlatform('web mobile tv', 'allow');
$item->setLive('no');
$sitemap->add($item,'http://www.example.com/');
$files = $sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
http://www.example.com/
IE GB US CA
http://cooking.example.com
0.99
0.75
action
drama
entrepreneur
GrillyMcGrillerson
web mobile tv
```
### 4.6 - Build a Media Sitemap (mRSS feed as a Sitemap)
#### Creation
```php
use NilPortugues\Sitemap\MediaSitemap;
use NilPortugues\Sitemap\Item\Media\MediaItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new MediaSitemap('path/to/folder','sitemap.media.xml');
$sitemap->setTitle('Media RSS de ejemplo');
$sitemap->setLink('http://www.example.com/ejemplos/mrss/');
$sitemap->setDescription('Ejemplo de MRSS');
$item = new MediaItem('http://www.example.com/examples/mrss/example1.html');
//Optional
$item->setContent('video/x-flv', 120);
$item->setPlayer('http://www.example.com/shows/example/video.swf?flash_params');
$item->setTitle('Barbacoas en verano');
$item->setDescription('Consigue que los filetes queden perfectamente hechos siempre');
$item->setThumbnail('http://www.example.com/examples/mrss/example1.png', 120, 160);
$sitemap->add($item);
$item = new MediaItem('http://www.example.com/examples/mrss/example2.html');
$item->setContent('video/x-flv', 120);
$item->setPlayer('http://www.example.com/shows/example/video.swf?flash_params');
$item->setTitle('Barbacoas en invierno');
$item->setDescription('Consigue unos filetes frios');
$item->setThumbnail('http://www.example.com/examples/mrss/example2.png', 120, 160);
$sitemap->add($item);
$sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
Media RSS de ejemplo
http://www.example.com/ejemplos/mrss/
Ejemplo de MRSS
http://www.example.com/examples/mrss/example1.html
Barbacoas en verano
Consigue que los filetes queden perfectamente hechos siempre
http://www.example.com/examples/mrss/example2.html
Barbacoas en invierno
Consigue unos filetes frios
```
### 4.7 - Build a Sitemap for News
#### Creation
```php
use NilPortugues\Sitemap\NewsSitemap;
use NilPortugues\Sitemap\Item\News\NewsItem;
use NilPortugues\Sitemap\SitemapException;
try {
$sitemap = new NewsSitemap('path/to/folder','sitemap.news.xml');
$item = new NewsItem(
'http://www.example.org/business/article55.html', //URL
'Companies A, B in Merger Talks', //Title
'2008-12-23', //Publication Date
'The Example Times', //Publication Name
'en' //locale
);
//Optional Values
$item->setAccess('Subscription');
$item->setKeywords('business, merger, acquisition, A, B');
$item->setStockTickers('NASDAQ:A, NASDAQ:B');
$item->setGenres('PressRelease, Blog');
$sitemap->add($item);
$sitemap->build();
} catch (SitemapException $e) {
echo $e->getMessage();
}
```
#### Output
```xml
http://www.example.org/business/article55.html
The Example Times
en
Subscription
PressRelease, Blog
2008-12-23
Companies A, B in Merger Talks
business, merger, acquisition, A, B
NASDAQ:A, NASDAQ:B
```
---
## 5. Fully tested.
Testing has been done using PHPUnit and [Travis-CI](https://travis-ci.org). All code has been tested to be compatible from PHP 5.4 up to PHP 5.6 and [Facebook's HHVM](http://hhvm.com/).
Drop me an e-mail or get in touch with me using [](https://gitter.im/nilportugues/sitemap-component?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
--
## 7. Author
Nil Portugués Calderó
-
- http://nilportugues.com