rename method into 'refresh'

DavidBadura · DavidBadura · commit bbc0a184963b · 2026-02-17T19:13:06.000+01:00
diff --git a/src/Console/Command/SubscriptionRefreshCommand.php b/src/Console/Command/SubscriptionRefreshCommand.php
@@ -22,14 +22,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if (!$this->engine instanceof CanRefreshSubscriptions) {
             throw new LogicException(sprintf(
-                '"%s" does not implement "%s" and can therefore not refresh subscriptions.',
+                '"%s" does not implement "%s" and cannot call refresh.',
                 $this->engine::class,
                 CanRefreshSubscriptions::class,
             ));
         }
 
         $criteria = $this->subscriptionEngineCriteria($input);
-        $this->engine->refreshSubscriptions($criteria);
+        $this->engine->refresh($criteria);
 
         return 0;
     }
diff --git a/src/Subscription/Engine/CanRefreshSubscriptions.php b/src/Subscription/Engine/CanRefreshSubscriptions.php
@@ -6,5 +6,5 @@
 
 interface CanRefreshSubscriptions
 {
-    public function refreshSubscriptions(SubscriptionEngineCriteria|null $criteria = null): Result;
+    public function refresh(SubscriptionEngineCriteria|null $criteria = null): Result;
 }
diff --git a/src/Subscription/Engine/CatchUpSubscriptionEngine.php b/src/Subscription/Engine/CatchUpSubscriptionEngine.php
@@ -88,17 +88,17 @@ public function subscriptions(SubscriptionEngineCriteria|null $criteria = null):
         return $this->parent->subscriptions($criteria);
     }
 
-    public function refreshSubscriptions(SubscriptionEngineCriteria|null $criteria = null): Result
+    public function refresh(SubscriptionEngineCriteria|null $criteria = null): Result
     {
         if (!$this->parent instanceof CanRefreshSubscriptions) {
             throw new LogicException(sprintf(
-                '"%s" does not implement "%s" and can therefore not refresh subscriptions.',
+                '"%s" does not implement "%s" and cannot call refresh.',
                 $this->parent::class,
                 CanRefreshSubscriptions::class,
             ));
         }
 
-        return $this->parent->refreshSubscriptions($criteria);
+        return $this->parent->refresh($criteria);
     }
 
     private function mergeResult(ProcessedResult ...$results): ProcessedResult
diff --git a/src/Subscription/Engine/DefaultSubscriptionEngine.php b/src/Subscription/Engine/DefaultSubscriptionEngine.php
@@ -823,7 +823,7 @@ public function subscriptions(SubscriptionEngineCriteria|null $criteria = null):
         );
     }
 
-    public function refreshSubscriptions(SubscriptionEngineCriteria|null $criteria = null): Result
+    public function refresh(SubscriptionEngineCriteria|null $criteria = null): Result
     {
         $criteria ??= new SubscriptionEngineCriteria();
 
diff --git a/src/Subscription/Engine/ThrowOnErrorSubscriptionEngine.php b/src/Subscription/Engine/ThrowOnErrorSubscriptionEngine.php
@@ -57,17 +57,17 @@ public function subscriptions(SubscriptionEngineCriteria|null $criteria = null):
         return $this->parent->subscriptions($criteria);
     }
 
-    public function refreshSubscriptions(SubscriptionEngineCriteria|null $criteria = null): Result
+    public function refresh(SubscriptionEngineCriteria|null $criteria = null): Result
     {
         if (!$this->parent instanceof CanRefreshSubscriptions) {
             throw new LogicException(sprintf(
-                '"%s" does not implement "%s" and can therefore not refresh subscriptions.',
+                '"%s" does not implement "%s" and cannot call refresh.',
                 $this->parent::class,
                 CanRefreshSubscriptions::class,
             ));
         }
 
-        return $this->throwOnError($this->parent->refreshSubscriptions($criteria));
+        return $this->throwOnError($this->parent->refresh($criteria));
     }
 
     /**
diff --git a/tests/Integration/Subscription/SubscriptionTest.php b/tests/Integration/Subscription/SubscriptionTest.php
@@ -1623,7 +1623,7 @@ class {
             $newSubscriberRepository,
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptions = $engine->subscriptions();
         self::assertCount(1, $subscriptions);
diff --git a/tests/Unit/Subscription/Engine/CatchUpSubscriptionEngineTest.php b/tests/Unit/Subscription/Engine/CatchUpSubscriptionEngineTest.php
@@ -231,8 +231,8 @@ public function testRefreshSubscriptions(): void
 
         $expectedResult = new Result();
 
-        $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);
-        $result = $engine->refreshSubscriptions($criteria);
+        $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);
+        $result = $engine->refresh($criteria);
 
         self::assertSame($expectedResult, $result);
     }
@@ -244,6 +244,6 @@ public function testRefreshSubscriptionsNotSupported(): void
         $engine = new CatchUpSubscriptionEngine($parent);
 
         $this->expectException(LogicException::class);
-        $engine->refreshSubscriptions();
+        $engine->refresh();
     }
 }
diff --git a/tests/Unit/Subscription/Engine/DefaultSubscriptionEngineTest.php b/tests/Unit/Subscription/Engine/DefaultSubscriptionEngineTest.php
@@ -4597,7 +4597,7 @@ class {
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertNoChanges();
     }
@@ -4625,7 +4625,7 @@ class {
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertUpdated(
             new Subscription(
@@ -4660,7 +4660,7 @@ class {
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertUpdated(
             new Subscription(
@@ -4701,7 +4701,7 @@ public function cleanup(): iterable
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertUpdated(
             new Subscription(
@@ -4743,7 +4743,7 @@ public function cleanup(): iterable
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertUpdated(
             new Subscription(
@@ -4790,7 +4790,7 @@ class {
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions(new SubscriptionEngineCriteria(['test1']));
+        $engine->refresh(new SubscriptionEngineCriteria(['test1']));
 
         $subscriptionStore->assertUpdated(
             new Subscription(
@@ -4820,7 +4820,7 @@ class {
             cleaner: $this->createMock(Cleaner::class),
         );
 
-        $engine->refreshSubscriptions();
+        $engine->refresh();
 
         $subscriptionStore->assertAdded(
             new Subscription(
diff --git a/tests/Unit/Subscription/Engine/ThrowOnErrorSubscriptionEngineTest.php b/tests/Unit/Subscription/Engine/ThrowOnErrorSubscriptionEngineTest.php
@@ -276,8 +276,8 @@ public function testRefreshSubscriptionsSuccess(): void
 
         $expectedResult = new Result();
 
-        $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);
-        $result = $engine->refreshSubscriptions($criteria);
+        $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);
+        $result = $engine->refresh($criteria);
 
         self::assertSame($expectedResult, $result);
     }
@@ -298,8 +298,8 @@ public function testRefreshSubscriptionsError(): void
             new Error('id1', 'error1', new RuntimeException('error1')),
         ]);
 
-        $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);
-        $engine->refreshSubscriptions($criteria);
+        $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);
+        $engine->refresh($criteria);
     }
 
     public function testRefreshSubscriptionsNotSupported(): void
@@ -309,6 +309,6 @@ public function testRefreshSubscriptionsNotSupported(): void
         $engine = new ThrowOnErrorSubscriptionEngine($parent);
 
         $this->expectException(LogicException::class);
-        $engine->refreshSubscriptions();
+        $engine->refresh();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`22`	`22`	`{`
`23`	`23`	`if (!$this->engine instanceof CanRefreshSubscriptions) {`
`24`	`24`	`throw new LogicException(sprintf(`
`25`		`- '"%s" does not implement "%s" and can therefore not refresh subscriptions.',`
	`25`	`+ '"%s" does not implement "%s" and cannot call refresh.',`
`26`	`26`	`$this->engine::class,`
`27`	`27`	`CanRefreshSubscriptions::class,`
`28`	`28`	`));`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`$criteria = $this->subscriptionEngineCriteria($input);`
`32`		`- $this->engine->refreshSubscriptions($criteria);`
	`32`	`+ $this->engine->refresh($criteria);`
`33`	`33`
`34`	`34`	`return 0;`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`
`7`	`7`	`interface CanRefreshSubscriptions`
`8`	`8`	`{`
`9`		`- public function refreshSubscriptions(SubscriptionEngineCriteria\|null $criteria = null): Result;`
	`9`	`+ public function refresh(SubscriptionEngineCriteria\|null $criteria = null): Result;`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,17 +88,17 @@ public function subscriptions(SubscriptionEngineCriteria\|null $criteria = null):`
`88`	`88`	`return $this->parent->subscriptions($criteria);`
`89`	`89`	`}`
`90`	`90`
`91`		`- public function refreshSubscriptions(SubscriptionEngineCriteria\|null $criteria = null): Result`
	`91`	`+ public function refresh(SubscriptionEngineCriteria\|null $criteria = null): Result`
`92`	`92`	`{`
`93`	`93`	`if (!$this->parent instanceof CanRefreshSubscriptions) {`
`94`	`94`	`throw new LogicException(sprintf(`
`95`		`- '"%s" does not implement "%s" and can therefore not refresh subscriptions.',`
	`95`	`+ '"%s" does not implement "%s" and cannot call refresh.',`
`96`	`96`	`$this->parent::class,`
`97`	`97`	`CanRefreshSubscriptions::class,`
`98`	`98`	`));`
`99`	`99`	`}`
`100`	`100`
`101`		`- return $this->parent->refreshSubscriptions($criteria);`
	`101`	`+ return $this->parent->refresh($criteria);`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`private function mergeResult(ProcessedResult ...$results): ProcessedResult`
Original file line number	Diff line number	Diff line change
`@@ -823,7 +823,7 @@ public function subscriptions(SubscriptionEngineCriteria\|null $criteria = null):`
`823`	`823`	`);`
`824`	`824`	`}`
`825`	`825`
`826`		`- public function refreshSubscriptions(SubscriptionEngineCriteria\|null $criteria = null): Result`
	`826`	`+ public function refresh(SubscriptionEngineCriteria\|null $criteria = null): Result`
`827`	`827`	`{`
`828`	`828`	`$criteria ??= new SubscriptionEngineCriteria();`
`829`	`829`
Original file line number	Diff line number	Diff line change
`@@ -57,17 +57,17 @@ public function subscriptions(SubscriptionEngineCriteria\|null $criteria = null):`
`57`	`57`	`return $this->parent->subscriptions($criteria);`
`58`	`58`	`}`
`59`	`59`
`60`		`- public function refreshSubscriptions(SubscriptionEngineCriteria\|null $criteria = null): Result`
	`60`	`+ public function refresh(SubscriptionEngineCriteria\|null $criteria = null): Result`
`61`	`61`	`{`
`62`	`62`	`if (!$this->parent instanceof CanRefreshSubscriptions) {`
`63`	`63`	`throw new LogicException(sprintf(`
`64`		`- '"%s" does not implement "%s" and can therefore not refresh subscriptions.',`
	`64`	`+ '"%s" does not implement "%s" and cannot call refresh.',`
`65`	`65`	`$this->parent::class,`
`66`	`66`	`CanRefreshSubscriptions::class,`
`67`	`67`	`));`
`68`	`68`	`}`
`69`	`69`
`70`		`- return $this->throwOnError($this->parent->refreshSubscriptions($criteria));`
	`70`	`+ return $this->throwOnError($this->parent->refresh($criteria));`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -231,8 +231,8 @@ public function testRefreshSubscriptions(): void`
`231`	`231`
`232`	`232`	`$expectedResult = new Result();`
`233`	`233`
`234`		`- $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);`
`235`		`- $result = $engine->refreshSubscriptions($criteria);`
	`234`	`+ $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);`
	`235`	`+ $result = $engine->refresh($criteria);`
`236`	`236`
`237`	`237`	`self::assertSame($expectedResult, $result);`
`238`	`238`	`}`
`@@ -244,6 +244,6 @@ public function testRefreshSubscriptionsNotSupported(): void`
`244`	`244`	`$engine = new CatchUpSubscriptionEngine($parent);`
`245`	`245`
`246`	`246`	`$this->expectException(LogicException::class);`
`247`		`- $engine->refreshSubscriptions();`
	`247`	`+ $engine->refresh();`
`248`	`248`	`}`
`249`	`249`	`}`
Original file line number	Diff line number	Diff line change
`@@ -276,8 +276,8 @@ public function testRefreshSubscriptionsSuccess(): void`
`276`	`276`
`277`	`277`	`$expectedResult = new Result();`
`278`	`278`
`279`		`- $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);`
`280`		`- $result = $engine->refreshSubscriptions($criteria);`
	`279`	`+ $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);`
	`280`	`+ $result = $engine->refresh($criteria);`
`281`	`281`
`282`	`282`	`self::assertSame($expectedResult, $result);`
`283`	`283`	`}`
`@@ -298,8 +298,8 @@ public function testRefreshSubscriptionsError(): void`
`298`	`298`	`new Error('id1', 'error1', new RuntimeException('error1')),`
`299`	`299`	`]);`
`300`	`300`
`301`		`- $parent->expects($this->once())->method('refreshSubscriptions')->with($criteria)->willReturn($expectedResult);`
`302`		`- $engine->refreshSubscriptions($criteria);`
	`301`	`+ $parent->expects($this->once())->method('refresh')->with($criteria)->willReturn($expectedResult);`
	`302`	`+ $engine->refresh($criteria);`
`303`	`303`	`}`
`304`	`304`
`305`	`305`	`public function testRefreshSubscriptionsNotSupported(): void`
`@@ -309,6 +309,6 @@ public function testRefreshSubscriptionsNotSupported(): void`
`309`	`309`	`$engine = new ThrowOnErrorSubscriptionEngine($parent);`
`310`	`310`
`311`	`311`	`$this->expectException(LogicException::class);`
`312`		`- $engine->refreshSubscriptions();`
	`312`	`+ $engine->refresh();`
`313`	`313`	`}`
`314`	`314`	`}`