Upstream briannesbitt/Carbon state of the touched files before 56c9340e26
This commit is contained in:
commit
06596ca5df
2 files changed
+434
No files matched your search
@@ -0,0 +1,226 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of the Carbon package.
|
||||
*
|
||||
* (c) Brian Nesbitt <brian@nesbot.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Carbon\Traits;
|
||||
|
||||
use Carbon\CarbonInterface;
|
||||
use Carbon\Exceptions\UnknownUnitException;
|
||||
use Carbon\WeekDay;
|
||||
use DateInterval;
|
||||
|
||||
/**
|
||||
* Trait Rounding.
|
||||
*
|
||||
* Round, ceil, floor units.
|
||||
*
|
||||
* Depends on the following methods:
|
||||
*
|
||||
* @method static copy()
|
||||
* @method static startOfWeek(int $weekStartsAt = null)
|
||||
*/
|
||||
trait Rounding
|
||||
{
|
||||
use IntervalRounding;
|
||||
|
||||
/**
|
||||
* Round the current instance at the given unit with given precision if specified and the given function.
|
||||
*/
|
||||
public function roundUnit(
|
||||
string $unit,
|
||||
DateInterval|string|float|int $precision = 1,
|
||||
callable|string $function = 'round',
|
||||
): static {
|
||||
$metaUnits = [
|
||||
// @call roundUnit
|
||||
'millennium' => [static::YEARS_PER_MILLENNIUM, 'year'],
|
||||
// @call roundUnit
|
||||
'century' => [static::YEARS_PER_CENTURY, 'year'],
|
||||
// @call roundUnit
|
||||
'decade' => [static::YEARS_PER_DECADE, 'year'],
|
||||
// @call roundUnit
|
||||
'quarter' => [static::MONTHS_PER_QUARTER, 'month'],
|
||||
// @call roundUnit
|
||||
'millisecond' => [1000, 'microsecond'],
|
||||
];
|
||||
$normalizedUnit = static::singularUnit($unit);
|
||||
$ranges = array_merge(static::getRangesByUnit($this->daysInMonth), [
|
||||
// @call roundUnit
|
||||
'microsecond' => [0, 999999],
|
||||
]);
|
||||
$factor = 1;
|
||||
|
||||
if ($normalizedUnit === 'week') {
|
||||
$normalizedUnit = 'day';
|
||||
$precision *= static::DAYS_PER_WEEK;
|
||||
}
|
||||
|
||||
if (isset($metaUnits[$normalizedUnit])) {
|
||||
[$factor, $normalizedUnit] = $metaUnits[$normalizedUnit];
|
||||
}
|
||||
|
||||
$precision *= $factor;
|
||||
|
||||
if (!isset($ranges[$normalizedUnit])) {
|
||||
throw new UnknownUnitException($unit);
|
||||
}
|
||||
|
||||
$found = false;
|
||||
$fraction = 0;
|
||||
$arguments = null;
|
||||
$initialValue = null;
|
||||
$factor = $this->year < 0 ? -1 : 1;
|
||||
$changes = [];
|
||||
$minimumInc = null;
|
||||
|
||||
foreach ($ranges as $unit => [$minimum, $maximum]) {
|
||||
if ($normalizedUnit === $unit) {
|
||||
$arguments = [$this->$unit, $minimum];
|
||||
$initialValue = $this->$unit;
|
||||
$fraction = $precision - floor($precision);
|
||||
$found = true;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($found) {
|
||||
$delta = $maximum + 1 - $minimum;
|
||||
$factor /= $delta;
|
||||
$fraction *= $delta;
|
||||
$inc = ($this->$unit - $minimum) * $factor;
|
||||
|
||||
if ($inc !== 0.0) {
|
||||
$minimumInc = $minimumInc ?? ($arguments[0] / pow(2, 52));
|
||||
|
||||
// If value is still the same when adding a non-zero increment/decrement,
|
||||
// it means precision got lost in the addition
|
||||
if (abs($inc) < $minimumInc) {
|
||||
$inc = $minimumInc * ($inc < 0 ? -1 : 1);
|
||||
}
|
||||
|
||||
// If greater than $precision, assume precision loss caused an overflow
|
||||
if ($function !== 'floor' || abs($arguments[0] + $inc - $initialValue) >= $precision) {
|
||||
$arguments[0] += $inc;
|
||||
}
|
||||
}
|
||||
|
||||
$changes[$unit] = round(
|
||||
$minimum + ($fraction ? $fraction * $function(($this->$unit - $minimum) / $fraction) : 0),
|
||||
);
|
||||
|
||||
// Cannot use modulo as it lose double precision
|
||||
while ($changes[$unit] >= $delta) {
|
||||
$changes[$unit] -= $delta;
|
||||
}
|
||||
|
||||
$fraction -= floor($fraction);
|
||||
}
|
||||
}
|
||||
|
||||
[$value, $minimum] = $arguments;
|
||||
$normalizedValue = floor($function(($value - $minimum) / $precision) * $precision + $minimum);
|
||||
|
||||
/** @var CarbonInterface $result */
|
||||
$result = $this;
|
||||
|
||||
foreach ($changes as $unit => $value) {
|
||||
$result = $result->$unit($value);
|
||||
}
|
||||
|
||||
return $result->$normalizedUnit($normalizedValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Truncate the current instance at the given unit with given precision if specified.
|
||||
*/
|
||||
public function floorUnit(string $unit, DateInterval|string|float|int $precision = 1): static
|
||||
{
|
||||
return $this->roundUnit($unit, $precision, 'floor');
|
||||
}
|
||||
|
||||
/**
|
||||
* Ceil the current instance at the given unit with given precision if specified.
|
||||
*/
|
||||
public function ceilUnit(string $unit, DateInterval|string|float|int $precision = 1): static
|
||||
{
|
||||
return $this->roundUnit($unit, $precision, 'ceil');
|
||||
}
|
||||
|
||||
/**
|
||||
* Round the current instance second with given precision if specified.
|
||||
*/
|
||||
public function round(DateInterval|string|float|int $precision = 1, callable|string $function = 'round'): static
|
||||
{
|
||||
return $this->roundWith($precision, $function);
|
||||
}
|
||||
|
||||
/**
|
||||
* Round the current instance second with given precision if specified.
|
||||
*/
|
||||
public function floor(DateInterval|string|float|int $precision = 1): static
|
||||
{
|
||||
return $this->round($precision, 'floor');
|
||||
}
|
||||
|
||||
/**
|
||||
* Ceil the current instance second with given precision if specified.
|
||||
*/
|
||||
public function ceil(DateInterval|string|float|int $precision = 1): static
|
||||
{
|
||||
return $this->round($precision, 'ceil');
|
||||
}
|
||||
|
||||
/**
|
||||
* Round the current instance week.
|
||||
*
|
||||
* @param WeekDay|int|null $weekStartsAt optional start allow you to specify the day of week to use to start the week
|
||||
*/
|
||||
public function roundWeek(WeekDay|int|null $weekStartsAt = null): static
|
||||
{
|
||||
return $this->closest(
|
||||
$this->avoidMutation()->floorWeek($weekStartsAt),
|
||||
$this->avoidMutation()->ceilWeek($weekStartsAt),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Truncate the current instance week.
|
||||
*
|
||||
* @param WeekDay|int|null $weekStartsAt optional start allow you to specify the day of week to use to start the week
|
||||
*/
|
||||
public function floorWeek(WeekDay|int|null $weekStartsAt = null): static
|
||||
{
|
||||
return $this->startOfWeek($weekStartsAt);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ceil the current instance week.
|
||||
*
|
||||
* @param WeekDay|int|null $weekStartsAt optional start allow you to specify the day of week to use to start the week
|
||||
*/
|
||||
public function ceilWeek(WeekDay|int|null $weekStartsAt = null): static
|
||||
{
|
||||
if ($this->isMutable()) {
|
||||
$startOfWeek = $this->avoidMutation()->startOfWeek($weekStartsAt);
|
||||
|
||||
return $startOfWeek != $this ?
|
||||
$this->startOfWeek($weekStartsAt)->addWeek() :
|
||||
$this;
|
||||
}
|
||||
|
||||
$startOfWeek = $this->startOfWeek($weekStartsAt);
|
||||
|
||||
return $startOfWeek != $this ?
|
||||
$startOfWeek->addWeek() :
|
||||
$this->avoidMutation();
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user