xref: /webtrees/app/Contracts/CalendarDateFactoryInterface.php (revision d11be7027e34e3121be11cc025421873364403f9)
1f882f05dSGreg Roach<?php
2f882f05dSGreg Roach
3f882f05dSGreg Roach/**
4f882f05dSGreg Roach * webtrees: online genealogy
5*d11be702SGreg Roach * Copyright (C) 2023 webtrees development team
6f882f05dSGreg Roach * This program is free software: you can redistribute it and/or modify
7f882f05dSGreg Roach * it under the terms of the GNU General Public License as published by
8f882f05dSGreg Roach * the Free Software Foundation, either version 3 of the License, or
9f882f05dSGreg Roach * (at your option) any later version.
10f882f05dSGreg Roach * This program is distributed in the hope that it will be useful,
11f882f05dSGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12f882f05dSGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13f882f05dSGreg Roach * GNU General Public License for more details.
14f882f05dSGreg Roach * You should have received a copy of the GNU General Public License
15f882f05dSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16f882f05dSGreg Roach */
17f882f05dSGreg Roach
18f882f05dSGreg Roachdeclare(strict_types=1);
19f882f05dSGreg Roach
20f882f05dSGreg Roachnamespace Fisharebest\Webtrees\Contracts;
21f882f05dSGreg Roach
22f882f05dSGreg Roachuse Fisharebest\Webtrees\Date\AbstractCalendarDate;
23f882f05dSGreg Roach
24f882f05dSGreg Roach/**
25f882f05dSGreg Roach * Create a calendar date object.
26f882f05dSGreg Roach */
27f882f05dSGreg Roachinterface CalendarDateFactoryInterface
28f882f05dSGreg Roach{
29f882f05dSGreg Roach    /**
30f882f05dSGreg Roach     * Parse a string containing a calendar date.
31f882f05dSGreg Roach     *
32f882f05dSGreg Roach     * @param string $date
33f882f05dSGreg Roach     *
34f3b2e323SGreg Roach     * @return AbstractCalendarDate
35f882f05dSGreg Roach     */
36f3b2e323SGreg Roach    public function make(string $date): AbstractCalendarDate;
37f882f05dSGreg Roach
38f882f05dSGreg Roach    /**
39f882f05dSGreg Roach     * A list of supported calendars and their names.
40f882f05dSGreg Roach     *
41f882f05dSGreg Roach     * @return array<string,string>
42f882f05dSGreg Roach     */
43f882f05dSGreg Roach    public function supportedCalendars(): array;
44f882f05dSGreg Roach}
45