thepixeldeveloper / sitemap
PHP XML sitemap generation
Installs: 1 587 586
Dependents: 19
Suggesters: 0
Security: 0
Stars: 135
Watchers: 9
Forks: 37
Open Issues: 7
Requires
- php: >=7.1
Requires (Dev)
This package is not auto-updated.
Last update: 2024-11-04 18:43:59 UTC
README
A tool to generate XML sitemaps. Integrates with Symfony via SitemapBundle
Installation
composer require "thepixeldeveloper/sitemap"
Basic Usage
Generating a typical (<urlset>) sitemap.
<?php declare(strict_types=1); use Thepixeldeveloper\Sitemap\Urlset; use Thepixeldeveloper\Sitemap\Url; use Thepixeldeveloper\Sitemap\Drivers\XmlWriterDriver; $url = new Url($loc); $url->setLastMod($lastMod); $url->setChangeFreq($changeFreq); $url->setPriority($priority); $urlset = new Urlset(); $urlset->add($url); $driver = new XmlWriterDriver(); $urlset->accept($driver); echo $driver->output();
Generating a parent (<sitemapindex>) sitemap.
<?php declare(strict_types=1); use Thepixeldeveloper\Sitemap\SitemapIndex; use Thepixeldeveloper\Sitemap\Sitemap; use Thepixeldeveloper\Sitemap\Drivers\XmlWriterDriver; // Sitemap entry. $url = new Sitemap($loc); $url->setLastMod($lastMod); // Add it to a collection. $urlset = new SitemapIndex(); $urlset->add($url); $driver = new XmlWriterDriver(); $urlset->accept($driver); echo $driver->output();
Extensions
The following extensions are supported: Image, Link, Mobile, News and Video. They work in the following way (taking image as an example):
<?php declare(strict_types=1); use Thepixeldeveloper\Sitemap\Urlset; use Thepixeldeveloper\Sitemap\Url; use Thepixeldeveloper\Sitemap\Extensions\Image; $url = new Url($loc); $url->setLastMod($lastMod); $url->setChangeFreq($changeFreq); $url->setPriority($priority); $image = new Image('https://image-location.com'); $url->addExtension($image); ...
Advanced Usage
Processing Instructions
You can add processing instructions on the output as such.
<?php declare(strict_types=1); use Thepixeldeveloper\Sitemap\Drivers\XmlWriterDriver; $driver = new XmlWriterDriver(); $driver->addProcessingInstructions('xml-stylesheet', 'type="text/xsl" href="/path/to/xslt/main-sitemap.xsl"');
Which will add before the document starts.
<?xml-stylesheet type="text/xsl" href="/path/to/xslt/main-sitemap.xsl"?>
Comments
Comments are useful for information such as when the file was created.
<?php declare(strict_types=1); use Thepixeldeveloper\Sitemap\Drivers\XmlWriterDriver; $date = date('Y-m-d H:i:s'); $driver = new XmlWriterDriver(); $driver->addComment('This XML file was written on ' . $date . '. Bye!');
Which will render out.
<?xml version="1.0" encoding="UTF-8"?> <!--This XML file was written on 2018-06-24 15:57:23. Bye!-->