Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/html/webtrees/app/Module/
Upload File :
Current File : /var/www/html/webtrees/app/Module/InteractiveTreeModule.php
<?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\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Module\InteractiveTree\TreeView;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
/**
* Class InteractiveTreeModule
* Tip : you could change the number of generations loaded before ajax calls both in individual page and in treeview page to optimize speed and server load
*/
class InteractiveTreeModule extends AbstractModule implements ModuleChartInterface, ModuleTabInterface
{
use ModuleChartTrait;
use ModuleTabTrait;
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Interactive tree');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Interactive tree” module */
return I18N::translate('An interactive tree, showing all the ancestors and descendants of an individual.');
}
/**
* The default position for this tab. It can be changed in the control panel.
*
* @return int
*/
public function defaultTabOrder(): int
{
return 7;
}
/**
* Generate the HTML content of this tab.
*
* @param Individual $individual
*
* @return string
*/
public function getTabContent(Individual $individual): string
{
$treeview = new TreeView('tvTab');
[$html, $js] = $treeview->drawViewport($individual, 3);
return view('modules/interactive-tree/tab', [
'html' => $html,
'js' => $js,
]);
}
/**
* Is this tab empty? If so, we don't always need to display it.
*
* @param Individual $individual
*
* @return bool
*/
public function hasTabContent(Individual $individual): bool
{
return $individual->facts(['FAMC', 'FAMS'])->isNotEmpty();
}
/**
* A greyed out tab has no actual content, but may perhaps have
* options to create content.
*
* @param Individual $individual
*
* @return bool
*/
public function isGrayedOut(Individual $individual): bool
{
return false;
}
/**
* Can this tab load asynchronously?
*
* @return bool
*/
public function canLoadAjax(): bool
{
return true;
}
/**
* CSS class for the URL.
*
* @return string
*/
public function chartMenuClass(): string
{
return 'menu-chart-tree';
}
/**
* Return a menu item for this chart - for use in individual boxes.
*
* @param Individual $individual
*
* @return Menu|null
*/
public function chartBoxMenu(Individual $individual): ?Menu
{
return $this->chartMenu($individual);
}
/**
* The title for a specific instance of this chart.
*
* @param Individual $individual
*
* @return string
*/
public function chartTitle(Individual $individual): string
{
/* I18N: %s is an individual’s name */
return I18N::translate('Interactive tree of %s', $individual->fullName());
}
/**
* The URL for this chart.
*
* @param Individual $individual
* @param array<bool|int|string|array<string>|null> $parameters
*
* @return string
*/
public function chartUrl(Individual $individual, array $parameters = []): string
{
return route('module', [
'module' => $this->name(),
'action' => 'Chart',
'xref' => $individual->xref(),
'tree' => $individual->tree()->name(),
] + $parameters);
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getChartAction(ServerRequestInterface $request): ResponseInterface
{
$tree = Validator::attributes($request)->tree();
$user = Validator::attributes($request)->user();
$xref = Validator::queryParams($request)->isXref()->string('xref');
Auth::checkComponentAccess($this, ModuleChartInterface::class, $tree, $user);
$individual = Registry::individualFactory()->make($xref, $tree);
$individual = Auth::checkIndividualAccess($individual, false, true);
$tv = new TreeView('tv');
[$html, $js] = $tv->drawViewport($individual, 4);
return $this->viewResponse('modules/interactive-tree/page', [
'html' => $html,
'individual' => $individual,
'js' => $js,
'module' => $this->name(),
'title' => $this->chartTitle($individual),
'tree' => $tree,
]);
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postChartAction(ServerRequestInterface $request): ResponseInterface
{
return redirect(route('module', [
'module' => $this->name(),
'action' => 'Chart',
'tree' => Validator::attributes($request)->tree()->name(),
'xref' => Validator::parsedBody($request)->isXref()->string('xref'),
]));
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getDetailsAction(ServerRequestInterface $request): ResponseInterface
{
$tree = Validator::attributes($request)->tree();
$pid = Validator::queryParams($request)->string('pid');
$individual = Registry::individualFactory()->make($pid, $tree);
$individual = Auth::checkIndividualAccess($individual);
$instance = Validator::queryParams($request)->string('instance');
$treeview = new TreeView($instance);
return response($treeview->getDetails($individual));
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getIndividualsAction(ServerRequestInterface $request): ResponseInterface
{
$tree = Validator::attributes($request)->tree();
$q = Validator::queryParams($request)->string('q');
$instance = Validator::queryParams($request)->string('instance');
$treeview = new TreeView($instance);
return response($treeview->getIndividuals($tree, $q));
}
}
Server : Apache/2.4.41 (Ubuntu)