xref: /webtrees/app/Statistics/Google/ChartMedia.php (revision 89f7189b61a494347591c99bdb92afb7d8b66e1b)
18add1155SRico Sonntag<?php
23976b470SGreg Roach
38add1155SRico Sonntag/**
48add1155SRico Sonntag * webtrees: online genealogy
5*89f7189bSGreg Roach * Copyright (C) 2021 webtrees development team
68add1155SRico Sonntag * This program is free software: you can redistribute it and/or modify
78add1155SRico Sonntag * it under the terms of the GNU General Public License as published by
88add1155SRico Sonntag * the Free Software Foundation, either version 3 of the License, or
98add1155SRico Sonntag * (at your option) any later version.
108add1155SRico Sonntag * This program is distributed in the hope that it will be useful,
118add1155SRico Sonntag * but WITHOUT ANY WARRANTY; without even the implied warranty of
128add1155SRico Sonntag * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138add1155SRico Sonntag * GNU General Public License for more details.
148add1155SRico Sonntag * You should have received a copy of the GNU General Public License
15*89f7189bSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
168add1155SRico Sonntag */
17fcfa147eSGreg Roach
188add1155SRico Sonntagdeclare(strict_types=1);
198add1155SRico Sonntag
208add1155SRico Sonntagnamespace Fisharebest\Webtrees\Statistics\Google;
218add1155SRico Sonntag
228add1155SRico Sonntaguse Fisharebest\Webtrees\GedcomTag;
238add1155SRico Sonntaguse Fisharebest\Webtrees\I18N;
2493ccd686SRico Sonntaguse Fisharebest\Webtrees\Module\ModuleThemeInterface;
2593ccd686SRico Sonntaguse Fisharebest\Webtrees\Statistics\Service\ColorService;
268add1155SRico Sonntag
2790a2f718SGreg Roachuse function app;
2871378461SGreg Roachuse function count;
2971378461SGreg Roach
308add1155SRico Sonntag/**
3193ccd686SRico Sonntag * A chart showing the top used media types.
328add1155SRico Sonntag */
3393ccd686SRico Sonntagclass ChartMedia
348add1155SRico Sonntag{
358add1155SRico Sonntag    /**
3693ccd686SRico Sonntag     * @var ModuleThemeInterface
3793ccd686SRico Sonntag     */
3893ccd686SRico Sonntag    private $theme;
3993ccd686SRico Sonntag
4093ccd686SRico Sonntag    /**
4193ccd686SRico Sonntag     * @var ColorService
4293ccd686SRico Sonntag     */
4393ccd686SRico Sonntag    private $color_service;
4493ccd686SRico Sonntag
4593ccd686SRico Sonntag    /**
4693ccd686SRico Sonntag     * Constructor.
4793ccd686SRico Sonntag     */
4893ccd686SRico Sonntag    public function __construct()
4993ccd686SRico Sonntag    {
50cab242e7SGreg Roach        $this->theme         = app(ModuleThemeInterface::class);
5193ccd686SRico Sonntag        $this->color_service = new ColorService();
5293ccd686SRico Sonntag    }
5393ccd686SRico Sonntag
5493ccd686SRico Sonntag    /**
558add1155SRico Sonntag     * Create a chart of media types.
568add1155SRico Sonntag     *
57bfe98399SGreg Roach     * @param array<string,int> $media      The list of media types to display
588add1155SRico Sonntag     * @param string|null       $color_from
598add1155SRico Sonntag     * @param string|null       $color_to
608add1155SRico Sonntag     *
618add1155SRico Sonntag     * @return string
628add1155SRico Sonntag     */
638add1155SRico Sonntag    public function chartMedia(
648add1155SRico Sonntag        array $media,
658add1155SRico Sonntag        string $color_from = null,
668add1155SRico Sonntag        string $color_to = null
678add1155SRico Sonntag    ): string {
6888de55fdSRico Sonntag        $chart_color1 = (string) $this->theme->parameter('distribution-chart-no-values');
6988de55fdSRico Sonntag        $chart_color2 = (string) $this->theme->parameter('distribution-chart-high-values');
708add1155SRico Sonntag        $color_from   = $color_from ?? $chart_color1;
718add1155SRico Sonntag        $color_to     = $color_to   ?? $chart_color2;
728add1155SRico Sonntag
7388de55fdSRico Sonntag        $data = [
7488de55fdSRico Sonntag            [
7588de55fdSRico Sonntag                I18N::translate('Type'),
7688de55fdSRico Sonntag                I18N::translate('Total')
7788de55fdSRico Sonntag            ],
7888de55fdSRico Sonntag        ];
798add1155SRico Sonntag
808add1155SRico Sonntag        foreach ($media as $type => $count) {
8188de55fdSRico Sonntag            $data[] = [
8288de55fdSRico Sonntag                GedcomTag::getFileFormTypeValue($type),
8388de55fdSRico Sonntag                $count
8488de55fdSRico Sonntag            ];
858add1155SRico Sonntag        }
868add1155SRico Sonntag
876ccdf4f0SGreg Roach        $colors = $this->color_service->interpolateRgb($color_from, $color_to, count($data) - 1);
888add1155SRico Sonntag
8990a2f718SGreg Roach        return view('statistics/other/charts/pie', [
9088de55fdSRico Sonntag            'title'    => null,
9188de55fdSRico Sonntag            'data'     => $data,
9288de55fdSRico Sonntag            'colors'   => $colors,
9365cf5706SGreg Roach            'language' => I18N::languageTag(),
9490a2f718SGreg Roach        ]);
958add1155SRico Sonntag    }
968add1155SRico Sonntag}
97