AbstractXmlSitemapDataProvider

AbstractYes

Base class for XmlSitemapProviders to extend

Deprecated

since TYPO3 v15.0, will be removed in TYPO3 v16.0. Implement XmlSitemapDataProviderInterface directly instead: Runtime information is handed over as XmlSitemapRequest to getSitemap(), the constructor is free for dependency injection. This class is kept in v15 to ease compatibility with TYPO3 v14.

Table of Contents

Properties

$cObj  : ContentObjectRenderer
$config  : array<string|int, mixed>
$items  : array<string|int, mixed>
$key  : string
$numberOfItemsPerPage  : int
$request  : ServerRequestInterface

Methods

__construct()  : mixed
getItems()  : array<string|int, mixed>
getKey()  : string
getLastModified()  : int
getNumberOfPages()  : int
getSitemap()  : XmlSitemap
Bridges legacy providers to XmlSitemapDataProviderInterface. The items have already been generated by the constructor of the concrete provider, so the XmlSitemapRequest is not evaluated here.
defineUrl()  : array<string|int, mixed>

Properties

$config

protected array<string|int, mixed> $config = []

$items

protected array<string|int, mixed> $items = []

$numberOfItemsPerPage

protected int $numberOfItemsPerPage = 1000

$request

protected ServerRequestInterface $request

Methods

__construct()

public __construct(ServerRequestInterface $request, string $key[, array<string|int, mixed> $config = [] ][, ContentObjectRenderer|null $cObj = null ]) : mixed
Parameters
$request : ServerRequestInterface
$key : string
$config : array<string|int, mixed> = []
$cObj : ContentObjectRenderer|null = null

getItems()

public getItems() : array<string|int, mixed>
Return values
array<string|int, mixed>

getKey()

public getKey() : string
Return values
string

getLastModified()

public getLastModified() : int
Return values
int

getNumberOfPages()

public getNumberOfPages() : int
Return values
int

getSitemap()

Bridges legacy providers to XmlSitemapDataProviderInterface. The items have already been generated by the constructor of the concrete provider, so the XmlSitemapRequest is not evaluated here.

public getSitemap(XmlSitemapRequest $sitemapRequest) : XmlSitemap

This method is intentionally implemented although this class does not declare XmlSitemapDataProviderInterface: Extensions declaring the interface on their own provider class stay functional this way.

Parameters
$sitemapRequest : XmlSitemapRequest
Return values
XmlSitemap

defineUrl()

protected defineUrl(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results