AbstractGeneratorPlugin
in package
implements
GeneratorPluginInterface
Base class for sitemap generator plugins
Tags
Interfaces, Classes, Traits and Enums
- GeneratorPluginInterface
- Interface for sitemap generator plugins
Table of Contents
- $verboseMessageCallback : callable
- Verbose message callback
- 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
- verboseMsg() : void
- Write a verbose message (if callback is available and configured to do so)
Properties
$verboseMessageCallback
Verbose message callback
protected
callable
$verboseMessageCallback
= null
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
abstract getSitemapName() : string
Return values
string —getUrls()
Generate urls for the sitemap.
public
abstract 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
Return values
bool —verboseMsg()
Write a verbose message (if callback is available and configured to do so)
protected
verboseMsg(string $msg) : void
Parameters
- $msg : string
-
Message to display