Expand Short links entity interface (#3737)

Author: padmasreegade

module/VuFind/src/VuFind/Db/Entity/ShortlinksEntityInterface.php

@@ -29,6 +29,8 @@
 
 namespace VuFind\Db\Entity;
 
+use DateTime;
+
 /**
  * Entity model interface for shortlinks table
  *
@@ -40,4 +42,59 @@
  */
 interface ShortlinksEntityInterface extends EntityInterface
 {
+    /**
+     * Get identifier (returns null for an uninitialized or non-persisted object).
+     *
+     * @return ?int
+     */
+    public function getId(): ?int;
+
+    /**
+     * Get the path of the URL.
+     *
+     * @return string
+     */
+    public function getPath(): string;
+
+    /**
+     * Set the path (e.g. /Search/Results?lookfor=foo) of the URL being shortened;
+     * shortened URLs are always assumed to be within the hostname where VuFind is running.
+     *
+     * @param string $path Path
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setPath(string $path): ShortlinksEntityInterface;
+
+    /**
+     * Get shortlinks hash.
+     *
+     * @return ?string
+     */
+    public function getHash(): ?string;
+
+    /**
+     * Set shortlinks hash.
+     *
+     * @param ?string $hash Shortlinks hash
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setHash(?string $hash): ShortlinksEntityInterface;
+
+    /**
+     * Get creation timestamp.
+     *
+     * @return DateTime
+     */
+    public function getCreated(): DateTime;
+
+    /**
+     * Set creation timestamp.
+     *
+     * @param DateTime $dateTime Creation timestamp
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setCreated(DateTime $dateTime): ShortlinksEntityInterface;
 }

module/VuFind/src/VuFind/Db/Row/Shortlinks.php

@@ -29,6 +29,9 @@
 
 namespace VuFind\Db\Row;
 
+use DateTime;
+use VuFind\Db\Entity\ShortlinksEntityInterface;
+
 /**
  * Row Definition for shortlinks
  *
@@ -37,6 +40,11 @@
  * @author   Demian Katz <[email protected]>
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org Main Site
+ *
+ * @property int    $id
+ * @property string $path
+ * @property string $hash
+ * @property string $created
  */
 class Shortlinks extends RowGateway implements \VuFind\Db\Entity\ShortlinksEntityInterface
 {
@@ -49,4 +57,84 @@ public function __construct($adapter)
     {
         parent::__construct('id', 'shortlinks', $adapter);
     }
+
+    /**
+     * Get identifier (returns null for an uninitialized or non-persisted object).
+     *
+     * @return ?int
+     */
+    public function getId(): ?int
+    {
+        return $this->id ?? null;
+    }
+
+    /**
+     * Get the path of the URL.
+     *
+     * @return string
+     */
+    public function getPath(): string
+    {
+        return $this->path ?? '';
+    }
+
+    /**
+     * Set the path (e.g. /Search/Results?lookfor=foo) of the URL being shortened;
+     * shortened URLs are always assumed to be within the hostname where VuFind is running.
+     *
+     * @param string $path Path
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setPath(string $path): ShortlinksEntityInterface
+    {
+        $this->path = $path;
+        return $this;
+    }
+
+    /**
+     * Get shortlinks hash.
+     *
+     * @return ?string
+     */
+    public function getHash(): ?string
+    {
+        return $this->hash ?? null;
+    }
+
+    /**
+     * Set shortlinks hash.
+     *
+     * @param ?string $hash Shortlinks hash
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setHash(?string $hash): ShortlinksEntityInterface
+    {
+        $this->hash = $hash;
+        return $this;
+    }
+
+    /**
+     * Get creation timestamp.
+     *
+     * @return DateTime
+     */
+    public function getCreated(): DateTime
+    {
+        return DateTime::createFromFormat('Y-m-d H:i:s', $this->created);
+    }
+
+    /**
+     * Set creation timestamp.
+     *
+     * @param DateTime $dateTime Creation timestamp
+     *
+     * @return ShortlinksEntityInterface
+     */
+    public function setCreated(DateTime $dateTime): ShortlinksEntityInterface
+    {
+        $this->created = $dateTime->format('Y-m-d H:i:s');
+        return $this;
+    }
 }