. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fig\Http\Message\RequestMethodInterface; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Individual; use Fisharebest\Webtrees\Menu; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\Services\ChartService; use Fisharebest\Webtrees\Validator; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use function route; /** * Class DescendancyChartModule */ class DescendancyChartModule extends AbstractModule implements ModuleChartInterface, RequestHandlerInterface { use ModuleChartTrait; protected const string ROUTE_URL = '/tree/{tree}/descendants-{style}-{generations}/{xref}'; // Chart styles public const string CHART_STYLE_TREE = 'tree'; public const string CHART_STYLE_INDIVIDUALS = 'individuals'; public const string CHART_STYLE_FAMILIES = 'families'; // Defaults public const string DEFAULT_STYLE = self::CHART_STYLE_TREE; public const string DEFAULT_GENERATIONS = '3'; protected const array DEFAULT_PARAMETERS = [ 'generations' => self::DEFAULT_GENERATIONS, 'style' => self::DEFAULT_STYLE, ]; // Limits protected const int MINIMUM_GENERATIONS = 2; protected const int MAXIMUM_GENERATIONS = 10; private ChartService $chart_service; /** * @param ChartService $chart_service */ public function __construct(ChartService $chart_service) { $this->chart_service = $chart_service; } /** * Initialization. * * @return void */ public function boot(): void { Registry::routeFactory()->routeMap() ->get(static::class, static::ROUTE_URL, $this) ->allows(RequestMethodInterface::METHOD_POST); } /** * How should this module be identified in the control panel, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module/chart */ return I18N::translate('Descendants'); } public function description(): string { /* I18N: Description of the “DescendancyChart” module */ return I18N::translate('A chart of an individual’s descendants.'); } /** * CSS class for the URL. * * @return string */ public function chartMenuClass(): string { return 'menu-chart-descendants'; } /** * Return a menu item for this chart - for use in individual boxes. */ public function chartBoxMenu(Individual $individual): Menu|null { 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('Descendants of %s', $individual->fullName()); } /** * The URL for a page showing chart options. * * @param Individual $individual * @param array|null> $parameters * * @return string */ public function chartUrl(Individual $individual, array $parameters = []): string { return route(static::class, [ 'tree' => $individual->tree()->name(), 'xref' => $individual->xref(), ] + $parameters + self::DEFAULT_PARAMETERS); } /** * @param ServerRequestInterface $request * * @return ResponseInterface */ public function handle(ServerRequestInterface $request): ResponseInterface { $tree = Validator::attributes($request)->tree(); $user = Validator::attributes($request)->user(); $xref = Validator::attributes($request)->isXref()->string('xref'); $style = Validator::attributes($request)->isInArrayKeys($this->styles())->string('style'); $generations = Validator::attributes($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'); $ajax = Validator::queryParams($request)->boolean('ajax', false); // Convert POST requests into GET requests for pretty URLs. if ($request->getMethod() === RequestMethodInterface::METHOD_POST) { return redirect(route(static::class, [ 'tree' => $tree->name(), 'generations' => Validator::parsedBody($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'), 'style' => Validator::parsedBody($request)->isInArrayKeys($this->styles())->string('style'), 'xref' => Validator::parsedBody($request)->isXref()->string('xref'), ])); } Auth::checkComponentAccess($this, ModuleChartInterface::class, $tree, $user); $individual = Registry::individualFactory()->make($xref, $tree); $individual = Auth::checkIndividualAccess($individual, false, true); if ($ajax) { $this->layout = 'layouts/ajax'; switch ($style) { case self::CHART_STYLE_TREE: return $this->viewResponse('modules/descendancy_chart/tree', [ 'individual' => $individual, 'generations' => $generations, 'daboville' => '1', ]); case self::CHART_STYLE_INDIVIDUALS: $individuals = $this->chart_service->descendants($individual, $generations - 1); return $this->viewResponse('lists/individuals-table', [ 'individuals' => $individuals, 'sosa' => false, 'tree' => $tree, ]); case self::CHART_STYLE_FAMILIES: $families = $this->chart_service->descendantFamilies($individual, $generations - 1); return $this->viewResponse('lists/families-table', [ 'families' => $families, 'tree' => $tree, ]); } } $ajax_url = $this->chartUrl($individual, [ 'generations' => $generations, 'style' => $style, 'ajax' => true, ]); return $this->viewResponse('modules/descendancy_chart/page', [ 'ajax_url' => $ajax_url, 'style' => $style, 'styles' => $this->styles(), 'default_generations' => self::DEFAULT_GENERATIONS, 'generations' => $generations, 'individual' => $individual, 'maximum_generations' => self::MAXIMUM_GENERATIONS, 'minimum_generations' => self::MINIMUM_GENERATIONS, 'module' => $this->name(), 'title' => $this->chartTitle($individual), 'tree' => $tree, ]); } /** * This chart can display its output in a number of styles * * @return array */ protected function styles(): array { return [ self::CHART_STYLE_TREE => I18N::translate('Tree'), self::CHART_STYLE_INDIVIDUALS => I18N::translate('Individuals'), self::CHART_STYLE_FAMILIES => I18N::translate('Families'), ]; } }