Boundaries.php
2 months ago
Cast.php
2 months ago
Comparison.php
2 months ago
Converter.php
2 months ago
Creator.php
2 months ago
Date.php
2 months ago
DeprecatedProperties.php
2 months ago
Difference.php
2 months ago
IntervalRounding.php
2 months ago
IntervalStep.php
2 months ago
Localization.php
2 months ago
Macro.php
2 months ago
MagicParameter.php
2 months ago
Mixin.php
2 months ago
Modifiers.php
2 months ago
Mutability.php
2 months ago
ObjectInitialisation.php
2 months ago
Options.php
2 months ago
Rounding.php
2 months ago
Serialization.php
2 months ago
Test.php
2 months ago
Timestamp.php
2 months ago
ToStringFormat.php
2 months ago
Units.php
2 months ago
Week.php
2 months ago
Rounding.php
214 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This file is part of the Carbon package. |
| 5 | * |
| 6 | * (c) Brian Nesbitt <brian@nesbot.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace ProfilePressVendor\Carbon\Traits; |
| 12 | |
| 13 | use ProfilePressVendor\Carbon\CarbonInterface; |
| 14 | use ProfilePressVendor\Carbon\Exceptions\UnknownUnitException; |
| 15 | /** |
| 16 | * Trait Rounding. |
| 17 | * |
| 18 | * Round, ceil, floor units. |
| 19 | * |
| 20 | * Depends on the following methods: |
| 21 | * |
| 22 | * @method static copy() |
| 23 | * @method static startOfWeek(int $weekStartsAt = null) |
| 24 | */ |
| 25 | trait Rounding |
| 26 | { |
| 27 | use IntervalRounding; |
| 28 | /** |
| 29 | * Round the current instance at the given unit with given precision if specified and the given function. |
| 30 | * |
| 31 | * @param string $unit |
| 32 | * @param float|int $precision |
| 33 | * @param string $function |
| 34 | * |
| 35 | * @return CarbonInterface |
| 36 | */ |
| 37 | public function roundUnit($unit, $precision = 1, $function = 'round') |
| 38 | { |
| 39 | $metaUnits = [ |
| 40 | // @call roundUnit |
| 41 | 'millennium' => [static::YEARS_PER_MILLENNIUM, 'year'], |
| 42 | // @call roundUnit |
| 43 | 'century' => [static::YEARS_PER_CENTURY, 'year'], |
| 44 | // @call roundUnit |
| 45 | 'decade' => [static::YEARS_PER_DECADE, 'year'], |
| 46 | // @call roundUnit |
| 47 | 'quarter' => [static::MONTHS_PER_QUARTER, 'month'], |
| 48 | // @call roundUnit |
| 49 | 'millisecond' => [1000, 'microsecond'], |
| 50 | ]; |
| 51 | $normalizedUnit = static::singularUnit($unit); |
| 52 | $ranges = array_merge(static::getRangesByUnit($this->daysInMonth), [ |
| 53 | // @call roundUnit |
| 54 | 'microsecond' => [0, 999999], |
| 55 | ]); |
| 56 | $factor = 1; |
| 57 | if ($normalizedUnit === 'week') { |
| 58 | $normalizedUnit = 'day'; |
| 59 | $precision *= static::DAYS_PER_WEEK; |
| 60 | } |
| 61 | if (isset($metaUnits[$normalizedUnit])) { |
| 62 | [$factor, $normalizedUnit] = $metaUnits[$normalizedUnit]; |
| 63 | } |
| 64 | $precision *= $factor; |
| 65 | if (!isset($ranges[$normalizedUnit])) { |
| 66 | throw new UnknownUnitException($unit); |
| 67 | } |
| 68 | $found = \false; |
| 69 | $fraction = 0; |
| 70 | $arguments = null; |
| 71 | $initialValue = null; |
| 72 | $factor = $this->year < 0 ? -1 : 1; |
| 73 | $changes = []; |
| 74 | $minimumInc = null; |
| 75 | foreach ($ranges as $unit => [$minimum, $maximum]) { |
| 76 | if ($normalizedUnit === $unit) { |
| 77 | $arguments = [$this->{$unit}, $minimum]; |
| 78 | $initialValue = $this->{$unit}; |
| 79 | $fraction = $precision - floor($precision); |
| 80 | $found = \true; |
| 81 | continue; |
| 82 | } |
| 83 | if ($found) { |
| 84 | $delta = $maximum + 1 - $minimum; |
| 85 | $factor /= $delta; |
| 86 | $fraction *= $delta; |
| 87 | $inc = ($this->{$unit} - $minimum) * $factor; |
| 88 | if ($inc !== 0.0) { |
| 89 | $minimumInc = $minimumInc ?? $arguments[0] / pow(2, 52); |
| 90 | // If value is still the same when adding a non-zero increment/decrement, |
| 91 | // it means precision got lost in the addition |
| 92 | if (abs($inc) < $minimumInc) { |
| 93 | $inc = $minimumInc * ($inc < 0 ? -1 : 1); |
| 94 | } |
| 95 | // If greater than $precision, assume precision loss caused an overflow |
| 96 | if ($function !== 'floor' || abs($arguments[0] + $inc - $initialValue) >= $precision) { |
| 97 | $arguments[0] += $inc; |
| 98 | } |
| 99 | } |
| 100 | $changes[$unit] = round($minimum + ($fraction ? $fraction * $function(($this->{$unit} - $minimum) / $fraction) : 0)); |
| 101 | // Cannot use modulo as it lose double precision |
| 102 | while ($changes[$unit] >= $delta) { |
| 103 | $changes[$unit] -= $delta; |
| 104 | } |
| 105 | $fraction -= floor($fraction); |
| 106 | } |
| 107 | } |
| 108 | [$value, $minimum] = $arguments; |
| 109 | $normalizedValue = floor($function(($value - $minimum) / $precision) * $precision + $minimum); |
| 110 | /** @var CarbonInterface $result */ |
| 111 | $result = $this; |
| 112 | foreach ($changes as $unit => $value) { |
| 113 | $result = $result->{$unit}($value); |
| 114 | } |
| 115 | return $result->{$normalizedUnit}($normalizedValue); |
| 116 | } |
| 117 | /** |
| 118 | * Truncate the current instance at the given unit with given precision if specified. |
| 119 | * |
| 120 | * @param string $unit |
| 121 | * @param float|int $precision |
| 122 | * |
| 123 | * @return CarbonInterface |
| 124 | */ |
| 125 | public function floorUnit($unit, $precision = 1) |
| 126 | { |
| 127 | return $this->roundUnit($unit, $precision, 'floor'); |
| 128 | } |
| 129 | /** |
| 130 | * Ceil the current instance at the given unit with given precision if specified. |
| 131 | * |
| 132 | * @param string $unit |
| 133 | * @param float|int $precision |
| 134 | * |
| 135 | * @return CarbonInterface |
| 136 | */ |
| 137 | public function ceilUnit($unit, $precision = 1) |
| 138 | { |
| 139 | return $this->roundUnit($unit, $precision, 'ceil'); |
| 140 | } |
| 141 | /** |
| 142 | * Round the current instance second with given precision if specified. |
| 143 | * |
| 144 | * @param float|int|string|\DateInterval|null $precision |
| 145 | * @param string $function |
| 146 | * |
| 147 | * @return CarbonInterface |
| 148 | */ |
| 149 | public function round($precision = 1, $function = 'round') |
| 150 | { |
| 151 | return $this->roundWith($precision, $function); |
| 152 | } |
| 153 | /** |
| 154 | * Round the current instance second with given precision if specified. |
| 155 | * |
| 156 | * @param float|int|string|\DateInterval|null $precision |
| 157 | * |
| 158 | * @return CarbonInterface |
| 159 | */ |
| 160 | public function floor($precision = 1) |
| 161 | { |
| 162 | return $this->round($precision, 'floor'); |
| 163 | } |
| 164 | /** |
| 165 | * Ceil the current instance second with given precision if specified. |
| 166 | * |
| 167 | * @param float|int|string|\DateInterval|null $precision |
| 168 | * |
| 169 | * @return CarbonInterface |
| 170 | */ |
| 171 | public function ceil($precision = 1) |
| 172 | { |
| 173 | return $this->round($precision, 'ceil'); |
| 174 | } |
| 175 | /** |
| 176 | * Round the current instance week. |
| 177 | * |
| 178 | * @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week |
| 179 | * |
| 180 | * @return CarbonInterface |
| 181 | */ |
| 182 | public function roundWeek($weekStartsAt = null) |
| 183 | { |
| 184 | return $this->closest($this->avoidMutation()->floorWeek($weekStartsAt), $this->avoidMutation()->ceilWeek($weekStartsAt)); |
| 185 | } |
| 186 | /** |
| 187 | * Truncate the current instance week. |
| 188 | * |
| 189 | * @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week |
| 190 | * |
| 191 | * @return CarbonInterface |
| 192 | */ |
| 193 | public function floorWeek($weekStartsAt = null) |
| 194 | { |
| 195 | return $this->startOfWeek($weekStartsAt); |
| 196 | } |
| 197 | /** |
| 198 | * Ceil the current instance week. |
| 199 | * |
| 200 | * @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week |
| 201 | * |
| 202 | * @return CarbonInterface |
| 203 | */ |
| 204 | public function ceilWeek($weekStartsAt = null) |
| 205 | { |
| 206 | if ($this->isMutable()) { |
| 207 | $startOfWeek = $this->avoidMutation()->startOfWeek($weekStartsAt); |
| 208 | return $startOfWeek != $this ? $this->startOfWeek($weekStartsAt)->addWeek() : $this; |
| 209 | } |
| 210 | $startOfWeek = $this->startOfWeek($weekStartsAt); |
| 211 | return $startOfWeek != $this ? $startOfWeek->addWeek() : $this->avoidMutation(); |
| 212 | } |
| 213 | } |
| 214 |