Fisharebest\Webtrees\Module\ModuleMapProviderTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	leafletJsTileLayers()	0	3	1
A	hasApiKey()	0	15	4

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 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\Auth;
use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
use Fisharebest\Webtrees\I18N;

use function e;

/**
 * Trait ModuleMapProviderTrait - default implementation of ModuleMapProviderInterface
 */
trait ModuleMapProviderTrait
{
    use ModuleConfigTrait;

    /**
     * Parameters to create a TileLayer in LeafletJs.
     *
     * @return array<object>
     */
    public function leafletJsTileLayers(): array
    {
        return [];
    }

    /**
     *  If module requires an api key then return false if not valid
     *
     * @return bool
     * @throws HttpServerErrorException
     */
    public function hasApiKey(): bool
    {
        $api_key = $this->getPreference('api_key');

It seems like getPreference() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Do the functions to manage the config page exist in the provider module?
        $function_diff = array_diff(get_class_methods(__CLASS__ ?? ''), get_class_methods(get_parent_class()));

        $error = in_array("getAdminAction", $function_diff) && $api_key === '';
        if ($error && Auth::isAdmin()) {
            $message = I18N::translate('<a href="%s">The %s service requires an API key.', e($this->getConfigLink()), $this->title());

It seems like title() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            throw new HttpServerErrorException($message);
        }

        return !$error;
    }
}