-
Notifications
You must be signed in to change notification settings - Fork 16
/
Carbon.php
1778 lines (1492 loc) · 36.2 KB
/
Carbon.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace Carbon;
use Carbon\Traits\Date;
use Carbon\Traits\DeprecatedProperties;
use DateTime;
use DateTimeInterface;
use DateTimeZone;
class Carbon extends \DateTime
{
public $year;
public $yearIso;
public $month;
public $day;
public $hour;
public $minute;
public $second;
public $micro;
public $microsecond;
public $timestamp;
public $englishDayOfWeek;
public $shortEnglishDayOfWeek;
public $englishMonth;
public $shortEnglishMonth;
public $milliseconds;
public $millisecond;
public $milli;
public $week;
public $isoWeek;
public $weekYear;
public $isoWeekYear;
public $dayOfYear;
public $age;
public $offset;
public $offsetMinutes;
public $offsetHours;
public $timezone;
public $tz;
/**
* Get a copy of the instance.
*/
abstract public function copy(
):Carbon;
/**
* Returns a present instance in the same timezone.
*/
abstract public function nowWithSameTz(
):Carbon;
/**
* Set the date and time all together.
*/
abstract public function setDateTime(
int $year,
int $month,
int $day,
int $hour,
int $minute,
int $second = 0,
int $microseconds = 0
):Carbon;
/**
* Set the time by time string.
*/
abstract public function setTimeFromTimeString(
string $time
):Carbon;
abstract public function timezone(
$value
):Carbon;
/**
* Set the timezone or returns the timezone name if no arguments passed.
*/
abstract public function tz(
$value = null
):Carbon;
/**
* Set the year, month, and date for this instance to that of the passed instance.
*/
abstract public function setDateFrom(
$date = null
):Carbon;
/**
* Set the hour, minute, second and microseconds for this instance to that of the passed instance.
*/
abstract public function setTimeFrom(
$date = null
):Carbon;
/**
* Get the days of the week
*/
abstract public static function getDays(
):array;
/**
* Get the first day of week
*/
abstract public static function getWeekStartsAt(
):int;
abstract public static function setWeekStartsAt(
$day
);
/**
* Get the last day of week
*/
abstract public static function getWeekEndsAt(
):int;
abstract public static function setWeekEndsAt(
$day
);
/**
* Get weekend days
*/
abstract public static function getWeekendDays(
):array;
abstract public static function setWeekendDays(
array $days
);
/**
* Determine if a time string will produce a relative date.
*/
abstract public static function hasRelativeKeywords(
string $time
):bool;
abstract public static function setUtf8(
bool $utf8
);
/**
* Format the instance with the current locale. You can set the current
locale using setlocale() https://php.net/setlocale.
*/
abstract public function formatLocalized(
string $format
):string;
/**
* Resets the time to 00:00:00 start of day
*/
abstract public function startOfDay(
):Carbon;
/**
* Resets the time to 23:59:59.999999 end of day
*/
abstract public function endOfDay(
):Carbon;
/**
* Resets the date to the first day of the month and the time to 00:00:00
*/
abstract public function startOfMonth(
):Carbon;
/**
* Resets the date to end of the month and time to 23:59:59.999999
*/
abstract public function endOfMonth(
):Carbon;
/**
* Resets the date to the first day of the quarter and the time to 00:00:00
*/
abstract public function startOfQuarter(
):Carbon;
/**
* Resets the date to end of the quarter and time to 23:59:59.999999
*/
abstract public function endOfQuarter(
):Carbon;
/**
* Resets the date to the first day of the year and the time to 00:00:00
*/
abstract public function startOfYear(
):Carbon;
/**
* Resets the date to end of the year and time to 23:59:59.999999
*/
abstract public function endOfYear(
):Carbon;
/**
* Resets the date to the first day of the decade and the time to 00:00:00
*/
abstract public function startOfDecade(
):Carbon;
/**
* Resets the date to end of the decade and time to 23:59:59.999999
*/
abstract public function endOfDecade(
):Carbon;
/**
* Resets the date to the first day of the century and the time to 00:00:00
*/
abstract public function startOfCentury(
):Carbon;
/**
* Resets the date to end of the century and time to 23:59:59.999999
*/
abstract public function endOfCentury(
):Carbon;
/**
* Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
*/
abstract public function startOfWeek(
int $weekStartsAt = null
):Carbon;
/**
* Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59.999999
*/
abstract public function endOfWeek(
int $weekEndsAt = null
):Carbon;
/**
* Modify to start of current hour, minutes and seconds become 0
*/
abstract public function startOfHour(
):Carbon;
/**
* Modify to end of current hour, minutes and seconds become 59
*/
abstract public function endOfHour(
):Carbon;
/**
* Modify to start of current minute, seconds become 0
*/
abstract public function startOfMinute(
):Carbon;
/**
* Modify to end of current minute, seconds become 59
*/
abstract public function endOfMinute(
):Carbon;
/**
* Determines if the instance is equal to another
*/
abstract public function eq(
$date
):bool;
/**
* Determines if the instance is equal to another
*/
abstract public function equalTo(
$date
):bool;
/**
* Determines if the instance is not equal to another
*/
abstract public function ne(
$date
):bool;
/**
* Determines if the instance is not equal to another
*/
abstract public function notEqualTo(
$date
):bool;
/**
* Determines if the instance is greater (after) than another
*/
abstract public function gt(
$date
):bool;
/**
* Determines if the instance is greater (after) than another
*/
abstract public function greaterThan(
$date
):bool;
/**
* Determines if the instance is greater (after) than or equal to another
*/
abstract public function gte(
$date
):bool;
/**
* Determines if the instance is greater (after) than or equal to another
*/
abstract public function greaterThanOrEqualTo(
$date
):bool;
/**
* Determines if the instance is less (before) than another
*/
abstract public function lt(
$date
):bool;
/**
* Determines if the instance is less (before) than another
*/
abstract public function lessThan(
$date
):bool;
/**
* Determines if the instance is less (before) or equal to another
*/
abstract public function lte(
$date
):bool;
/**
* Determines if the instance is less (before) or equal to another
*/
abstract public function lessThanOrEqualTo(
$date
):bool;
/**
* Determines if the instance is between two others.
*/
abstract public function between(
$date1,
$date2,
bool $equal = true
):bool;
/**
* Determines if the instance is a weekday.
*/
abstract public function isWeekday(
):bool;
/**
* Determines if the instance is a weekend day.
*/
abstract public function isWeekend(
):bool;
/**
* Determines if the instance is yesterday.
*/
abstract public function isYesterday(
):bool;
/**
* Determines if the instance is today.
*/
abstract public function isToday(
):bool;
/**
* Determines if the instance is tomorrow.
*/
abstract public function isTomorrow(
):bool;
/**
* Determines if the instance is in the future, ie. greater (after) than now.
*/
abstract public function isFuture(
):bool;
/**
* Determines if the instance is in the past, ie. less (before) than now.
*/
abstract public function isPast(
):bool;
/**
* Determines if the instance is a leap year.
*/
abstract public function isLeapYear(
):bool;
/**
* Determines if the instance is a long year (using calendar year).
*/
abstract public function isLongYear(
):bool;
/**
* Compares the formatted values of the two dates.
*/
abstract public function isSameAs(
string $format,
$date = null
):bool;
/**
* Checks if the passed in date is in the same quarter as the instance quarter (and year if needed).
*/
abstract public function isSameQuarter(
$date = null,
bool $ofSameYear = true
):bool;
/**
* Checks if the passed in date is in the same month as the instance´s month.
*/
abstract public function isSameMonth(
$date = null,
bool $ofSameYear = true
):bool;
/**
* Checks if this day is a specific day of the week.
*/
abstract public function isDayOfWeek(
int $dayOfWeek
):bool;
/**
* Check if its the birthday. Compares the date/month values of the two dates.
*/
abstract public function isBirthday(
$date = null
):bool;
/**
* Check if today is the last day of the Month
*/
abstract public function isLastOfMonth(
):bool;
/**
* Checks if the (date)time string is in a given format.
*/
abstract public static function hasFormat(
string $date,
string $format
):bool;
/**
* Format the instance as date
*/
abstract public function toDateString(
):string;
/**
* Format the instance as a readable date
*/
abstract public function toFormattedDateString(
):string;
/**
* Format the instance as time
*/
abstract public function toTimeString(
string $unitPrecision = "second"
):string;
/**
* Format the instance as date and time
*/
abstract public function toDateTimeString(
string $unitPrecision = "second"
):string;
/**
* Format the instance with day, date and time
*/
abstract public function toDayDateTimeString(
):string;
/**
* Format the instance as ATOM
*/
abstract public function toAtomString(
):string;
/**
* Format the instance as COOKIE
*/
abstract public function toCookieString(
):string;
/**
* Format the instance as ISO8601
*/
abstract public function toIso8601String(
):string;
/**
* Format the instance as RFC822
*/
abstract public function toRfc822String(
):string;
/**
* Convert the instance to UTC and return as Zulu ISO8601
*/
abstract public function toIso8601ZuluString(
string $unitPrecision = "second"
):string;
/**
* Format the instance as RFC850
*/
abstract public function toRfc850String(
):string;
/**
* Format the instance as RFC1036
*/
abstract public function toRfc1036String(
):string;
/**
* Format the instance as RFC1123
*/
abstract public function toRfc1123String(
):string;
/**
* Format the instance as RFC2822
*/
abstract public function toRfc2822String(
):string;
/**
* Format the instance as RFC3339
*/
abstract public function toRfc3339String(
bool $extended = false
):string;
/**
* Format the instance as RSS
*/
abstract public function toRssString(
):string;
/**
* Format the instance as W3C
*/
abstract public function toW3cString(
):string;
/**
* Format the instance as RFC7231
*/
abstract public function toRfc7231String(
):string;
/**
* Get default array representation.
*/
abstract public function toArray(
):array;
/**
* Reset the format used to the default when type juggling a Carbon instance to a string
*/
abstract public static function resetToStringFormat(
);
abstract public static function setToStringFormat(
$format
);
/**
* Create a Carbon instance from a DateTime one.
*/
abstract public static function instance(
\DateTimeInterface $date
):Carbon;
/**
* Create a carbon instance from a string.
*/
abstract public static function parse(
$time = null,
$tz = null
):Carbon;
/**
* Get a Carbon instance for the current date and time.
*/
abstract public static function now(
$tz = null
):Carbon;
/**
* Create a Carbon instance for today.
*/
abstract public static function today(
$tz = null
):Carbon;
/**
* Create a Carbon instance for tomorrow.
*/
abstract public static function tomorrow(
$tz = null
):Carbon;
/**
* Create a Carbon instance for yesterday.
*/
abstract public static function yesterday(
$tz = null
):Carbon;
/**
* Create a Carbon instance for the greatest supported date.
*/
abstract public static function maxValue(
):Carbon;
/**
* Create a Carbon instance for the lowest supported date.
*/
abstract public static function minValue(
):Carbon;
/**
* Create a new Carbon instance from a specific date and time.
*/
abstract public static function create(
$year = 0,
int $month = 1,
int $day = 1,
int $hour = 0,
int $minute = 0,
int $second = 0,
$tz = null
):Carbon;
/**
* Create a new safe Carbon instance from a specific date and time.
*/
abstract public static function createSafe(
int $year = null,
int $month = null,
int $day = null,
int $hour = null,
int $minute = null,
int $second = null,
$tz = null
):Carbon;
/**
* Create a Carbon instance from just a date. The time portion is set to now.
*/
abstract public static function createFromDate(
int $year = null,
int $month = null,
int $day = null,
$tz = null
):Carbon;
/**
* Create a Carbon instance from just a date. The time portion is set to midnight.
*/
abstract public static function createMidnightDate(
int $year = null,
int $month = null,
int $day = null,
$tz = null
):Carbon;
/**
* Create a Carbon instance from just a time. The date portion is set to today.
*/
abstract public static function createFromTime(
int $hour = 0,
int $minute = 0,
int $second = 0,
$tz = null
):Carbon;
/**
* Create a Carbon instance from a time string. The date portion is set to today.
*/
abstract public static function createFromTimeString(
string $time,
$tz = null
):Carbon;
/**
* Get the difference in years
*/
abstract public function diffInYears(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in months rounded down.
*/
abstract public function diffInMonths(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in weeks rounded down.
*/
abstract public function diffInWeeks(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in days rounded down.
*/
abstract public function diffInDays(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in weekdays rounded down.
*/
abstract public function diffInWeekdays(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in weekend days using a filter rounded down.
*/
abstract public function diffInWeekendDays(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in hours rounded down.
*/
abstract public function diffInHours(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in hours rounded down using timestamps.
*/
abstract public function diffInRealHours(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in minutes rounded down.
*/
abstract public function diffInMinutes(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in minutes rounded down using timestamps.
*/
abstract public function diffInRealMinutes(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in seconds rounded down.
*/
abstract public function diffInSeconds(
$date = null,
bool $absolute = true
):int;
/**
* Get the difference in seconds using timestamps.
*/
abstract public function diffInRealSeconds(
$date = null,
bool $absolute = true
):int;
/**
* The number of seconds since midnight.
*/
abstract public function secondsSinceMidnight(
):int;
/**
* The number of seconds until 23:59:59.
*/
abstract public function secondsUntilEndOfDay(
):int;
/**
* Get the difference in a human readable format in the current locale from current instance to an other
instance given (or now if null given).
*/
abstract public function diffForHumans(
$other = null,
$syntax = null,
bool $short = false,
int $parts = 1,
int $options = null
):string;
/**
* Register a custom macro.
*/
abstract public static function macro(
string $name,
$macro
);
/**
* Checks if macro is registered globally.
*/
abstract public static function hasMacro(
string $name
):bool;
/**
* get midday/noon hour
*/
abstract public static function getMidDayAt(
):int;
abstract public static function setMidDayAt(
int $hour
);
/**
* Modify to midday, default to self::$midDayAt
*/
abstract public function midDay(
):Carbon;
/**
* Modify to the next occurrence of a given modifier such as a day of
the week. If no modifier is provided, modify to the next occurrence
of the current day of the week. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function next(
$modifier = null
):Carbon;
/**
* Go forward to the next weekday.
*/
abstract public function nextWeekday(
):Carbon;
/**
* Go backward to the previous weekday.
*/
abstract public function previousWeekday(
):Carbon;
/**
* Go forward to the next weekend day.
*/
abstract public function nextWeekendDay(
):Carbon;
/**
* Go backward to the previous weekend day.
*/
abstract public function previousWeekendDay(
):Carbon;
/**
* Modify to the previous occurrence of a given modifier such as a day of
the week. If no dayOfWeek is provided, modify to the previous occurrence
of the current day of the week. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function previous(
$modifier = null
):Carbon;
/**
* Modify to the first occurrence of a given day of the week
in the current month. If no dayOfWeek is provided, modify to the
first day of the current month. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function firstOfMonth(
int $dayOfWeek = null
):Carbon;
/**
* Modify to the last occurrence of a given day of the week
in the current month. If no dayOfWeek is provided, modify to the
last day of the current month. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function lastOfMonth(
int $dayOfWeek = null
):Carbon;
/**
* Modify to the given occurrence of a given day of the week
in the current month. If the calculated occurrence is outside the scope
of the current month, then return false and no modifications are made.
*/
abstract public function nthOfMonth(
int $nth,
int $dayOfWeek
);
/**
* Modify to the first occurrence of a given day of the week
in the current quarter. If no dayOfWeek is provided, modify to the
first day of the current quarter. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function firstOfQuarter(
int $dayOfWeek = null
):Carbon;
/**
* Modify to the last occurrence of a given day of the week
in the current quarter. If no dayOfWeek is provided, modify to the
last day of the current quarter. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function lastOfQuarter(
int $dayOfWeek = null
):Carbon;
/**
* Modify to the given occurrence of a given day of the week
in the current quarter. If the calculated occurrence is outside the scope
of the current quarter, then return false and no modifications are made.
*/
abstract public function nthOfQuarter(
int $nth,
int $dayOfWeek
);
/**
* Modify to the first occurrence of a given day of the week
in the current year. If no dayOfWeek is provided, modify to the
first day of the current year. Use the supplied constants
to indicate the desired dayOfWeek, ex. static::MONDAY.
*/
abstract public function firstOfYear(
int $dayOfWeek = null