Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 2.43 KB

sitemap.md

File metadata and controls

89 lines (68 loc) · 2.43 KB
Raw

Sitemap generator

About

Generate sitemap files.

Usage

use LireinCore\Helpers\Seo\Sitemap;
use LireinCore\Helpers\Seo\Index;

// create sitemap
$sitemap = new Sitemap(__DIR__ . '/sitemap.xml');

// add some URLs
$sitemap->addItem(new Url('http://example.com/mylink1'));
$sitemap->addItem(
    (new Url('http://example.com/mylink2'))
        ->lastModified(time())
);
$sitemap->addItem(
    (new Url('http://example.com/mylink3'))
        ->lastModified(time())
        ->changeFrequency(Url::HOURLY)
);
$sitemap->addItem(
    (new Url('http://example.com/mylink4'))
        ->lastModified(time())
        ->changeFrequency(Url::DAILY)
        ->priority(0.3)
);

// write it
$sitemap->write();

// get URLs of sitemaps written
$sitemapFileUrls = $sitemap->getSitemapUrls('http://example.com/');

// create sitemap for static files
$staticSitemap = new Sitemap(__DIR__ . '/sitemap_static.xml');

// add some URLs
$staticSitemap->addItem(new Url('http://example.com/about'));
$staticSitemap->addItem(new Url('http://example.com/tos'));
$staticSitemap->addItem(new Url('http://example.com/jobs'));

// write it
$staticSitemap->write();

// get URLs of sitemaps written
$staticSitemapUrls = $staticSitemap->getSitemapUrls('http://example.com/');

// create sitemap index file
$index = new SitemapIndex(__DIR__ . '/sitemap_index.xml');

// add URLs
foreach ($sitemapFileUrls as $sitemapUrl) {
    $index->addSitemap($sitemapUrl);
}

// add more URLs
foreach ($staticSitemapUrls as $sitemapUrl) {
    $index->addSitemap($sitemapUrl);
}

// write it
$index->write();

Options

There are methods to configure Sitemap instance:

  • setMaxUrls($number). Sets maximum number of URLs to write in a single file. Default is 50000 which is the limit according to specification and most of existing implementations.
  • setBufferSize($number). Sets number of URLs to be kept in memory before writing it to file. Default is 1000. If you have more memory consider increasing it. If 1000 URLs doesn't fit, decrease it.
  • setUseIndent($bool). Sets if XML should be indented. Default is true.
  • setUseGzip($bool). Sets whether the resulting sitemap files will be gzipped or not. Default is false. zlib extension must be enabled to use this feature.

There is a method to configure Index instance:

  • setUseGzip($bool). Sets whether the resulting index file will be gzipped or not. Default is false. zlib extension must be enabled to use this feature.