Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
88.89%
64 / 72
42.86%
3 / 7
 CRAP
0.00%
0 / 1
Base
88.89%
64 / 72
42.86%
3 / 7
 30.15
0.00%
0 / 1
 sanitizeDownloadFilenamePart
100.00%
1 / 1
100.00%
1 / 1
 1
 resolveDictionaryHeader
33.33%
2 / 6
0.00%
0 / 1
 5.67
 writeRawReport
100.00%
9 / 9
100.00%
1 / 1
 5
 writeFilteredExchangeReport
93.75%
15 / 16
0.00%
0 / 1
 6.01
 writeInfoHeader
92.59%
25 / 27
0.00%
0 / 1
 10.04
 setDateTime
75.00%
3 / 4
0.00%
0 / 1
 3.14
 getFormatedDates
100.00%
9 / 9
100.00%
1 / 1
 1
1<?php
2
3/**
4 * @package zmsstatistic
5 * @copyright BerlinOnline Stadtportal GmbH & Co. KG
6 **/
7
8namespace BO\Zmsstatistic\Download;
9
10use BO\Zmsentities\Exchange;
11use BO\Zmsstatistic\BaseController;
12use Exception;
13use PhpOffice\PhpSpreadsheet\Spreadsheet;
14
15class Base extends BaseController
16{
17    public static array $ignoreColumns = [
18        'subjectid',
19        'scopeids',
20        'max',
21        'sum',
22        'ticketprinter',
23        'ticketprintermissed'
24    ];
25    public static array $subjectTranslations = [
26        'waitingscope' => 'Wartesituation',
27        'waitingdepartment' => 'Wartesituation',
28        'waitingorganisation' => 'Wartesituation',
29        'clientscope' => 'Kundenstatistik',
30        'clientdepartment' => 'Kundenstatistik',
31        'clientorganisation' => 'Kundenstatistik',
32        'requestscope' => 'Dienstleistungsstatistik',
33        'requestdepartment' => 'Dienstleistungsstatistik',
34        'requestorganisation' => 'Dienstleistungsstatistik',
35        'raw-waitingscope' => 'Rohdaten Wartesituation',
36        'raw-waitingdepartment' => 'Rohdaten Wartesituation',
37        'raw-waitingorganisation' => 'Rohdaten Wartesituation',
38        'raw-clientscope' => 'Rohdaten Wartende',
39        'raw-clientdepartment' => 'Rohdaten Wartende',
40        'raw-clientorganisation' => 'Rohdaten Wartende',
41        'raw-requestscope' => 'Rohdaten Dienstleistungsstatistik',
42        'raw-requestdepartment' => 'Rohdaten Dienstleistungsstatistik',
43        'raw-requestorganisation' => 'Rohdaten Dienstleistungsstatistik',
44        'capacityscope' => 'Terminkapazität',
45        'raw-capacityscope' => 'Rohdaten Terminkapazität'
46    ];
47
48    public static array $headlines = [
49        'subjectid' => 'ID',
50        'scopeids' => 'Standort IDs',
51        'date' => 'Datum',
52        'clientscount' => 'Kunden Erschienen',
53        'missed' => 'Kunden Nicht Erschienen',
54        'withappointment' => 'davon Terminkunden Erschienen',
55        'missedwithappointment' => 'davon Terminkunden Nicht Erschienen',
56        'noappointment' => 'davon Spontankunden Erschienen',
57        'missednoappointment' => 'davon Spontankunden Nicht Erschienen',
58        'ticketprinter' => 'Erschienen (E-Kiosk)',
59        'ticketprintermissed' => 'Nicht Erschienen (E-Kiosk)',
60        'requestscount' => 'Dienstleistungen',
61        'organisationname' => 'Organisation',
62        'departmentname' => 'Behörde',
63        'scopename' => 'Standort',
64        'bookedcount' => 'Gebuchte Kapazität (Zeitschlitze)',
65        'plannedcount' => 'Geplante Kapazität (Zeitschlitze)',
66        'bookedminutes' => 'Gebuchte Kapazität (Minuten)',
67        'plannedminutes' => 'Geplante Kapazität (Minuten)',
68    ];
69
70    protected function sanitizeDownloadFilenamePart(string $part): string
71    {
72        return str_replace(',', '_', $part);
73    }
74
75    protected function resolveDictionaryHeader(array $item): string
76    {
77        if (!empty($item['description'])) {
78            return (string) $item['description'];
79        }
80
81        $variable = $item['variable'] ?? '';
82        if (isset(static::$headlines[$variable])) {
83            return static::$headlines[$variable];
84        }
85
86        return (string) $variable;
87    }
88
89    protected function writeRawReport(Exchange $report, Spreadsheet $spreadsheet): Spreadsheet
90    {
91        $sheet = $spreadsheet->getActiveSheet();
92        $reportData = [];
93        foreach ($report->dictionary as $item) {
94            $reportData['header'][] = $this->resolveDictionaryHeader($item);
95        }
96        foreach ($report->data as $row => $entry) {
97            foreach ($entry as $item) {
98                $reportData[$row][] = is_numeric($item) ? (string) $item : $item;
99            }
100        }
101        $sheet->fromArray($reportData, null, 'A' . ($sheet->getHighestRow()));
102
103        return $spreadsheet;
104    }
105
106    protected function writeFilteredExchangeReport(
107        Exchange $report,
108        Spreadsheet $spreadsheet,
109        array $skipVariables = [],
110        int $rowGap = 0
111    ): Spreadsheet {
112        $sheet = $spreadsheet->getActiveSheet();
113        $columnIndexes = [];
114        $reportData = [];
115
116        foreach ($report->dictionary as $index => $item) {
117            $variable = $item['variable'] ?? '';
118            if (in_array($variable, $skipVariables, true)) {
119                continue;
120            }
121            $columnIndexes[] = $index;
122            $reportData['header'][] = $this->resolveDictionaryHeader($item);
123        }
124
125        foreach ($report->data as $row => $entry) {
126            foreach ($columnIndexes as $index) {
127                $value = $entry[$index] ?? '';
128                $reportData[$row][] = is_numeric($value) ? (string) $value : $value;
129            }
130        }
131
132        $startRow = $sheet->getHighestRow() + $rowGap;
133        $sheet->fromArray($reportData, null, 'A' . $startRow);
134
135        return $spreadsheet;
136    }
137
138    protected function writeInfoHeader(array $args, Spreadsheet $spreadsheet): Spreadsheet|null
139    {
140        $sheet = $spreadsheet->getActiveSheet();
141        $infoData = [];
142        $infoData[] = static::$subjectTranslations[$args['category']];
143        if (isset($args['selectedScopes'])) {
144            try {
145                $scopesResult = \App::http()->readGetResult('/scope/')->getData();
146                $scopeMap = [];
147                foreach ($scopesResult ?? [] as $scope) {
148                    $scopeMap[$scope->id] = $scope;
149                }
150                foreach ($args['selectedScopes'] as $scopeId) {
151                    if (isset($scopeMap[$scopeId])) {
152                        $infoData[] = $scopeMap[$scopeId]->provider->name . " " . $scopeMap[$scopeId]->shortName;
153                    }
154                }
155            } catch (Exception $exception) {
156                return null;
157            }
158        } else {
159            if (isset($args['organisation'])) {
160                $infoData[] = $args['organisation']['name'] ;
161            }
162            if (isset($args['department'])) {
163                $infoData[] = $args['department']['name'];
164            }
165            if (isset($args['scope'])) {
166                $infoData[] = $args['scope']['contact']['name'] . ' ' . $args['scope']['shortName'];
167            }
168        }
169
170        $infoData = array_chunk($infoData, 1);
171        $sheet->fromArray($infoData, null, 'A' . $sheet->getHighestRow());
172
173        if (isset($args['reports'][0]->firstDay)) {
174            $firstDay = $args['reports'][0]->firstDay->toDateTime()->format('d.m.Y');
175            $lastDay = $args['reports'][0]->lastDay->toDateTime()->format('d.m.Y');
176            $range = array('Zeitraum:', $firstDay, 'bis', $lastDay);
177            $sheet->fromArray($range, null, 'A' . ($sheet->getHighestRow() + 1));
178        }
179
180        return $spreadsheet;
181    }
182
183    /** @psalm-api */
184    protected function setDateTime(string $dateString): \DateTime
185    {
186        $dateArr = explode('-', $dateString);
187        if (2 == count($dateArr)) {
188            $dateString = $dateString . '-01';
189        }
190        /* ignore because not in use now */
191        //@codeCoverageIgnoreStart
192        if (1 == count($dateArr)) {
193            $dateString = $dateString . '-01-01';
194        }
195        //@codeCoverageIgnoreEnd
196        return new \DateTime($dateString);
197    }
198
199    /**
200     * @psalm-api
201     * @return false|string
202     */
203    protected function getFormatedDates(\DateTimeInterface $date, string $pattern = 'MMMM'): string|false
204    {
205        $dateFormatter = new \IntlDateFormatter(
206            'de-DE',
207            \IntlDateFormatter::MEDIUM,
208            \IntlDateFormatter::MEDIUM,
209            \App::TIMEZONE,
210            \IntlDateFormatter::GREGORIAN,
211            $pattern
212        );
213
214        return $dateFormatter->format($date->getTimestamp());
215    }
216}