xref: /webtrees/app/Contracts/TimestampFactoryInterface.php (revision 202c018b592d5a516e4a465dc6dc515f3be37399) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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
22/**
23 * Create a timestamp object.
24 */
25interface TimestampFactoryInterface
26{
27    /**
28     * @param int                $timestamp
29     * @param UserInterface|null $user
30     *
31     * @return TimestampInterface
32     */
33    public function make(int $timestamp, UserInterface|null $user = null): TimestampInterface;
34
35    /**
36     * @param string|null        $string YYYY-MM-DD HH:MM:SS (as provided by SQL).
37     * @param string             $format
38     * @param UserInterface|null $user
39     *
40     * @return TimestampInterface
41     */
42    public function fromString(string|null $string, string $format = 'Y-m-d H:i:s', UserInterface|null $user = null): TimestampInterface;
43
44    /**
45     * @param UserInterface|null $user
46     *
47     * @return TimestampInterface
48     */
49    public function now(UserInterface|null $user = null): TimestampInterface;
50}
51