94 lines
2.3 KiB
PHP
94 lines
2.3 KiB
PHP
<?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);
|
|
}
|
|
}
|