blob: cd63b94dee316b83884e6f1e9fb7853c38829ff4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\AppFramework\Utility;
use Psr\Clock\ClockInterface;
/**
* Use this to get a timestamp or DateTime object in code to remain testable
*
* @since 8.0.0
* @since 27.0.0 Extends the \Psr\Clock\ClockInterface interface
* @ref https://www.php-fig.org/psr/psr-20/#21-clockinterface
*/
interface ITimeFactory extends ClockInterface {
/**
* @return int the result of a call to time()
* @since 8.0.0
*/
public function getTime(): int;
/**
* @param string $time
* @param \DateTimeZone|null $timezone
* @return \DateTime
* @since 15.0.0
*/
public function getDateTime(string $time = 'now', ?\DateTimeZone $timezone = null): \DateTime;
/**
* @param \DateTimeZone $timezone
* @return static
* @since 26.0.0
*/
public function withTimeZone(\DateTimeZone $timezone): static;
/**
* @param string|null $timezone
* @return \DateTimeZone Requested timezone if provided, UTC otherwise
* @throws \Exception
* @since 29.0.0
*/
public function getTimeZone(?string $timezone = null): \DateTimeZone;
}
|