bitandblack/sitemap

Creates a sitemap.xml by parsing the whole website.

1.1.1 2022-05-20 12:04 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-dom: *
• ext-libxml: *
• bitandblack/composer-helper: ^0 || ^1.0
• bitandblack/helpers: ^1.0
• jakeasmith/http_build_url: ^1.0
• myclabs/php-enum: ^1.8
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/console: ^5.0 || ^6.0
• symfony/yaml: ^5.0 || ^6.0

Requires (Dev)

• ext-json: *
• monolog/monolog: ^2.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.0
• rector/rector: ^0.12
• spatie/browsershot: ^3.40
• symplify/easy-coding-standard: ^10.0

MIT

• Tobias Köngeter

• Sitemap
• crawler
• BitAndBlack
• WirbelWild
• Köngeter

README

Bit&Black Sitemap

Creates a sitemap.xml by parsing the whole website including all language versions and all images.

If multiple language versions are found, multiple xml files will be written.

Installation

This library is made for the use with Composer. Add it to your project by running $ composer require bitandblack/sitemap.

Usage

Set up the sitemap generation like that:

<?php

use BitAndBlack\Sitemap\Config\YamlConfig;
use BitAndBlack\Sitemap\SitemapCrawler;
use BitAndBlack\Sitemap\Writer\FileWriter;

$config = new YamlConfig('/path/to/config.yaml');
$writer = new FileWriter('/path/to/xml/files');

$sitemapCrawler = new SitemapCrawler(
    $config,
    $writer
);

$sitemapCrawler->createSitemap('https://crawl.me');

The YamlConfig stores some information which are needed when the process needs to run in multiple steps. Therefore it needs a path where the config file may get stored.

FileWriter stores the xml files, so it needs to know a folder for those files.

createSitemap() starts the crawling. If the time limit has been reached, the process will stop and store its status in the config file. If you call createSitemap() again it will continue the process. This is helpful for large websites which may take a long time to crawl.

Options

Page limit

Set a page limit that stops the crawler when the defined page count has been reached:

<?php

$sitemapCrawler->setCrawlingLimit(500);

Help

If you have any questions, feel free to contact us under [e-mail].

Further information about Bit&Black can be found under www.bitandblack.com.