Index
extends AbstractGeneratorPlugin
in package
Index-based generator plugin
Tags
Table of Contents
- $backendSettings : array<string|int, mixed>
- Settings specifying which backends to index.
- $baseUrl : string
- Base URL for site
- $countPerPage : int
- Page size for data retrieval
- $filters : array<string|int, string>
- Search filters
- $idFetcher : AbstractIdFetcher
- Helper for fetching IDs from the search service.
- $verboseMessageCallback : callable
- Verbose message callback
- __construct() : mixed
- Constructor
- 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
$backendSettings
Settings specifying which backends to index.
protected
array<string|int, mixed>
$backendSettings
$baseUrl
Base URL for site
protected
string
$baseUrl
= ''
$countPerPage
Page size for data retrieval
protected
int
$countPerPage
$filters
Search filters
protected
array<string|int, string>
$filters
$idFetcher
Helper for fetching IDs from the search service.
protected
AbstractIdFetcher
$idFetcher
$verboseMessageCallback
Verbose message callback
protected
callable
$verboseMessageCallback
= null
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $backendSettings, AbstractIdFetcher $idFetcher, int $countPerPage[, array<string|int, string> $filters = [] ]) : mixed
Parameters
- $backendSettings : array<string|int, mixed>
-
Settings specifying which backends to index
- $idFetcher : AbstractIdFetcher
-
The helper object for retrieving IDs
- $countPerPage : int
-
Page size for data retrieval
- $filters : array<string|int, string> = []
-
Search filters
Return values
mixed —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 lastmod 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