xref: /webtrees/app/Statistics/Google/ChartMedia.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
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\GedcomTag;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Module\ModuleThemeInterface;
23use Fisharebest\Webtrees\Statistics\AbstractGoogle;
24
25/**
26 *
27 */
28class ChartMedia extends AbstractGoogle
29{
30    /**
31     * Create a chart of media types.
32     *
33     * @param int         $tot        The total number of media files
34     * @param array       $media      The list of media types to display
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 chartMedia(
42        int $tot,
43        array $media,
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        // Beware divide by zero
59        if ($tot === 0) {
60            return I18N::translate('None');
61        }
62
63        // Build a table listing only the media types actually present in the GEDCOM
64        $mediaCounts = [];
65        $mediaTypes  = '';
66        $chart_title = '';
67
68        foreach ($media as $type => $count) {
69            $mediaCounts[] = intdiv(100 * $count, $tot);
70            $mediaTypes    .= GedcomTag::getFileFormTypeValue($type) . ' - ' . I18N::number($count) . '|';
71            $chart_title   .= GedcomTag::getFileFormTypeValue($type) . ' (' . $count . '), ';
72        }
73
74        $chart_title = substr($chart_title, 0, -2);
75        $chd         = $this->arrayToExtendedEncoding($mediaCounts);
76        $chl         = substr($mediaTypes, 0, -1);
77        $colors      = [$color_from, $color_to];
78
79        return view(
80            'statistics/other/chart-google',
81            [
82                'chart_title' => $chart_title,
83                'chart_url'   => $this->getPieChartUrl($chd, $size, $colors, $chl),
84                'sizes'       => $sizes,
85            ]
86        );
87    }
88}
89