xref: /webtrees/app/Statistics/Google/ChartFamilyWithSources.php (revision b50dba3a86d260384d07c30bedf82d8e78ab49f7) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Statistics\Google;
21
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Statistics\Service\ColorService;
24
25use function count;
26use function view;
27
28/**
29 * A chart showing families with sources.
30 */
31class ChartFamilyWithSources
32{
33    private ColorService $color_service;
34
35    /**
36     * @param ColorService $color_service
37     */
38    public function __construct(ColorService $color_service)
39    {
40        $this->color_service = $color_service;
41    }
42
43    /**
44     * Create a chart of individuals with/without sources.
45     *
46     * @param int         $tot_fam        The total number of families
47     * @param int         $tot_fam_source The total number of families with sources
48     * @param string|null $color_from
49     * @param string|null $color_to
50     *
51     * @return string
52     */
53    public function chartFamsWithSources(
54        int $tot_fam,
55        int $tot_fam_source,
56        string|null $color_from = null,
57        string|null $color_to = null
58    ): string {
59        $color_from ??= 'ffffff';
60        $color_to ??= '84beff';
61
62        $data = [
63            [
64                I18N::translate('Type'),
65                I18N::translate('Total')
66            ],
67        ];
68
69        if ($tot_fam > 0 || $tot_fam_source > 0) {
70            $data[] = [
71                I18N::translate('Without sources'),
72                $tot_fam - $tot_fam_source
73            ];
74
75            $data[] = [
76                I18N::translate('With sources'),
77                $tot_fam_source
78            ];
79        }
80
81        $colors = $this->color_service->interpolateRgb($color_from, $color_to, count($data) - 1);
82
83        return view('statistics/other/charts/pie', [
84            'title'            => I18N::translate('Families with sources'),
85            'data'             => $data,
86            'colors'           => $colors,
87            'labeledValueText' => 'percentage',
88            'language'         => I18N::languageTag(),
89        ]);
90    }
91}
92