Ngiler SH3LL 360
Home
Information
Create File
Create Folder
:
/
home
/
tbf
/
tbf.ro
/
vendor
/
nesbot
/
carbon
/
src
/
Carbon
/
Information Server
MySQL :
OFF
Perl :
OFF
CURL :
ON
WGET :
OFF
PKEXEC :
OFF
Directive
Local Value
IP Address
89.40.16.97
System
Linux server.atelieruldeit.ro 3.10.0-1160.el7.x86_64 #1 SMP Mon Oct 19 16:18:59 UTC 2020 x86_64
User
tbf
PHP Version
7.3.33
Software
Apache
Doc root
Writable
close
Edit File :
Carbon.php
| Size :
142.77
KB
Copy
<?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; use Carbon\Exceptions\InvalidDateException; use Closure; use DateInterval; use DatePeriod; use DateTime; use DateTimeInterface; use DateTimeZone; use InvalidArgumentException; use JsonSerializable; use Symfony\Component\Translation\TranslatorInterface; /** * A simple API extension for DateTime * * @property int $year * @property int $yearIso * @property int $month * @property int $day * @property int $hour * @property int $minute * @property int $second * @property int $timestamp seconds since the Unix Epoch * @property \DateTimeZone $timezone the current timezone * @property \DateTimeZone $tz alias of timezone * @property-read int $micro * @property-read int $dayOfWeek 0 (for Sunday) through 6 (for Saturday) * @property-read int $dayOfWeekIso 1 (for Monday) through 7 (for Sunday) * @property-read int $dayOfYear 0 through 365 * @property-read int $weekOfMonth 1 through 5 * @property-read int $weekNumberInMonth 1 through 5 * @property-read int $weekOfYear ISO-8601 week number of year, weeks starting on Monday * @property-read int $daysInMonth number of days in the given month * @property-read int $age does a diffInYears() with default parameters * @property-read int $quarter the quarter of this instance, 1 - 4 * @property-read int $offset the timezone offset in seconds from UTC * @property-read int $offsetHours the timezone offset in hours from UTC * @property-read bool $dst daylight savings time indicator, true if DST, false otherwise * @property-read bool $local checks if the timezone is local, true if local, false otherwise * @property-read bool $utc checks if the timezone is UTC, true if UTC, false otherwise * @property-read string $timezoneName * @property-read string $tzName * @property-read string $englishDayOfWeek the day of week in English * @property-read string $shortEnglishDayOfWeek the abbreviated day of week in English * @property-read string $englishMonth the day of week in English * @property-read string $shortEnglishMonth the abbreviated day of week in English * @property-read string $localeDayOfWeek the day of week in current locale LC_TIME * @property-read string $shortLocaleDayOfWeek the abbreviated day of week in current locale LC_TIME * @property-read string $localeMonth the month in current locale LC_TIME * @property-read string $shortLocaleMonth the abbreviated month in current locale LC_TIME */ class Carbon extends DateTime implements JsonSerializable { const NO_ZERO_DIFF = 01; const JUST_NOW = 02; const ONE_DAY_WORDS = 04; const TWO_DAY_WORDS = 010; // Substitutes for Carbon 2 modes const DIFF_RELATIVE_TO_NOW = 'relative-to-now'; const DIFF_RELATIVE_TO_OTHER = 'relative-to-other'; /** * The day constants. */ const SUNDAY = 0; const MONDAY = 1; const TUESDAY = 2; const WEDNESDAY = 3; const THURSDAY = 4; const FRIDAY = 5; const SATURDAY = 6; /** * Names of days of the week. * * @var array */ protected static $days = array( self::SUNDAY => 'Sunday', self::MONDAY => 'Monday', self::TUESDAY => 'Tuesday', self::WEDNESDAY => 'Wednesday', self::THURSDAY => 'Thursday', self::FRIDAY => 'Friday', self::SATURDAY => 'Saturday', ); /** * Number of X in Y. */ const YEARS_PER_MILLENNIUM = 1000; const YEARS_PER_CENTURY = 100; const YEARS_PER_DECADE = 10; const MONTHS_PER_YEAR = 12; const MONTHS_PER_QUARTER = 3; const WEEKS_PER_YEAR = 52; const WEEKS_PER_MONTH = 4; const DAYS_PER_WEEK = 7; const HOURS_PER_DAY = 24; const MINUTES_PER_HOUR = 60; const SECONDS_PER_MINUTE = 60; const MICROSECONDS_PER_MILLISECOND = 1000; const MICROSECONDS_PER_SECOND = 1000000; /** * RFC7231 DateTime format. * * @var string */ const RFC7231_FORMAT = 'D, d M Y H:i:s \G\M\T'; /** * Default format to use for __toString method when type juggling occurs. * * @var string */ const DEFAULT_TO_STRING_FORMAT = 'Y-m-d H:i:s'; /** * Format for converting mocked time, includes microseconds. * * @var string */ const MOCK_DATETIME_FORMAT = 'Y-m-d H:i:s.u'; /** * Customizable PHP_INT_SIZE override. * * @var int */ public static $PHPIntSize = PHP_INT_SIZE; /** * Format to use for __toString method when type juggling occurs. * * @var string */ protected static $toStringFormat = self::DEFAULT_TO_STRING_FORMAT; /** * First day of week. * * @var int */ protected static $weekStartsAt = self::MONDAY; /** * Last day of week. * * @var int */ protected static $weekEndsAt = self::SUNDAY; /** * Days of weekend. * * @var array */ protected static $weekendDays = array( self::SATURDAY, self::SUNDAY, ); /** * Midday/noon hour. * * @var int */ protected static $midDayAt = 12; /** * Format regex patterns. * * @var array */ protected static $regexFormats = array( 'd' => '(3[01]|[12][0-9]|0[1-9])', 'D' => '([a-zA-Z]{3})', 'j' => '([123][0-9]|[1-9])', 'l' => '([a-zA-Z]{2,})', 'N' => '([1-7])', 'S' => '([a-zA-Z]{2})', 'w' => '([0-6])', 'z' => '(36[0-5]|3[0-5][0-9]|[12][0-9]{2}|[1-9]?[0-9])', 'W' => '(5[012]|[1-4][0-9]|[1-9])', 'F' => '([a-zA-Z]{2,})', 'm' => '(1[012]|0[1-9])', 'M' => '([a-zA-Z]{3})', 'n' => '(1[012]|[1-9])', 't' => '(2[89]|3[01])', 'L' => '(0|1)', 'o' => '([1-9][0-9]{0,4})', 'Y' => '([1-9]?[0-9]{4})', 'y' => '([0-9]{2})', 'a' => '(am|pm)', 'A' => '(AM|PM)', 'B' => '([0-9]{3})', 'g' => '(1[012]|[1-9])', 'G' => '(2[0-3]|1?[0-9])', 'h' => '(1[012]|0[1-9])', 'H' => '(2[0-3]|[01][0-9])', 'i' => '([0-5][0-9])', 's' => '([0-5][0-9])', 'u' => '([0-9]{1,6})', 'v' => '([0-9]{1,3})', 'e' => '([a-zA-Z]{1,5})|([a-zA-Z]*\/[a-zA-Z]*)', 'I' => '(0|1)', 'O' => '([\+\-](1[012]|0[0-9])[0134][05])', 'P' => '([\+\-](1[012]|0[0-9]):[0134][05])', 'T' => '([a-zA-Z]{1,5})', 'Z' => '(-?[1-5]?[0-9]{1,4})', 'U' => '([0-9]*)', // The formats below are combinations of the above formats. 'c' => '(([1-9]?[0-9]{4})\-(1[012]|0[1-9])\-(3[01]|[12][0-9]|0[1-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])[\+\-](1[012]|0[0-9]):([0134][05]))', // Y-m-dTH:i:sP 'r' => '(([a-zA-Z]{3}), ([123][0-9]|[1-9]) ([a-zA-Z]{3}) ([1-9]?[0-9]{4}) (2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9]) [\+\-](1[012]|0[0-9])([0134][05]))', // D, j M Y H:i:s O ); /** * A test Carbon instance to be returned when now instances are created. * * @var \Carbon\Carbon */ protected static $testNow; /** * A translator to ... er ... translate stuff. * * @var \Symfony\Component\Translation\TranslatorInterface */ protected static $translator; /** * The errors that can occur. * * @var array */ protected static $lastErrors; /** * The custom Carbon JSON serializer. * * @var callable|null */ protected static $serializer; /** * The registered string macros. * * @var array */ protected static $localMacros = array(); /** * Will UTF8 encoding be used to print localized date/time ? * * @var bool */ protected static $utf8 = false; /** * Add microseconds to now on PHP < 7.1 and 7.1.3. true by default. * * @var bool */ protected static $microsecondsFallback = true; /** * Indicates if months should be calculated with overflow. * * @var bool */ protected static $monthsOverflow = true; /** * Indicates if years should be calculated with overflow. * * @var bool */ protected static $yearsOverflow = true; /** * Indicates if years are compared with month by default so isSameMonth and isSameQuarter have $ofSameYear set * to true by default. * * @var bool */ protected static $compareYearWithMonth = false; /** * Options for diffForHumans(). * * @var int */ protected static $humanDiffOptions = self::NO_ZERO_DIFF; /** * @param int $humanDiffOptions */ public static function setHumanDiffOptions($humanDiffOptions) { static::$humanDiffOptions = $humanDiffOptions; } /** * @param int $humanDiffOption */ public static function enableHumanDiffOption($humanDiffOption) { static::$humanDiffOptions = static::getHumanDiffOptions() | $humanDiffOption; } /** * @param int $humanDiffOption */ public static function disableHumanDiffOption($humanDiffOption) { static::$humanDiffOptions = static::getHumanDiffOptions() & ~$humanDiffOption; } /** * @return int */ public static function getHumanDiffOptions() { return static::$humanDiffOptions; } /** * Add microseconds to now on PHP < 7.1 and 7.1.3 if set to true, * let microseconds to 0 on those PHP versions if false. * * @param bool $microsecondsFallback */ public static function useMicrosecondsFallback($microsecondsFallback = true) { static::$microsecondsFallback = $microsecondsFallback; } /** * Return true if microseconds fallback on PHP < 7.1 and 7.1.3 is * enabled. false if disabled. * * @return bool */ public static function isMicrosecondsFallbackEnabled() { return static::$microsecondsFallback; } /** * Indicates if months should be calculated with overflow. * * @param bool $monthsOverflow * * @return void */ public static function useMonthsOverflow($monthsOverflow = true) { static::$monthsOverflow = $monthsOverflow; } /** * Reset the month overflow behavior. * * @return void */ public static function resetMonthsOverflow() { static::$monthsOverflow = true; } /** * Get the month overflow behavior. * * @return bool */ public static function shouldOverflowMonths() { return static::$monthsOverflow; } /** * Indicates if years should be calculated with overflow. * * @param bool $yearsOverflow * * @return void */ public static function useYearsOverflow($yearsOverflow = true) { static::$yearsOverflow = $yearsOverflow; } /** * Reset the month overflow behavior. * * @return void */ public static function resetYearsOverflow() { static::$yearsOverflow = true; } /** * Get the month overflow behavior. * * @return bool */ public static function shouldOverflowYears() { return static::$yearsOverflow; } /** * Get the month comparison default behavior. * * @return bool */ public static function compareYearWithMonth($compareYearWithMonth = true) { static::$compareYearWithMonth = $compareYearWithMonth; } /** * Get the month comparison default behavior. * * @return bool */ public static function shouldCompareYearWithMonth() { return static::$compareYearWithMonth; } /** * Creates a DateTimeZone from a string, DateTimeZone or integer offset. * * @param \DateTimeZone|string|int|null $object * * @throws \InvalidArgumentException * * @return \DateTimeZone */ protected static function safeCreateDateTimeZone($object) { if ($object === null) { // Don't return null... avoid Bug #52063 in PHP <5.3.6 return new DateTimeZone(date_default_timezone_get()); } if ($object instanceof DateTimeZone) { return $object; } if (is_numeric($object)) { $tzName = timezone_name_from_abbr(null, $object * 3600, true); if ($tzName === false) { throw new InvalidArgumentException('Unknown or bad timezone ('.$object.')'); } $object = $tzName; } $tz = @timezone_open($object = (string) $object); if ($tz !== false) { return $tz; } // Work-around for a bug fixed in PHP 5.5.10 https://bugs.php.net/bug.php?id=45528 // See: https://stackoverflow.com/q/14068594/2646927 // @codeCoverageIgnoreStart if (strpos($object, ':') !== false) { try { return static::createFromFormat('O', $object)->getTimezone(); } catch (InvalidArgumentException $e) { // } } // @codeCoverageIgnoreEnd throw new InvalidArgumentException('Unknown or bad timezone ('.$object.')'); } /////////////////////////////////////////////////////////////////// //////////////////////////// CONSTRUCTORS ///////////////////////// /////////////////////////////////////////////////////////////////// /** * Create a new Carbon instance. * * Please see the testing aids section (specifically static::setTestNow()) * for more on the possibility of this constructor returning a test instance. * * @param string|null $time * @param \DateTimeZone|string|null $tz */ public function __construct($time = null, $tz = null) { // If the class has a test now set and we are trying to create a now() // instance then override as required $isNow = empty($time) || $time === 'now'; if (static::hasTestNow() && ($isNow || static::hasRelativeKeywords($time))) { $testInstance = clone static::getTestNow(); //shift the time according to the given time zone if ($tz !== null && $tz !== static::getTestNow()->getTimezone()) { $testInstance->setTimezone($tz); } else { $tz = $testInstance->getTimezone(); } if (static::hasRelativeKeywords($time)) { $testInstance->modify($time); } $time = $testInstance->format(static::MOCK_DATETIME_FORMAT); } $timezone = static::safeCreateDateTimeZone($tz); // @codeCoverageIgnoreStart if ($isNow && !isset($testInstance) && static::isMicrosecondsFallbackEnabled() && ( version_compare(PHP_VERSION, '7.1.0-dev', '<') || version_compare(PHP_VERSION, '7.1.3-dev', '>=') && version_compare(PHP_VERSION, '7.1.4-dev', '<') ) ) { // Get microseconds from microtime() if "now" asked and PHP < 7.1 and PHP 7.1.3 if fallback enabled. list($microTime, $timeStamp) = explode(' ', microtime()); $dateTime = new DateTime('now', $timezone); $dateTime->setTimestamp($timeStamp); // Use the timestamp returned by microtime as now can happen in the next second $time = $dateTime->format(static::DEFAULT_TO_STRING_FORMAT).substr($microTime, 1, 7); } // @codeCoverageIgnoreEnd // Work-around for PHP bug https://bugs.php.net/bug.php?id=67127 if (strpos((string) .1, '.') === false) { $locale = setlocale(LC_NUMERIC, '0'); setlocale(LC_NUMERIC, 'C'); } parent::__construct($time, $timezone); if (isset($locale)) { setlocale(LC_NUMERIC, $locale); } static::setLastErrors(parent::getLastErrors()); } /** * Create a Carbon instance from a DateTime one. * * @param \DateTime|\DateTimeInterface $date * * @return static */ public static function instance($date) { if ($date instanceof static) { return clone $date; } static::expectDateTime($date); return new static($date->format('Y-m-d H:i:s.u'), $date->getTimezone()); } /** * Create a carbon instance from a string. * * This is an alias for the constructor that allows better fluent syntax * as it allows you to do Carbon::parse('Monday next week')->fn() rather * than (new Carbon('Monday next week'))->fn(). * * @param string|null $time * @param \DateTimeZone|string|null $tz * * @return static */ public static function parse($time = null, $tz = null) { return new static($time, $tz); } /** * Get a Carbon instance for the current date and time. * * @param \DateTimeZone|string|null $tz * * @return static */ public static function now($tz = null) { return new static(null, $tz); } /** * Create a Carbon instance for today. * * @param \DateTimeZone|string|null $tz * * @return static */ public static function today($tz = null) { return static::parse('today', $tz); } /** * Create a Carbon instance for tomorrow. * * @param \DateTimeZone|string|null $tz * * @return static */ public static function tomorrow($tz = null) { return static::parse('tomorrow', $tz); } /** * Create a Carbon instance for yesterday. * * @param \DateTimeZone|string|null $tz * * @return static */ public static function yesterday($tz = null) { return static::parse('yesterday', $tz); } /** * Create a Carbon instance for the greatest supported date. * * @return static */ public static function maxValue() { if (self::$PHPIntSize === 4) { // 32 bit return static::createFromTimestamp(PHP_INT_MAX); // @codeCoverageIgnore } // 64 bit return static::create(9999, 12, 31, 23, 59, 59); } /** * Create a Carbon instance for the lowest supported date. * * @return static */ public static function minValue() { if (self::$PHPIntSize === 4) { // 32 bit return static::createFromTimestamp(~PHP_INT_MAX); // @codeCoverageIgnore } // 64 bit return static::create(1, 1, 1, 0, 0, 0); } /** * Create a new Carbon instance from a specific date and time. * * If any of $year, $month or $day are set to null their now() values will * be used. * * If $hour is null it will be set to its now() value and the default * values for $minute and $second will be their now() values. * * If $hour is not null then the default values for $minute and $second * will be 0. * * @param int|null $year * @param int|null $month * @param int|null $day * @param int|null $hour * @param int|null $minute * @param int|null $second * @param \DateTimeZone|string|null $tz * * @throws \InvalidArgumentException * * @return static */ public static function create($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null) { $now = static::hasTestNow() ? static::getTestNow() : static::now($tz); $defaults = array_combine(array( 'year', 'month', 'day', 'hour', 'minute', 'second', ), explode('-', $now->format('Y-n-j-G-i-s'))); $year = $year === null ? $defaults['year'] : $year; $month = $month === null ? $defaults['month'] : $month; $day = $day === null ? $defaults['day'] : $day; if ($hour === null) { $hour = $defaults['hour']; $minute = $minute === null ? $defaults['minute'] : $minute; $second = $second === null ? $defaults['second'] : $second; } else { $minute = $minute === null ? 0 : $minute; $second = $second === null ? 0 : $second; } $fixYear = null; if ($year < 0) { $fixYear = $year; $year = 0; } elseif ($year > 9999) { $fixYear = $year - 9999; $year = 9999; } $instance = static::createFromFormat('!Y-n-j G:i:s', sprintf('%s-%s-%s %s:%02s:%02s', $year, $month, $day, $hour, $minute, $second), $tz); if ($fixYear !== null) { $instance->addYears($fixYear); } return $instance; } /** * Create a new safe Carbon instance from a specific date and time. * * If any of $year, $month or $day are set to null their now() values will * be used. * * If $hour is null it will be set to its now() value and the default * values for $minute and $second will be their now() values. * * If $hour is not null then the default values for $minute and $second * will be 0. * * If one of the set values is not valid, an \InvalidArgumentException * will be thrown. * * @param int|null $year * @param int|null $month * @param int|null $day * @param int|null $hour * @param int|null $minute * @param int|null $second * @param \DateTimeZone|string|null $tz * * @throws \Carbon\Exceptions\InvalidDateException|\InvalidArgumentException * * @return static */ public static function createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null) { $fields = array( 'year' => array(0, 9999), 'month' => array(0, 12), 'day' => array(0, 31), 'hour' => array(0, 24), 'minute' => array(0, 59), 'second' => array(0, 59), ); foreach ($fields as $field => $range) { if ($$field !== null && (!is_int($$field) || $$field < $range[0] || $$field > $range[1])) { throw new InvalidDateException($field, $$field); } } $instance = static::create($year, $month, $day, $hour, $minute, $second, $tz); foreach (array_reverse($fields) as $field => $range) { if ($$field !== null && (!is_int($$field) || $$field !== $instance->$field)) { throw new InvalidDateException($field, $$field); } } return $instance; } /** * Create a Carbon instance from just a date. The time portion is set to now. * * @param int|null $year * @param int|null $month * @param int|null $day * @param \DateTimeZone|string|null $tz * * @throws \InvalidArgumentException * * @return static */ public static function createFromDate($year = null, $month = null, $day = null, $tz = null) { return static::create($year, $month, $day, null, null, null, $tz); } /** * Create a Carbon instance from just a date. The time portion is set to midnight. * * @param int|null $year * @param int|null $month * @param int|null $day * @param \DateTimeZone|string|null $tz * * @return static */ public static function createMidnightDate($year = null, $month = null, $day = null, $tz = null) { return static::create($year, $month, $day, 0, 0, 0, $tz); } /** * Create a Carbon instance from just a time. The date portion is set to today. * * @param int|null $hour * @param int|null $minute * @param int|null $second * @param \DateTimeZone|string|null $tz * * @throws \InvalidArgumentException * * @return static */ public static function createFromTime($hour = null, $minute = null, $second = null, $tz = null) { return static::create(null, null, null, $hour, $minute, $second, $tz); } /** * Create a Carbon instance from a time string. The date portion is set to today. * * @param string $time * @param \DateTimeZone|string|null $tz * * @throws \InvalidArgumentException * * @return static */ public static function createFromTimeString($time, $tz = null) { return static::today($tz)->setTimeFromTimeString($time); } private static function createFromFormatAndTimezone($format, $time, $tz) { return $tz !== null ? parent::createFromFormat($format, $time, static::safeCreateDateTimeZone($tz)) : parent::createFromFormat($format, $time); } /** * Create a Carbon instance from a specific format. * * @param string $format Datetime format * @param string $time * @param \DateTimeZone|string|null $tz * * @throws InvalidArgumentException * * @return static */ public static function createFromFormat($format, $time, $tz = null) { // First attempt to create an instance, so that error messages are based on the unmodified format. $date = self::createFromFormatAndTimezone($format, $time, $tz); $lastErrors = parent::getLastErrors(); if (($mock = static::getTestNow()) && ($date instanceof DateTime || $date instanceof DateTimeInterface)) { // Set timezone from mock if custom timezone was neither given directly nor as a part of format. // First let's skip the part that will be ignored by the parser. $nonEscaped = '(?<!\\\\)(\\\\{2})*'; $nonIgnored = preg_replace("/^.*{$nonEscaped}!/s", '', $format); if ($tz === null && !preg_match("/{$nonEscaped}[eOPT]/", $nonIgnored)) { $tz = $mock->getTimezone(); } // Prepend mock datetime only if the format does not contain non escaped unix epoch reset flag. if (!preg_match("/{$nonEscaped}[!|]/", $format)) { $format = static::MOCK_DATETIME_FORMAT.' '.$format; $time = $mock->format(static::MOCK_DATETIME_FORMAT).' '.$time; } // Regenerate date from the modified format to base result on the mocked instance instead of now. $date = self::createFromFormatAndTimezone($format, $time, $tz); } if ($date instanceof DateTime || $date instanceof DateTimeInterface) { $instance = static::instance($date); $instance::setLastErrors($lastErrors); return $instance; } throw new InvalidArgumentException(implode(PHP_EOL, $lastErrors['errors'])); } /** * Set last errors. * * @param array $lastErrors * * @return void */ private static function setLastErrors(array $lastErrors) { static::$lastErrors = $lastErrors; } /** * {@inheritdoc} */ public static function getLastErrors() { return static::$lastErrors; } /** * Create a Carbon instance from a timestamp. * * @param int $timestamp * @param \DateTimeZone|string|null $tz * * @return static */ public static function createFromTimestamp($timestamp, $tz = null) { return static::today($tz)->setTimestamp($timestamp); } /** * Create a Carbon instance from a timestamp in milliseconds. * * @param int $timestamp * @param \DateTimeZone|string|null $tz * * @return static */ public static function createFromTimestampMs($timestamp, $tz = null) { return static::createFromFormat('U.u', sprintf('%F', $timestamp / 1000)) ->setTimezone($tz); } /** * Create a Carbon instance from an UTC timestamp. * * @param int $timestamp * * @return static */ public static function createFromTimestampUTC($timestamp) { return new static('@'.$timestamp); } /** * Make a Carbon instance from given variable if possible. * * Always return a new instance. Parse only strings and only these likely to be dates (skip intervals * and recurrences). Throw an exception for invalid format, but otherwise return null. * * @param mixed $var * * @return static|null */ public static function make($var) { if ($var instanceof DateTime || $var instanceof DateTimeInterface) { return static::instance($var); } if (is_string($var)) { $var = trim($var); $first = substr($var, 0, 1); if (is_string($var) && $first !== 'P' && $first !== 'R' && preg_match('/[a-z0-9]/i', $var)) { return static::parse($var); } } } /** * Get a copy of the instance. * * @return static */ public function copy() { return clone $this; } /** * Returns a present instance in the same timezone. * * @return static */ public function nowWithSameTz() { return static::now($this->getTimezone()); } /** * Throws an exception if the given object is not a DateTime and does not implement DateTimeInterface * and not in $other. * * @param mixed $date * @param string|array $other * * @throws \InvalidArgumentException */ protected static function expectDateTime($date, $other = array()) { $message = 'Expected '; foreach ((array) $other as $expect) { $message .= "{$expect}, "; } if (!$date instanceof DateTime && !$date instanceof DateTimeInterface) { throw new InvalidArgumentException( $message.'DateTime or DateTimeInterface, '. (is_object($date) ? get_class($date) : gettype($date)).' given' ); } } /** * Return the Carbon instance passed through, a now instance in the same timezone * if null given or parse the input if string given. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * * @return static */ protected function resolveCarbon($date = null) { if (!$date) { return $this->nowWithSameTz(); } if (is_string($date)) { return static::parse($date, $this->getTimezone()); } static::expectDateTime($date, array('null', 'string')); return $date instanceof self ? $date : static::instance($date); } /////////////////////////////////////////////////////////////////// ///////////////////////// GETTERS AND SETTERS ///////////////////// /////////////////////////////////////////////////////////////////// /** * Get a part of the Carbon object * * @param string $name * * @throws \InvalidArgumentException * * @return string|int|bool|\DateTimeZone */ public function __get($name) { static $formats = array( 'year' => 'Y', 'yearIso' => 'o', 'month' => 'n', 'day' => 'j', 'hour' => 'G', 'minute' => 'i', 'second' => 's', 'micro' => 'u', 'dayOfWeek' => 'w', 'dayOfWeekIso' => 'N', 'dayOfYear' => 'z', 'weekOfYear' => 'W', 'daysInMonth' => 't', 'timestamp' => 'U', 'englishDayOfWeek' => 'l', 'shortEnglishDayOfWeek' => 'D', 'englishMonth' => 'F', 'shortEnglishMonth' => 'M', 'localeDayOfWeek' => '%A', 'shortLocaleDayOfWeek' => '%a', 'localeMonth' => '%B', 'shortLocaleMonth' => '%b', ); switch (true) { case isset($formats[$name]): $format = $formats[$name]; $method = substr($format, 0, 1) === '%' ? 'formatLocalized' : 'format'; $value = $this->$method($format); return is_numeric($value) ? (int) $value : $value; case $name === 'weekOfMonth': return (int) ceil($this->day / static::DAYS_PER_WEEK); case $name === 'weekNumberInMonth': return (int) ceil(($this->day + $this->copy()->startOfMonth()->dayOfWeek - 1) / static::DAYS_PER_WEEK); case $name === 'age': return $this->diffInYears(); case $name === 'quarter': return (int) ceil($this->month / static::MONTHS_PER_QUARTER); case $name === 'offset': return $this->getOffset(); case $name === 'offsetHours': return $this->getOffset() / static::SECONDS_PER_MINUTE / static::MINUTES_PER_HOUR; case $name === 'dst': return $this->format('I') === '1'; case $name === 'local': return $this->getOffset() === $this->copy()->setTimezone(date_default_timezone_get())->getOffset(); case $name === 'utc': return $this->getOffset() === 0; case $name === 'timezone' || $name === 'tz': return $this->getTimezone(); case $name === 'timezoneName' || $name === 'tzName': return $this->getTimezone()->getName(); default: throw new InvalidArgumentException(sprintf("Unknown getter '%s'", $name)); } } /** * Check if an attribute exists on the object * * @param string $name * * @return bool */ public function __isset($name) { try { $this->__get($name); } catch (InvalidArgumentException $e) { return false; } return true; } /** * Set a part of the Carbon object * * @param string $name * @param string|int|\DateTimeZone $value * * @throws \InvalidArgumentException * * @return void */ public function __set($name, $value) { switch ($name) { case 'year': case 'month': case 'day': case 'hour': case 'minute': case 'second': list($year, $month, $day, $hour, $minute, $second) = explode('-', $this->format('Y-n-j-G-i-s')); $$name = $value; $this->setDateTime($year, $month, $day, $hour, $minute, $second); break; case 'timestamp': parent::setTimestamp($value); break; case 'timezone': case 'tz': $this->setTimezone($value); break; default: throw new InvalidArgumentException(sprintf("Unknown setter '%s'", $name)); } } /** * Set the instance's year * * @param int $value * * @return static */ public function year($value) { $this->year = $value; return $this; } /** * Set the instance's month * * @param int $value * * @return static */ public function month($value) { $this->month = $value; return $this; } /** * Set the instance's day * * @param int $value * * @return static */ public function day($value) { $this->day = $value; return $this; } /** * Set the instance's hour * * @param int $value * * @return static */ public function hour($value) { $this->hour = $value; return $this; } /** * Set the instance's minute * * @param int $value * * @return static */ public function minute($value) { $this->minute = $value; return $this; } /** * Set the instance's second * * @param int $value * * @return static */ public function second($value) { $this->second = $value; return $this; } /** * Sets the current date of the DateTime object to a different date. * Calls modify as a workaround for a php bug * * @param int $year * @param int $month * @param int $day * * @return static * * @see https://github.com/briannesbitt/Carbon/issues/539 * @see https://bugs.php.net/bug.php?id=63863 */ public function setDate($year, $month, $day) { $this->modify('+0 day'); return parent::setDate($year, $month, $day); } /** * Set the date and time all together * * @param int $year * @param int $month * @param int $day * @param int $hour * @param int $minute * @param int $second * * @return static */ public function setDateTime($year, $month, $day, $hour, $minute, $second = 0) { return $this->setDate($year, $month, $day)->setTime($hour, $minute, $second); } /** * Set the time by time string * * @param string $time * * @return static */ public function setTimeFromTimeString($time) { if (strpos($time, ':') === false) { $time .= ':0'; } return $this->modify($time); } /** * Set the instance's timestamp * * @param int $value * * @return static */ public function timestamp($value) { return $this->setTimestamp($value); } /** * Alias for setTimezone() * * @param \DateTimeZone|string $value * * @return static */ public function timezone($value) { return $this->setTimezone($value); } /** * Alias for setTimezone() * * @param \DateTimeZone|string $value * * @return static */ public function tz($value) { return $this->setTimezone($value); } /** * Set the instance's timezone from a string or object * * @param \DateTimeZone|string $value * * @return static */ public function setTimezone($value) { parent::setTimezone(static::safeCreateDateTimeZone($value)); // https://bugs.php.net/bug.php?id=72338 // just workaround on this bug $this->getTimestamp(); return $this; } /** * Set the year, month, and date for this instance to that of the passed instance. * * @param \Carbon\Carbon|\DateTimeInterface $date * * @return static */ public function setDateFrom($date) { $date = static::instance($date); $this->setDate($date->year, $date->month, $date->day); return $this; } /** * Set the hour, day, and time for this instance to that of the passed instance. * * @param \Carbon\Carbon|\DateTimeInterface $date * * @return static */ public function setTimeFrom($date) { $date = static::instance($date); $this->setTime($date->hour, $date->minute, $date->second); return $this; } /** * Get the days of the week * * @return array */ public static function getDays() { return static::$days; } /////////////////////////////////////////////////////////////////// /////////////////////// WEEK SPECIAL DAYS ///////////////////////// /////////////////////////////////////////////////////////////////// /** * Get the first day of week * * @return int */ public static function getWeekStartsAt() { return static::$weekStartsAt; } /** * Set the first day of week * * @param int $day week start day * * @throws InvalidArgumentException * * @return void */ public static function setWeekStartsAt($day) { if ($day > static::SATURDAY || $day < static::SUNDAY) { throw new InvalidArgumentException('Day of a week should be greater than or equal to 0 and less than or equal to 6.'); } static::$weekStartsAt = $day; } /** * Get the last day of week * * @return int */ public static function getWeekEndsAt() { return static::$weekEndsAt; } /** * Set the last day of week * * @param int $day * * @throws InvalidArgumentException * * @return void */ public static function setWeekEndsAt($day) { if ($day > static::SATURDAY || $day < static::SUNDAY) { throw new InvalidArgumentException('Day of a week should be greater than or equal to 0 and less than or equal to 6.'); } static::$weekEndsAt = $day; } /** * Get weekend days * * @return array */ public static function getWeekendDays() { return static::$weekendDays; } /** * Set weekend days * * @param array $days * * @return void */ public static function setWeekendDays($days) { static::$weekendDays = $days; } /** * get midday/noon hour * * @return int */ public static function getMidDayAt() { return static::$midDayAt; } /** * Set midday/noon hour * * @param int $hour midday hour * * @return void */ public static function setMidDayAt($hour) { static::$midDayAt = $hour; } /////////////////////////////////////////////////////////////////// ///////////////////////// TESTING AIDS //////////////////////////// /////////////////////////////////////////////////////////////////// /** * Set a Carbon instance (real or mock) to be returned when a "now" * instance is created. The provided instance will be returned * specifically under the following conditions: * - A call to the static now() method, ex. Carbon::now() * - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null) * - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now') * - When a string containing the desired time is passed to Carbon::parse(). * * Note the timezone parameter was left out of the examples above and * has no affect as the mock value will be returned regardless of its value. * * To clear the test instance call this method using the default * parameter of null. * * @param \Carbon\Carbon|null $testNow real or mock Carbon instance * @param \Carbon\Carbon|string|null $testNow */ public static function setTestNow($testNow = null) { static::$testNow = is_string($testNow) ? static::parse($testNow) : $testNow; } /** * Get the Carbon instance (real or mock) to be returned when a "now" * instance is created. * * @return static the current instance used for testing */ public static function getTestNow() { return static::$testNow; } /** * Determine if there is a valid test instance set. A valid test instance * is anything that is not null. * * @return bool true if there is a test instance, otherwise false */ public static function hasTestNow() { return static::getTestNow() !== null; } /** * Determine if a time string will produce a relative date. * * @param string $time * * @return bool true if time match a relative date, false if absolute or invalid time string */ public static function hasRelativeKeywords($time) { if (strtotime($time) === false) { return false; } $date1 = new DateTime('2000-01-01T00:00:00Z'); $date1->modify($time); $date2 = new DateTime('2001-12-25T00:00:00Z'); $date2->modify($time); return $date1 != $date2; } /////////////////////////////////////////////////////////////////// /////////////////////// LOCALIZATION ////////////////////////////// /////////////////////////////////////////////////////////////////// /** * Initialize the translator instance if necessary. * * @return \Symfony\Component\Translation\TranslatorInterface */ protected static function translator() { if (static::$translator === null) { static::$translator = Translator::get(); } return static::$translator; } /** * Get the translator instance in use * * @return \Symfony\Component\Translation\TranslatorInterface */ public static function getTranslator() { return static::translator(); } /** * Set the translator instance to use * * @param \Symfony\Component\Translation\TranslatorInterface $translator * * @return void */ public static function setTranslator(TranslatorInterface $translator) { static::$translator = $translator; } /** * Get the current translator locale * * @return string */ public static function getLocale() { return static::translator()->getLocale(); } /** * Set the current translator locale and indicate if the source locale file exists * * @param string $locale locale ex. en * * @return bool */ public static function setLocale($locale) { return static::translator()->setLocale($locale) !== false; } /** * Set the current locale to the given, execute the passed function, reset the locale to previous one, * then return the result of the closure (or null if the closure was void). * * @param string $locale locale ex. en * * @return mixed */ public static function executeWithLocale($locale, $func) { $currentLocale = static::getLocale(); $result = call_user_func($func, static::setLocale($locale) ? static::getLocale() : false, static::translator()); static::setLocale($currentLocale); return $result; } /** * Returns true if the given locale is internally supported and has short-units support. * Support is considered enabled if either year, day or hour has a short variant translated. * * @param string $locale locale ex. en * * @return bool */ public static function localeHasShortUnits($locale) { return static::executeWithLocale($locale, function ($newLocale, TranslatorInterface $translator) { return $newLocale && ( ($y = $translator->trans('y')) !== 'y' && $y !== $translator->trans('year') ) || ( ($y = $translator->trans('d')) !== 'd' && $y !== $translator->trans('day') ) || ( ($y = $translator->trans('h')) !== 'h' && $y !== $translator->trans('hour') ); }); } /** * Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after). * Support is considered enabled if the 4 sentences are translated in the given locale. * * @param string $locale locale ex. en * * @return bool */ public static function localeHasDiffSyntax($locale) { return static::executeWithLocale($locale, function ($newLocale, TranslatorInterface $translator) { return $newLocale && $translator->trans('ago') !== 'ago' && $translator->trans('from_now') !== 'from_now' && $translator->trans('before') !== 'before' && $translator->trans('after') !== 'after'; }); } /** * Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow). * Support is considered enabled if the 3 words are translated in the given locale. * * @param string $locale locale ex. en * * @return bool */ public static function localeHasDiffOneDayWords($locale) { return static::executeWithLocale($locale, function ($newLocale, TranslatorInterface $translator) { return $newLocale && $translator->trans('diff_now') !== 'diff_now' && $translator->trans('diff_yesterday') !== 'diff_yesterday' && $translator->trans('diff_tomorrow') !== 'diff_tomorrow'; }); } /** * Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow). * Support is considered enabled if the 2 words are translated in the given locale. * * @param string $locale locale ex. en * * @return bool */ public static function localeHasDiffTwoDayWords($locale) { return static::executeWithLocale($locale, function ($newLocale, TranslatorInterface $translator) { return $newLocale && $translator->trans('diff_before_yesterday') !== 'diff_before_yesterday' && $translator->trans('diff_after_tomorrow') !== 'diff_after_tomorrow'; }); } /** * Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X). * Support is considered enabled if the 4 sentences are translated in the given locale. * * @param string $locale locale ex. en * * @return bool */ public static function localeHasPeriodSyntax($locale) { return static::executeWithLocale($locale, function ($newLocale, TranslatorInterface $translator) { return $newLocale && $translator->trans('period_recurrences') !== 'period_recurrences' && $translator->trans('period_interval') !== 'period_interval' && $translator->trans('period_start_date') !== 'period_start_date' && $translator->trans('period_end_date') !== 'period_end_date'; }); } /** * Returns the list of internally available locales and already loaded custom locales. * (It will ignore custom translator dynamic loading.) * * @return array */ public static function getAvailableLocales() { $translator = static::translator(); $locales = array(); if ($translator instanceof Translator) { foreach (glob(__DIR__.'/Lang/*.php') as $file) { $locales[] = substr($file, strrpos($file, '/') + 1, -4); } $locales = array_unique(array_merge($locales, array_keys($translator->getMessages()))); } return $locales; } /////////////////////////////////////////////////////////////////// /////////////////////// STRING FORMATTING ///////////////////////// /////////////////////////////////////////////////////////////////// /** * Set if UTF8 will be used for localized date/time * * @param bool $utf8 */ public static function setUtf8($utf8) { static::$utf8 = $utf8; } /** * Format the instance with the current locale. You can set the current * locale using setlocale() http://php.net/setlocale. * * @param string $format * * @return string */ public function formatLocalized($format) { // Check for Windows to find and replace the %e modifier correctly. if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $format = preg_replace('#(?<!%)((?:%%)*)%e#', '\1%#d', $format); // @codeCoverageIgnore } $formatted = strftime($format, strtotime($this->toDateTimeString())); return static::$utf8 ? utf8_encode($formatted) : $formatted; } /** * Reset the format used to the default when type juggling a Carbon instance to a string * * @return void */ public static function resetToStringFormat() { static::setToStringFormat(static::DEFAULT_TO_STRING_FORMAT); } /** * Set the default format used when type juggling a Carbon instance to a string * * @param string|Closure $format * * @return void */ public static function setToStringFormat($format) { static::$toStringFormat = $format; } /** * Format the instance as a string using the set format * * @return string */ public function __toString() { $format = static::$toStringFormat; return $this->format($format instanceof Closure ? $format($this) : $format); } /** * Format the instance as date * * @return string */ public function toDateString() { return $this->format('Y-m-d'); } /** * Format the instance as a readable date * * @return string */ public function toFormattedDateString() { return $this->format('M j, Y'); } /** * Format the instance as time * * @return string */ public function toTimeString() { return $this->format('H:i:s'); } /** * Format the instance as date and time * * @return string */ public function toDateTimeString() { return $this->format('Y-m-d H:i:s'); } /** * Format the instance as date and time T-separated with no timezone * * @example * ``` * echo Carbon::now()->toDateTimeLocalString(); * ``` * * @return string */ public function toDateTimeLocalString() { return $this->format('Y-m-d\TH:i:s'); } /** * Format the instance with day, date and time * * @return string */ public function toDayDateTimeString() { return $this->format('D, M j, Y g:i A'); } /** * Format the instance as ATOM * * @return string */ public function toAtomString() { return $this->format(static::ATOM); } /** * Format the instance as COOKIE * * @return string */ public function toCookieString() { return $this->format(static::COOKIE); } /** * Format the instance as ISO8601 * * @return string */ public function toIso8601String() { return $this->toAtomString(); } /** * Format the instance as RFC822 * * @return string */ public function toRfc822String() { return $this->format(static::RFC822); } /** * Convert the instance to UTC and return as Zulu ISO8601 * * @return string */ public function toIso8601ZuluString() { return $this->copy()->setTimezone('UTC')->format('Y-m-d\TH:i:s\Z'); } /** * Format the instance as RFC850 * * @return string */ public function toRfc850String() { return $this->format(static::RFC850); } /** * Format the instance as RFC1036 * * @return string */ public function toRfc1036String() { return $this->format(static::RFC1036); } /** * Format the instance as RFC1123 * * @return string */ public function toRfc1123String() { return $this->format(static::RFC1123); } /** * Format the instance as RFC2822 * * @return string */ public function toRfc2822String() { return $this->format(static::RFC2822); } /** * Format the instance as RFC3339 * * @return string */ public function toRfc3339String() { return $this->format(static::RFC3339); } /** * Format the instance as RSS * * @return string */ public function toRssString() { return $this->format(static::RSS); } /** * Format the instance as W3C * * @return string */ public function toW3cString() { return $this->format(static::W3C); } /** * Format the instance as RFC7231 * * @return string */ public function toRfc7231String() { return $this->copy() ->setTimezone('GMT') ->format(static::RFC7231_FORMAT); } /** * Get default array representation * * @return array */ public function toArray() { return array( 'year' => $this->year, 'month' => $this->month, 'day' => $this->day, 'dayOfWeek' => $this->dayOfWeek, 'dayOfYear' => $this->dayOfYear, 'hour' => $this->hour, 'minute' => $this->minute, 'second' => $this->second, 'micro' => $this->micro, 'timestamp' => $this->timestamp, 'formatted' => $this->format(self::DEFAULT_TO_STRING_FORMAT), 'timezone' => $this->timezone, ); } /** * Get default object representation. * * @example * ``` * var_dump(Carbon::now()->toObject()); * ``` * * @return object */ public function toObject() { return (object) $this->toArray(); } /** * Returns english human readable complete date string. * * @example * ``` * echo Carbon::now()->toString(); * ``` * * @return string */ public function toString() { return $this->format('D M j Y H:i:s \G\M\TO'); } /** * Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z, if $keepOffset truthy, offset will be kept: * 1977-04-22T01:00:00-05:00). * * @example * ``` * echo Carbon::now('America/Toronto')->toISOString() . "\n"; * echo Carbon::now('America/Toronto')->toISOString(true) . "\n"; * ``` * * @param bool $keepOffset Pass true to keep the date offset. Else forced to UTC. * * @return null|string */ public function toISOString($keepOffset = false) { if ($this->year === 0) { return null; } $year = $this->year < 0 || $this->year > 9999 ? ($this->year < 0 ? '-' : '+').str_pad(abs($this->year), 6, '0', STR_PAD_LEFT) : str_pad($this->year, 4, '0', STR_PAD_LEFT); $tz = $keepOffset ? $this->format('P') : 'Z'; $date = $keepOffset ? $this : $this->copy()->setTimezone('UTC'); return $year.$date->format('-m-d\TH:i:s.u').$tz; } /** * Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z) with UTC timezone. * * @example * ``` * echo Carbon::now('America/Toronto')->toJSON(); * ``` * * @return null|string */ public function toJSON() { return $this->toISOString(); } /** * Return native DateTime PHP object matching the current instance. * * @example * ``` * var_dump(Carbon::now()->toDateTime()); * ``` * * @return DateTime */ public function toDateTime() { return new DateTime($this->format('Y-m-d H:i:s.u'), $this->getTimezone()); } /** * @alias toDateTime * * Return native DateTime PHP object matching the current instance. * * @example * ``` * var_dump(Carbon::now()->toDate()); * ``` * * @return DateTime */ public function toDate() { return $this->toDateTime(); } /////////////////////////////////////////////////////////////////// ////////////////////////// COMPARISONS //////////////////////////// /////////////////////////////////////////////////////////////////// /** * Determines if the instance is equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function eq($date) { return $this == $date; } /** * Determines if the instance is equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see eq() * * @return bool */ public function equalTo($date) { return $this->eq($date); } /** * Determines if the instance is not equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function ne($date) { return !$this->eq($date); } /** * Determines if the instance is not equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see ne() * * @return bool */ public function notEqualTo($date) { return $this->ne($date); } /** * Determines if the instance is greater (after) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function gt($date) { return $this > $date; } /** * Determines if the instance is greater (after) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see gt() * * @return bool */ public function greaterThan($date) { return $this->gt($date); } /** * Determines if the instance is greater (after) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see gt() * * @return bool */ public function isAfter($date) { return $this->gt($date); } /** * Determines if the instance is greater (after) than or equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function gte($date) { return $this >= $date; } /** * Determines if the instance is greater (after) than or equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see gte() * * @return bool */ public function greaterThanOrEqualTo($date) { return $this->gte($date); } /** * Determines if the instance is less (before) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function lt($date) { return $this < $date; } /** * Determines if the instance is less (before) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see lt() * * @return bool */ public function lessThan($date) { return $this->lt($date); } /** * Determines if the instance is less (before) than another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see lt() * * @return bool */ public function isBefore($date) { return $this->lt($date); } /** * Determines if the instance is less (before) or equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @return bool */ public function lte($date) { return $this <= $date; } /** * Determines if the instance is less (before) or equal to another * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see lte() * * @return bool */ public function lessThanOrEqualTo($date) { return $this->lte($date); } /** * Determines if the instance is between two others * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date1 * @param \Carbon\Carbon|\DateTimeInterface|mixed $date2 * @param bool $equal Indicates if an equal to comparison should be done * * @return bool */ public function between($date1, $date2, $equal = true) { if ($date1->gt($date2)) { $temp = $date1; $date1 = $date2; $date2 = $temp; } if ($equal) { return $this->gte($date1) && $this->lte($date2); } return $this->gt($date1) && $this->lt($date2); } protected function floatDiffInSeconds($date) { $date = $this->resolveCarbon($date); return abs($this->diffInRealSeconds($date, false) + ($date->micro - $this->micro) / 1000000); } /** * Determines if the instance is between two others * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date1 * @param \Carbon\Carbon|\DateTimeInterface|mixed $date2 * @param bool $equal Indicates if a > and < comparison should be used or <= or >= * * @return bool */ public function isBetween($date1, $date2, $equal = true) { return $this->between($date1, $date2, $equal); } /** * Get the closest date from the instance. * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date1 * @param \Carbon\Carbon|\DateTimeInterface|mixed $date2 * * @return static */ public function closest($date1, $date2) { return $this->floatDiffInSeconds($date1) < $this->floatDiffInSeconds($date2) ? $date1 : $date2; } /** * Get the farthest date from the instance. * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date1 * @param \Carbon\Carbon|\DateTimeInterface|mixed $date2 * * @return static */ public function farthest($date1, $date2) { return $this->floatDiffInSeconds($date1) > $this->floatDiffInSeconds($date2) ? $date1 : $date2; } /** * Get the minimum instance between a given instance (default now) and the current instance. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * * @return static */ public function min($date = null) { $date = $this->resolveCarbon($date); return $this->lt($date) ? $this : $date; } /** * Get the minimum instance between a given instance (default now) and the current instance. * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see min() * * @return static */ public function minimum($date = null) { return $this->min($date); } /** * Get the maximum instance between a given instance (default now) and the current instance. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * * @return static */ public function max($date = null) { $date = $this->resolveCarbon($date); return $this->gt($date) ? $this : $date; } /** * Get the maximum instance between a given instance (default now) and the current instance. * * @param \Carbon\Carbon|\DateTimeInterface|mixed $date * * @see max() * * @return static */ public function maximum($date = null) { return $this->max($date); } /** * Determines if the instance is a weekday. * * @return bool */ public function isWeekday() { return !$this->isWeekend(); } /** * Determines if the instance is a weekend day. * * @return bool */ public function isWeekend() { return in_array($this->dayOfWeek, static::$weekendDays); } /** * Determines if the instance is yesterday. * * @return bool */ public function isYesterday() { return $this->toDateString() === static::yesterday($this->getTimezone())->toDateString(); } /** * Determines if the instance is today. * * @return bool */ public function isToday() { return $this->toDateString() === $this->nowWithSameTz()->toDateString(); } /** * Determines if the instance is tomorrow. * * @return bool */ public function isTomorrow() { return $this->toDateString() === static::tomorrow($this->getTimezone())->toDateString(); } /** * Determines if the instance is within the next week. * * @return bool */ public function isNextWeek() { return $this->weekOfYear === $this->nowWithSameTz()->addWeek()->weekOfYear; } /** * Determines if the instance is within the last week. * * @return bool */ public function isLastWeek() { return $this->weekOfYear === $this->nowWithSameTz()->subWeek()->weekOfYear; } /** * Determines if the instance is within the next quarter. * * @return bool */ public function isNextQuarter() { return $this->quarter === $this->nowWithSameTz()->addQuarter()->quarter; } /** * Determines if the instance is within the last quarter. * * @return bool */ public function isLastQuarter() { return $this->quarter === $this->nowWithSameTz()->subQuarter()->quarter; } /** * Determines if the instance is within the next month. * * @return bool */ public function isNextMonth() { return $this->month === $this->nowWithSameTz()->addMonthNoOverflow()->month; } /** * Determines if the instance is within the last month. * * @return bool */ public function isLastMonth() { return $this->month === $this->nowWithSameTz()->subMonthNoOverflow()->month; } /** * Determines if the instance is within next year. * * @return bool */ public function isNextYear() { return $this->year === $this->nowWithSameTz()->addYear()->year; } /** * Determines if the instance is within the previous year. * * @return bool */ public function isLastYear() { return $this->year === $this->nowWithSameTz()->subYear()->year; } /** * Determines if the instance is in the future, ie. greater (after) than now. * * @return bool */ public function isFuture() { return $this->gt($this->nowWithSameTz()); } /** * Determines if the instance is in the past, ie. less (before) than now. * * @return bool */ public function isPast() { return $this->lt($this->nowWithSameTz()); } /** * Determines if the instance is a leap year. * * @return bool */ public function isLeapYear() { return $this->format('L') === '1'; } /** * Determines if the instance is a long year * * @see https://en.wikipedia.org/wiki/ISO_8601#Week_dates * * @return bool */ public function isLongYear() { return static::create($this->year, 12, 28, 0, 0, 0, $this->tz)->weekOfYear === 53; } /** * Compares the formatted values of the two dates. * * @param string $format The date formats to compare. * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day. * * @throws \InvalidArgumentException * * @return bool */ public function isSameAs($format, $date = null) { $date = $date ?: static::now($this->tz); static::expectDateTime($date, 'null'); return $this->format($format) === $date->format($format); } /** * Determines if the instance is in the current year. * * @return bool */ public function isCurrentYear() { return $this->isSameYear(); } /** * Checks if the passed in date is in the same year as the instance year. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day. * * @return bool */ public function isSameYear($date = null) { return $this->isSameAs('Y', $date); } /** * Determines if the instance is in the current month. * * @return bool */ public function isCurrentQuarter() { return $this->isSameQuarter(); } /** * Checks if the passed in date is in the same quarter as the instance quarter (and year if needed). * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day. * @param bool $ofSameYear Check if it is the same month in the same year. * * @return bool */ public function isSameQuarter($date = null, $ofSameYear = null) { $date = $date ? static::instance($date) : static::now($this->tz); static::expectDateTime($date, 'null'); $ofSameYear = is_null($ofSameYear) ? static::shouldCompareYearWithMonth() : $ofSameYear; return $this->quarter === $date->quarter && (!$ofSameYear || $this->isSameYear($date)); } /** * Determines if the instance is in the current month. * * @param bool $ofSameYear Check if it is the same month in the same year. * * @return bool */ public function isCurrentMonth($ofSameYear = null) { return $this->isSameMonth(null, $ofSameYear); } /** * Checks if the passed in date is in the same month as the instance´s month. * * Note that this defaults to only comparing the month while ignoring the year. * To test if it is the same exact month of the same year, pass in true as the second parameter. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date. * @param bool $ofSameYear Check if it is the same month in the same year. * * @return bool */ public function isSameMonth($date = null, $ofSameYear = null) { $ofSameYear = is_null($ofSameYear) ? static::shouldCompareYearWithMonth() : $ofSameYear; return $this->isSameAs($ofSameYear ? 'Y-m' : 'm', $date); } /** * Determines if the instance is in the current day. * * @return bool */ public function isCurrentDay() { return $this->isSameDay(); } /** * Checks if the passed in date is the same exact day as the instance´s day. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date. * * @return bool */ public function isSameDay($date = null) { return $this->isSameAs('Y-m-d', $date); } /** * Determines if the instance is in the current hour. * * @return bool */ public function isCurrentHour() { return $this->isSameHour(); } /** * Checks if the passed in date is the same exact hour as the instance´s hour. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date. * * @return bool */ public function isSameHour($date = null) { return $this->isSameAs('Y-m-d H', $date); } /** * Determines if the instance is in the current minute. * * @return bool */ public function isCurrentMinute() { return $this->isSameMinute(); } /** * Checks if the passed in date is the same exact minute as the instance´s minute. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date. * * @return bool */ public function isSameMinute($date = null) { return $this->isSameAs('Y-m-d H:i', $date); } /** * Determines if the instance is in the current second. * * @return bool */ public function isCurrentSecond() { return $this->isSameSecond(); } /** * Checks if the passed in date is the same exact second as the instance´s second. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date. * * @return bool */ public function isSameSecond($date = null) { return $this->isSameAs('Y-m-d H:i:s', $date); } /** * Checks if this day is a specific day of the week. * * @param int $dayOfWeek * * @return bool */ public function isDayOfWeek($dayOfWeek) { return $this->dayOfWeek === $dayOfWeek; } /** * Checks if this day is a Sunday. * * @return bool */ public function isSunday() { return $this->dayOfWeek === static::SUNDAY; } /** * Checks if this day is a Monday. * * @return bool */ public function isMonday() { return $this->dayOfWeek === static::MONDAY; } /** * Checks if this day is a Tuesday. * * @return bool */ public function isTuesday() { return $this->dayOfWeek === static::TUESDAY; } /** * Checks if this day is a Wednesday. * * @return bool */ public function isWednesday() { return $this->dayOfWeek === static::WEDNESDAY; } /** * Checks if this day is a Thursday. * * @return bool */ public function isThursday() { return $this->dayOfWeek === static::THURSDAY; } /** * Checks if this day is a Friday. * * @return bool */ public function isFriday() { return $this->dayOfWeek === static::FRIDAY; } /** * Checks if this day is a Saturday. * * @return bool */ public function isSaturday() { return $this->dayOfWeek === static::SATURDAY; } /** * Check if its the birthday. Compares the date/month values of the two dates. * * @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day. * * @return bool */ public function isBirthday($date = null) { return $this->isSameAs('md', $date); } /** * Check if today is the last day of the Month * * @return bool */ public function isLastOfMonth() { return $this->day === $this->daysInMonth; } /** * Check if the instance is start of day / midnight. * * @param bool $checkMicroseconds check time at microseconds precision * /!\ Warning, this is not reliable with PHP < 7.1.4 * * @return bool */ public function isStartOfDay($checkMicroseconds = false) { return $checkMicroseconds ? $this->format('H:i:s.u') === '00:00:00.000000' : $this->format('H:i:s') === '00:00:00'; } /** * Check if the instance is end of day. * * @param bool $checkMicroseconds check time at microseconds precision * /!\ Warning, this is not reliable with PHP < 7.1.4 * * @return bool */ public function isEndOfDay($checkMicroseconds = false) { return $checkMicroseconds ? $this->format('H:i:s.u') === '23:59:59.999999' : $this->format('H:i:s') === '23:59:59'; } /** * Check if the instance is start of day / midnight. * * @return bool */ public function isMidnight() { return $this->isStartOfDay(); } /** * Check if the instance is midday. * * @return bool */ public function isMidday() { return $this->format('G:i:s') === static::$midDayAt.':00:00'; } /** * Checks if the (date)time string is in a given format. * * @param string $date * @param string $format * * @return bool */ public static function hasFormat($date, $format) { try { // Try to create a DateTime object. Throws an InvalidArgumentException if the provided time string // doesn't match the format in any way. static::createFromFormat($format, $date); // createFromFormat() is known to handle edge cases silently. // E.g. "1975-5-1" (Y-n-j) will still be parsed correctly when "Y-m-d" is supplied as the format. // To ensure we're really testing against our desired format, perform an additional regex validation. $regex = strtr( preg_quote($format, '/'), static::$regexFormats ); return (bool) preg_match('/^'.$regex.'$/', $date); } catch (InvalidArgumentException $e) { } return false; } /////////////////////////////////////////////////////////////////// /////////////////// ADDITIONS AND SUBTRACTIONS //////////////////// /////////////////////////////////////////////////////////////////// /** * Add centuries to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addCenturies($value) { return $this->addYears(static::YEARS_PER_CENTURY * $value); } /** * Add a century to the instance * * @param int $value * * @return static */ public function addCentury($value = 1) { return $this->addCenturies($value); } /** * Remove centuries from the instance * * @param int $value * * @return static */ public function subCenturies($value) { return $this->addCenturies(-1 * $value); } /** * Remove a century from the instance * * @param int $value * * @return static */ public function subCentury($value = 1) { return $this->subCenturies($value); } /** * Add years to the instance. Positive $value travel forward while * negative $value travel into the past. * * @param int $value * * @return static */ public function addYears($value) { if ($this->shouldOverflowYears()) { return $this->addYearsWithOverflow($value); } return $this->addYearsNoOverflow($value); } /** * Add a year to the instance * * @param int $value * * @return static */ public function addYear($value = 1) { return $this->addYears($value); } /** * Add years to the instance with no overflow of months * Positive $value travel forward while * negative $value travel into the past. * * @param int $value * * @return static */ public function addYearsNoOverflow($value) { return $this->addMonthsNoOverflow($value * static::MONTHS_PER_YEAR); } /** * Add year with overflow months set to false * * @param int $value * * @return static */ public function addYearNoOverflow($value = 1) { return $this->addYearsNoOverflow($value); } /** * Add years to the instance. * Positive $value travel forward while * negative $value travel into the past. * * @param int $value * * @return static */ public function addYearsWithOverflow($value) { return $this->modify((int) $value.' year'); } /** * Add year with overflow. * * @param int $value * * @return static */ public function addYearWithOverflow($value = 1) { return $this->addYearsWithOverflow($value); } /** * Remove years from the instance. * * @param int $value * * @return static */ public function subYears($value) { return $this->addYears(-1 * $value); } /** * Remove a year from the instance * * @param int $value * * @return static */ public function subYear($value = 1) { return $this->subYears($value); } /** * Remove years from the instance with no month overflow. * * @param int $value * * @return static */ public function subYearsNoOverflow($value) { return $this->subMonthsNoOverflow($value * static::MONTHS_PER_YEAR); } /** * Remove year from the instance with no month overflow * * @param int $value * * @return static */ public function subYearNoOverflow($value = 1) { return $this->subYearsNoOverflow($value); } /** * Remove years from the instance. * * @param int $value * * @return static */ public function subYearsWithOverflow($value) { return $this->subMonthsWithOverflow($value * static::MONTHS_PER_YEAR); } /** * Remove year from the instance. * * @param int $value * * @return static */ public function subYearWithOverflow($value = 1) { return $this->subYearsWithOverflow($value); } /** * Add quarters to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addQuarters($value) { return $this->addMonths(static::MONTHS_PER_QUARTER * $value); } /** * Add a quarter to the instance * * @param int $value * * @return static */ public function addQuarter($value = 1) { return $this->addQuarters($value); } /** * Remove quarters from the instance * * @param int $value * * @return static */ public function subQuarters($value) { return $this->addQuarters(-1 * $value); } /** * Remove a quarter from the instance * * @param int $value * * @return static */ public function subQuarter($value = 1) { return $this->subQuarters($value); } /** * Add months to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addMonths($value) { if (static::shouldOverflowMonths()) { return $this->addMonthsWithOverflow($value); } return $this->addMonthsNoOverflow($value); } /** * Add a month to the instance * * @param int $value * * @return static */ public function addMonth($value = 1) { return $this->addMonths($value); } /** * Remove months from the instance * * @param int $value * * @return static */ public function subMonths($value) { return $this->addMonths(-1 * $value); } /** * Remove a month from the instance * * @param int $value * * @return static */ public function subMonth($value = 1) { return $this->subMonths($value); } /** * Add months to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addMonthsWithOverflow($value) { return $this->modify((int) $value.' month'); } /** * Add a month to the instance * * @param int $value * * @return static */ public function addMonthWithOverflow($value = 1) { return $this->addMonthsWithOverflow($value); } /** * Remove months from the instance * * @param int $value * * @return static */ public function subMonthsWithOverflow($value) { return $this->addMonthsWithOverflow(-1 * $value); } /** * Remove a month from the instance * * @param int $value * * @return static */ public function subMonthWithOverflow($value = 1) { return $this->subMonthsWithOverflow($value); } /** * Add months without overflowing to the instance. Positive $value * travels forward while negative $value travels into the past. * * @param int $value * * @return static */ public function addMonthsNoOverflow($value) { $day = $this->day; $this->modify((int) $value.' month'); if ($day !== $this->day) { $this->modify('last day of previous month'); } return $this; } /** * Add a month with no overflow to the instance * * @param int $value * * @return static */ public function addMonthNoOverflow($value = 1) { return $this->addMonthsNoOverflow($value); } /** * Remove months with no overflow from the instance * * @param int $value * * @return static */ public function subMonthsNoOverflow($value) { return $this->addMonthsNoOverflow(-1 * $value); } /** * Remove a month with no overflow from the instance * * @param int $value * * @return static */ public function subMonthNoOverflow($value = 1) { return $this->subMonthsNoOverflow($value); } /** * Add days to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addDays($value) { return $this->modify((int) $value.' day'); } /** * Add a day to the instance * * @param int $value * * @return static */ public function addDay($value = 1) { return $this->addDays($value); } /** * Remove days from the instance * * @param int $value * * @return static */ public function subDays($value) { return $this->addDays(-1 * $value); } /** * Remove a day from the instance * * @param int $value * * @return static */ public function subDay($value = 1) { return $this->subDays($value); } /** * Add weekdays to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addWeekdays($value) { // Fix for weekday bug https://bugs.php.net/bug.php?id=54909 $t = $this->toTimeString(); $this->modify((int) $value.' weekday'); return $this->setTimeFromTimeString($t); } /** * Add a weekday to the instance * * @param int $value * * @return static */ public function addWeekday($value = 1) { return $this->addWeekdays($value); } /** * Remove weekdays from the instance * * @param int $value * * @return static */ public function subWeekdays($value) { return $this->addWeekdays(-1 * $value); } /** * Remove a weekday from the instance * * @param int $value * * @return static */ public function subWeekday($value = 1) { return $this->subWeekdays($value); } /** * Add weeks to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addWeeks($value) { return $this->modify((int) $value.' week'); } /** * Add a week to the instance * * @param int $value * * @return static */ public function addWeek($value = 1) { return $this->addWeeks($value); } /** * Remove weeks to the instance * * @param int $value * * @return static */ public function subWeeks($value) { return $this->addWeeks(-1 * $value); } /** * Remove a week from the instance * * @param int $value * * @return static */ public function subWeek($value = 1) { return $this->subWeeks($value); } /** * Add hours to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addHours($value) { return $this->modify((int) $value.' hour'); } /** * Add hours to the instance using timestamp. Positive $value travels * forward while negative $value travels into the past. * * @param int $value * * @return static */ public function addRealHours($value) { return $this->addRealMinutes($value * static::MINUTES_PER_HOUR); } /** * Add an hour to the instance. * * @param int $value * * @return static */ public function addHour($value = 1) { return $this->addHours($value); } /** * Add an hour to the instance using timestamp. * * @param int $value * * @return static */ public function addRealHour($value = 1) { return $this->addRealHours($value); } /** * Remove hours from the instance. * * @param int $value * * @return static */ public function subHours($value) { return $this->addHours(-1 * $value); } /** * Remove hours from the instance using timestamp. * * @param int $value * * @return static */ public function subRealHours($value) { return $this->addRealHours(-1 * $value); } /** * Remove an hour from the instance. * * @param int $value * * @return static */ public function subHour($value = 1) { return $this->subHours($value); } /** * Remove an hour from the instance. * * @param int $value * * @return static */ public function subRealHour($value = 1) { return $this->subRealHours($value); } /** * Add minutes to the instance using timestamp. Positive $value * travels forward while negative $value travels into the past. * * @param int $value * * @return static */ public function addMinutes($value) { return $this->modify((int) $value.' minute'); } /** * Add minutes to the instance using timestamp. Positive $value travels * forward while negative $value travels into the past. * * @param int $value * * @return static */ public function addRealMinutes($value) { return $this->addRealSeconds($value * static::SECONDS_PER_MINUTE); } /** * Add a minute to the instance. * * @param int $value * * @return static */ public function addMinute($value = 1) { return $this->addMinutes($value); } /** * Add a minute to the instance using timestamp. * * @param int $value * * @return static */ public function addRealMinute($value = 1) { return $this->addRealMinutes($value); } /** * Remove a minute from the instance. * * @param int $value * * @return static */ public function subMinute($value = 1) { return $this->subMinutes($value); } /** * Remove a minute from the instance using timestamp. * * @param int $value * * @return static */ public function subRealMinute($value = 1) { return $this->addRealMinutes(-1 * $value); } /** * Remove minutes from the instance. * * @param int $value * * @return static */ public function subMinutes($value) { return $this->addMinutes(-1 * $value); } /** * Remove a minute from the instance using timestamp. * * @param int $value * * @return static */ public function subRealMinutes($value = 1) { return $this->subRealMinute($value); } /** * Add seconds to the instance. Positive $value travels forward while * negative $value travels into the past. * * @param int $value * * @return static */ public function addSeconds($value) { return $this->modify((int) $value.' second'); } /** * Add seconds to the instance using timestamp. Positive $value travels * forward while negative $value travels into the past. * * @param int $value * * @return static */ public function addRealSeconds($value) { return $this->setTimestamp($this->getTimestamp() + $value); } /** * Add a second to the instance. * * @param int $value * * @return static */ public function addSecond($value = 1) { return $this->addSeconds($value); } /** * Add a second to the instance using timestamp. * * @param int $value * * @return static */ public function addRealSecond($value = 1) { return $this->addRealSeconds($value); } /** * Remove seconds from the instance. * * @param int $value * * @return static */ public function subSeconds($value) { return $this->addSeconds(-1 * $value); } /** * Remove seconds from the instance using timestamp. * * @param int $value * * @return static */ public function subRealSeconds($value) { return $this->addRealSeconds(-1 * $value); } /** * Remove a second from the instance * * @param int $value * * @return static */ public function subSecond($value = 1) { return $this->subSeconds($value); } /** * Remove a second from the instance using timestamp. * * @param int $value * * @return static */ public function subRealSecond($value = 1) { return $this->subRealSeconds($value); } /////////////////////////////////////////////////////////////////// /////////////////////////// DIFFERENCES /////////////////////////// /////////////////////////////////////////////////////////////////// /** * @param DateInterval $diff * @param bool $absolute * @param bool $trimMicroseconds * * @return CarbonInterval */ protected static function fixDiffInterval(DateInterval $diff, $absolute, $trimMicroseconds) { $diff = CarbonInterval::instance($diff, $trimMicroseconds); // @codeCoverageIgnoreStart if (version_compare(PHP_VERSION, '7.1.0-dev', '<')) { return $diff; } // Work-around for https://bugs.php.net/bug.php?id=77145 if ($diff->f > 0 && $diff->y === -1 && $diff->m === 11 && $diff->d >= 27 && $diff->h === 23 && $diff->i === 59 && $diff->s === 59) { $diff->y = 0; $diff->m = 0; $diff->d = 0; $diff->h = 0; $diff->i = 0; $diff->s = 0; $diff->f = (1000000 - round($diff->f * 1000000)) / 1000000; $diff->invert(); } elseif ($diff->f < 0) { if ($diff->s !== 0 || $diff->i !== 0 || $diff->h !== 0 || $diff->d !== 0 || $diff->m !== 0 || $diff->y !== 0) { $diff->f = (round($diff->f * 1000000) + 1000000) / 1000000; $diff->s--; if ($diff->s < 0) { $diff->s += 60; $diff->i--; if ($diff->i < 0) { $diff->i += 60; $diff->h--; if ($diff->h < 0) { $diff->h += 24; $diff->d--; if ($diff->d < 0) { $diff->d += 30; $diff->m--; if ($diff->m < 0) { $diff->m += 12; $diff->y--; } } } } } } else { $diff->f *= -1; $diff->invert(); } } // @codeCoverageIgnoreEnd if ($absolute && $diff->invert) { $diff->invert(); } return $diff; } /** * Get the difference as a CarbonInterval instance. * * Pass false as second argument to get a microseconds-precise interval. Else * microseconds in the original interval will not be kept. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * @param bool $trimMicroseconds (true by default) * * @return CarbonInterval */ public function diffAsCarbonInterval($date = null, $absolute = true, $trimMicroseconds = true) { $from = $this; $to = $this->resolveCarbon($date); if ($trimMicroseconds) { $from = $from->copy()->startOfSecond(); $to = $to->copy()->startOfSecond(); } return static::fixDiffInterval($from->diff($to, $absolute), $absolute, $trimMicroseconds); } /** * Get the difference in years * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInYears($date = null, $absolute = true) { return (int) $this->diff($this->resolveCarbon($date), $absolute)->format('%r%y'); } /** * Get the difference in months * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInMonths($date = null, $absolute = true) { $date = $this->resolveCarbon($date); return $this->diffInYears($date, $absolute) * static::MONTHS_PER_YEAR + (int) $this->diff($date, $absolute)->format('%r%m'); } /** * Get the difference in weeks * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInWeeks($date = null, $absolute = true) { return (int) ($this->diffInDays($date, $absolute) / static::DAYS_PER_WEEK); } /** * Get the difference in days * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInDays($date = null, $absolute = true) { return (int) $this->diff($this->resolveCarbon($date), $absolute)->format('%r%a'); } /** * Get the difference in days using a filter closure * * @param Closure $callback * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInDaysFiltered(Closure $callback, $date = null, $absolute = true) { return $this->diffFiltered(CarbonInterval::day(), $callback, $date, $absolute); } /** * Get the difference in hours using a filter closure * * @param Closure $callback * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInHoursFiltered(Closure $callback, $date = null, $absolute = true) { return $this->diffFiltered(CarbonInterval::hour(), $callback, $date, $absolute); } /** * Get the difference by the given interval using a filter closure * * @param CarbonInterval $ci An interval to traverse by * @param Closure $callback * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffFiltered(CarbonInterval $ci, Closure $callback, $date = null, $absolute = true) { $start = $this; $end = $this->resolveCarbon($date); $inverse = false; if ($end < $start) { $start = $end; $end = $this; $inverse = true; } $period = new DatePeriod($start, $ci, $end); $values = array_filter(iterator_to_array($period), function ($date) use ($callback) { return call_user_func($callback, Carbon::instance($date)); }); $diff = count($values); return $inverse && !$absolute ? -$diff : $diff; } /** * Get the difference in weekdays * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInWeekdays($date = null, $absolute = true) { return $this->diffInDaysFiltered(function (Carbon $date) { return $date->isWeekday(); }, $date, $absolute); } /** * Get the difference in weekend days using a filter * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInWeekendDays($date = null, $absolute = true) { return $this->diffInDaysFiltered(function (Carbon $date) { return $date->isWeekend(); }, $date, $absolute); } /** * Get the difference in hours. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInHours($date = null, $absolute = true) { return (int) ($this->diffInSeconds($date, $absolute) / static::SECONDS_PER_MINUTE / static::MINUTES_PER_HOUR); } /** * Get the difference in hours using timestamps. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInRealHours($date = null, $absolute = true) { return (int) ($this->diffInRealSeconds($date, $absolute) / static::SECONDS_PER_MINUTE / static::MINUTES_PER_HOUR); } /** * Get the difference in minutes. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInMinutes($date = null, $absolute = true) { return (int) ($this->diffInSeconds($date, $absolute) / static::SECONDS_PER_MINUTE); } /** * Get the difference in minutes using timestamps. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInRealMinutes($date = null, $absolute = true) { return (int) ($this->diffInRealSeconds($date, $absolute) / static::SECONDS_PER_MINUTE); } /** * Get the difference in seconds. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInSeconds($date = null, $absolute = true) { $diff = $this->diff($this->resolveCarbon($date)); if (!$diff->days && version_compare(PHP_VERSION, '5.4.0-dev', '>=')) { $diff = static::fixDiffInterval($diff, $absolute, false); } $value = $diff->days * static::HOURS_PER_DAY * static::MINUTES_PER_HOUR * static::SECONDS_PER_MINUTE + $diff->h * static::MINUTES_PER_HOUR * static::SECONDS_PER_MINUTE + $diff->i * static::SECONDS_PER_MINUTE + $diff->s; return $absolute || !$diff->invert ? $value : -$value; } /** * Get the difference in seconds using timestamps. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInRealSeconds($date = null, $absolute = true) { $date = $this->resolveCarbon($date); $value = $date->getTimestamp() - $this->getTimestamp(); return $absolute ? abs($value) : $value; } /** * Get the difference in milliseconds. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInMilliseconds($date = null, $absolute = true) { return (int) ($this->diffInMicroseconds($date, $absolute) / static::MICROSECONDS_PER_MILLISECOND); } /** * Get the difference in milliseconds using timestamps. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInRealMilliseconds($date = null, $absolute = true) { return (int) ($this->diffInRealMicroseconds($date, $absolute) / static::MICROSECONDS_PER_MILLISECOND); } /** * Get the difference in microseconds. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInMicroseconds($date = null, $absolute = true) { $diff = $this->diff($this->resolveCarbon($date)); $micro = isset($diff->f) ? $diff->f : 0; $value = (int) round((((($diff->days * static::HOURS_PER_DAY) + $diff->h) * static::MINUTES_PER_HOUR + $diff->i) * static::SECONDS_PER_MINUTE + ($micro + $diff->s)) * static::MICROSECONDS_PER_SECOND); return $absolute || !$diff->invert ? $value : -$value; } /** * Get the difference in microseconds using timestamps. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * @param bool $absolute Get the absolute of the difference * * @return int */ public function diffInRealMicroseconds($date = null, $absolute = true) { /** @var Carbon $date */ $date = $this->resolveCarbon($date); $value = ($date->timestamp - $this->timestamp) * static::MICROSECONDS_PER_SECOND + $date->micro - $this->micro; return $absolute ? abs($value) : $value; } /** * The number of seconds since midnight. * * @return int */ public function secondsSinceMidnight() { return $this->diffInSeconds($this->copy()->startOfDay()); } /** * The number of seconds until 23:59:59. * * @return int */ public function secondsUntilEndOfDay() { return $this->diffInSeconds($this->copy()->endOfDay()); } /** * Get the difference in a human readable format in the current locale. * * When comparing a value in the past to default now: * 1 hour ago * 5 months ago * * When comparing a value in the future to default now: * 1 hour from now * 5 months from now * * When comparing a value in the past to another value: * 1 hour before * 5 months before * * When comparing a value in the future to another value: * 1 hour after * 5 months after * * @param Carbon|null $other * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function diffForHumans($other = null, $absolute = false, $short = false, $parts = 1) { $isNow = $other === null; $relativeToNow = $isNow; if ($absolute === static::DIFF_RELATIVE_TO_NOW) { $absolute = false; $relativeToNow = true; } elseif ($absolute === static::DIFF_RELATIVE_TO_OTHER) { $absolute = false; $relativeToNow = false; } $interval = array(); $parts = min(6, max(1, (int) $parts)); $count = 1; $unit = $short ? 's' : 'second'; if ($isNow) { $other = $this->nowWithSameTz(); } elseif (!$other instanceof DateTime && !$other instanceof DateTimeInterface) { $other = static::parse($other); } $diffInterval = $this->diff($other); $diffIntervalArray = array( array('value' => $diffInterval->y, 'unit' => 'year', 'unitShort' => 'y'), array('value' => $diffInterval->m, 'unit' => 'month', 'unitShort' => 'm'), array('value' => $diffInterval->d, 'unit' => 'day', 'unitShort' => 'd'), array('value' => $diffInterval->h, 'unit' => 'hour', 'unitShort' => 'h'), array('value' => $diffInterval->i, 'unit' => 'minute', 'unitShort' => 'min'), array('value' => $diffInterval->s, 'unit' => 'second', 'unitShort' => 's'), ); foreach ($diffIntervalArray as $diffIntervalData) { if ($diffIntervalData['value'] > 0) { $unit = $short ? $diffIntervalData['unitShort'] : $diffIntervalData['unit']; $count = $diffIntervalData['value']; if ($diffIntervalData['unit'] === 'day' && $count >= static::DAYS_PER_WEEK) { $unit = $short ? 'w' : 'week'; $count = (int) ($count / static::DAYS_PER_WEEK); $interval[] = static::translator()->transChoice($unit, $count, array(':count' => $count)); // get the count days excluding weeks (might be zero) $numOfDaysCount = (int) ($diffIntervalData['value'] - ($count * static::DAYS_PER_WEEK)); if ($numOfDaysCount > 0 && count($interval) < $parts) { $unit = $short ? 'd' : 'day'; $count = $numOfDaysCount; $interval[] = static::translator()->transChoice($unit, $count, array(':count' => $count)); } } else { $interval[] = static::translator()->transChoice($unit, $count, array(':count' => $count)); } } // break the loop after we get the required number of parts in array if (count($interval) >= $parts) { break; } } if (count($interval) === 0) { if ($isNow && static::getHumanDiffOptions() & self::JUST_NOW) { $key = 'diff_now'; $translation = static::translator()->trans($key); if ($translation !== $key) { return $translation; } } $count = static::getHumanDiffOptions() & self::NO_ZERO_DIFF ? 1 : 0; $unit = $short ? 's' : 'second'; $interval[] = static::translator()->transChoice($unit, $count, array(':count' => $count)); } // join the interval parts by a space $time = implode(' ', $interval); unset($diffIntervalArray, $interval); if ($absolute) { return $time; } $isFuture = $diffInterval->invert === 1; $transId = $relativeToNow ? ($isFuture ? 'from_now' : 'ago') : ($isFuture ? 'after' : 'before'); if ($parts === 1) { if ($isNow && $unit === 'day') { if ($count === 1 && static::getHumanDiffOptions() & self::ONE_DAY_WORDS) { $key = $isFuture ? 'diff_tomorrow' : 'diff_yesterday'; $translation = static::translator()->trans($key); if ($translation !== $key) { return $translation; } } if ($count === 2 && static::getHumanDiffOptions() & self::TWO_DAY_WORDS) { $key = $isFuture ? 'diff_after_tomorrow' : 'diff_before_yesterday'; $translation = static::translator()->trans($key); if ($translation !== $key) { return $translation; } } } // Some languages have special pluralization for past and future tense. $key = $unit.'_'.$transId; if ($key !== static::translator()->transChoice($key, $count)) { $time = static::translator()->transChoice($key, $count, array(':count' => $count)); } } return static::translator()->trans($transId, array(':time' => $time)); } /** * @alias diffForHumans * * Get the difference in a human readable format in the current locale. * * When comparing a value in the past to default now: * 1 hour ago * 5 months ago * * When comparing a value in the future to default now: * 1 hour from now * 5 months from now * * When comparing a value in the past to another value: * 1 hour before * 5 months before * * When comparing a value in the future to another value: * 1 hour after * 5 months after * * @param Carbon|null $other * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function from($other = null, $absolute = false, $short = false, $parts = 1) { if (!$other && !$absolute) { $absolute = static::DIFF_RELATIVE_TO_NOW; } return $this->diffForHumans($other, $absolute, $short, $parts); } /** * @alias diffForHumans * * Get the difference in a human readable format in the current locale. * * When comparing a value in the past to default now: * 1 hour ago * 5 months ago * * When comparing a value in the future to default now: * 1 hour from now * 5 months from now * * When comparing a value in the past to another value: * 1 hour before * 5 months before * * When comparing a value in the future to another value: * 1 hour after * 5 months after * * @param Carbon|null $other * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function since($other = null, $absolute = false, $short = false, $parts = 1) { return $this->diffForHumans($other, $absolute, $short, $parts); } /** * Get the difference in a human readable format in the current locale from an other * instance given (or now if null given) to current instance. * * When comparing a value in the past to default now: * 1 hour from now * 5 months from now * * When comparing a value in the future to default now: * 1 hour ago * 5 months ago * * When comparing a value in the past to another value: * 1 hour after * 5 months after * * When comparing a value in the future to another value: * 1 hour before * 5 months before * * @param Carbon|null $other * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function to($other = null, $absolute = false, $short = false, $parts = 1) { if (!$other && !$absolute) { $absolute = static::DIFF_RELATIVE_TO_NOW; } return $this->resolveCarbon($other)->diffForHumans($this, $absolute, $short, $parts); } /** * @alias to * * Get the difference in a human readable format in the current locale from an other * instance given (or now if null given) to current instance. * * @param Carbon|null $other * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function until($other = null, $absolute = false, $short = false, $parts = 1) { return $this->to($other, $absolute, $short, $parts); } /** * Get the difference in a human readable format in the current locale from current * instance to now. * * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function fromNow($absolute = null, $short = false, $parts = 1) { $other = null; if ($absolute instanceof DateTimeInterface) { list($other, $absolute, $short, $parts) = array_pad(func_get_args(), 5, null); } return $this->from($other, $absolute, $short, $parts); } /** * Get the difference in a human readable format in the current locale from an other * instance given to now * * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function toNow($absolute = null, $short = false, $parts = 1) { return $this->to(null, $absolute, $short, $parts); } /** * Get the difference in a human readable format in the current locale from an other * instance given to now * * @param bool $absolute removes time difference modifiers ago, after, etc * @param bool $short displays short format of time units * @param int $parts displays number of parts in the interval * * @return string */ public function ago($absolute = null, $short = false, $parts = 1) { $other = null; if ($absolute instanceof DateTimeInterface) { list($other, $absolute, $short, $parts) = array_pad(func_get_args(), 5, null); } return $this->from($other, $absolute, $short, $parts); } /////////////////////////////////////////////////////////////////// //////////////////////////// MODIFIERS //////////////////////////// /////////////////////////////////////////////////////////////////// /** * Resets the time to 00:00:00 start of day * * @return static */ public function startOfDay() { return $this->modify('00:00:00.000000'); } /** * Resets the time to 23:59:59 end of day * * @return static */ public function endOfDay() { return $this->modify('23:59:59.999999'); } /** * Resets the date to the first day of the month and the time to 00:00:00 * * @return static */ public function startOfMonth() { return $this->setDate($this->year, $this->month, 1)->startOfDay(); } /** * Resets the date to end of the month and time to 23:59:59 * * @return static */ public function endOfMonth() { return $this->setDate($this->year, $this->month, $this->daysInMonth)->endOfDay(); } /** * Resets the date to the first day of the quarter and the time to 00:00:00 * * @return static */ public function startOfQuarter() { $month = ($this->quarter - 1) * static::MONTHS_PER_QUARTER + 1; return $this->setDate($this->year, $month, 1)->startOfDay(); } /** * Resets the date to end of the quarter and time to 23:59:59 * * @return static */ public function endOfQuarter() { return $this->startOfQuarter()->addMonths(static::MONTHS_PER_QUARTER - 1)->endOfMonth(); } /** * Resets the date to the first day of the year and the time to 00:00:00 * * @return static */ public function startOfYear() { return $this->setDate($this->year, 1, 1)->startOfDay(); } /** * Resets the date to end of the year and time to 23:59:59 * * @return static */ public function endOfYear() { return $this->setDate($this->year, 12, 31)->endOfDay(); } /** * Resets the date to the first day of the decade and the time to 00:00:00 * * @return static */ public function startOfDecade() { $year = $this->year - $this->year % static::YEARS_PER_DECADE; return $this->setDate($year, 1, 1)->startOfDay(); } /** * Resets the date to end of the decade and time to 23:59:59 * * @return static */ public function endOfDecade() { $year = $this->year - $this->year % static::YEARS_PER_DECADE + static::YEARS_PER_DECADE - 1; return $this->setDate($year, 12, 31)->endOfDay(); } /** * Resets the date to the first day of the century and the time to 00:00:00 * * @return static */ public function startOfCentury() { $year = $this->year - ($this->year - 1) % static::YEARS_PER_CENTURY; return $this->setDate($year, 1, 1)->startOfDay(); } /** * Resets the date to end of the century and time to 23:59:59 * * @return static */ public function endOfCentury() { $year = $this->year - 1 - ($this->year - 1) % static::YEARS_PER_CENTURY + static::YEARS_PER_CENTURY; return $this->setDate($year, 12, 31)->endOfDay(); } /** * Resets the date to the first day of the century and the time to 00:00:00 * * @return static */ public function startOfMillennium() { $year = $this->year - ($this->year - 1) % static::YEARS_PER_MILLENNIUM; return $this->setDate($year, 1, 1)->startOfDay(); } /** * Resets the date to end of the century and time to 23:59:59 * * @return static */ public function endOfMillennium() { $year = $this->year - 1 - ($this->year - 1) % static::YEARS_PER_MILLENNIUM + static::YEARS_PER_MILLENNIUM; return $this->setDate($year, 12, 31)->endOfDay(); } /** * Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00 * * @return static */ public function startOfWeek() { while ($this->dayOfWeek !== static::$weekStartsAt) { $this->subDay(); } return $this->startOfDay(); } /** * Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59 * * @return static */ public function endOfWeek() { while ($this->dayOfWeek !== static::$weekEndsAt) { $this->addDay(); } return $this->endOfDay(); } /** * Modify to start of current hour, minutes and seconds become 0 * * @return static */ public function startOfHour() { return $this->setTime($this->hour, 0, 0); } /** * Modify to end of current hour, minutes and seconds become 59 * * @return static */ public function endOfHour() { return $this->modify("$this->hour:59:59.999999"); } /** * Modify to start of current minute, seconds become 0 * * @return static */ public function startOfMinute() { return $this->setTime($this->hour, $this->minute, 0); } /** * Modify to end of current minute, seconds become 59 * * @return static */ public function endOfMinute() { return $this->modify("$this->hour:$this->minute:59.999999"); } /** * Modify to start of current minute, seconds become 0 * * @return static */ public function startOfSecond() { return $this->modify("$this->hour:$this->minute:$this->second.0"); } /** * Modify to end of current minute, seconds become 59 * * @return static */ public function endOfSecond() { return $this->modify("$this->hour:$this->minute:$this->second.999999"); } /** * Modify to midday, default to self::$midDayAt * * @return static */ public function midDay() { return $this->setTime(self::$midDayAt, 0, 0); } /** * Modify to the next occurrence of a given day of the week. * If no dayOfWeek is provided, modify to the next occurrence * of the current day of the week. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek * * @return static */ public function next($dayOfWeek = null) { if ($dayOfWeek === null) { $dayOfWeek = $this->dayOfWeek; } return $this->startOfDay()->modify('next '.static::$days[$dayOfWeek]); } /** * Go forward or backward to the next week- or weekend-day. * * @param bool $weekday * @param bool $forward * * @return $this */ private function nextOrPreviousDay($weekday = true, $forward = true) { $step = $forward ? 1 : -1; do { $this->addDay($step); } while ($weekday ? $this->isWeekend() : $this->isWeekday()); return $this; } /** * Go forward to the next weekday. * * @return $this */ public function nextWeekday() { return $this->nextOrPreviousDay(); } /** * Go backward to the previous weekday. * * @return $this */ public function previousWeekday() { return $this->nextOrPreviousDay(true, false); } /** * Go forward to the next weekend day. * * @return $this */ public function nextWeekendDay() { return $this->nextOrPreviousDay(false); } /** * Go backward to the previous weekend day. * * @return $this */ public function previousWeekendDay() { return $this->nextOrPreviousDay(false, false); } /** * Modify to the previous occurrence of a given day of the week. * If no dayOfWeek is provided, modify to the previous occurrence * of the current day of the week. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek * * @return static */ public function previous($dayOfWeek = null) { if ($dayOfWeek === null) { $dayOfWeek = $this->dayOfWeek; } return $this->startOfDay()->modify('last '.static::$days[$dayOfWeek]); } /** * Modify to the first occurrence of a given day of the week * in the current month. If no dayOfWeek is provided, modify to the * first day of the current month. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek * * @return static */ public function firstOfMonth($dayOfWeek = null) { $this->startOfDay(); if ($dayOfWeek === null) { return $this->day(1); } return $this->modify('first '.static::$days[$dayOfWeek].' of '.$this->format('F').' '.$this->year); } /** * Modify to the last occurrence of a given day of the week * in the current month. If no dayOfWeek is provided, modify to the * last day of the current month. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek * * @return static */ public function lastOfMonth($dayOfWeek = null) { $this->startOfDay(); if ($dayOfWeek === null) { return $this->day($this->daysInMonth); } return $this->modify('last '.static::$days[$dayOfWeek].' of '.$this->format('F').' '.$this->year); } /** * Modify to the given occurrence of a given day of the week * in the current month. If the calculated occurrence is outside the scope * of the current month, then return false and no modifications are made. * Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int $nth * @param int $dayOfWeek * * @return mixed */ public function nthOfMonth($nth, $dayOfWeek) { $date = $this->copy()->firstOfMonth(); $check = $date->format('Y-m'); $date->modify('+'.$nth.' '.static::$days[$dayOfWeek]); return $date->format('Y-m') === $check ? $this->modify($date) : false; } /** * Modify to the first occurrence of a given day of the week * in the current quarter. If no dayOfWeek is provided, modify to the * first day of the current quarter. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek day of the week default null * * @return static */ public function firstOfQuarter($dayOfWeek = null) { return $this->setDate($this->year, $this->quarter * static::MONTHS_PER_QUARTER - 2, 1)->firstOfMonth($dayOfWeek); } /** * Modify to the last occurrence of a given day of the week * in the current quarter. If no dayOfWeek is provided, modify to the * last day of the current quarter. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek day of the week default null * * @return static */ public function lastOfQuarter($dayOfWeek = null) { return $this->setDate($this->year, $this->quarter * static::MONTHS_PER_QUARTER, 1)->lastOfMonth($dayOfWeek); } /** * Modify to the given occurrence of a given day of the week * in the current quarter. If the calculated occurrence is outside the scope * of the current quarter, then return false and no modifications are made. * Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int $nth * @param int $dayOfWeek * * @return mixed */ public function nthOfQuarter($nth, $dayOfWeek) { $date = $this->copy()->day(1)->month($this->quarter * static::MONTHS_PER_QUARTER); $lastMonth = $date->month; $year = $date->year; $date->firstOfQuarter()->modify('+'.$nth.' '.static::$days[$dayOfWeek]); return ($lastMonth < $date->month || $year !== $date->year) ? false : $this->modify($date); } /** * Modify to the first occurrence of a given day of the week * in the current year. If no dayOfWeek is provided, modify to the * first day of the current year. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek day of the week default null * * @return static */ public function firstOfYear($dayOfWeek = null) { return $this->month(1)->firstOfMonth($dayOfWeek); } /** * Modify to the last occurrence of a given day of the week * in the current year. If no dayOfWeek is provided, modify to the * last day of the current year. Use the supplied constants * to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int|null $dayOfWeek day of the week default null * * @return static */ public function lastOfYear($dayOfWeek = null) { return $this->month(static::MONTHS_PER_YEAR)->lastOfMonth($dayOfWeek); } /** * Modify to the given occurrence of a given day of the week * in the current year. If the calculated occurrence is outside the scope * of the current year, then return false and no modifications are made. * Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY. * * @param int $nth * @param int $dayOfWeek * * @return mixed */ public function nthOfYear($nth, $dayOfWeek) { $date = $this->copy()->firstOfYear()->modify('+'.$nth.' '.static::$days[$dayOfWeek]); return $this->year === $date->year ? $this->modify($date) : false; } /** * Modify the current instance to the average of a given instance (default now) and the current instance. * * @param \Carbon\Carbon|\DateTimeInterface|string|null $date * * @return static */ public function average($date = null) { $date = $this->resolveCarbon($date); $increment = $this->diffInRealSeconds($date, false) / 2; $intIncrement = floor($increment); $microIncrement = (int) (($date->micro - $this->micro) / 2 + 1000000 * ($increment - $intIncrement)); $micro = (int) ($this->micro + $microIncrement); while ($micro >= 1000000) { $micro -= 1000000; $intIncrement++; } $this->addSeconds($intIncrement); if (version_compare(PHP_VERSION, '7.1.8-dev', '>=')) { $this->setTime($this->hour, $this->minute, $this->second, $micro); } return $this; } /////////////////////////////////////////////////////////////////// /////////////////////////// SERIALIZATION ///////////////////////// /////////////////////////////////////////////////////////////////// /** * Return a serialized string of the instance. * * @return string */ public function serialize() { return serialize($this); } /** * Create an instance from a serialized string. * * @param string $value * * @throws \InvalidArgumentException * * @return static */ public static function fromSerialized($value) { $instance = @unserialize($value); if (!$instance instanceof static) { throw new InvalidArgumentException('Invalid serialized value.'); } return $instance; } /** * The __set_state handler. * * @param array $array * * @return static */ public static function __set_state($array) { return static::instance(parent::__set_state($array)); } /** * Prepare the object for JSON serialization. * * @return array|string */ public function jsonSerialize() { if (static::$serializer) { return call_user_func(static::$serializer, $this); } $carbon = $this; return call_user_func(function () use ($carbon) { return get_object_vars($carbon); }); } /** * JSON serialize all Carbon instances using the given callback. * * @param callable $callback * * @return void */ public static function serializeUsing($callback) { static::$serializer = $callback; } /////////////////////////////////////////////////////////////////// /////////////////////////////// MACRO ///////////////////////////// /////////////////////////////////////////////////////////////////// /** * Register a custom macro. * * @param string $name * @param object|callable $macro * * @return void */ public static function macro($name, $macro) { static::$localMacros[$name] = $macro; } /** * Remove all macros. */ public static function resetMacros() { static::$localMacros = array(); } /** * Mix another object into the class. * * @param object $mixin * * @return void */ public static function mixin($mixin) { $reflection = new \ReflectionClass($mixin); $methods = $reflection->getMethods( \ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED ); foreach ($methods as $method) { $method->setAccessible(true); static::macro($method->name, $method->invoke($mixin)); } } /** * Checks if macro is registered. * * @param string $name * * @return bool */ public static function hasMacro($name) { return isset(static::$localMacros[$name]); } /** * Dynamically handle calls to the class. * * @param string $method * @param array $parameters * * @throws \BadMethodCallException * * @return mixed */ public static function __callStatic($method, $parameters) { if (!static::hasMacro($method)) { throw new \BadMethodCallException("Method $method does not exist."); } if (static::$localMacros[$method] instanceof Closure && method_exists('Closure', 'bind')) { return call_user_func_array(Closure::bind(static::$localMacros[$method], null, get_called_class()), $parameters); } return call_user_func_array(static::$localMacros[$method], $parameters); } /** * Dynamically handle calls to the class. * * @param string $method * @param array $parameters * * @throws \BadMethodCallException|\ReflectionException * * @return mixed */ public function __call($method, $parameters) { if (!static::hasMacro($method)) { throw new \BadMethodCallException("Method $method does not exist."); } $macro = static::$localMacros[$method]; $reflexion = new \ReflectionFunction($macro); $reflectionParameters = $reflexion->getParameters(); $expectedCount = count($reflectionParameters); $actualCount = count($parameters); if ($expectedCount > $actualCount && $reflectionParameters[$expectedCount - 1]->name === 'self') { for ($i = $actualCount; $i < $expectedCount - 1; $i++) { $parameters[] = $reflectionParameters[$i]->getDefaultValue(); } $parameters[] = $this; } if ($macro instanceof Closure && method_exists($macro, 'bindTo')) { return call_user_func_array($macro->bindTo($this, get_class($this)), $parameters); } return call_user_func_array($macro, $parameters); } /** * Show truthy properties on var_dump(). * * @return array */ public function __debugInfo() { return array_filter(get_object_vars($this), function ($var) { return $var; }); } /** * Cast the current instance into the given class. * * @param string $className The $className::instance() method will be called to cast the current object. * * @return object */ public function cast($className) { if (!method_exists($className, 'instance')) { throw new \InvalidArgumentException("$className has not the instance() method needed to cast the date."); } return $className::instance($this); } }
Back