[PLUGINS][Pinboard] Add initial implementation of Pinboard API, lacking authentication, tags and feed endpoints

2022-03-28 03:19:35 +01:00
parent 87e35716c1
commit bd868a2675
5 changed files with 342 additions and 0 deletions
--- a/plugins/Pinboard/Entity/Pin.php
+++ b/plugins/Pinboard/Entity/Pin.php
@@ -0,0 +1,131 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Plugin\Pinboard\Entity;
+
+use App\Core\Entity;
+use DateTimeInterface;
+
+class Pin extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $note_id;
+    private int $actor_id;
+    private string $url_hash;
+    private string $url;
+    private bool $replace;
+    private bool $public;
+    private bool $unread;
+    private DateTimeInterface $modified;
+
+    public function setNoteId(int $note_id): self
+    {
+        $this->note_id = $note_id;
+        return $this;
+    }
+
+    public function getNoteId(): int
+    {
+        return $this->note_id;
+    }
+
+    public function setActorId(int $actor_id): self
+    {
+        $this->actor_id = $actor_id;
+        return $this;
+    }
+
+    public function getActorId(): int
+    {
+        return $this->actor_id;
+    }
+
+    public function setUrlHash(string $url_hash): self
+    {
+        $this->url_hash = mb_substr($url_hash, 0, 64);
+        return $this;
+    }
+
+    public function getUrlHash(): string
+    {
+        return $this->url_hash;
+    }
+
+    public function setUrl(string $url): self
+    {
+        $this->url = $url;
+        return $this;
+    }
+
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+
+    public function setReplace(bool $replace): self
+    {
+        $this->replace = $replace;
+        return $this;
+    }
+
+    public function getReplace(): bool
+    {
+        return $this->replace;
+    }
+
+    public function setPublic(bool $public): self
+    {
+        $this->public = $public;
+        return $this;
+    }
+
+    public function getPublic(): bool
+    {
+        return $this->public;
+    }
+
+    public function setUnread(bool $unread): self
+    {
+        $this->unread = $unread;
+        return $this;
+    }
+
+    public function getUnread(): bool
+    {
+        return $this->unread;
+    }
+
+    public function setModified(DateTimeInterface $modified): self
+    {
+        $this->modified = $modified;
+        return $this;
+    }
+
+    public function getModified(): DateTimeInterface
+    {
+        return $this->modified;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    public static function schemaDef(): array
+    {
+        return [
+            'name'   => 'pinboard_pin',
+            'fields' => [
+                'note_id'  => ['type' => 'int',  'not null' => true, 'description' => 'Id of the note this pin created'],
+                'actor_id' => ['type' => 'int',  'not null' => true, 'description' => 'Actor who created this note'],
+                'url_hash' => ['type' => 'char', 'length' => 64, 'not null' => true, 'description' => 'Hash of the url, for indexing'],
+                'url'      => ['type' => 'text', 'not null' => true, 'description' => 'Plain URL this pin refers to (gets rendered in the corresponding note, useful for replace)'],
+                'replace'  => ['type' => 'bool', 'not null' => true, 'description' => 'Replace any existing bookmark with this URL. Default is yes. If set to no, will throw an error if bookmark exists'],
+                'public'   => ['type' => 'bool', 'not null' => true, 'description' => 'Whether private or public'],
+                'unread'   => ['type' => 'bool', 'not null' => true, 'description' => 'Has this been read'],
+                'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'],
+            ],
+            'primary key' => ['actor_id', 'url_hash'],
+        ];
+    }
+}