<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com>
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Bernhard Posselt <dev@bernhard-posselt.com>
 * @author Joas Schilling <coding@schilljs.com>
 * @author Morris Jobke <hey@morrisjobke.de>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program. If not, see <http://www.gnu.org/licenses/>
 *
 */
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;
}