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 1b0129e5e6960503b1ff7cdf89e44f5105e8255c..8841487412a69aafab5b7a9ac06f5874e882d056 100644 (file)
--- a/src/Model/Storage/IStorage.php
+++ b/src/Model/Storage/IStorage.php
@@ -1,89 +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);
-
-       /**
-        * @brief Put data in backend as $ref. If $ref is not defined a new reference is created.
-        * @param string  $data  Data to save
-        * @param string  $ref   Data referece. Optional.
-        * @return string Saved data referece
+        *
+        * @throws StorageException in case there's an unexpected error
+        * @throws ReferenceStorageException in case the reference doesn't exist
         */
-       public static function put($data, $ref = "");
+       public function get(string $reference): string;
 
        /**
-        * @brief Remove data from backend
-        * @param string  $ref  Data referece
-        * @return boolean  True on success
-        */
-       public static function delete($ref);
-       
-       /**
-        * @brief Get info about storage options
-        *
-        * @return array
-        *
-        * This method return an array with informations about storage options
-        * from which the form presented to the user is build.
-        *
-        * The returned array is:
-        *
-        *    [
-        *      'option1name' => [ ..info.. ],
-        *      'option2name' => [ ..info.. ],
-        *      ...
-        *    ]
+        * The name of the backend
         *
-        * An empty array can be returned if backend doesn't have any options
-        *
-        * The info array for each option MUST be as follows:
-        *
-        *    [
-        *      'type',      // define the field used in form, and the type of data.
-        *                   // one of 'checkbox', 'combobox', 'custom', 'datetime',
-        *                   // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
-        *                   // 'select', 'select_raw', 'textarea', 'yesno'
-        *
-        *      'label',     // Translatable label of the field
-        *      'value',     // Current value
-        *      'help text', // Translatable description for the field
-        *      extra data   // Optional. Depends on 'type':
-        *                   // select: array [ value => label ] of choices
-        *                   // intcheckbox: value of input element
-        *                   // select_raw: prebuild html string of < option > tags
-        *                   // yesno: array [ 'label no', 'label yes']
-        *    ]
-        *
-        * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
+        * @return string
         */
-       public static function getOptions();
-       
+       public function __toString();
+
        /**
-        * @brief Validate and save options
+        * The name of the backend
         *
-        * @param array  $data  Array [optionname => value] to be saved
-        *
-        * @return array  Validation errors: [optionname => error message]
-        *
-        * Return array must be empty if no error.
+        * @return string
         */
-       public static function saveOptions($data);
-       
+       public static function getName(): string;
 }
-
-