Skip to content

Commit

Permalink
Refactor Timestamp to avoid mistakes (#4924)
Browse files Browse the repository at this point in the history 
Fixes #4923

By implementing Carbon helper methods, we avoid some of the copypasta found in v2.1.0.
  • Loading branch information
@miqrogroove
miqrogroove authored Dec 30, 2023
1 parent f260889 commit 7796152
Showing 1 changed file with 29 additions and 62 deletions.
91 changes: 29 additions & 62 deletions app/Timestamp.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
namespace Fisharebest\Webtrees;

use Carbon\Carbon;
use DateInterval;
use Fisharebest\Webtrees\Contracts\TimestampInterface;

/**
Expand Down Expand Up @@ -120,13 +119,9 @@ public function compare(TimestampInterface $datetime): int
*/
public function addSeconds(int $seconds): TimestampInterface
{
if ($seconds < 0) {
return $this->subtractSeconds(-$seconds);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('PT' . $seconds . 'S'));
$clone->carbon->addSeconds($seconds);

return $clone;
}
Expand All @@ -138,13 +133,9 @@ public function addSeconds(int $seconds): TimestampInterface
*/
public function addMinutes(int $minutes): TimestampInterface
{
if ($minutes < 0) {
return $this->subtractMinutes(-$minutes);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('PT' . $minutes . 'M'));
$clone->carbon->addMinutes($minutes);

return $this;
}
Expand All @@ -156,13 +147,9 @@ public function addMinutes(int $minutes): TimestampInterface
*/
public function addHours(int $hours): TimestampInterface
{
if ($hours < 0) {
return $this->subtractHours(-$hours);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('PT' . $hours . 'H'));
$clone->carbon->addHours($hours);

return $clone;
}
Expand All @@ -174,49 +161,45 @@ public function addHours(int $hours): TimestampInterface
*/
public function addDays(int $days): TimestampInterface
{
if ($days < 0) {
return $this->subtractHours(-$days);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('P' . $days . 'D'));
$clone->carbon->addDays($days);

return $clone;
}

/**
* Add to the month portion of the date.
*
* Allows overflow, consistent with v2.1.0 ... 2023-10-31 plus 1 month = 2023-12-01.
*
* @param int $months
*
* @return self
*/
public function addMonths(int $months): TimestampInterface
{
if ($months < 0) {
return $this->subtractMonths(-$months);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('P' . $months . 'M'));
$clone->carbon->addMonths($months);

return $clone;
}

/**
* Add to the year portion of the date.
*
* Allows overflow, consistent with v2.1.0 ... 2024-02-29 plus 1 year = 2025-03-01.
*
* @param int $years
*
* @return self
*/
public function addYears(int $years): TimestampInterface
{
if ($years < 0) {
return $this->subtractYears(-$years);
}

$clone = clone($this);

$clone->carbon->add(new DateInterval('P' . $years . 'Y'));
$clone->carbon->addYears($years);

return $clone;
}
Expand All @@ -228,13 +211,9 @@ public function addYears(int $years): TimestampInterface
*/
public function subtractSeconds(int $seconds): TimestampInterface
{
if ($seconds < 0) {
return $this->addSeconds(-$seconds);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('PT' . $seconds . 'S'));
$clone->carbon->subSeconds($seconds);

return $clone;
}
Expand All @@ -246,15 +225,11 @@ public function subtractSeconds(int $seconds): TimestampInterface
*/
public function subtractMinutes(int $minutes): TimestampInterface
{
if ($minutes < 0) {
return $this->addMinutes(-$minutes);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('PT' . $minutes . 'M'));
$clone->carbon->subMinutes($minutes);

return $clone;
return $this;
}

/**
Expand All @@ -264,13 +239,9 @@ public function subtractMinutes(int $minutes): TimestampInterface
*/
public function subtractHours(int $hours): TimestampInterface
{
if ($hours < 0) {
return $this->addHours(-$hours);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('PT' . $hours . 'H'));
$clone->carbon->subHours($hours);

return $clone;
}
Expand All @@ -282,49 +253,45 @@ public function subtractHours(int $hours): TimestampInterface
*/
public function subtractDays(int $days): TimestampInterface
{
if ($days < 0) {
return $this->addDays(-$days);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('P' . $days . 'D'));
$clone->carbon->subDays($days);

return $clone;
}

/**
* Subtract from the month portion of the date.
*
* Allows overflow, consistent with v2.1.0 ... 2023-10-31 minus 1 month = 2023-10-01.
*
* @param int $months
*
* @return self
*/
public function subtractMonths(int $months): TimestampInterface
{
if ($months < 0) {
return $this->addMonths(-$months);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('P' . $months . 'M'));
$clone->carbon->subMonths($months);

return $clone;
}

/**
* Subtract from the year portion of the date.
*
* Allows overflow, consistent with v2.1.0 ... 2024-02-29 minus 1 year = 2023-03-01.
*
* @param int $years
*
* @return self
*/
public function subtractYears(int $years): TimestampInterface
{
if ($years < 0) {
return $this->addYears(-$years);
}

$clone = clone($this);

$clone->carbon->sub(new DateInterval('P' . $years . 'Y'));
$clone->carbon->subYears($years);

return $clone;
}
Expand Down

0 comments on commit 7796152

Please sign in to comment.