Fisharebest\Webtrees\Module\OrdnanceSurveyHistoricMaps

Complexity

Total Complexity

4

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnabledByDefault()	0	3	1
A	description()	0	6	1
A	title()	0	3	1
A	layerData()	0	16	1

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\I18N;

/**
 * Class OrdnanceSurvey - use maps within webtrees
 */
class OrdnanceSurveyHistoricMaps extends AbstractModule implements ModuleMapProviderInterface
{
    use ModuleMapProviderTrait;

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function title(): string
    {
        return I18N::translate('Ordnance Survey historic maps');
    }

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function description(): string
    {
        $link = '<a href="https://maps.nls.uk/projects/api" dir="ltr">maps.nls.uk/projects/api</a>';

        // I18N: %s is a link/URL
        return I18N::translate('Create maps using %s.', $link);
    }

    /**
     * Should this module be enabled when it is first installed?
     *
     * @return bool
     */
    public function isEnabledByDefault(): bool
    {
        return false;
    }

    /**
     * LeafletJS definitions for the layer
     *
     * @return object
     */
    public function layerData(): object
    {
        return (object) [
            'title'  => 'Ordnance Survey',
            'help'   => '',
            'user'   => (object) [],
            'common' => [],
            'styles' => [
                (object) [
                    'title'      => 'Historic map of Great Britain',
                    'parameters' => (object) [
                        'url'         => '',
                        'attribution' => '',
                        'subdomains'  => '',
                        'max_zoom'    => 17,
                        'bounds'      => [[49.852539, -7.793077], [60.894042, 1.790425]],
                    ],
                ],
            ],
        ];
    }
}