[upd] Небольшие исправления в документации и установка модификатора final для одного исключения

Author: kEERill

src/Consumers/Consumer.php

@@ -42,25 +42,17 @@ public function forceStop(): void
         $this->highLevelConsumer->forceStop();
     }
 
-    /**
-     * @return ProcessorData
-     */
     public function getProcessorData(): ProcessorData
     {
         return $this->processorData;
     }
 
-    /**
-     * @return ConsumerOptions
-     */
     public function getConsumerOptions(): ConsumerOptions
     {
         return $this->consumerOptions;
     }
 
     /**
-     * @return void
-     *
      * @throws Exception
      * @throws Throwable
      */

src/Consumers/Factories/ConsumerFactory.php

@@ -17,10 +17,6 @@ public function __construct(
     }
 
     /**
-     * @param string $topicKey
-     * @param string $consumerName
-     * @return Consumer
-     *
      * @throws KafkaConsumerProcessorException
      */
     public function build(string $topicKey, string $consumerName = 'default'): Consumer
@@ -37,10 +33,6 @@ public function build(string $topicKey, string $consumerName = 'default'): Consu
     }
 
     /**
-     * @param string $topicKey
-     * @param string $consumerName
-     * @return ProcessorData
-     *
      * @throws KafkaConsumerProcessorException
      */
     protected function makeProcessorData(string $topicKey, string $consumerName): ProcessorData
@@ -60,10 +52,6 @@ protected function makeProcessorData(string $topicKey, string $consumerName): Pr
     }
 
     /**
-     * @param string $topicKey
-     * @param string $consumerName
-     * @return ProcessorData
-     *
      * @throws KafkaConsumerProcessorException
      */
     protected function findMatchedProcessor(string $topicKey, string $consumerName): ProcessorData

src/Exceptions/KafkaConsumerMessagedEndedException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class KafkaConsumerMessagedEndedException extends Exception
+final class KafkaConsumerMessagedEndedException extends Exception
 {
 }

src/HighLevelConsumer.php

@@ -81,6 +81,7 @@ public function listen(string $topicName, ProcessorData $processorData, Consumer
                 }
             }
         } catch (KafkaConsumerMessagedEndedException) {
+            // Called only during testing to stop reading Consumer
         }
     }
 

src/Tests/Consumer/KafkaConsumer.php

@@ -7,7 +7,6 @@
 use Ensi\LaravelPhpRdKafkaConsumer\Tests\Consumer\Topics\Topic;
 use RdKafka\Conf;
 use RdKafka\KafkaConsumer as BaseKafkaConsumer;
-use RdKafka\TopicConf;
 
 class KafkaConsumer extends BaseKafkaConsumer
 {
@@ -41,11 +40,6 @@ public function consume($timeout_ms)
     }
 
     /**
-     * @param $all_topics
-     * @param $only_topic
-     * @param $timeout_ms
-     * @return Metadata
-     *
      * @phpstan-ignore-next-line
      */
     public function getMetadata($all_topics, $only_topic = null, $timeout_ms): Metadata
@@ -59,10 +53,6 @@ public function getCommittedOffsets($topic_partitions, $timeout_ms): array
     }
 
     /**
-     * @param $topic_name
-     * @param TopicConf|null $topic_conf
-     * @return Topic
-     *
      * @phpstan-ignore-next-line
      */
     public function newTopic($topic_name, $topic_conf = null): Topic

src/Tests/ConsumerFaker.php

@@ -40,8 +40,6 @@ public function addMessageRaw(Message $message): self
     }
 
     /**
-     * @return void
-     *
      * @throws KafkaConsumerProcessorException
      * @throws Throwable
      */