xref: /webtrees/app/Module/ModuleChartTrait.php (revision 0010d42b5dcc725e166945c3345a365d5aa115e3) 
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 menu item for this chart for an individual box in a chart.
30     *
31     * @param Individual $individual
32     *
33     * @return Menu|null
34     */
35    public function chartBoxMenu(Individual $individual): ?Menu
36    {
37        return null;
38    }
39
40    /**
41     * A main menu item for this chart.
42     *
43     * @param Individual $individual
44     *
45     * @return Menu
46     */
47    public function chartMenu(Individual $individual): Menu
48    {
49        return new Menu(
50            $this->title(),
51            $this->chartUrl($individual),
52            $this->chartMenuClass(),
53            $this->chartUrlAttributes()
54        );
55    }
56
57    /**
58     * CSS class for the menu.
59     *
60     * @return string
61     */
62    public function chartMenuClass(): string
63    {
64        return '';
65    }
66
67    /**
68     * The title for a specific instance of this chart.
69     *
70     * @param Individual $individual
71     *
72     * @return string
73     */
74    public function chartTitle(Individual $individual): string
75    {
76        return $this->title();
77    }
78
79    /**
80     * The URL for a page showing chart options.
81     *
82     * @param Individual $individual
83     * @param string[]   $parameters
84     *
85     * @return string
86     */
87    public function chartUrl(Individual $individual, array $parameters = []): string
88    {
89        return route('module', [
90                'module' => $this->name(),
91                'action' => 'Chart',
92                'xref'   => $individual->xref(),
93                'ged'    => $individual->tree()->name(),
94        ] + $parameters);
95    }
96
97    /**
98     * Attributes for the URL.
99     *
100     * @return string[]
101     */
102    public function chartUrlAttributes(): array
103    {
104        return ['rel' => 'nofollow'];
105    }
106}
107