xref: /webtrees/app/Contracts/CalendarDateFactoryInterface.php (revision 4ff0652c9f716485ce1866f88c40897142051b8b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Contracts;
21
22use Fisharebest\Webtrees\Date\AbstractCalendarDate;
23
24/**
25 * Create a calendar date object.
26 */
27interface CalendarDateFactoryInterface
28{
29    /**
30     * Parse a string containing a calendar date.
31     *
32     * @param string $date
33     *
34     * @return AbstractCalendarDate
35     */
36    public function make(string $date): AbstractCalendarDate;
37
38    /**
39     * A list of supported calendars and their names.
40     *
41     * @return array<string,string>
42     */
43    public function supportedCalendars(): array;
44}
45