HelpText::formatDates() - Code Metrics - Inspection of "Working on routing" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 258cb0...d72b28 )

by Greg

created 2019-10-10 22:46 UTC

HelpText::formatDates() A

↳ Parent: HelpText

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	1
dl	0
loc	13
rs	10
c	0
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\RequestHandlers;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Date;
use Fisharebest\Webtrees\Http\Controllers\AbstractBaseController;
use Fisharebest\Webtrees\I18N;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

use function array_keys;
use function array_merge;
use function preg_replace;
use function response;
use function str_replace;
use function strip_tags;
use function view;

/**
 * Show help text.
 */
class HelpText extends AbstractBaseController
{
    private const FRENCH_DATES = [
        '@#DFRENCH R@ 12',
        '@#DFRENCH R@ VEND 12',
        'ABT @#DFRENCH R@ BRUM 12',
        'BET @#DFRENCH R@ FRIM 12 AND @#DFRENCH R@ NIVO 12',
        'FROM @#DFRENCH R@ PLUV 12 TO @#DFRENCH R@ VENT 12',
        'AFT @#DFRENCH R@ GERM 12',
        'BEF @#DFRENCH R@ FLOR 12',
        'ABT @#DFRENCH R@ PRAI 12',
        'FROM @#DFRENCH R@ MESS 12',
        'TO @#DFRENCH R@ THER 12',
        'EST @#DFRENCH R@ FRUC 12',
        '@#DFRENCH R@ 03 COMP 12',
    ];

    private const HIJRI_DATES = [
        '@#DHIJRI@ 1497',
        '@#DHIJRI@ MUHAR 1497',
        'ABT @#DHIJRI@ SAFAR 1497',
        'BET @#DHIJRI@ RABIA 1497 AND @#DHIJRI@ RABIT 1497',
        'FROM @#DHIJRI@ JUMAA 1497 TO @#DHIJRI@ JUMAT 1497',
        'AFT @#DHIJRI@ RAJAB 1497',
        'BEF @#DHIJRI@ SHAAB 1497',
        'ABT @#DHIJRI@ RAMAD 1497',
        'FROM @#DHIJRI@ SHAWW 1497',
        'TO @#DHIJRI@ DHUAQ 1497',
        '@#DHIJRI@ 03 DHUAH 1497',
    ];

    private const JEWISH_DATES = [
        '@#DHEBREW@ 5481',
        '@#DHEBREW@ TSH 5481',
        'ABT @#DHEBREW@ CSH 5481',
        'BET @#DHEBREW@ KSL 5481 AND @#DHEBREW@ TVT 5481',
        'FROM @#DHEBREW@ SHV 5481 TO @#DHEBREW@ ADR 5481',
        'AFT @#DHEBREW@ ADR 5481',
        'AFT @#DHEBREW@ ADS 5480',
        'BEF @#DHEBREW@ NSN 5481',
        'ABT @#DHEBREW@ IYR 5481',
        'FROM @#DHEBREW@ SVN 5481',
        'TO @#DHEBREW@ TMZ 5481',
        'EST @#DHEBREW@ AAV 5481',
        '@#DHEBREW@ 03 ELL 5481',
    ];

    private const JULIAN_DATES = [
        '@#DJULIAN@ 14 JAN 1700',
        '@#DJULIAN@ 44 B.C.',
        '@#DJULIAN@ 20 FEB 1742/43',
        'BET @#DJULIAN@ 01 SEP 1752 AND @#DGREGORIAN@ 30 SEP 1752',
    ];

    private const DATE_SHORTCUTS = [
        '1900'           => [],
        'JAN 1900'       => [],
        'FEB 1900'       => [],
        'MAR 1900'       => [],
        'APR 1900'       => [],
        'MAY 1900'       => [],
        'JUN 1900'       => [],
        'JUL 1900'       => [],
        'AUG 1900'       => [],
        'SEP 1900'       => [],
        'OCT 1900'       => [],
        'NOV 1900'       => [],
        'DEC 1900'       => [],
        'ABT 1900'       => ['~1900'],
        'EST 1900'       => ['*1900'],
        'CAL 1900'       => ['#1900'],
        'INT 1900 (...)' => [],
    ];

    private const DATE_RANGE_SHORTCUTS = [
        'BET 1900 AND 1910'         => ['1900-1910'],
        'AFT 1900'                  => ['>1900'],
        'BEF 1910'                  => ['<1910'],
        'BET JAN 1900 AND MAR 1900' => ['Q1 1900'],
        'BET APR 1900 AND JUN 1900' => ['Q2 1900'],
        'BET JUL 1900 AND SEP 1900' => ['Q3 1900'],
        'BET OCT 1900 AND DEC 1900' => ['Q4 1900'],
    ];

    private const DATE_PERIOD_SHORTCUTS = [
        'FROM 1900 TO 1910' => ['1900~1910'],
        'FROM 1900'         => ['1900-'],
        'TO 1910'           => ['-1900'],
    ];

    private const DMY_SHORTCUTS = [
        '11 DEC 1913' => [
            '11/12/1913',
            '11-12-1913',
            '11.12.1913',
        ],
        '01 FEB 2003' => [
            '01/02/03',
            '01-02-03',
            '01.02.03',
        ],
    ];

    private const MDY_SHORTCUTS = [
        '11 DEC 1913' => [
            '12/11/1913',
            '12-11-1913',
            '12.11.1913',
        ],
        '01 FEB 2003' => [
            '02/01/03',
            '02-01-03',
            '02.01.03',
        ],
    ];

    private const YMD_SHORTCUTS = [
        '11 DEC 1913' => [
            '11/12/1913',
            '11-12-1913',
            '11.12.1913',
        ],
        '01 FEB 2003' => [
            '03/02/01',
            '03-02-01',
            '03.02.01',
        ],
    ];

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $topic = $request->getAttribute('topic');

        switch ($topic) {
            case 'DATE':
                switch ($this->dmyOrder()) {
                    case 'YMD':
                        $date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::YMD_SHORTCUTS);
                        break;
                    case 'MDY':
                        $date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::MDY_SHORTCUTS);
                        break;
                    case 'DMY':
                    default:
                        $date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::DMY_SHORTCUTS);
                        break;
                }

                $title = I18N::translate('Date');
                $text  = view('help/date', [
                    'date_dates'            => $this->formatDates(array_keys($date_shortcuts)),
                    'date_shortcuts'        => $date_shortcuts,
                    'date_period_dates'     => $this->formatDates(array_keys(self::DATE_PERIOD_SHORTCUTS)),
                    'date_period_shortcuts' => self::DATE_PERIOD_SHORTCUTS,
                    'date_range_dates'      => $this->formatDates(array_keys(self::DATE_RANGE_SHORTCUTS)),
                    'date_range_shortcuts'  => self::DATE_RANGE_SHORTCUTS,
                    'french_dates'          => $this->formatDates(self::FRENCH_DATES),
                    'hijri_dates'           => $this->formatDates(self::HIJRI_DATES),
                    'jewish_dates'          => $this->formatDates(self::JEWISH_DATES),
                    'julian_dates'          => $this->formatDates(self::JULIAN_DATES),
                ]);
                break;

            case 'NAME':
                $title = I18N::translate('Name');
                $text  = view('help/name');
                break;

            case 'SURN':
                $title = I18N::translate('Surname');
                $text  = view('help/surname');
                break;

            case 'OBJE':
                $title = I18N::translate('Media object');
                $text  = view('help/media-object');
                break;

            case 'PLAC':
                $title = I18N::translate('Place');
                $text  = view('help/place');
                break;

            case 'RESN':
                $title = I18N::translate('Restriction');
                $text  = view('help/restriction');
                break;

            case 'ROMN':
                $title = I18N::translate('Romanized');
                $text  = view('help/romanized');
                break;

            case '_HEB':
                $title = I18N::translate('Hebrew');
                $text  = view('help/hebrew');
                break;

            case 'edit_SOUR_EVEN':
                $title = I18N::translate('Associate events with this source');
                $text  = view('help/source-events');
                break;

            case 'pending_changes':
                $title = I18N::translate('Pending changes');
                $text  = view('help/pending-changes', [
                    'is_admin' => Auth::isAdmin(),
                ]);
                break;

            case 'relationship-privacy':
                $title = I18N::translate('Restrict to immediate family');
                $text  = view('help/relationship-privacy');
                break;

            default:
                $title = I18N::translate('Help');
                $text  = I18N::translate('The help text has not been written for this item.');
                break;
        }

        $html = view('modals/help', [
            'title' => $title,
            'text'  => $text,
        ]);

        return response($html);
    }

    /**
     * Format GEDCOM dates in the local language.
     *
     * @param string[] $gedcom_dates
     *
     * @return string[]
     */
    private function formatDates(array $gedcom_dates): array
    {
        $dates = [];

        foreach ($gedcom_dates as $gedcom_date) {
            // PHP converts numeric array keys ('1900') to integers (1900), so reverse this.
            $gedcom_date = (string) $gedcom_date;

            $date                = new Date($gedcom_date);
            $dates[$gedcom_date] = strip_tags($date->display(false, null, false));
        }

        return $dates;
    }

    /**
     * Does the current language use DMY, MDY or YMD for numeric date.
     *
     * @return string
     */
    private function dmyOrder(): string
    {
        return preg_replace('/[^DMY]/', '', str_replace(['J', 'F',], ['D', 'M',], I18N::dateFormat()));
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16			*/
17			declare(strict_types=1);
18
19			namespace Fisharebest\Webtrees\Http\RequestHandlers;
20
21			use Fisharebest\Webtrees\Auth;
22			use Fisharebest\Webtrees\Date;
23			use Fisharebest\Webtrees\Http\Controllers\AbstractBaseController;
24			use Fisharebest\Webtrees\I18N;
25			use Psr\Http\Message\ResponseInterface;
26			use Psr\Http\Message\ServerRequestInterface;
27
28			use function array_keys;
29			use function array_merge;
30			use function preg_replace;
31			use function response;
32			use function str_replace;
33			use function strip_tags;
34			use function view;
35
36			/**
37			* Show help text.
38			*/
39			class HelpText extends AbstractBaseController
40			{
41			private const FRENCH_DATES = [
42			'@#DFRENCH R@ 12',
43			'@#DFRENCH R@ VEND 12',
44			'ABT @#DFRENCH R@ BRUM 12',
45			'BET @#DFRENCH R@ FRIM 12 AND @#DFRENCH R@ NIVO 12',
46			'FROM @#DFRENCH R@ PLUV 12 TO @#DFRENCH R@ VENT 12',
47			'AFT @#DFRENCH R@ GERM 12',
48			'BEF @#DFRENCH R@ FLOR 12',
49			'ABT @#DFRENCH R@ PRAI 12',
50			'FROM @#DFRENCH R@ MESS 12',
51			'TO @#DFRENCH R@ THER 12',
52			'EST @#DFRENCH R@ FRUC 12',
53			'@#DFRENCH R@ 03 COMP 12',
54			];
55
56			private const HIJRI_DATES = [
57			'@#DHIJRI@ 1497',
58			'@#DHIJRI@ MUHAR 1497',
59			'ABT @#DHIJRI@ SAFAR 1497',
60			'BET @#DHIJRI@ RABIA 1497 AND @#DHIJRI@ RABIT 1497',
61			'FROM @#DHIJRI@ JUMAA 1497 TO @#DHIJRI@ JUMAT 1497',
62			'AFT @#DHIJRI@ RAJAB 1497',
63			'BEF @#DHIJRI@ SHAAB 1497',
64			'ABT @#DHIJRI@ RAMAD 1497',
65			'FROM @#DHIJRI@ SHAWW 1497',
66			'TO @#DHIJRI@ DHUAQ 1497',
67			'@#DHIJRI@ 03 DHUAH 1497',
68			];
69
70			private const JEWISH_DATES = [
71			'@#DHEBREW@ 5481',
72			'@#DHEBREW@ TSH 5481',
73			'ABT @#DHEBREW@ CSH 5481',
74			'BET @#DHEBREW@ KSL 5481 AND @#DHEBREW@ TVT 5481',
75			'FROM @#DHEBREW@ SHV 5481 TO @#DHEBREW@ ADR 5481',
76			'AFT @#DHEBREW@ ADR 5481',
77			'AFT @#DHEBREW@ ADS 5480',
78			'BEF @#DHEBREW@ NSN 5481',
79			'ABT @#DHEBREW@ IYR 5481',
80			'FROM @#DHEBREW@ SVN 5481',
81			'TO @#DHEBREW@ TMZ 5481',
82			'EST @#DHEBREW@ AAV 5481',
83			'@#DHEBREW@ 03 ELL 5481',
84			];
85
86			private const JULIAN_DATES = [
87			'@#DJULIAN@ 14 JAN 1700',
88			'@#DJULIAN@ 44 B.C.',
89			'@#DJULIAN@ 20 FEB 1742/43',
90			'BET @#DJULIAN@ 01 SEP 1752 AND @#DGREGORIAN@ 30 SEP 1752',
91			];
92
93			private const DATE_SHORTCUTS = [
94			'1900' => [],
95			'JAN 1900' => [],
96			'FEB 1900' => [],
97			'MAR 1900' => [],
98			'APR 1900' => [],
99			'MAY 1900' => [],
100			'JUN 1900' => [],
101			'JUL 1900' => [],
102			'AUG 1900' => [],
103			'SEP 1900' => [],
104			'OCT 1900' => [],
105			'NOV 1900' => [],
106			'DEC 1900' => [],
107			'ABT 1900' => ['~1900'],
108			'EST 1900' => ['*1900'],
109			'CAL 1900' => ['#1900'],
110			'INT 1900 (...)' => [],
111			];
112
113			private const DATE_RANGE_SHORTCUTS = [
114			'BET 1900 AND 1910' => ['1900-1910'],
115			'AFT 1900' => ['>1900'],
116			'BEF 1910' => ['<1910'],
117			'BET JAN 1900 AND MAR 1900' => ['Q1 1900'],
118			'BET APR 1900 AND JUN 1900' => ['Q2 1900'],
119			'BET JUL 1900 AND SEP 1900' => ['Q3 1900'],
120			'BET OCT 1900 AND DEC 1900' => ['Q4 1900'],
121			];
122
123			private const DATE_PERIOD_SHORTCUTS = [
124			'FROM 1900 TO 1910' => ['1900~1910'],
125			'FROM 1900' => ['1900-'],
126			'TO 1910' => ['-1900'],
127			];
128
129			private const DMY_SHORTCUTS = [
130			'11 DEC 1913' => [
131			'11/12/1913',
132			'11-12-1913',
133			'11.12.1913',
134			],
135			'01 FEB 2003' => [
136			'01/02/03',
137			'01-02-03',
138			'01.02.03',
139			],
140			];
141
142			private const MDY_SHORTCUTS = [
143			'11 DEC 1913' => [
144			'12/11/1913',
145			'12-11-1913',
146			'12.11.1913',
147			],
148			'01 FEB 2003' => [
149			'02/01/03',
150			'02-01-03',
151			'02.01.03',
152			],
153			];
154
155			private const YMD_SHORTCUTS = [
156			'11 DEC 1913' => [
157			'11/12/1913',
158			'11-12-1913',
159			'11.12.1913',
160			],
161			'01 FEB 2003' => [
162			'03/02/01',
163			'03-02-01',
164			'03.02.01',
165			],
166			];
167
168			/**
169			* @param ServerRequestInterface $request
170			*
171			* @return ResponseInterface
172			*/
173			public function handle(ServerRequestInterface $request): ResponseInterface
174			{
175			$topic = $request->getAttribute('topic');
176
177			switch ($topic) {
178			case 'DATE':
179			switch ($this->dmyOrder()) {
180			case 'YMD':
181			$date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::YMD_SHORTCUTS);
182			break;
183			case 'MDY':
184			$date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::MDY_SHORTCUTS);
185			break;
186			case 'DMY':
187			default:
188			$date_shortcuts = array_merge(self::DATE_SHORTCUTS, self::DMY_SHORTCUTS);
189			break;
190			}
191
192			$title = I18N::translate('Date');
193			$text = view('help/date', [
194			'date_dates' => $this->formatDates(array_keys($date_shortcuts)),
195			'date_shortcuts' => $date_shortcuts,
196			'date_period_dates' => $this->formatDates(array_keys(self::DATE_PERIOD_SHORTCUTS)),
197			'date_period_shortcuts' => self::DATE_PERIOD_SHORTCUTS,
198			'date_range_dates' => $this->formatDates(array_keys(self::DATE_RANGE_SHORTCUTS)),
199			'date_range_shortcuts' => self::DATE_RANGE_SHORTCUTS,
200			'french_dates' => $this->formatDates(self::FRENCH_DATES),
201			'hijri_dates' => $this->formatDates(self::HIJRI_DATES),
202			'jewish_dates' => $this->formatDates(self::JEWISH_DATES),
203			'julian_dates' => $this->formatDates(self::JULIAN_DATES),
204			]);
205			break;
206
207			case 'NAME':
208			$title = I18N::translate('Name');
209			$text = view('help/name');
210			break;
211
212			case 'SURN':
213			$title = I18N::translate('Surname');
214			$text = view('help/surname');
215			break;
216
217			case 'OBJE':
218			$title = I18N::translate('Media object');
219			$text = view('help/media-object');
220			break;
221
222			case 'PLAC':
223			$title = I18N::translate('Place');
224			$text = view('help/place');
225			break;
226
227			case 'RESN':
228			$title = I18N::translate('Restriction');
229			$text = view('help/restriction');
230			break;
231
232			case 'ROMN':
233			$title = I18N::translate('Romanized');
234			$text = view('help/romanized');
235			break;
236
237			case '_HEB':
238			$title = I18N::translate('Hebrew');
239			$text = view('help/hebrew');
240			break;
241
242			case 'edit_SOUR_EVEN':
243			$title = I18N::translate('Associate events with this source');
244			$text = view('help/source-events');
245			break;
246
247			case 'pending_changes':
248			$title = I18N::translate('Pending changes');
249			$text = view('help/pending-changes', [
250			'is_admin' => Auth::isAdmin(),
251			]);
252			break;
253
254			case 'relationship-privacy':
255			$title = I18N::translate('Restrict to immediate family');
256			$text = view('help/relationship-privacy');
257			break;
258
259			default:
260			$title = I18N::translate('Help');
261			$text = I18N::translate('The help text has not been written for this item.');
262			break;
263			}
264
265			$html = view('modals/help', [
266			'title' => $title,
267			'text' => $text,
268			]);
269
270			return response($html);
271			}
272
273			/**
274			* Format GEDCOM dates in the local language.
275			*
276			* @param string[] $gedcom_dates
277			*
278			* @return string[]
279			*/
280			private function formatDates(array $gedcom_dates): array
281			{
282			$dates = [];
283
284			foreach ($gedcom_dates as $gedcom_date) {
285			// PHP converts numeric array keys ('1900') to integers (1900), so reverse this.
286			$gedcom_date = (string) $gedcom_date;
287
288			$date = new Date($gedcom_date);
289			$dates[$gedcom_date] = strip_tags($date->display(false, null, false));
290			}
291
292			return $dates;
293			}
294
295			/**
296			* Does the current language use DMY, MDY or YMD for numeric date.
297			*
298			* @return string
299			*/
300			private function dmyOrder(): string
301			{
302			return preg_replace('/[^DMY]/', '', str_replace(['J', 'F',], ['D', 'M',], I18N::dateFormat()));
303			}
304			}
305

fisharebest / webtrees

Push — master ( 258cb0...d72b28 )

HelpText::formatDates() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like