vendor/nesbot/carbon/src/Carbon/Carbon.php line 510

Open in your IDE?
  1. <?php
  2. /**
  3.  * This file is part of the Carbon package.
  4.  *
  5.  * (c) Brian Nesbitt <brian@nesbot.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Carbon;
  11. use Carbon\Traits\Date;
  12. use Carbon\Traits\DeprecatedProperties;
  13. use DateTime;
  14. use DateTimeInterface;
  15. use DateTimeZone;
  16. /**
  17.  * A simple API extension for DateTime.
  18.  *
  19.  * @mixin DeprecatedProperties
  20.  *
  21.  * <autodoc generated by `composer phpdoc`>
  22.  *
  23.  * @property      int                 $year
  24.  * @property      int                 $yearIso
  25.  * @property      int                 $month
  26.  * @property      int                 $day
  27.  * @property      int                 $hour
  28.  * @property      int                 $minute
  29.  * @property      int                 $second
  30.  * @property      int                 $micro
  31.  * @property      int                 $microsecond
  32.  * @property      int|float|string    $timestamp                                                                           seconds since the Unix Epoch
  33.  * @property      string              $englishDayOfWeek                                                                    the day of week in English
  34.  * @property      string              $shortEnglishDayOfWeek                                                               the abbreviated day of week in English
  35.  * @property      string              $englishMonth                                                                        the month in English
  36.  * @property      string              $shortEnglishMonth                                                                   the abbreviated month in English
  37.  * @property      int                 $milliseconds
  38.  * @property      int                 $millisecond
  39.  * @property      int                 $milli
  40.  * @property      int                 $week                                                                                1 through 53
  41.  * @property      int                 $isoWeek                                                                             1 through 53
  42.  * @property      int                 $weekYear                                                                            year according to week format
  43.  * @property      int                 $isoWeekYear                                                                         year according to ISO week format
  44.  * @property      int                 $dayOfYear                                                                           1 through 366
  45.  * @property      int                 $age                                                                                 does a diffInYears() with default parameters
  46.  * @property      int                 $offset                                                                              the timezone offset in seconds from UTC
  47.  * @property      int                 $offsetMinutes                                                                       the timezone offset in minutes from UTC
  48.  * @property      int                 $offsetHours                                                                         the timezone offset in hours from UTC
  49.  * @property      CarbonTimeZone      $timezone                                                                            the current timezone
  50.  * @property      CarbonTimeZone      $tz                                                                                  alias of $timezone
  51.  * @property-read int                 $dayOfWeek                                                                           0 (for Sunday) through 6 (for Saturday)
  52.  * @property-read int                 $dayOfWeekIso                                                                        1 (for Monday) through 7 (for Sunday)
  53.  * @property-read int                 $weekOfYear                                                                          ISO-8601 week number of year, weeks starting on Monday
  54.  * @property-read int                 $daysInMonth                                                                         number of days in the given month
  55.  * @property-read string              $latinMeridiem                                                                       "am"/"pm" (Ante meridiem or Post meridiem latin lowercase mark)
  56.  * @property-read string              $latinUpperMeridiem                                                                  "AM"/"PM" (Ante meridiem or Post meridiem latin uppercase mark)
  57.  * @property-read string              $timezoneAbbreviatedName                                                             the current timezone abbreviated name
  58.  * @property-read string              $tzAbbrName                                                                          alias of $timezoneAbbreviatedName
  59.  * @property-read string              $dayName                                                                             long name of weekday translated according to Carbon locale, in english if no translation available for current language
  60.  * @property-read string              $shortDayName                                                                        short name of weekday translated according to Carbon locale, in english if no translation available for current language
  61.  * @property-read string              $minDayName                                                                          very short name of weekday translated according to Carbon locale, in english if no translation available for current language
  62.  * @property-read string              $monthName                                                                           long name of month translated according to Carbon locale, in english if no translation available for current language
  63.  * @property-read string              $shortMonthName                                                                      short name of month translated according to Carbon locale, in english if no translation available for current language
  64.  * @property-read string              $meridiem                                                                            lowercase meridiem mark translated according to Carbon locale, in latin if no translation available for current language
  65.  * @property-read string              $upperMeridiem                                                                       uppercase meridiem mark translated according to Carbon locale, in latin if no translation available for current language
  66.  * @property-read int                 $noZeroHour                                                                          current hour from 1 to 24
  67.  * @property-read int                 $weeksInYear                                                                         51 through 53
  68.  * @property-read int                 $isoWeeksInYear                                                                      51 through 53
  69.  * @property-read int                 $weekOfMonth                                                                         1 through 5
  70.  * @property-read int                 $weekNumberInMonth                                                                   1 through 5
  71.  * @property-read int                 $firstWeekDay                                                                        0 through 6
  72.  * @property-read int                 $lastWeekDay                                                                         0 through 6
  73.  * @property-read int                 $daysInYear                                                                          365 or 366
  74.  * @property-read int                 $quarter                                                                             the quarter of this instance, 1 - 4
  75.  * @property-read int                 $decade                                                                              the decade of this instance
  76.  * @property-read int                 $century                                                                             the century of this instance
  77.  * @property-read int                 $millennium                                                                          the millennium of this instance
  78.  * @property-read bool                $dst                                                                                 daylight savings time indicator, true if DST, false otherwise
  79.  * @property-read bool                $local                                                                               checks if the timezone is local, true if local, false otherwise
  80.  * @property-read bool                $utc                                                                                 checks if the timezone is UTC, true if UTC, false otherwise
  81.  * @property-read string              $timezoneName                                                                        the current timezone name
  82.  * @property-read string              $tzName                                                                              alias of $timezoneName
  83.  * @property-read string              $locale                                                                              locale of the current instance
  84.  *
  85.  * @method        bool                isUtc()                                                                              Check if the current instance has UTC timezone. (Both isUtc and isUTC cases are valid.)
  86.  * @method        bool                isLocal()                                                                            Check if the current instance has non-UTC timezone.
  87.  * @method        bool                isValid()                                                                            Check if the current instance is a valid date.
  88.  * @method        bool                isDST()                                                                              Check if the current instance is in a daylight saving time.
  89.  * @method        bool                isSunday()                                                                           Checks if the instance day is sunday.
  90.  * @method        bool                isMonday()                                                                           Checks if the instance day is monday.
  91.  * @method        bool                isTuesday()                                                                          Checks if the instance day is tuesday.
  92.  * @method        bool                isWednesday()                                                                        Checks if the instance day is wednesday.
  93.  * @method        bool                isThursday()                                                                         Checks if the instance day is thursday.
  94.  * @method        bool                isFriday()                                                                           Checks if the instance day is friday.
  95.  * @method        bool                isSaturday()                                                                         Checks if the instance day is saturday.
  96.  * @method        bool                isSameYear(Carbon|DateTimeInterface|string|null $date = null)                        Checks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).
  97.  * @method        bool                isCurrentYear()                                                                      Checks if the instance is in the same year as the current moment.
  98.  * @method        bool                isNextYear()                                                                         Checks if the instance is in the same year as the current moment next year.
  99.  * @method        bool                isLastYear()                                                                         Checks if the instance is in the same year as the current moment last year.
  100.  * @method        bool                isSameWeek(Carbon|DateTimeInterface|string|null $date = null)                        Checks if the given date is in the same week as the instance. If null passed, compare to now (with the same timezone).
  101.  * @method        bool                isCurrentWeek()                                                                      Checks if the instance is in the same week as the current moment.
  102.  * @method        bool                isNextWeek()                                                                         Checks if the instance is in the same week as the current moment next week.
  103.  * @method        bool                isLastWeek()                                                                         Checks if the instance is in the same week as the current moment last week.
  104.  * @method        bool                isSameDay(Carbon|DateTimeInterface|string|null $date = null)                         Checks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).
  105.  * @method        bool                isCurrentDay()                                                                       Checks if the instance is in the same day as the current moment.
  106.  * @method        bool                isNextDay()                                                                          Checks if the instance is in the same day as the current moment next day.
  107.  * @method        bool                isLastDay()                                                                          Checks if the instance is in the same day as the current moment last day.
  108.  * @method        bool                isSameHour(Carbon|DateTimeInterface|string|null $date = null)                        Checks if the given date is in the same hour as the instance. If null passed, compare to now (with the same timezone).
  109.  * @method        bool                isCurrentHour()                                                                      Checks if the instance is in the same hour as the current moment.
  110.  * @method        bool                isNextHour()                                                                         Checks if the instance is in the same hour as the current moment next hour.
  111.  * @method        bool                isLastHour()                                                                         Checks if the instance is in the same hour as the current moment last hour.
  112.  * @method        bool                isSameMinute(Carbon|DateTimeInterface|string|null $date = null)                      Checks if the given date is in the same minute as the instance. If null passed, compare to now (with the same timezone).
  113.  * @method        bool                isCurrentMinute()                                                                    Checks if the instance is in the same minute as the current moment.
  114.  * @method        bool                isNextMinute()                                                                       Checks if the instance is in the same minute as the current moment next minute.
  115.  * @method        bool                isLastMinute()                                                                       Checks if the instance is in the same minute as the current moment last minute.
  116.  * @method        bool                isSameSecond(Carbon|DateTimeInterface|string|null $date = null)                      Checks if the given date is in the same second as the instance. If null passed, compare to now (with the same timezone).
  117.  * @method        bool                isCurrentSecond()                                                                    Checks if the instance is in the same second as the current moment.
  118.  * @method        bool                isNextSecond()                                                                       Checks if the instance is in the same second as the current moment next second.
  119.  * @method        bool                isLastSecond()                                                                       Checks if the instance is in the same second as the current moment last second.
  120.  * @method        bool                isSameMicro(Carbon|DateTimeInterface|string|null $date = null)                       Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).
  121.  * @method        bool                isCurrentMicro()                                                                     Checks if the instance is in the same microsecond as the current moment.
  122.  * @method        bool                isNextMicro()                                                                        Checks if the instance is in the same microsecond as the current moment next microsecond.
  123.  * @method        bool                isLastMicro()                                                                        Checks if the instance is in the same microsecond as the current moment last microsecond.
  124.  * @method        bool                isSameMicrosecond(Carbon|DateTimeInterface|string|null $date = null)                 Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).
  125.  * @method        bool                isCurrentMicrosecond()                                                               Checks if the instance is in the same microsecond as the current moment.
  126.  * @method        bool                isNextMicrosecond()                                                                  Checks if the instance is in the same microsecond as the current moment next microsecond.
  127.  * @method        bool                isLastMicrosecond()                                                                  Checks if the instance is in the same microsecond as the current moment last microsecond.
  128.  * @method        bool                isCurrentMonth()                                                                     Checks if the instance is in the same month as the current moment.
  129.  * @method        bool                isNextMonth()                                                                        Checks if the instance is in the same month as the current moment next month.
  130.  * @method        bool                isLastMonth()                                                                        Checks if the instance is in the same month as the current moment last month.
  131.  * @method        bool                isCurrentQuarter()                                                                   Checks if the instance is in the same quarter as the current moment.
  132.  * @method        bool                isNextQuarter()                                                                      Checks if the instance is in the same quarter as the current moment next quarter.
  133.  * @method        bool                isLastQuarter()                                                                      Checks if the instance is in the same quarter as the current moment last quarter.
  134.  * @method        bool                isSameDecade(Carbon|DateTimeInterface|string|null $date = null)                      Checks if the given date is in the same decade as the instance. If null passed, compare to now (with the same timezone).
  135.  * @method        bool                isCurrentDecade()                                                                    Checks if the instance is in the same decade as the current moment.
  136.  * @method        bool                isNextDecade()                                                                       Checks if the instance is in the same decade as the current moment next decade.
  137.  * @method        bool                isLastDecade()                                                                       Checks if the instance is in the same decade as the current moment last decade.
  138.  * @method        bool                isSameCentury(Carbon|DateTimeInterface|string|null $date = null)                     Checks if the given date is in the same century as the instance. If null passed, compare to now (with the same timezone).
  139.  * @method        bool                isCurrentCentury()                                                                   Checks if the instance is in the same century as the current moment.
  140.  * @method        bool                isNextCentury()                                                                      Checks if the instance is in the same century as the current moment next century.
  141.  * @method        bool                isLastCentury()                                                                      Checks if the instance is in the same century as the current moment last century.
  142.  * @method        bool                isSameMillennium(Carbon|DateTimeInterface|string|null $date = null)                  Checks if the given date is in the same millennium as the instance. If null passed, compare to now (with the same timezone).
  143.  * @method        bool                isCurrentMillennium()                                                                Checks if the instance is in the same millennium as the current moment.
  144.  * @method        bool                isNextMillennium()                                                                   Checks if the instance is in the same millennium as the current moment next millennium.
  145.  * @method        bool                isLastMillennium()                                                                   Checks if the instance is in the same millennium as the current moment last millennium.
  146.  * @method        $this               years(int $value)                                                                    Set current instance year to the given value.
  147.  * @method        $this               year(int $value)                                                                     Set current instance year to the given value.
  148.  * @method        $this               setYears(int $value)                                                                 Set current instance year to the given value.
  149.  * @method        $this               setYear(int $value)                                                                  Set current instance year to the given value.
  150.  * @method        $this               months(int $value)                                                                   Set current instance month to the given value.
  151.  * @method        $this               month(int $value)                                                                    Set current instance month to the given value.
  152.  * @method        $this               setMonths(int $value)                                                                Set current instance month to the given value.
  153.  * @method        $this               setMonth(int $value)                                                                 Set current instance month to the given value.
  154.  * @method        $this               days(int $value)                                                                     Set current instance day to the given value.
  155.  * @method        $this               day(int $value)                                                                      Set current instance day to the given value.
  156.  * @method        $this               setDays(int $value)                                                                  Set current instance day to the given value.
  157.  * @method        $this               setDay(int $value)                                                                   Set current instance day to the given value.
  158.  * @method        $this               hours(int $value)                                                                    Set current instance hour to the given value.
  159.  * @method        $this               hour(int $value)                                                                     Set current instance hour to the given value.
  160.  * @method        $this               setHours(int $value)                                                                 Set current instance hour to the given value.
  161.  * @method        $this               setHour(int $value)                                                                  Set current instance hour to the given value.
  162.  * @method        $this               minutes(int $value)                                                                  Set current instance minute to the given value.
  163.  * @method        $this               minute(int $value)                                                                   Set current instance minute to the given value.
  164.  * @method        $this               setMinutes(int $value)                                                               Set current instance minute to the given value.
  165.  * @method        $this               setMinute(int $value)                                                                Set current instance minute to the given value.
  166.  * @method        $this               seconds(int $value)                                                                  Set current instance second to the given value.
  167.  * @method        $this               second(int $value)                                                                   Set current instance second to the given value.
  168.  * @method        $this               setSeconds(int $value)                                                               Set current instance second to the given value.
  169.  * @method        $this               setSecond(int $value)                                                                Set current instance second to the given value.
  170.  * @method        $this               millis(int $value)                                                                   Set current instance millisecond to the given value.
  171.  * @method        $this               milli(int $value)                                                                    Set current instance millisecond to the given value.
  172.  * @method        $this               setMillis(int $value)                                                                Set current instance millisecond to the given value.
  173.  * @method        $this               setMilli(int $value)                                                                 Set current instance millisecond to the given value.
  174.  * @method        $this               milliseconds(int $value)                                                             Set current instance millisecond to the given value.
  175.  * @method        $this               millisecond(int $value)                                                              Set current instance millisecond to the given value.
  176.  * @method        $this               setMilliseconds(int $value)                                                          Set current instance millisecond to the given value.
  177.  * @method        $this               setMillisecond(int $value)                                                           Set current instance millisecond to the given value.
  178.  * @method        $this               micros(int $value)                                                                   Set current instance microsecond to the given value.
  179.  * @method        $this               micro(int $value)                                                                    Set current instance microsecond to the given value.
  180.  * @method        $this               setMicros(int $value)                                                                Set current instance microsecond to the given value.
  181.  * @method        $this               setMicro(int $value)                                                                 Set current instance microsecond to the given value.
  182.  * @method        $this               microseconds(int $value)                                                             Set current instance microsecond to the given value.
  183.  * @method        $this               microsecond(int $value)                                                              Set current instance microsecond to the given value.
  184.  * @method        $this               setMicroseconds(int $value)                                                          Set current instance microsecond to the given value.
  185.  * @method        $this               setMicrosecond(int $value)                                                           Set current instance microsecond to the given value.
  186.  * @method        $this               addYears(int $value = 1)                                                             Add years (the $value count passed in) to the instance (using date interval).
  187.  * @method        $this               addYear()                                                                            Add one year to the instance (using date interval).
  188.  * @method        $this               subYears(int $value = 1)                                                             Sub years (the $value count passed in) to the instance (using date interval).
  189.  * @method        $this               subYear()                                                                            Sub one year to the instance (using date interval).
  190.  * @method        $this               addYearsWithOverflow(int $value = 1)                                                 Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  191.  * @method        $this               addYearWithOverflow()                                                                Add one year to the instance (using date interval) with overflow explicitly allowed.
  192.  * @method        $this               subYearsWithOverflow(int $value = 1)                                                 Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  193.  * @method        $this               subYearWithOverflow()                                                                Sub one year to the instance (using date interval) with overflow explicitly allowed.
  194.  * @method        $this               addYearsWithoutOverflow(int $value = 1)                                              Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  195.  * @method        $this               addYearWithoutOverflow()                                                             Add one year to the instance (using date interval) with overflow explicitly forbidden.
  196.  * @method        $this               subYearsWithoutOverflow(int $value = 1)                                              Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  197.  * @method        $this               subYearWithoutOverflow()                                                             Sub one year to the instance (using date interval) with overflow explicitly forbidden.
  198.  * @method        $this               addYearsWithNoOverflow(int $value = 1)                                               Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  199.  * @method        $this               addYearWithNoOverflow()                                                              Add one year to the instance (using date interval) with overflow explicitly forbidden.
  200.  * @method        $this               subYearsWithNoOverflow(int $value = 1)                                               Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  201.  * @method        $this               subYearWithNoOverflow()                                                              Sub one year to the instance (using date interval) with overflow explicitly forbidden.
  202.  * @method        $this               addYearsNoOverflow(int $value = 1)                                                   Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  203.  * @method        $this               addYearNoOverflow()                                                                  Add one year to the instance (using date interval) with overflow explicitly forbidden.
  204.  * @method        $this               subYearsNoOverflow(int $value = 1)                                                   Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  205.  * @method        $this               subYearNoOverflow()                                                                  Sub one year to the instance (using date interval) with overflow explicitly forbidden.
  206.  * @method        $this               addMonths(int $value = 1)                                                            Add months (the $value count passed in) to the instance (using date interval).
  207.  * @method        $this               addMonth()                                                                           Add one month to the instance (using date interval).
  208.  * @method        $this               subMonths(int $value = 1)                                                            Sub months (the $value count passed in) to the instance (using date interval).
  209.  * @method        $this               subMonth()                                                                           Sub one month to the instance (using date interval).
  210.  * @method        $this               addMonthsWithOverflow(int $value = 1)                                                Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  211.  * @method        $this               addMonthWithOverflow()                                                               Add one month to the instance (using date interval) with overflow explicitly allowed.
  212.  * @method        $this               subMonthsWithOverflow(int $value = 1)                                                Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  213.  * @method        $this               subMonthWithOverflow()                                                               Sub one month to the instance (using date interval) with overflow explicitly allowed.
  214.  * @method        $this               addMonthsWithoutOverflow(int $value = 1)                                             Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  215.  * @method        $this               addMonthWithoutOverflow()                                                            Add one month to the instance (using date interval) with overflow explicitly forbidden.
  216.  * @method        $this               subMonthsWithoutOverflow(int $value = 1)                                             Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  217.  * @method        $this               subMonthWithoutOverflow()                                                            Sub one month to the instance (using date interval) with overflow explicitly forbidden.
  218.  * @method        $this               addMonthsWithNoOverflow(int $value = 1)                                              Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  219.  * @method        $this               addMonthWithNoOverflow()                                                             Add one month to the instance (using date interval) with overflow explicitly forbidden.
  220.  * @method        $this               subMonthsWithNoOverflow(int $value = 1)                                              Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  221.  * @method        $this               subMonthWithNoOverflow()                                                             Sub one month to the instance (using date interval) with overflow explicitly forbidden.
  222.  * @method        $this               addMonthsNoOverflow(int $value = 1)                                                  Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  223.  * @method        $this               addMonthNoOverflow()                                                                 Add one month to the instance (using date interval) with overflow explicitly forbidden.
  224.  * @method        $this               subMonthsNoOverflow(int $value = 1)                                                  Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  225.  * @method        $this               subMonthNoOverflow()                                                                 Sub one month to the instance (using date interval) with overflow explicitly forbidden.
  226.  * @method        $this               addDays(int $value = 1)                                                              Add days (the $value count passed in) to the instance (using date interval).
  227.  * @method        $this               addDay()                                                                             Add one day to the instance (using date interval).
  228.  * @method        $this               subDays(int $value = 1)                                                              Sub days (the $value count passed in) to the instance (using date interval).
  229.  * @method        $this               subDay()                                                                             Sub one day to the instance (using date interval).
  230.  * @method        $this               addHours(int $value = 1)                                                             Add hours (the $value count passed in) to the instance (using date interval).
  231.  * @method        $this               addHour()                                                                            Add one hour to the instance (using date interval).
  232.  * @method        $this               subHours(int $value = 1)                                                             Sub hours (the $value count passed in) to the instance (using date interval).
  233.  * @method        $this               subHour()                                                                            Sub one hour to the instance (using date interval).
  234.  * @method        $this               addMinutes(int $value = 1)                                                           Add minutes (the $value count passed in) to the instance (using date interval).
  235.  * @method        $this               addMinute()                                                                          Add one minute to the instance (using date interval).
  236.  * @method        $this               subMinutes(int $value = 1)                                                           Sub minutes (the $value count passed in) to the instance (using date interval).
  237.  * @method        $this               subMinute()                                                                          Sub one minute to the instance (using date interval).
  238.  * @method        $this               addSeconds(int $value = 1)                                                           Add seconds (the $value count passed in) to the instance (using date interval).
  239.  * @method        $this               addSecond()                                                                          Add one second to the instance (using date interval).
  240.  * @method        $this               subSeconds(int $value = 1)                                                           Sub seconds (the $value count passed in) to the instance (using date interval).
  241.  * @method        $this               subSecond()                                                                          Sub one second to the instance (using date interval).
  242.  * @method        $this               addMillis(int $value = 1)                                                            Add milliseconds (the $value count passed in) to the instance (using date interval).
  243.  * @method        $this               addMilli()                                                                           Add one millisecond to the instance (using date interval).
  244.  * @method        $this               subMillis(int $value = 1)                                                            Sub milliseconds (the $value count passed in) to the instance (using date interval).
  245.  * @method        $this               subMilli()                                                                           Sub one millisecond to the instance (using date interval).
  246.  * @method        $this               addMilliseconds(int $value = 1)                                                      Add milliseconds (the $value count passed in) to the instance (using date interval).
  247.  * @method        $this               addMillisecond()                                                                     Add one millisecond to the instance (using date interval).
  248.  * @method        $this               subMilliseconds(int $value = 1)                                                      Sub milliseconds (the $value count passed in) to the instance (using date interval).
  249.  * @method        $this               subMillisecond()                                                                     Sub one millisecond to the instance (using date interval).
  250.  * @method        $this               addMicros(int $value = 1)                                                            Add microseconds (the $value count passed in) to the instance (using date interval).
  251.  * @method        $this               addMicro()                                                                           Add one microsecond to the instance (using date interval).
  252.  * @method        $this               subMicros(int $value = 1)                                                            Sub microseconds (the $value count passed in) to the instance (using date interval).
  253.  * @method        $this               subMicro()                                                                           Sub one microsecond to the instance (using date interval).
  254.  * @method        $this               addMicroseconds(int $value = 1)                                                      Add microseconds (the $value count passed in) to the instance (using date interval).
  255.  * @method        $this               addMicrosecond()                                                                     Add one microsecond to the instance (using date interval).
  256.  * @method        $this               subMicroseconds(int $value = 1)                                                      Sub microseconds (the $value count passed in) to the instance (using date interval).
  257.  * @method        $this               subMicrosecond()                                                                     Sub one microsecond to the instance (using date interval).
  258.  * @method        $this               addMillennia(int $value = 1)                                                         Add millennia (the $value count passed in) to the instance (using date interval).
  259.  * @method        $this               addMillennium()                                                                      Add one millennium to the instance (using date interval).
  260.  * @method        $this               subMillennia(int $value = 1)                                                         Sub millennia (the $value count passed in) to the instance (using date interval).
  261.  * @method        $this               subMillennium()                                                                      Sub one millennium to the instance (using date interval).
  262.  * @method        $this               addMillenniaWithOverflow(int $value = 1)                                             Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  263.  * @method        $this               addMillenniumWithOverflow()                                                          Add one millennium to the instance (using date interval) with overflow explicitly allowed.
  264.  * @method        $this               subMillenniaWithOverflow(int $value = 1)                                             Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  265.  * @method        $this               subMillenniumWithOverflow()                                                          Sub one millennium to the instance (using date interval) with overflow explicitly allowed.
  266.  * @method        $this               addMillenniaWithoutOverflow(int $value = 1)                                          Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  267.  * @method        $this               addMillenniumWithoutOverflow()                                                       Add one millennium to the instance (using date interval) with overflow explicitly forbidden.
  268.  * @method        $this               subMillenniaWithoutOverflow(int $value = 1)                                          Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  269.  * @method        $this               subMillenniumWithoutOverflow()                                                       Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.
  270.  * @method        $this               addMillenniaWithNoOverflow(int $value = 1)                                           Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  271.  * @method        $this               addMillenniumWithNoOverflow()                                                        Add one millennium to the instance (using date interval) with overflow explicitly forbidden.
  272.  * @method        $this               subMillenniaWithNoOverflow(int $value = 1)                                           Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  273.  * @method        $this               subMillenniumWithNoOverflow()                                                        Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.
  274.  * @method        $this               addMillenniaNoOverflow(int $value = 1)                                               Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  275.  * @method        $this               addMillenniumNoOverflow()                                                            Add one millennium to the instance (using date interval) with overflow explicitly forbidden.
  276.  * @method        $this               subMillenniaNoOverflow(int $value = 1)                                               Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  277.  * @method        $this               subMillenniumNoOverflow()                                                            Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.
  278.  * @method        $this               addCenturies(int $value = 1)                                                         Add centuries (the $value count passed in) to the instance (using date interval).
  279.  * @method        $this               addCentury()                                                                         Add one century to the instance (using date interval).
  280.  * @method        $this               subCenturies(int $value = 1)                                                         Sub centuries (the $value count passed in) to the instance (using date interval).
  281.  * @method        $this               subCentury()                                                                         Sub one century to the instance (using date interval).
  282.  * @method        $this               addCenturiesWithOverflow(int $value = 1)                                             Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  283.  * @method        $this               addCenturyWithOverflow()                                                             Add one century to the instance (using date interval) with overflow explicitly allowed.
  284.  * @method        $this               subCenturiesWithOverflow(int $value = 1)                                             Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  285.  * @method        $this               subCenturyWithOverflow()                                                             Sub one century to the instance (using date interval) with overflow explicitly allowed.
  286.  * @method        $this               addCenturiesWithoutOverflow(int $value = 1)                                          Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  287.  * @method        $this               addCenturyWithoutOverflow()                                                          Add one century to the instance (using date interval) with overflow explicitly forbidden.
  288.  * @method        $this               subCenturiesWithoutOverflow(int $value = 1)                                          Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  289.  * @method        $this               subCenturyWithoutOverflow()                                                          Sub one century to the instance (using date interval) with overflow explicitly forbidden.
  290.  * @method        $this               addCenturiesWithNoOverflow(int $value = 1)                                           Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  291.  * @method        $this               addCenturyWithNoOverflow()                                                           Add one century to the instance (using date interval) with overflow explicitly forbidden.
  292.  * @method        $this               subCenturiesWithNoOverflow(int $value = 1)                                           Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  293.  * @method        $this               subCenturyWithNoOverflow()                                                           Sub one century to the instance (using date interval) with overflow explicitly forbidden.
  294.  * @method        $this               addCenturiesNoOverflow(int $value = 1)                                               Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  295.  * @method        $this               addCenturyNoOverflow()                                                               Add one century to the instance (using date interval) with overflow explicitly forbidden.
  296.  * @method        $this               subCenturiesNoOverflow(int $value = 1)                                               Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  297.  * @method        $this               subCenturyNoOverflow()                                                               Sub one century to the instance (using date interval) with overflow explicitly forbidden.
  298.  * @method        $this               addDecades(int $value = 1)                                                           Add decades (the $value count passed in) to the instance (using date interval).
  299.  * @method        $this               addDecade()                                                                          Add one decade to the instance (using date interval).
  300.  * @method        $this               subDecades(int $value = 1)                                                           Sub decades (the $value count passed in) to the instance (using date interval).
  301.  * @method        $this               subDecade()                                                                          Sub one decade to the instance (using date interval).
  302.  * @method        $this               addDecadesWithOverflow(int $value = 1)                                               Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  303.  * @method        $this               addDecadeWithOverflow()                                                              Add one decade to the instance (using date interval) with overflow explicitly allowed.
  304.  * @method        $this               subDecadesWithOverflow(int $value = 1)                                               Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  305.  * @method        $this               subDecadeWithOverflow()                                                              Sub one decade to the instance (using date interval) with overflow explicitly allowed.
  306.  * @method        $this               addDecadesWithoutOverflow(int $value = 1)                                            Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  307.  * @method        $this               addDecadeWithoutOverflow()                                                           Add one decade to the instance (using date interval) with overflow explicitly forbidden.
  308.  * @method        $this               subDecadesWithoutOverflow(int $value = 1)                                            Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  309.  * @method        $this               subDecadeWithoutOverflow()                                                           Sub one decade to the instance (using date interval) with overflow explicitly forbidden.
  310.  * @method        $this               addDecadesWithNoOverflow(int $value = 1)                                             Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  311.  * @method        $this               addDecadeWithNoOverflow()                                                            Add one decade to the instance (using date interval) with overflow explicitly forbidden.
  312.  * @method        $this               subDecadesWithNoOverflow(int $value = 1)                                             Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  313.  * @method        $this               subDecadeWithNoOverflow()                                                            Sub one decade to the instance (using date interval) with overflow explicitly forbidden.
  314.  * @method        $this               addDecadesNoOverflow(int $value = 1)                                                 Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  315.  * @method        $this               addDecadeNoOverflow()                                                                Add one decade to the instance (using date interval) with overflow explicitly forbidden.
  316.  * @method        $this               subDecadesNoOverflow(int $value = 1)                                                 Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  317.  * @method        $this               subDecadeNoOverflow()                                                                Sub one decade to the instance (using date interval) with overflow explicitly forbidden.
  318.  * @method        $this               addQuarters(int $value = 1)                                                          Add quarters (the $value count passed in) to the instance (using date interval).
  319.  * @method        $this               addQuarter()                                                                         Add one quarter to the instance (using date interval).
  320.  * @method        $this               subQuarters(int $value = 1)                                                          Sub quarters (the $value count passed in) to the instance (using date interval).
  321.  * @method        $this               subQuarter()                                                                         Sub one quarter to the instance (using date interval).
  322.  * @method        $this               addQuartersWithOverflow(int $value = 1)                                              Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  323.  * @method        $this               addQuarterWithOverflow()                                                             Add one quarter to the instance (using date interval) with overflow explicitly allowed.
  324.  * @method        $this               subQuartersWithOverflow(int $value = 1)                                              Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
  325.  * @method        $this               subQuarterWithOverflow()                                                             Sub one quarter to the instance (using date interval) with overflow explicitly allowed.
  326.  * @method        $this               addQuartersWithoutOverflow(int $value = 1)                                           Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  327.  * @method        $this               addQuarterWithoutOverflow()                                                          Add one quarter to the instance (using date interval) with overflow explicitly forbidden.
  328.  * @method        $this               subQuartersWithoutOverflow(int $value = 1)                                           Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  329.  * @method        $this               subQuarterWithoutOverflow()                                                          Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.
  330.  * @method        $this               addQuartersWithNoOverflow(int $value = 1)                                            Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  331.  * @method        $this               addQuarterWithNoOverflow()                                                           Add one quarter to the instance (using date interval) with overflow explicitly forbidden.
  332.  * @method        $this               subQuartersWithNoOverflow(int $value = 1)                                            Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  333.  * @method        $this               subQuarterWithNoOverflow()                                                           Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.
  334.  * @method        $this               addQuartersNoOverflow(int $value = 1)                                                Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  335.  * @method        $this               addQuarterNoOverflow()                                                               Add one quarter to the instance (using date interval) with overflow explicitly forbidden.
  336.  * @method        $this               subQuartersNoOverflow(int $value = 1)                                                Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
  337.  * @method        $this               subQuarterNoOverflow()                                                               Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.
  338.  * @method        $this               addWeeks(int $value = 1)                                                             Add weeks (the $value count passed in) to the instance (using date interval).
  339.  * @method        $this               addWeek()                                                                            Add one week to the instance (using date interval).
  340.  * @method        $this               subWeeks(int $value = 1)                                                             Sub weeks (the $value count passed in) to the instance (using date interval).
  341.  * @method        $this               subWeek()                                                                            Sub one week to the instance (using date interval).
  342.  * @method        $this               addWeekdays(int $value = 1)                                                          Add weekdays (the $value count passed in) to the instance (using date interval).
  343.  * @method        $this               addWeekday()                                                                         Add one weekday to the instance (using date interval).
  344.  * @method        $this               subWeekdays(int $value = 1)                                                          Sub weekdays (the $value count passed in) to the instance (using date interval).
  345.  * @method        $this               subWeekday()                                                                         Sub one weekday to the instance (using date interval).
  346.  * @method        $this               addRealMicros(int $value = 1)                                                        Add microseconds (the $value count passed in) to the instance (using timestamp).
  347.  * @method        $this               addRealMicro()                                                                       Add one microsecond to the instance (using timestamp).
  348.  * @method        $this               subRealMicros(int $value = 1)                                                        Sub microseconds (the $value count passed in) to the instance (using timestamp).
  349.  * @method        $this               subRealMicro()                                                                       Sub one microsecond to the instance (using timestamp).
  350.  * @method        CarbonPeriod        microsUntil($endDate = null, int $factor = 1)                                        Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.
  351.  * @method        $this               addRealMicroseconds(int $value = 1)                                                  Add microseconds (the $value count passed in) to the instance (using timestamp).
  352.  * @method        $this               addRealMicrosecond()                                                                 Add one microsecond to the instance (using timestamp).
  353.  * @method        $this               subRealMicroseconds(int $value = 1)                                                  Sub microseconds (the $value count passed in) to the instance (using timestamp).
  354.  * @method        $this               subRealMicrosecond()                                                                 Sub one microsecond to the instance (using timestamp).
  355.  * @method        CarbonPeriod        microsecondsUntil($endDate = null, int $factor = 1)                                  Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.
  356.  * @method        $this               addRealMillis(int $value = 1)                                                        Add milliseconds (the $value count passed in) to the instance (using timestamp).
  357.  * @method        $this               addRealMilli()                                                                       Add one millisecond to the instance (using timestamp).
  358.  * @method        $this               subRealMillis(int $value = 1)                                                        Sub milliseconds (the $value count passed in) to the instance (using timestamp).
  359.  * @method        $this               subRealMilli()                                                                       Sub one millisecond to the instance (using timestamp).
  360.  * @method        CarbonPeriod        millisUntil($endDate = null, int $factor = 1)                                        Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.
  361.  * @method        $this               addRealMilliseconds(int $value = 1)                                                  Add milliseconds (the $value count passed in) to the instance (using timestamp).
  362.  * @method        $this               addRealMillisecond()                                                                 Add one millisecond to the instance (using timestamp).
  363.  * @method        $this               subRealMilliseconds(int $value = 1)                                                  Sub milliseconds (the $value count passed in) to the instance (using timestamp).
  364.  * @method        $this               subRealMillisecond()                                                                 Sub one millisecond to the instance (using timestamp).
  365.  * @method        CarbonPeriod        millisecondsUntil($endDate = null, int $factor = 1)                                  Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.
  366.  * @method        $this               addRealSeconds(int $value = 1)                                                       Add seconds (the $value count passed in) to the instance (using timestamp).
  367.  * @method        $this               addRealSecond()                                                                      Add one second to the instance (using timestamp).
  368.  * @method        $this               subRealSeconds(int $value = 1)                                                       Sub seconds (the $value count passed in) to the instance (using timestamp).
  369.  * @method        $this               subRealSecond()                                                                      Sub one second to the instance (using timestamp).
  370.  * @method        CarbonPeriod        secondsUntil($endDate = null, int $factor = 1)                                       Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each second or every X seconds if a factor is given.
  371.  * @method        $this               addRealMinutes(int $value = 1)                                                       Add minutes (the $value count passed in) to the instance (using timestamp).
  372.  * @method        $this               addRealMinute()                                                                      Add one minute to the instance (using timestamp).
  373.  * @method        $this               subRealMinutes(int $value = 1)                                                       Sub minutes (the $value count passed in) to the instance (using timestamp).
  374.  * @method        $this               subRealMinute()                                                                      Sub one minute to the instance (using timestamp).
  375.  * @method        CarbonPeriod        minutesUntil($endDate = null, int $factor = 1)                                       Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each minute or every X minutes if a factor is given.
  376.  * @method        $this               addRealHours(int $value = 1)                                                         Add hours (the $value count passed in) to the instance (using timestamp).
  377.  * @method        $this               addRealHour()                                                                        Add one hour to the instance (using timestamp).
  378.  * @method        $this               subRealHours(int $value = 1)                                                         Sub hours (the $value count passed in) to the instance (using timestamp).
  379.  * @method        $this               subRealHour()                                                                        Sub one hour to the instance (using timestamp).
  380.  * @method        CarbonPeriod        hoursUntil($endDate = null, int $factor = 1)                                         Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each hour or every X hours if a factor is given.
  381.  * @method        $this               addRealDays(int $value = 1)                                                          Add days (the $value count passed in) to the instance (using timestamp).
  382.  * @method        $this               addRealDay()                                                                         Add one day to the instance (using timestamp).
  383.  * @method        $this               subRealDays(int $value = 1)                                                          Sub days (the $value count passed in) to the instance (using timestamp).
  384.  * @method        $this               subRealDay()                                                                         Sub one day to the instance (using timestamp).
  385.  * @method        CarbonPeriod        daysUntil($endDate = null, int $factor = 1)                                          Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each day or every X days if a factor is given.
  386.  * @method        $this               addRealWeeks(int $value = 1)                                                         Add weeks (the $value count passed in) to the instance (using timestamp).
  387.  * @method        $this               addRealWeek()                                                                        Add one week to the instance (using timestamp).
  388.  * @method        $this               subRealWeeks(int $value = 1)                                                         Sub weeks (the $value count passed in) to the instance (using timestamp).
  389.  * @method        $this               subRealWeek()                                                                        Sub one week to the instance (using timestamp).
  390.  * @method        CarbonPeriod        weeksUntil($endDate = null, int $factor = 1)                                         Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each week or every X weeks if a factor is given.
  391.  * @method        $this               addRealMonths(int $value = 1)                                                        Add months (the $value count passed in) to the instance (using timestamp).
  392.  * @method        $this               addRealMonth()                                                                       Add one month to the instance (using timestamp).
  393.  * @method        $this               subRealMonths(int $value = 1)                                                        Sub months (the $value count passed in) to the instance (using timestamp).
  394.  * @method        $this               subRealMonth()                                                                       Sub one month to the instance (using timestamp).
  395.  * @method        CarbonPeriod        monthsUntil($endDate = null, int $factor = 1)                                        Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each month or every X months if a factor is given.
  396.  * @method        $this               addRealQuarters(int $value = 1)                                                      Add quarters (the $value count passed in) to the instance (using timestamp).
  397.  * @method        $this               addRealQuarter()                                                                     Add one quarter to the instance (using timestamp).
  398.  * @method        $this               subRealQuarters(int $value = 1)                                                      Sub quarters (the $value count passed in) to the instance (using timestamp).
  399.  * @method        $this               subRealQuarter()                                                                     Sub one quarter to the instance (using timestamp).
  400.  * @method        CarbonPeriod        quartersUntil($endDate = null, int $factor = 1)                                      Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each quarter or every X quarters if a factor is given.
  401.  * @method        $this               addRealYears(int $value = 1)                                                         Add years (the $value count passed in) to the instance (using timestamp).
  402.  * @method        $this               addRealYear()                                                                        Add one year to the instance (using timestamp).
  403.  * @method        $this               subRealYears(int $value = 1)                                                         Sub years (the $value count passed in) to the instance (using timestamp).
  404.  * @method        $this               subRealYear()                                                                        Sub one year to the instance (using timestamp).
  405.  * @method        CarbonPeriod        yearsUntil($endDate = null, int $factor = 1)                                         Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each year or every X years if a factor is given.
  406.  * @method        $this               addRealDecades(int $value = 1)                                                       Add decades (the $value count passed in) to the instance (using timestamp).
  407.  * @method        $this               addRealDecade()                                                                      Add one decade to the instance (using timestamp).
  408.  * @method        $this               subRealDecades(int $value = 1)                                                       Sub decades (the $value count passed in) to the instance (using timestamp).
  409.  * @method        $this               subRealDecade()                                                                      Sub one decade to the instance (using timestamp).
  410.  * @method        CarbonPeriod        decadesUntil($endDate = null, int $factor = 1)                                       Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each decade or every X decades if a factor is given.
  411.  * @method        $this               addRealCenturies(int $value = 1)                                                     Add centuries (the $value count passed in) to the instance (using timestamp).
  412.  * @method        $this               addRealCentury()                                                                     Add one century to the instance (using timestamp).
  413.  * @method        $this               subRealCenturies(int $value = 1)                                                     Sub centuries (the $value count passed in) to the instance (using timestamp).
  414.  * @method        $this               subRealCentury()                                                                     Sub one century to the instance (using timestamp).
  415.  * @method        CarbonPeriod        centuriesUntil($endDate = null, int $factor = 1)                                     Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each century or every X centuries if a factor is given.
  416.  * @method        $this               addRealMillennia(int $value = 1)                                                     Add millennia (the $value count passed in) to the instance (using timestamp).
  417.  * @method        $this               addRealMillennium()                                                                  Add one millennium to the instance (using timestamp).
  418.  * @method        $this               subRealMillennia(int $value = 1)                                                     Sub millennia (the $value count passed in) to the instance (using timestamp).
  419.  * @method        $this               subRealMillennium()                                                                  Sub one millennium to the instance (using timestamp).
  420.  * @method        CarbonPeriod        millenniaUntil($endDate = null, int $factor = 1)                                     Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millennium or every X millennia if a factor is given.
  421.  * @method        $this               roundYear(float $precision = 1, string $function = "round")                          Round the current instance year with given precision using the given function.
  422.  * @method        $this               roundYears(float $precision = 1, string $function = "round")                         Round the current instance year with given precision using the given function.
  423.  * @method        $this               floorYear(float $precision = 1)                                                      Truncate the current instance year with given precision.
  424.  * @method        $this               floorYears(float $precision = 1)                                                     Truncate the current instance year with given precision.
  425.  * @method        $this               ceilYear(float $precision = 1)                                                       Ceil the current instance year with given precision.
  426.  * @method        $this               ceilYears(float $precision = 1)                                                      Ceil the current instance year with given precision.
  427.  * @method        $this               roundMonth(float $precision = 1, string $function = "round")                         Round the current instance month with given precision using the given function.
  428.  * @method        $this               roundMonths(float $precision = 1, string $function = "round")                        Round the current instance month with given precision using the given function.
  429.  * @method        $this               floorMonth(float $precision = 1)                                                     Truncate the current instance month with given precision.
  430.  * @method        $this               floorMonths(float $precision = 1)                                                    Truncate the current instance month with given precision.
  431.  * @method        $this               ceilMonth(float $precision = 1)                                                      Ceil the current instance month with given precision.
  432.  * @method        $this               ceilMonths(float $precision = 1)                                                     Ceil the current instance month with given precision.
  433.  * @method        $this               roundDay(float $precision = 1, string $function = "round")                           Round the current instance day with given precision using the given function.
  434.  * @method        $this               roundDays(float $precision = 1, string $function = "round")                          Round the current instance day with given precision using the given function.
  435.  * @method        $this               floorDay(float $precision = 1)                                                       Truncate the current instance day with given precision.
  436.  * @method        $this               floorDays(float $precision = 1)                                                      Truncate the current instance day with given precision.
  437.  * @method        $this               ceilDay(float $precision = 1)                                                        Ceil the current instance day with given precision.
  438.  * @method        $this               ceilDays(float $precision = 1)                                                       Ceil the current instance day with given precision.
  439.  * @method        $this               roundHour(float $precision = 1, string $function = "round")                          Round the current instance hour with given precision using the given function.
  440.  * @method        $this               roundHours(float $precision = 1, string $function = "round")                         Round the current instance hour with given precision using the given function.
  441.  * @method        $this               floorHour(float $precision = 1)                                                      Truncate the current instance hour with given precision.
  442.  * @method        $this               floorHours(float $precision = 1)                                                     Truncate the current instance hour with given precision.
  443.  * @method        $this               ceilHour(float $precision = 1)                                                       Ceil the current instance hour with given precision.
  444.  * @method        $this               ceilHours(float $precision = 1)                                                      Ceil the current instance hour with given precision.
  445.  * @method        $this               roundMinute(float $precision = 1, string $function = "round")                        Round the current instance minute with given precision using the given function.
  446.  * @method        $this               roundMinutes(float $precision = 1, string $function = "round")                       Round the current instance minute with given precision using the given function.
  447.  * @method        $this               floorMinute(float $precision = 1)                                                    Truncate the current instance minute with given precision.
  448.  * @method        $this               floorMinutes(float $precision = 1)                                                   Truncate the current instance minute with given precision.
  449.  * @method        $this               ceilMinute(float $precision = 1)                                                     Ceil the current instance minute with given precision.
  450.  * @method        $this               ceilMinutes(float $precision = 1)                                                    Ceil the current instance minute with given precision.
  451.  * @method        $this               roundSecond(float $precision = 1, string $function = "round")                        Round the current instance second with given precision using the given function.
  452.  * @method        $this               roundSeconds(float $precision = 1, string $function = "round")                       Round the current instance second with given precision using the given function.
  453.  * @method        $this               floorSecond(float $precision = 1)                                                    Truncate the current instance second with given precision.
  454.  * @method        $this               floorSeconds(float $precision = 1)                                                   Truncate the current instance second with given precision.
  455.  * @method        $this               ceilSecond(float $precision = 1)                                                     Ceil the current instance second with given precision.
  456.  * @method        $this               ceilSeconds(float $precision = 1)                                                    Ceil the current instance second with given precision.
  457.  * @method        $this               roundMillennium(float $precision = 1, string $function = "round")                    Round the current instance millennium with given precision using the given function.
  458.  * @method        $this               roundMillennia(float $precision = 1, string $function = "round")                     Round the current instance millennium with given precision using the given function.
  459.  * @method        $this               floorMillennium(float $precision = 1)                                                Truncate the current instance millennium with given precision.
  460.  * @method        $this               floorMillennia(float $precision = 1)                                                 Truncate the current instance millennium with given precision.
  461.  * @method        $this               ceilMillennium(float $precision = 1)                                                 Ceil the current instance millennium with given precision.
  462.  * @method        $this               ceilMillennia(float $precision = 1)                                                  Ceil the current instance millennium with given precision.
  463.  * @method        $this               roundCentury(float $precision = 1, string $function = "round")                       Round the current instance century with given precision using the given function.
  464.  * @method        $this               roundCenturies(float $precision = 1, string $function = "round")                     Round the current instance century with given precision using the given function.
  465.  * @method        $this               floorCentury(float $precision = 1)                                                   Truncate the current instance century with given precision.
  466.  * @method        $this               floorCenturies(float $precision = 1)                                                 Truncate the current instance century with given precision.
  467.  * @method        $this               ceilCentury(float $precision = 1)                                                    Ceil the current instance century with given precision.
  468.  * @method        $this               ceilCenturies(float $precision = 1)                                                  Ceil the current instance century with given precision.
  469.  * @method        $this               roundDecade(float $precision = 1, string $function = "round")                        Round the current instance decade with given precision using the given function.
  470.  * @method        $this               roundDecades(float $precision = 1, string $function = "round")                       Round the current instance decade with given precision using the given function.
  471.  * @method        $this               floorDecade(float $precision = 1)                                                    Truncate the current instance decade with given precision.
  472.  * @method        $this               floorDecades(float $precision = 1)                                                   Truncate the current instance decade with given precision.
  473.  * @method        $this               ceilDecade(float $precision = 1)                                                     Ceil the current instance decade with given precision.
  474.  * @method        $this               ceilDecades(float $precision = 1)                                                    Ceil the current instance decade with given precision.
  475.  * @method        $this               roundQuarter(float $precision = 1, string $function = "round")                       Round the current instance quarter with given precision using the given function.
  476.  * @method        $this               roundQuarters(float $precision = 1, string $function = "round")                      Round the current instance quarter with given precision using the given function.
  477.  * @method        $this               floorQuarter(float $precision = 1)                                                   Truncate the current instance quarter with given precision.
  478.  * @method        $this               floorQuarters(float $precision = 1)                                                  Truncate the current instance quarter with given precision.
  479.  * @method        $this               ceilQuarter(float $precision = 1)                                                    Ceil the current instance quarter with given precision.
  480.  * @method        $this               ceilQuarters(float $precision = 1)                                                   Ceil the current instance quarter with given precision.
  481.  * @method        $this               roundMillisecond(float $precision = 1, string $function = "round")                   Round the current instance millisecond with given precision using the given function.
  482.  * @method        $this               roundMilliseconds(float $precision = 1, string $function = "round")                  Round the current instance millisecond with given precision using the given function.
  483.  * @method        $this               floorMillisecond(float $precision = 1)                                               Truncate the current instance millisecond with given precision.
  484.  * @method        $this               floorMilliseconds(float $precision = 1)                                              Truncate the current instance millisecond with given precision.
  485.  * @method        $this               ceilMillisecond(float $precision = 1)                                                Ceil the current instance millisecond with given precision.
  486.  * @method        $this               ceilMilliseconds(float $precision = 1)                                               Ceil the current instance millisecond with given precision.
  487.  * @method        $this               roundMicrosecond(float $precision = 1, string $function = "round")                   Round the current instance microsecond with given precision using the given function.
  488.  * @method        $this               roundMicroseconds(float $precision = 1, string $function = "round")                  Round the current instance microsecond with given precision using the given function.
  489.  * @method        $this               floorMicrosecond(float $precision = 1)                                               Truncate the current instance microsecond with given precision.
  490.  * @method        $this               floorMicroseconds(float $precision = 1)                                              Truncate the current instance microsecond with given precision.
  491.  * @method        $this               ceilMicrosecond(float $precision = 1)                                                Ceil the current instance microsecond with given precision.
  492.  * @method        $this               ceilMicroseconds(float $precision = 1)                                               Ceil the current instance microsecond with given precision.
  493.  * @method        string              shortAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1)          Get the difference (short format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  494.  * @method        string              longAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1)           Get the difference (long format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  495.  * @method        string              shortRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1)          Get the difference (short format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  496.  * @method        string              longRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1)           Get the difference (long format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  497.  * @method        string              shortRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1)     Get the difference (short format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  498.  * @method        string              longRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1)      Get the difference (long format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  499.  * @method        string              shortRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1)   Get the difference (short format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  500.  * @method        string              longRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1)    Get the difference (long format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)
  501.  * @method        static Carbon|false createFromFormat(string $format, string $time, string|DateTimeZone $timezone = null) Parse a string into a new Carbon object according to the specified format.
  502.  * @method        static Carbon       __set_state(array $array)                                                            https://php.net/manual/en/datetime.set-state.php
  503.  *
  504.  * </autodoc>
  505.  */
  506. class Carbon extends DateTime implements CarbonInterface
  507. {
  508.     use Date;
  509.     /**
  510.      * Returns true if the current class/instance is mutable.
  511.      *
  512.      * @return bool
  513.      */
  514.     public static function isMutable()
  515.     {
  516.         return true;
  517.     }
  518. }