WIP: ideas for refactoring repository and subscriptions

Author: thg2k

src/PendingMessage.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMqtt\Client;
+
+use DateTime;
+
+/**
+ * Represents a pending message.
+ *
+ * If the message is not acknowledged by the broker, having one of these
+ * objects allows the client to resend the request.
+ *
+ * @package PhpMqtt\Client
+ */
+abstract class PendingMessage
+{
+    /** @var int */
+    protected $messageId;
+
+    /** @var int */
+    protected $sendingAttempts = 1;
+
+    /** @var DateTime */
+    protected $lastSentAt;
+
+    /**
+     * Creates a new pending message object.
+     *
+     * @param int           $messageId
+     * @param DateTime|null $sentAt
+     */
+    protected function __construct(int $messageId, DateTime $sentAt = null)
+    {
+        $this->messageId  = $messageId;
+        $this->topic      = $topic;
+        $this->lastSentAt = $sentAt ?? new DateTime();
+    }
+
+    /**
+     * Returns the message identifier.
+     *
+     * @return int
+     */
+    public function getMessageId(): int
+    {
+        return $this->messageId;
+    }
+
+    /**
+     * Returns the date time when the message was last attempted to be sent.
+     *
+     * @return DateTime
+     */
+    public function getLastSentAt(): DateTime
+    {
+        return $this->lastSentAt;
+    }
+
+    /**
+     * Returns the number of times the message has been attempted to be sent.
+     *
+     * @return int
+     */
+    public function getSendingAttempts(): int
+    {
+        return $this->sendingAttempts;
+    }
+
+    /**
+     * Sets the date time when the message was last attempted to be sent.
+     *
+     * @param DateTime|null $value
+     * @return static
+     */
+    public function setLastSentAt(DateTime $value = null): self
+    {
+        $this->lastSentAt = $value ?? new DateTime();
+
+        return $this;
+    }
+
+    /**
+     * Increments the sending attempts by one.
+     *
+     * @return static
+     */
+    public function incrementSendingAttempts(): self
+    {
+        $this->sendingAttempts++;
+
+        return $this;
+    }
+}

src/PublishedMessage.php

@@ -12,11 +12,8 @@
  *
  * @package PhpMqtt\Client
  */
-class PublishedMessage
+class PublishedMessage extends PendingMessage
 {
-    /** @var int */
-    private $messageId;
-
     /** @var string */
     private $topic;
 
@@ -29,12 +26,6 @@ class PublishedMessage
     /** @var bool */
     private $retain;
 
-    /** @var DateTime */
-    private $lastSentAt;
-
-    /** @var int */
-    private $sendingAttempts = 1;
-
     /** @var bool */
     private $received = false;
 
@@ -61,22 +52,10 @@ public function __construct(
             $sentAt = new DateTime();
         }
 
-        $this->messageId        = $messageId;
         $this->topic            = $topic;
         $this->message          = $message;
         $this->qualityOfService = $qualityOfService;
         $this->retain           = $retain;
-        $this->lastSentAt       = $sentAt;
-    }
-
-    /**
-     * Returns the message identifier.
-     *
-     * @return int
-     */
-    public function getMessageId(): int
-    {
-        return $this->messageId;
     }
 
     /**
@@ -119,26 +98,6 @@ public function wantsToBeRetained(): bool
         return $this->retain;
     }
 
-    /**
-     * Returns the date time when the message was last attempted to be sent.
-     *
-     * @return DateTime
-     */
-    public function getLastSentAt(): DateTime
-    {
-        return $this->lastSentAt;
-    }
-
-    /**
-     * Returns the number of times the message has been attempted to be sent.
-     *
-     * @return int
-     */
-    public function getSendingAttempts(): int
-    {
-        return $this->sendingAttempts;
-    }
-
     /**
      * Determines whether the message has been confirmed as received.
      *
@@ -149,31 +108,6 @@ public function hasBeenReceived(): bool
         return $this->received;
     }
 
-    /**
-     * Sets the date time when the message was last attempted to be sent.
-     *
-     * @param DateTime $value
-     * @return static
-     */
-    public function setLastSentAt(DateTime $value): self
-    {
-        $this->lastSentAt = $value;
-
-        return $this;
-    }
-
-    /**
-     * Increments the sending attempts by one.
-     *
-     * @return static
-     */
-    public function incrementSendingAttempts(): self
-    {
-        $this->sendingAttempts++;
-
-        return $this;
-    }
-
     /**
      * Sets the received state.
      *