Fix wrong return types

Adam Halfar · Adam Halfar · commit 8b53c33aaf03 · 2024-07-26T17:50:37.000+02:00
diff --git a/src/ChronosInterface.php b/src/ChronosInterface.php
@@ -1245,7 +1245,7 @@ public function endOfWeek(): self;
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function next(?int $dayOfWeek = null);
 
@@ -1256,7 +1256,7 @@ public function next(?int $dayOfWeek = null);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function previous(?int $dayOfWeek = null);
 
@@ -1267,7 +1267,7 @@ public function previous(?int $dayOfWeek = null);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfMonth(?int $dayOfWeek = null);
 
@@ -1278,7 +1278,7 @@ public function firstOfMonth(?int $dayOfWeek = null);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfMonth(?int $dayOfWeek = null);
 
@@ -1290,7 +1290,7 @@ public function lastOfMonth(?int $dayOfWeek = null);
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfMonth(int $nth, int $dayOfWeek);
 
@@ -1301,7 +1301,7 @@ public function nthOfMonth(int $nth, int $dayOfWeek);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfQuarter(?int $dayOfWeek = null);
 
@@ -1312,7 +1312,7 @@ public function firstOfQuarter(?int $dayOfWeek = null);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfQuarter(?int $dayOfWeek = null);
 
@@ -1324,7 +1324,7 @@ public function lastOfQuarter(?int $dayOfWeek = null);
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfQuarter(int $nth, int $dayOfWeek);
 
@@ -1335,7 +1335,7 @@ public function nthOfQuarter(int $nth, int $dayOfWeek);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfYear(?int $dayOfWeek = null);
 
@@ -1346,7 +1346,7 @@ public function firstOfYear(?int $dayOfWeek = null);
      * to indicate the desired dayOfWeek, ex. static::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfYear(?int $dayOfWeek = null);
 
@@ -1358,7 +1358,7 @@ public function lastOfYear(?int $dayOfWeek = null);
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfYear(int $nth, int $dayOfWeek);
 
diff --git a/src/Traits/ModifierTrait.php b/src/Traits/ModifierTrait.php
@@ -1083,7 +1083,7 @@ public function endOfWeek(): ChronosInterface
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function next(?int $dayOfWeek = null)
     {
@@ -1103,7 +1103,7 @@ public function next(?int $dayOfWeek = null)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function previous(?int $dayOfWeek = null)
     {
@@ -1123,7 +1123,7 @@ public function previous(?int $dayOfWeek = null)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfMonth(?int $dayOfWeek = null)
     {
@@ -1139,7 +1139,7 @@ public function firstOfMonth(?int $dayOfWeek = null)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfMonth(?int $dayOfWeek = null)
     {
@@ -1156,7 +1156,7 @@ public function lastOfMonth(?int $dayOfWeek = null)
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfMonth(int $nth, int $dayOfWeek)
     {
@@ -1174,7 +1174,7 @@ public function nthOfMonth(int $nth, int $dayOfWeek)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfQuarter(?int $dayOfWeek = null)
     {
@@ -1191,7 +1191,7 @@ public function firstOfQuarter(?int $dayOfWeek = null)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfQuarter(?int $dayOfWeek = null)
     {
@@ -1209,7 +1209,7 @@ public function lastOfQuarter(?int $dayOfWeek = null)
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfQuarter(int $nth, int $dayOfWeek)
     {
@@ -1228,7 +1228,7 @@ public function nthOfQuarter(int $nth, int $dayOfWeek)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function firstOfYear(?int $dayOfWeek = null)
     {
@@ -1244,7 +1244,7 @@ public function firstOfYear(?int $dayOfWeek = null)
      * to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.
      *
      * @param int|null $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static
      */
     public function lastOfYear(?int $dayOfWeek = null)
     {
@@ -1261,7 +1261,7 @@ public function lastOfYear(?int $dayOfWeek = null)
      *
      * @param int $nth The offset to use.
      * @param int $dayOfWeek The day of the week to move to.
-     * @return mixed
+     * @return static|false
      */
     public function nthOfYear(int $nth, int $dayOfWeek)
     {

Original file line number	Diff line number	Diff line change
`@@ -1083,7 +1083,7 @@ public function endOfWeek(): ChronosInterface`
`1083`	`1083`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1084`	`1084`	`*`
`1085`	`1085`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1086`		`- * @return mixed`
	`1086`	`+ * @return static`
`1087`	`1087`	`*/`
`1088`	`1088`	`public function next(?int $dayOfWeek = null)`
`1089`	`1089`	`{`
`@@ -1103,7 +1103,7 @@ public function next(?int $dayOfWeek = null)`
`1103`	`1103`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1104`	`1104`	`*`
`1105`	`1105`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1106`		`- * @return mixed`
	`1106`	`+ * @return static`
`1107`	`1107`	`*/`
`1108`	`1108`	`public function previous(?int $dayOfWeek = null)`
`1109`	`1109`	`{`
`@@ -1123,7 +1123,7 @@ public function previous(?int $dayOfWeek = null)`
`1123`	`1123`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1124`	`1124`	`*`
`1125`	`1125`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1126`		`- * @return mixed`
	`1126`	`+ * @return static`
`1127`	`1127`	`*/`
`1128`	`1128`	`public function firstOfMonth(?int $dayOfWeek = null)`
`1129`	`1129`	`{`
`@@ -1139,7 +1139,7 @@ public function firstOfMonth(?int $dayOfWeek = null)`
`1139`	`1139`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1140`	`1140`	`*`
`1141`	`1141`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1142`		`- * @return mixed`
	`1142`	`+ * @return static`
`1143`	`1143`	`*/`
`1144`	`1144`	`public function lastOfMonth(?int $dayOfWeek = null)`
`1145`	`1145`	`{`
`@@ -1156,7 +1156,7 @@ public function lastOfMonth(?int $dayOfWeek = null)`
`1156`	`1156`	`*`
`1157`	`1157`	`* @param int $nth The offset to use.`
`1158`	`1158`	`* @param int $dayOfWeek The day of the week to move to.`
`1159`		`- * @return mixed`
	`1159`	`+ * @return static\|false`
`1160`	`1160`	`*/`
`1161`	`1161`	`public function nthOfMonth(int $nth, int $dayOfWeek)`
`1162`	`1162`	`{`
`@@ -1174,7 +1174,7 @@ public function nthOfMonth(int $nth, int $dayOfWeek)`
`1174`	`1174`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1175`	`1175`	`*`
`1176`	`1176`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1177`		`- * @return mixed`
	`1177`	`+ * @return static`
`1178`	`1178`	`*/`
`1179`	`1179`	`public function firstOfQuarter(?int $dayOfWeek = null)`
`1180`	`1180`	`{`
`@@ -1191,7 +1191,7 @@ public function firstOfQuarter(?int $dayOfWeek = null)`
`1191`	`1191`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1192`	`1192`	`*`
`1193`	`1193`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1194`		`- * @return mixed`
	`1194`	`+ * @return static`
`1195`	`1195`	`*/`
`1196`	`1196`	`public function lastOfQuarter(?int $dayOfWeek = null)`
`1197`	`1197`	`{`
`@@ -1209,7 +1209,7 @@ public function lastOfQuarter(?int $dayOfWeek = null)`
`1209`	`1209`	`*`
`1210`	`1210`	`* @param int $nth The offset to use.`
`1211`	`1211`	`* @param int $dayOfWeek The day of the week to move to.`
`1212`		`- * @return mixed`
	`1212`	`+ * @return static\|false`
`1213`	`1213`	`*/`
`1214`	`1214`	`public function nthOfQuarter(int $nth, int $dayOfWeek)`
`1215`	`1215`	`{`
`@@ -1228,7 +1228,7 @@ public function nthOfQuarter(int $nth, int $dayOfWeek)`
`1228`	`1228`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1229`	`1229`	`*`
`1230`	`1230`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1231`		`- * @return mixed`
	`1231`	`+ * @return static`
`1232`	`1232`	`*/`
`1233`	`1233`	`public function firstOfYear(?int $dayOfWeek = null)`
`1234`	`1234`	`{`
`@@ -1244,7 +1244,7 @@ public function firstOfYear(?int $dayOfWeek = null)`
`1244`	`1244`	`* to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.`
`1245`	`1245`	`*`
`1246`	`1246`	`* @param int\|null $dayOfWeek The day of the week to move to.`
`1247`		`- * @return mixed`
	`1247`	`+ * @return static`
`1248`	`1248`	`*/`
`1249`	`1249`	`public function lastOfYear(?int $dayOfWeek = null)`
`1250`	`1250`	`{`
`@@ -1261,7 +1261,7 @@ public function lastOfYear(?int $dayOfWeek = null)`
`1261`	`1261`	`*`
`1262`	`1262`	`* @param int $nth The offset to use.`
`1263`	`1263`	`* @param int $dayOfWeek The day of the week to move to.`
`1264`		`- * @return mixed`
	`1264`	`+ * @return static\|false`
`1265`	`1265`	`*/`
`1266`	`1266`	`public function nthOfYear(int $nth, int $dayOfWeek)`
`1267`	`1267`	`{`