XML sitemap locator 

• Using the API
• Console commands
• Sitemap providers

Extension key

sitemap_locator

Package name

eliashaeussler/typo3-sitemap-locator

Version

main

Language

en

Author

Elias Häußler & contributors

License

This extension documentation is published under the CC BY-NC-SA 4.0 (Creative Commons) license.

An extension for TYPO3 CMS that provides a service to locate XML sitemaps of a configured site. It supports various sitemap providers, e.g. by configured page type or robots.txt, and provides an interface to implement custom sitemap providers.

Introduction 

Installation 

composer require eliashaeussler/typo3-sitemap-locator

Configuration 

In normal installations, no special configuration is required. However, the extension provides some possibilities to explicitly configure the path to XML sitemaps.

Learn what configuration options are available on the following pages:

Site configuration 

Within the site configuration of each site, it is possible to explicitly configure the path to a related XML sitemap. The following configuration options are available for this purpose:

Usage 

This section describes how to properly use the extension in various ways. The main functionality is provided by a PHP API which allows to locate XML sitemaps of a given site. In addition, the extension provides a console command to allow XML sitemap location from console.

Using the API 

The main functionality of this extension is to provide a PHP API which allows to locate XML sitemaps for a given site and optional site language. Read more about how to use this API on this page.

class SitemapLocator

Fully qualified name

\EliasHaeussler\Typo3SitemapLocator\Sitemap\SitemapLocator

Service to locate XML sitemaps of a given site.

locateBySite ( $site, $siteLanguage = null)

Locate XML sitemaps of the given site and site language.

param TYPO3\CMS\Core\Site\Entity\Site $site

The site whose XML sitemap path should be located.

param TYPO3\CMS\Core\Site\Entity\SiteLanguage $siteLanguage

An optional site language to include while locating the XML sitemap path.

Returns

An array of instances of \EliasHaeussler\Typo3SitemapLocator\Domain\Model\Sitemap.

locateAllBySite ( $site)

Locate XML sitemaps of the given site and all their available languages.

param TYPO3\CMS\Core\Site\Entity\Site $site

The site whose XML sitemap path should be located.

Returns

An array of instances of \EliasHaeussler\Typo3SitemapLocator\Domain\Model\Sitemap, indexed by the site language id.

isValidSitemap ( $sitemap)

Check whether the given sitemap actually exists.

param EliasHaeussler\Typo3SitemapLocator\Domain\Model\Sitemap $sitemap

The XML sitemap to check for existence

returntype

bool

use EliasHaeussler\Typo3SitemapLocator;
use TYPO3\CMS\Core;

$sitemapLocator = Core\Utility\GeneralUtility::makeInstance(Typo3SitemapLocator\Sitemap\SitemapLocator::class);
$siteFinder = Core\Utility\GeneralUtility::makeInstance(Core\Site\SiteFinder::class);
$sitemaps = [];

// Fetch all available sites
$sites = $siteFinder->getAllSites();

// Locate XML sitemaps of each site
foreach ($sites as $site) {
    $sitemaps[$site->getIdentifier()] = $sitemapLocator->locateBySite($site);
}

Console commands 

The extension provides the following console commands:

vendor/bin/typo3 sitemap-locator:locate <site> [<options>]

typo3/sysext/core/bin/typo3 sitemap-locator:locate <site> [<options>]

Developer corner 

This section provides some insights into which development options are available and how these can be used to modify the lookup process of XML sitemaps.

Sitemap providers 

To locate the sitemap of a site, so-called "sitemap providers" are available. These are executed one after the other (depending on priority) to localize XML sitemaps according to certain criteria.

interface Provider

Fully qualified name

\EliasHaeussler\Typo3SitemapLocator\Sitemap\Provider\Provider

Interface for sitemap providers used to locate the path to an XML sitemap of a given site.

get ( $site, $siteLanguage = null)

Locate XML sitemaps of the given site.

param TYPO3\CMS\Core\Site\Entity\Site $site

The site whose XML sitemap path should be located.

param TYPO3\CMS\Core\Site\Entity\SiteLanguage $siteLanguage

An optional site language to include while locating the XML sitemap path.

Returns

An array of instances of \EliasHaeussler\Typo3SitemapLocator\Domain\Model\Sitemap.

static getPriority ( )

Get the provider's priority. The higher the returned value, the earlier the provider will be executed in the sitemap location process.

returntype

int

Caching 

Once a sitemap is located by a sitemap provider, the path to the XML sitemap is cached. Caching happens with a custom sitemap_locator cache which defaults to a filesystem cache located at var/cache/code/sitemap_locator.

class SitemapsCache

Fully qualified name

\EliasHaeussler\Typo3SitemapLocator\Cache\SitemapsCache

Read and write sitemap cache entries from custom sitemap_locator cache.

get ( $site, $siteLanguage = null)

Get the located sitemaps of a given site.

param TYPO3\CMS\Core\Site\Entity\Site $site

The sitemap's site object.

param TYPO3\CMS\Core\Site\Entity\SiteLanguage $siteLanguage

An optional site language.

Returns

Located sitemaps of a given site.

set ( $sitemaps)

Add the located sitemaps to the sitemap_locator cache.

param array $sitemaps

The located sitemaps to be cached.

Events 

The extension dispatches some PSR-14 events to provide end users the ability to step in to the sitemap location and validation process.

The following events are currently dispatched:

Contributing 

Thanks for considering contributing to this extension! Since it is an open source product, its successful further development depends largely on improving and optimizing it together.

The development of this extension follows the official TYPO3 coding standards. To ensure the stability and cleanliness of the code, various code quality tools are used and most components are covered with test cases. In addition, we use DDEV for local development. Make sure to set it up as described below. For continuous integration, we use GitHub Actions.

git clone https://github.com/eliashaeussler/typo3-sitemap-locator.git
cd typo3-sitemap-locator

ddev start

ddev composer install

# All analyzers
ddev cgl analyze

# Specific analyzers
ddev cgl analyze:dependencies

# All linters
ddev cgl lint

# Specific linters
ddev cgl lint:composer
ddev cgl lint:editorconfig
ddev cgl lint:php

# Fix all CGL issues
ddev cgl fix

# Fix specific CGL issues
ddev cgl fix:composer
ddev cgl fix:editorconfig
ddev cgl fix:php

# All static code analyzers
ddev cgl sca

# Specific static code analyzers
ddev cgl sca:php

# All tests
ddev test

# Specific tests
ddev test functional
ddev test unit

# All tests with code coverage
ddev test coverage

# Specific tests with code coverage
ddev test coverage:functional
ddev test coverage:unit

# Merge code coverage of all test suites
ddev test coverage:merge

open .Build/coverage/html/_merged/index.html

# Rebuild and open documentation
composer docs

# Build documentation (from cache)
composer docs:build

# Open rendered documentation
composer docs:open

Sitemap