Browse Source

feat(appframework): ⌚ Make ITimeFactory extend \PSR\Clock\ClockInterface

Signed-off-by: Joas Schilling <coding@schilljs.com>
tags/v27.0.0beta1
Joas Schilling 1 year ago
parent
commit
c297f8ee96
No account linked to committer's email address

+ 25
- 1
lib/private/AppFramework/Utility/TimeFactory.php View File

@@ -3,6 +3,7 @@
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>
@@ -30,11 +31,23 @@ namespace OC\AppFramework\Utility;
use OCP\AppFramework\Utility\ITimeFactory;

/**
* Needed to mock calls to time()
* Use this to get a timestamp or DateTime object in code to remain testable
*
* @since 8.0.0
* @since 26.0.0 Extends the \Psr\Clock\ClockInterface interface
* @ref https://www.php-fig.org/psr/psr-20/#21-clockinterface
*/
class TimeFactory implements ITimeFactory {
protected \DateTimeZone $timezone;

public function __construct() {
$this->timezone = new \DateTimeZone('UTC');
}

/**
* @return int the result of a call to time()
* @since 8.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getTime(): int {
return time();
@@ -45,8 +58,19 @@ class TimeFactory implements ITimeFactory {
* @param \DateTimeZone $timezone
* @return \DateTime
* @since 15.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime {
return new \DateTime($time, $timezone);
}

public function now(): \DateTimeImmutable {
return new \DateTimeImmutable('now', $this->timezone);
}
public function withTimeZone(\DateTimeZone $timezone): static {
$clone = clone $this;
$clone->timezone = $timezone;

return $clone;
}
}

+ 1
- 0
lib/private/Server.php View File

@@ -1387,6 +1387,7 @@ class Server extends ServerContainer implements IServerContainer {
$this->registerDeprecatedAlias('ControllerMethodReflector', \OCP\AppFramework\Utility\IControllerMethodReflector::class);

$this->registerAlias(\OCP\AppFramework\Utility\ITimeFactory::class, \OC\AppFramework\Utility\TimeFactory::class);
$this->registerAlias(\Psr\Clock\ClockInterface::class, \OCP\AppFramework\Utility\ITimeFactory::class);
/** @deprecated 19.0.0 */
$this->registerDeprecatedAlias('TimeFactory', \OCP\AppFramework\Utility\ITimeFactory::class);


+ 19
- 3
lib/public/AppFramework/Utility/ITimeFactory.php View File

@@ -3,6 +3,7 @@
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>
@@ -26,22 +27,37 @@ declare(strict_types=1);
*/
namespace OCP\AppFramework\Utility;

use Psr\Clock\ClockInterface;

/**
* Needed to mock calls to time()
* Use this to get a timestamp or DateTime object in code to remain testable
*
* @since 8.0.0
* @since 26.0.0 Extends the \Psr\Clock\ClockInterface interface
* @ref https://www.php-fig.org/psr/psr-20/#21-clockinterface
*/
interface ITimeFactory {

interface ITimeFactory extends ClockInterface {
/**
* @return int the result of a call to time()
* @since 8.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getTime(): int;

/**
* @param string $time
* @param \DateTimeZone $timezone
* @param \DateTimeZone|null $timezone
* @return \DateTime
* @since 15.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
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;
}

+ 49
- 0
tests/lib/AppFramework/Utility/TimeFactoryTest.php View File

@@ -0,0 +1,49 @@
<?php

declare(strict_types=1);

/**
* @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com>
*
* @author Joas Schilling <coding@schilljs.com>
*
* @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 Test\AppFramework\Utility;

use OC\AppFramework\Utility\TimeFactory;

class TimeFactoryTest extends \Test\TestCase {
protected TimeFactory $timeFactory;

protected function setUp(): void {
$this->timeFactory = new TimeFactory();
}

public function testNow(): void {
$now = $this->timeFactory->now();
self::assertSame('UTC', $now->getTimezone()->getName());
}

public function testNowWithTimeZone(): void {
$timezone = new \DateTimeZone('Europe/Berlin');
$withTimeZone = $this->timeFactory->withTimeZone($timezone);

$now = $withTimeZone->now();
self::assertSame('Europe/Berlin', $now->getTimezone()->getName());
}
}

Loading…
Cancel
Save