xref: /webtrees/app/Elements/XrefSource.php (revision c2ed51d13a57743094c11c8fe84befd9d4f158cd)

<?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\Elements;

use Fisharebest\Webtrees\Http\RequestHandlers\CreateSourceModal;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;

use function e;
use function route;
use function trim;
use function view;

/**
 * XREF:SOUR := {Size=1:22}
 * A pointer to, or a cross-reference identifier of, a SOURce record.
 */
class XrefSource extends AbstractXrefElement
{
    protected const SUBTAGS = [
        'PAGE' => '0:1',
        'EVEN' => '0:1',
        'DATA' => '0:1',
        'OBJE' => '0:M',
        'NOTE' => '0:M',
        'QUAY' => '0:1',
    ];

    protected const ABRIDGED_SUBTAGS = [
        'PAGE' => '0:1',
        'DATA' => '0:1',
        'OBJE' => '0:M',
    ];

    /**
     * An edit control for this data.
     *
     * @param string $id
     * @param string $name
     * @param string $value
     * @param Tree   $tree
     *
     * @return string
     */
    public function edit(string $id, string $name, string $value, Tree $tree): string
    {
        $select = view('components/select-source', [
            'id'     => $id,
            'name'   => $name,
            'source' => Registry::sourceFactory()->make(trim($value, '@'), $tree),
            'tree'   => $tree,
            'at'     => '@',
        ]);

        return
            '<div class="input-group">' .
            '<div class="input-group-prepend">' .
            '<button class="btn btn-secondary" type="button" data-toggle="modal" data-backdrop="static" data-target="#wt-ajax-modal" data-href="' . e(route(CreateSourceModal::class, ['tree' => $tree->name()])) . '" data-select-id="' . $id . '" title="' . I18N::translate('Create a source') . '">' .
            view('icons/add') .
            '</button>' .
            '</div>' .
            $select .
            '</div>';
    }

    /**
     * @param Tree $tree
     *
     * @return array<string,string>
     */
    public function subtags(Tree $tree): array
    {
        if ($tree->getPreference('FULL_SOURCES') === '1') {
            return static::SUBTAGS;
        }

        return static::ABRIDGED_SUBTAGS;
    }

    /**
     * Display the value of this type of element.
     *
     * @param string $value
     * @param Tree   $tree
     *
     * @return string
     */
    public function value(string $value, Tree $tree): string
    {
        return $this->valueXrefLink($value, $tree, Registry::sourceFactory());
    }
}