vipnytt / sitemapparser
XML Sitemap parser class compliant with the Sitemaps.org protocol.
Installs: 1 458 422
Dependents: 13
Suggesters: 0
Security: 0
Stars: 74
Watchers: 2
Forks: 28
Open Issues: 0
Requires
- php: ^5.6 || ^7.0 || ^8.0
- ext-mbstring: *
- ext-simplexml: *
- lib-libxml: *
- guzzlehttp/guzzle: ^6.0 || ^7.0
Requires (Dev)
- codeclimate/php-test-reporter: ^0
- phpunit/phpunit: ^5.0 || ^6.0 || ^7.0 || ^8.0
Suggests
- caseyamcl/guzzle_retry_middleware: Allow automatic retry when request for sitemap fails
- gmponos/guzzle_logger: Advanced logging
- hamburgscleanest/guzzle-advanced-throttle: Throttle requests
README
XML Sitemap parser
An easy-to-use PHP library to parse XML Sitemaps compliant with the Sitemaps.org protocol.
The Sitemaps.org protocol is the leading standard and is supported by Google, Bing, Yahoo, Ask and many others.
Features
- Basic parsing
- Recursive parsing
- String parsing
- Custom User-Agent string
- Proxy support
- URL blacklist
- request throttling (using https://github.com/hamburgscleanest/guzzle-advanced-throttle)
- retry (using https://github.com/caseyamcl/guzzle_retry_middleware)
- advanced logging (using https://github.com/gmponos/guzzle_logger)
Formats supported
- XML
.xml
- Compressed XML
.xml.gz
- Robots.txt rule sheet
robots.txt
- Line separated text (disabled by default)
Requirements:
- PHP 5.6 or 7.0+, alternatively HHVM
- PHP extensions:
- Optional:
Installation
The library is available for install via Composer. Just add this to your composer.json
file:
{ "require": { "vipnytt/sitemapparser": "^1.0" } }
Then run composer update
.
Getting Started
Basic example
Returns an list of URLs only.
use vipnytt\SitemapParser; use vipnytt\SitemapParser\Exceptions\SitemapParserException; try { $parser = new SitemapParser(); $parser->parse('http://php.net/sitemap.xml'); foreach ($parser->getURLs() as $url => $tags) { echo $url . '<br>'; } } catch (SitemapParserException $e) { echo $e->getMessage(); }
Advanced
Returns all available tags, for both Sitemaps and URLs.
use vipnytt\SitemapParser; use vipnytt\SitemapParser\Exceptions\SitemapParserException; try { $parser = new SitemapParser('MyCustomUserAgent'); $parser->parse('http://php.net/sitemap.xml'); foreach ($parser->getSitemaps() as $url => $tags) { echo 'Sitemap<br>'; echo 'URL: ' . $url . '<br>'; echo 'LastMod: ' . $tags['lastmod'] . '<br>'; echo '<hr>'; } foreach ($parser->getURLs() as $url => $tags) { echo 'URL: ' . $url . '<br>'; echo 'LastMod: ' . $tags['lastmod'] . '<br>'; echo 'ChangeFreq: ' . $tags['changefreq'] . '<br>'; echo 'Priority: ' . $tags['priority'] . '<br>'; echo '<hr>'; } } catch (SitemapParserException $e) { echo $e->getMessage(); }
Recursive
Parses any sitemap detected while parsing, to get an complete list of URLs.
Use url_black_list
to skip sitemaps that are part of parent sitemap. Exact match only.
use vipnytt\SitemapParser; use vipnytt\SitemapParser\Exceptions\SitemapParserException; try { $parser = new SitemapParser('MyCustomUserAgent'); $parser->parseRecursive('http://www.google.com/robots.txt'); echo '<h2>Sitemaps</h2>'; foreach ($parser->getSitemaps() as $url => $tags) { echo 'URL: ' . $url . '<br>'; echo 'LastMod: ' . $tags['lastmod'] . '<br>'; echo '<hr>'; } echo '<h2>URLs</h2>'; foreach ($parser->getURLs() as $url => $tags) { echo 'URL: ' . $url . '<br>'; echo 'LastMod: ' . $tags['lastmod'] . '<br>'; echo 'ChangeFreq: ' . $tags['changefreq'] . '<br>'; echo 'Priority: ' . $tags['priority'] . '<br>'; echo '<hr>'; } } catch (SitemapParserException $e) { echo $e->getMessage(); }
Parsing of line separated text strings
Note: This is disabled by default to avoid false positives when expecting XML, but fetches plain text instead.
To disable strict
standards, simply pass this configuration to constructor parameter #2: ['strict' => false]
.
use vipnytt\SitemapParser; use vipnytt\SitemapParser\Exceptions\SitemapParserException; try { $parser = new SitemapParser('MyCustomUserAgent', ['strict' => false]); $parser->parse('https://www.xml-sitemaps.com/urllist.txt'); foreach ($parser->getSitemaps() as $url => $tags) { echo $url . '<br>'; } foreach ($parser->getURLs() as $url => $tags) { echo $url . '<br>'; } } catch (SitemapParserException $e) { echo $e->getMessage(); }
Throttling
- Install middleware:
composer require hamburgscleanest/guzzle-advanced-throttle
- Define host rules:
$rules = new RequestLimitRuleset([ 'https://www.google.com' => [ [ 'max_requests' => 20, 'request_interval' => 1 ], [ 'max_requests' => 100, 'request_interval' => 120 ] ] ]);
- Create handler stack:
$stack = new HandlerStack(); $stack->setHandler(new CurlHandler());
- Create middleware:
$throttle = new ThrottleMiddleware($rules); // Invoke the middleware $stack->push($throttle()); // OR: alternatively call the handle method directly $stack->push($throttle->handle());
- Create client manually:
$client = new \GuzzleHttp\Client(['handler' => $stack]);
- Pass client as an argument or use
setClient
method:
$parser = new SitemapParser(); $parser->setClient($client);
More details about this middle ware is available here
Automatic retry
- Install middleware:
composer require caseyamcl/guzzle_retry_middleware
- Create stack:
$stack = new HandlerStack(); $stack->setHandler(new CurlHandler());
- Add middleware to the stack:
$stack->push(GuzzleRetryMiddleware::factory());
- Create client manually:
$client = new \GuzzleHttp\Client(['handler' => $stack]);
- Pass client as an argument or use setClient method:
$parser = new SitemapParser(); $parser->setClient($client);
More details about this middle ware is available here
Advanced logging
- Install middleware:
composer require gmponos/guzzle_logger
- Create PSR-3 style logger
$logger = new Logger();
- Create handler stack:
$stack = new HandlerStack(); $stack->setHandler(new CurlHandler());
- Push logger middleware to stack
$stack->push(new LogMiddleware($logger));
- Create client manually:
$client = new \GuzzleHttp\Client(['handler' => $stack]);
- Pass client as an argument or use
setClient
method:
$parser = new SitemapParser(); $parser->setClient($client);
More details about this middleware config (like log levels, when to log and what to log) is available here
Additional examples
Even more examples available in the examples directory.
Configuration
Available configuration options, with their default values:
$config = [ 'strict' => true, // (bool) Disallow parsing of line-separated plain text 'guzzle' => [ // GuzzleHttp request options // http://docs.guzzlephp.org/en/latest/request-options.html ], // use this to ignore URL when parsing sitemaps that contain multiple other sitemaps. Exact match only. 'url_black_list' => [] ]; $parser = new SitemapParser('MyCustomUserAgent', $config);
If an User-agent also is set using the GuzzleHttp request options, it receives the highest priority and replaces the other User-agent.