Insert a `user-contact` for every contact

[friendica.git] / src / Model / Storage / IStorage.php

diff --git a/src/Model/Storage/IStorage.php b/src/Model/Storage/IStorage.php
index d9d2ddf7e23129bf60d89602b8432b5e26cae94c..8841487412a69aafab5b7a9ac06f5874e882d056 100644 (file)
--- a/src/Model/Storage/IStorage.php
+++ b/src/Model/Storage/IStorage.php
@@ -1,35 +1,54 @@
 <?php
 /**
- * @file src/Model/Storage/IStorage.php
- * @brief Storage backend system
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
 
 namespace Friendica\Model\Storage;
 
 /**
- * @brief Interface for storage backends
+ * Interface for basic storage backends
  */
 interface IStorage
 {
        /**
-        * @brief Get data from backend
-        * @param string  $ref  Data reference
+        * Get data from backend
+        *
+        * @param string $reference Data reference
+        *
         * @return string
-     */
-       public static function get($ref);
+        *
+        * @throws StorageException in case there's an unexpected error
+        * @throws ReferenceStorageException in case the reference doesn't exist
+        */
+       public function get(string $reference): string;
 
        /**
-        * @brief Put data in backend as $ref. If $ref is null a new reference is created.
-        * @param string  $data  Data to save
-        * @param string  $ref   Data referece. Optional.
-        * @return string Saved data referece
+        * The name of the backend
+        *
+        * @return string
         */
-       public static function put($data, $ref = null);
+       public function __toString();
 
        /**
-        * @brief Remove data from backend
-        * @param string  $ref  Data referece
-        * @return boolean  True on success
+        * The name of the backend
+        *
+        * @return string
         */
-       public static function delete($ref);
-}
\ No newline at end of file
+       public static function getName(): string;
+}