149a243cbSGreg Roach<?php 23976b470SGreg Roach 349a243cbSGreg Roach/** 449a243cbSGreg Roach * webtrees: online genealogy 589f7189bSGreg Roach * Copyright (C) 2021 webtrees development team 649a243cbSGreg Roach * This program is free software: you can redistribute it and/or modify 749a243cbSGreg Roach * it under the terms of the GNU General Public License as published by 849a243cbSGreg Roach * the Free Software Foundation, either version 3 of the License, or 949a243cbSGreg Roach * (at your option) any later version. 1049a243cbSGreg Roach * This program is distributed in the hope that it will be useful, 1149a243cbSGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 1249a243cbSGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1349a243cbSGreg Roach * GNU General Public License for more details. 1449a243cbSGreg Roach * You should have received a copy of the GNU General Public License 1589f7189bSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>. 1649a243cbSGreg Roach */ 17fcfa147eSGreg Roach 1849a243cbSGreg Roachdeclare(strict_types=1); 1949a243cbSGreg Roach 2049a243cbSGreg Roachnamespace Fisharebest\Webtrees\Module; 2149a243cbSGreg Roach 22852ede8cSGreg Roachuse Fisharebest\Webtrees\Auth; 2381b729d3SGreg Roachuse Fisharebest\Webtrees\Http\Exceptions\HttpAccessDeniedException; 246b9cb339SGreg Roachuse Fisharebest\Webtrees\Registry; 25*b55cbc6bSGreg Roachuse Fisharebest\Webtrees\Validator; 268eaf8709SGreg Roachuse Illuminate\Support\Collection; 27852ede8cSGreg Roachuse Psr\Http\Message\ResponseInterface; 28852ede8cSGreg Roachuse Psr\Http\Message\ServerRequestInterface; 29852ede8cSGreg Roach 30852ede8cSGreg Roachuse function response; 31852ede8cSGreg Roachuse function view; 328eaf8709SGreg Roach 3349a243cbSGreg Roach/** 3449a243cbSGreg Roach * Trait ModuleTabTrait - default implementation of ModuleTabInterface 3549a243cbSGreg Roach */ 3649a243cbSGreg Roachtrait ModuleTabTrait 3749a243cbSGreg Roach{ 3833c746f1SGreg Roach // The default position for this tab. It can be changed in the control panel. 3933c746f1SGreg Roach protected int $tab_order; 4049a243cbSGreg Roach 4149a243cbSGreg Roach /** 4239402588SGreg Roach * The text that appears on the tab. 4339402588SGreg Roach * 4439402588SGreg Roach * @return string 4539402588SGreg Roach */ 4639402588SGreg Roach public function tabTitle(): string 4739402588SGreg Roach { 4839402588SGreg Roach return $this->title(); 4939402588SGreg Roach } 5039402588SGreg Roach 5139402588SGreg Roach /** 5249a243cbSGreg Roach * Users change change the order of tabs using the control panel. 5349a243cbSGreg Roach * 5449a243cbSGreg Roach * @param int $tab_order 5549a243cbSGreg Roach * 5649a243cbSGreg Roach * @return void 5749a243cbSGreg Roach */ 5849a243cbSGreg Roach public function setTabOrder(int $tab_order): void 5949a243cbSGreg Roach { 6049a243cbSGreg Roach $this->tab_order = $tab_order; 6149a243cbSGreg Roach } 6249a243cbSGreg Roach 6349a243cbSGreg Roach /** 6449a243cbSGreg Roach * Users change change the order of tabs using the control panel. 6549a243cbSGreg Roach * 6649a243cbSGreg Roach * @return int 6749a243cbSGreg Roach */ 6849a243cbSGreg Roach public function getTabOrder(): int 6949a243cbSGreg Roach { 7024bd2cf5SGreg Roach return $this->tab_order ?? $this->defaultTabOrder(); 7149a243cbSGreg Roach } 7249a243cbSGreg Roach 7349a243cbSGreg Roach /** 7449a243cbSGreg Roach * The default position for this tab. It can be changed in the control panel. 7549a243cbSGreg Roach * 7649a243cbSGreg Roach * @return int 7749a243cbSGreg Roach */ 78cbf4b7faSGreg Roach public function defaultTabOrder(): int 79cbf4b7faSGreg Roach { 8049a243cbSGreg Roach return 9999; 8149a243cbSGreg Roach } 828eaf8709SGreg Roach 838eaf8709SGreg Roach /** 848eaf8709SGreg Roach * This module handles the following facts - so don't show them on the "Facts and events" tab. 858eaf8709SGreg Roach * 8636779af1SGreg Roach * @return Collection<int,string> 878eaf8709SGreg Roach */ 888eaf8709SGreg Roach public function supportedFacts(): Collection 898eaf8709SGreg Roach { 90075d1a05SGreg Roach return new Collection(); 918eaf8709SGreg Roach } 92852ede8cSGreg Roach 93852ede8cSGreg Roach /** 94852ede8cSGreg Roach * @param ServerRequestInterface $request 95852ede8cSGreg Roach * 96852ede8cSGreg Roach * @return ResponseInterface 97852ede8cSGreg Roach */ 98852ede8cSGreg Roach public function getTabAction(ServerRequestInterface $request): ResponseInterface 99852ede8cSGreg Roach { 100*b55cbc6bSGreg Roach $tree = Validator::attributes($request)->tree(); 101*b55cbc6bSGreg Roach $user = Validator::attributes($request)->user(); 102852ede8cSGreg Roach 103852ede8cSGreg Roach $xref = $request->getQueryParams()['xref']; 104852ede8cSGreg Roach 1056b9cb339SGreg Roach $record = Registry::individualFactory()->make($xref, $tree); 106852ede8cSGreg Roach $record = Auth::checkIndividualAccess($record); 107852ede8cSGreg Roach 108ef483801SGreg Roach if ($this->accessLevel($tree, ModuleTabInterface::class) < Auth::accessLevel($tree, $user)) { 109d501c45dSGreg Roach throw new HttpAccessDeniedException(); 110852ede8cSGreg Roach } 111852ede8cSGreg Roach 112852ede8cSGreg Roach $layout = view('layouts/ajax', [ 113852ede8cSGreg Roach 'content' => $this->getTabContent($record), 114852ede8cSGreg Roach ]); 115852ede8cSGreg Roach 116852ede8cSGreg Roach return response($layout); 117852ede8cSGreg Roach } 11849a243cbSGreg Roach} 119