xref: /webtrees/app/Module/ModuleChartTrait.php (revision e539f5c659fdb4b3fcf865b058906958d688ba15) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Individual;
21use Fisharebest\Webtrees\Menu;
22
23/**
24 * Trait ModuleChartTrait - default implementation of ModuleChartInterface
25 */
26trait ModuleChartTrait
27{
28    /**
29     * A main menu item for this chart.
30     *
31     * @param Individual $individual
32     *
33     * @return Menu
34     */
35    public function chartMenu(Individual $individual): Menu
36    {
37        return new Menu(
38            $this->title(),
39            $this->chartUrl($individual),
40            $this->chartUrlClasss(),
41            $this->chartUrlAttributes()
42        );
43    }
44
45    /**
46     * A menu item for this chart for an individual box in a chart.
47     *
48     * @param Individual $individual
49     *
50     * @return Menu|null
51     */
52    public function chartMenuIndividual(Individual $individual): ?Menu
53    {
54        return null;
55    }
56
57    /**
58     * The title for a specific instance of this chart.
59     *
60     * @param Individual $individual
61     *
62     * @return string
63     */
64    public function chartTitle(Individual $individual): string
65    {
66        return $this->title();
67    }
68
69    /**
70     * The URL for a page showing chart options.
71     *
72     * @param Individual $individual
73     * @param string[]   $parameters
74     *
75     * @return string
76     */
77    public function chartUrl(Individual $individual, array $parameters = []): string
78    {
79        return route('module', [
80            'module' => $this->getName(),
81            'action' => 'Chart',
82            'xref'   => $individual->xref(),
83            'ged'    => $individual->tree()->name(),
84        ] + $parameters);
85    }
86
87    /**
88     * Attributes for the URL.
89     *
90     * @return string[]
91     */
92    public function chartUrlAttributes(): array
93    {
94        return ['rel' => 'nofollow'];
95    }
96
97    /**
98     * CSS class for the URL.
99     *
100     * @return string
101     */
102    public function chartUrlClasss(): string
103    {
104        return '';
105    }
106}
107