xref: /webtrees/app/Statistics/Google/ChartCommonGiven.php (revision 77a2010793e07b8d01d1a336fa5967181694729d) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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\Statistics\Google;
19
20use Fisharebest\Webtrees\I18N;
21use Fisharebest\Webtrees\Module\ModuleThemeInterface;
22use Fisharebest\Webtrees\Statistics\AbstractGoogle;
23use Fisharebest\Webtrees\Theme;
24
25/**
26 *
27 */
28class ChartCommonGiven extends AbstractGoogle
29{
30    /**
31     * Create a chart of common given names.
32     *
33     * @param int         $tot_indi   The total number of individuals
34     * @param array       $given      The list of common given names
35     * @param string|null $size
36     * @param string|null $color_from
37     * @param string|null $color_to
38     *
39     * @return string
40     */
41    public function chartCommonGiven(
42        int $tot_indi,
43        array $given,
44        string $size = null,
45        string $color_from = null,
46        string $color_to = null
47    ) : string {
48        $chart_color1 = (string) app()->make(ModuleThemeInterface::class)->parameter('distribution-chart-no-values');
49        $chart_color2 = (string) app()->make(ModuleThemeInterface::class)->parameter('distribution-chart-high-values');
50        $chart_x      = app()->make(ModuleThemeInterface::class)->parameter('stats-small-chart-x');
51        $chart_y      = app()->make(ModuleThemeInterface::class)->parameter('stats-small-chart-y');
52
53        $size       = $size ?? ($chart_x . 'x' . $chart_y);
54        $color_from = $color_from ?? $chart_color1;
55        $color_to   = $color_to ?? $chart_color2;
56        $sizes      = explode('x', $size);
57
58        if (empty($given)) {
59            return '';
60        }
61
62        $tot = 0;
63        foreach ($given as $count) {
64            $tot += $count;
65        }
66
67        $chd = '';
68        $chl = [];
69
70        foreach ($given as $givn => $count) {
71            if ($tot === 0) {
72                $per = 0;
73            } else {
74                $per = intdiv(100 * $count, $tot_indi);
75            }
76            $chd .= $this->arrayToExtendedEncoding([$per]);
77            $chl[] = $givn . ' - ' . I18N::number($count);
78        }
79
80        $per   = intdiv(100 * ($tot_indi - $tot), $tot_indi);
81        $chd .= $this->arrayToExtendedEncoding([$per]);
82        $chl[] = I18N::translate('Other') . ' - ' . I18N::number($tot_indi - $tot);
83
84        $chart_title = implode(I18N::$list_separator, $chl);
85        $chl         = rawurlencode(implode('|', $chl));
86        $colors      = [$color_from, $color_to];
87
88        return view(
89            'statistics/other/chart-google',
90            [
91                'chart_title' => $chart_title,
92                'chart_url'   => $this->getPieChartUrl($chd, $size, $colors, $chl),
93                'sizes'       => $sizes,
94            ]
95        );
96    }
97}
98