<?php /** * 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\Carbon; use Carbon\CarbonImmutable; use Carbon\CarbonInterface; use Closure; use DateTimeImmutable; use DateTimeInterface; trait IntervalStep { /** * Step to apply instead of a fixed interval to get the new date. * * @var Closure|null */ protected $step; /** * Get the dynamic step in use. * * @return Closure */ public function getStep(): ?Closure { return $this->step; } /** * Set a step to apply instead of a fixed interval to get the new date. * * Or pass null to switch to fixed interval. * * @param Closure|null $step */ public function setStep(?Closure $step): void { $this->step = $step; } /** * Take a date and apply either the step if set, or the current interval else. * * The interval/step is applied negatively (typically subtraction instead of addition) if $negated is true. * * @param DateTimeInterface $dateTime * @param bool $negated * * @return CarbonInterface */ public function convertDate(DateTimeInterface $dateTime, bool $negated = false): CarbonInterface { /** @var CarbonInterface $carbonDate */ $carbonDate = $dateTime instanceof CarbonInterface ? $dateTime : $this->resolveCarbon($dateTime); if ($this->step) { return $carbonDate->setDateTimeFrom(($this->step)($carbonDate->avoidMutation(), $negated)); } if ($negated) { return $carbonDate->rawSub($this); } return $carbonDate->rawAdd($this); } /** * Convert DateTimeImmutable instance to CarbonImmutable instance and DateTime instance to Carbon instance. * * @param DateTimeInterface $dateTime * * @return Carbon|CarbonImmutable */ private function resolveCarbon(DateTimeInterface $dateTime) { if ($dateTime instanceof DateTimeImmutable) { return CarbonImmutable::instance($dateTime); } return Carbon::instance($dateTime); } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Boundaries.php | File | 11.04 KB | 0644 |
|
Cast.php | File | 1.06 KB | 0644 |
|
Comparison.php | File | 34.63 KB | 0644 |
|
Converter.php | File | 14.84 KB | 0644 |
|
Creator.php | File | 30.37 KB | 0644 |
|
Date.php | File | 161.43 KB | 0644 |
|
DeprecatedProperties.php | File | 1.57 KB | 0644 |
|
Difference.php | File | 52.91 KB | 0644 |
|
IntervalRounding.php | File | 1.54 KB | 0644 |
|
IntervalStep.php | File | 2.29 KB | 0644 |
|
Localization.php | File | 28.59 KB | 0644 |
|
Macro.php | File | 3.02 KB | 0644 |
|
MagicParameter.php | File | 721 B | 0644 |
|
Mixin.php | File | 4.58 KB | 0644 |
|
Modifiers.php | File | 13.44 KB | 0644 |
|
Mutability.php | File | 1.3 KB | 0644 |
|
ObjectInitialisation.php | File | 422 B | 0644 |
|
Options.php | File | 12.78 KB | 0644 |
|
Rounding.php | File | 7.54 KB | 0644 |
|
Serialization.php | File | 8.29 KB | 0644 |
|
Test.php | File | 7.56 KB | 0644 |
|
Timestamp.php | File | 6.44 KB | 0644 |
|
ToStringFormat.php | File | 1.43 KB | 0644 |
|
Units.php | File | 11.89 KB | 0644 |
|
Week.php | File | 7.22 KB | 0644 |
|