From 336a28fa4a09b968ce4705900bf57693e672f0bf Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Sat, 25 May 2019 15:46:47 +0200
Subject: Introduce Bookmark object and Service layer to retrieve them

See https://github.com/shaarli/Shaarli/issues/1307 for details
---
 .../exception/BookmarkNotFoundException.php        | 15 +++++++++++
 .../bookmark/exception/EmptyDataStoreException.php |  7 +++++
 .../exception/InvalidBookmarkException.php         | 30 ++++++++++++++++++++++
 .../bookmark/exception/LinkNotFoundException.php   | 15 -----------
 .../exception/NotWritableDataStoreException.php    | 19 ++++++++++++++
 5 files changed, 71 insertions(+), 15 deletions(-)
 create mode 100644 application/bookmark/exception/BookmarkNotFoundException.php
 create mode 100644 application/bookmark/exception/EmptyDataStoreException.php
 create mode 100644 application/bookmark/exception/InvalidBookmarkException.php
 delete mode 100644 application/bookmark/exception/LinkNotFoundException.php
 create mode 100644 application/bookmark/exception/NotWritableDataStoreException.php

(limited to 'application/bookmark/exception')

diff --git a/application/bookmark/exception/BookmarkNotFoundException.php b/application/bookmark/exception/BookmarkNotFoundException.php
new file mode 100644
index 00000000..827a3d35
--- /dev/null
+++ b/application/bookmark/exception/BookmarkNotFoundException.php
@@ -0,0 +1,15 @@
+<?php
+namespace Shaarli\Bookmark\Exception;
+
+use Exception;
+
+class BookmarkNotFoundException extends Exception
+{
+    /**
+     * LinkNotFoundException constructor.
+     */
+    public function __construct()
+    {
+        $this->message = t('The link you are trying to reach does not exist or has been deleted.');
+    }
+}
diff --git a/application/bookmark/exception/EmptyDataStoreException.php b/application/bookmark/exception/EmptyDataStoreException.php
new file mode 100644
index 00000000..cd48c1e6
--- /dev/null
+++ b/application/bookmark/exception/EmptyDataStoreException.php
@@ -0,0 +1,7 @@
+<?php
+
+
+namespace Shaarli\Bookmark\Exception;
+
+
+class EmptyDataStoreException extends \Exception {}
diff --git a/application/bookmark/exception/InvalidBookmarkException.php b/application/bookmark/exception/InvalidBookmarkException.php
new file mode 100644
index 00000000..10c84a6d
--- /dev/null
+++ b/application/bookmark/exception/InvalidBookmarkException.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Shaarli\Bookmark\Exception;
+
+use Shaarli\Bookmark\Bookmark;
+
+class InvalidBookmarkException extends \Exception
+{
+    public function __construct($bookmark)
+    {
+        if ($bookmark instanceof Bookmark) {
+            if ($bookmark->getCreated() instanceof \DateTime) {
+                $created = $bookmark->getCreated()->format(\DateTime::ATOM);
+            } elseif (empty($bookmark->getCreated())) {
+                $created = '';
+            } else {
+                $created = 'Not a DateTime object';
+            }
+            $this->message = 'This bookmark is not valid'. PHP_EOL;
+            $this->message .= ' - ID: '. $bookmark->getId() . PHP_EOL;
+            $this->message .= ' - Title: '. $bookmark->getTitle() . PHP_EOL;
+            $this->message .= ' - Url: '. $bookmark->getUrl() . PHP_EOL;
+            $this->message .= ' - ShortUrl: '. $bookmark->getShortUrl() . PHP_EOL;
+            $this->message .= ' - Created: '. $created . PHP_EOL;
+        } else {
+            $this->message = 'The provided data is not a bookmark'. PHP_EOL;
+            $this->message .= var_export($bookmark, true);
+        }
+    }
+}
diff --git a/application/bookmark/exception/LinkNotFoundException.php b/application/bookmark/exception/LinkNotFoundException.php
deleted file mode 100644
index f9414428..00000000
--- a/application/bookmark/exception/LinkNotFoundException.php
+++ /dev/null
@@ -1,15 +0,0 @@
-<?php
-namespace Shaarli\Bookmark\Exception;
-
-use Exception;
-
-class LinkNotFoundException extends Exception
-{
-    /**
-     * LinkNotFoundException constructor.
-     */
-    public function __construct()
-    {
-        $this->message = t('The link you are trying to reach does not exist or has been deleted.');
-    }
-}
diff --git a/application/bookmark/exception/NotWritableDataStoreException.php b/application/bookmark/exception/NotWritableDataStoreException.php
new file mode 100644
index 00000000..95f34b50
--- /dev/null
+++ b/application/bookmark/exception/NotWritableDataStoreException.php
@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Shaarli\Bookmark\Exception;
+
+
+class NotWritableDataStoreException extends \Exception
+{
+    /**
+     * NotReadableDataStore constructor.
+     *
+     * @param string $dataStore file path
+     */
+    public function __construct($dataStore)
+    {
+        $this->message = 'Couldn\'t load data from the data store file "'. $dataStore .'". '.
+            'Your data might be corrupted, or your file isn\'t readable.';
+    }
+}
-- 
cgit v1.2.3