fisharebest / webtrees

app/Module/HereMaps.php

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2025 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\FlashMessages;
use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

use function e;
use function redirect;

/**
 * Class HereMaps - use maps within webtrees
 */
class HereMaps extends AbstractModule implements ModuleConfigInterface, ModuleMapProviderInterface
{
    use ModuleConfigTrait;
    use ModuleMapProviderTrait;

    // This list comes from https://image.maps.hereapi.com/mia/v3/languages?apiKey={YOUR_API_KEY}
    private const array LANGUAGE_CODES = ["ar","as","az","be","bg","bn","bs","ca","cs","cy","da","de","el","en","es","et","eu","fi","fo","fr","ga","gl","gn","gu","he","hi","hr","hu","hy","id","is","it","ja","ka","kk","km","kn","ko","ky","lt","lv","mk","ml","mr","ms","mt","my","nl","no","or","pa","pl","pt","ro","ru","sk","sl","sq","sr","sv","ta","te","th","tr","uk","uz","vi","zh","zh-Hant"];

A parse error occurred: Syntax error, unexpected T_STRING, expecting '=' on line 42 at column 24

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function description(): string
    {
        $link = '<a href="https://www.here.com" dir="ltr">www.here.com</a>';

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

    public function isEnabledByDefault(): bool
    {
        return false;
    }

    /**
     * @return ResponseInterface
     */
    public function getAdminAction(): ResponseInterface
    {
        $this->layout = 'layouts/administration';

        $api_key = $this->getPreference('api_key');

        return $this->viewResponse('modules/here-maps/config', [
            'api_key' => $api_key,
            'title'   => $this->title(),
        ]);
    }

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function title(): string
    {
        return /* I18N: https://wego.here.com */ I18N::translate('Here maps');
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
    {
        $api_key = Validator::parsedBody($request)->string('api_key');

        $this->setPreference('api_key', $api_key);

        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');

        return redirect($this->getConfigLink());
    }

    /**
     * Parameters to create a TileLayer in LeafletJs.
     *
     * @return array<object>
     */
    public function leafletJsTileLayers(): array
    {
        $api_key = $this->getPreference('api_key');

        if ($api_key === '') {
            $message = I18N::translate('This service requires an API key.');

            if (Auth::isAdmin()) {
                $message = '<a href="' . e($this->getConfigLink()) . '">' . $message . '</a>';
            }

            throw new HttpServerErrorException($message);
        }

        $tag = I18N::languageTag();
        $lang2 = 'en';
        foreach (self::LANGUAGE_CODES as $code) {
            if ($tag === $lang2 || str_starts_with($tag, $code . '-')) {
                $lang2 = $code;
                break;
            }
        }

        return [
            (object) [
                'apiKey'      => $api_key,
                'attribution' => '&copy;2024 HERE Technologies',
                'label'       => 'Day',
                'maxZoom'     => 18,
                'minZoom'     => 2,
                'lang2'       => $lang2,
                'url'         => "https://maps.hereapi.com/v3/base/mc/{z}/{x}/{y}/jpeg?size=256&style={variant}&lang2={lang2}&apiKey={apiKey}",
                'variant'     => 'explore.day',
                'localName'   => 'HEREDay',
            ],
            (object) [
                'apiKey'      => $api_key,
                'attribution' => '&copy;2024 HERE Technologies',
                'label'       => 'Satellite Day',
                'maxZoom'     => 18,
                'minZoom'     => 2,
                'lang2'       => $lang2,
                'url'         => "https://maps.hereapi.com/v3/base/mc/{z}/{x}/{y}/jpeg?size=256&style={variant}&lang2={lang2}&apiKey={apiKey}",
                'variant'     => 'explore.satellite.day',
                'localName'   => 'HEREDSatelliteDay',
            ],
            (object) [
                'apiKey'      => $api_key,
                'attribution' => '&copy;2024 HERE Technologies',
                'label'       => 'Night',
                'maxZoom'     => 18,
                'minZoom'     => 2,
                'lang2'       => $lang2,
                'url'         => "https://maps.hereapi.com/v3/base/mc/{z}/{x}/{y}/jpeg?size=256&style={variant}&lang2={lang2}&apiKey={apiKey}",
                'variant'     => 'explore.night',
                'localName'   => 'HERENight',
            ],
            (object) [
                'apiKey'      => $api_key,
                'attribution' => '&copy;2024 HERE Technologies',
                'label'       => 'Terrain',
                'maxZoom'     => 18,
                'minZoom'     => 2,
                'lang2'       => $lang2,
                'url'         => "https://maps.hereapi.com/v3/base/mc/{z}/{x}/{y}/jpeg?size=256&style={variant}&lang2={lang2}&apiKey={apiKey}",
                'variant'     => 'topo.day',
                'localName'   => 'HERETerrain',
            ],
        ];
    }
}