GeneratorPluginInterface
in
Interface for sitemap generator plugins
Tags
Table of Contents
- getFrequency() : string
- Get update frequency. Empty string implies that the default from sitemap configuration should be used.
- getSitemapName() : string
- Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.
- getUrls() : Generator
- Generate urls for the sitemap.
- setOptions() : void
- Set plugin options.
- supportsVuFindLanguages() : bool
- Whether the URLs generated by the plugin support VuFind's lng parameter
Methods
getFrequency()
Get update frequency. Empty string implies that the default from sitemap configuration should be used.
public
getFrequency() : string
Return values
string —getSitemapName()
Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.
public
getSitemapName() : string
Return values
string —getUrls()
Generate urls for the sitemap.
public
getUrls() : Generator
May yield a string per URL or an array that defines language versions and/or frequency in addition to url.
Return values
Generator —setOptions()
Set plugin options.
public
setOptions(array<string|int, mixed> $options) : void
Parameters
- $options : array<string|int, mixed>
-
Options
Return values
void —supportsVuFindLanguages()
Whether the URLs generated by the plugin support VuFind's lng parameter
public
supportsVuFindLanguages() : bool