Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
StartPage
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
3 / 3
4
100.00% covered (success)
100.00%
1 / 1
 setOptions
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getSitemapName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getUrls
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * Start page generator plugin
5 *
6 * PHP version 8
7 *
8 * Copyright (C) The National Library of Finland 2021.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Sitemap
25 * @author   Ere Maijala <ere.maijala@helsinki.fi>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development:plugins:ils_drivers Wiki
28 */
29
30namespace VuFind\Sitemap\Plugin;
31
32/**
33 * Start page generator plugin
34 *
35 * @category VuFind
36 * @package  Sitemap
37 * @author   Ere Maijala <ere.maijala@helsinki.fi>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development:plugins:ils_drivers Wiki
40 */
41class StartPage extends AbstractGeneratorPlugin
42{
43    /**
44     * Base URL for site
45     *
46     * @var string
47     */
48    protected $baseUrl;
49
50    /**
51     * Set plugin options.
52     *
53     * @param array $options Options
54     *
55     * @return void
56     */
57    public function setOptions(array $options): void
58    {
59        parent::setOptions($options);
60        $this->baseUrl = $options['baseUrl'] ?? '';
61    }
62
63    /**
64     * Get the name of the sitemap used to create the sitemap file. This will be
65     * appended to the configured base name, and may be blank to use the base
66     * name without a suffix.
67     *
68     * @return string
69     */
70    public function getSitemapName(): string
71    {
72        return 'pages';
73    }
74
75    /**
76     * Generate urls for the sitemap.
77     *
78     * @return \Generator
79     */
80    public function getUrls(): \Generator
81    {
82        if ($this->baseUrl) {
83            $this->verboseMsg('Adding start page ' . $this->baseUrl);
84            yield $this->baseUrl;
85        }
86    }
87}