Merge pull request #10283 from very-ape/fix-message-button

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

diff --git a/src/Model/Storage/IStorage.php b/src/Model/Storage/IStorage.php
index c3ec3197c9e227a27fc8817c2fbc0fb4d248b98b..8a9b60f73bf4fdffd88f8134c2b24fc19f4d618b 100644 (file)
--- a/src/Model/Storage/IStorage.php
+++ b/src/Model/Storage/IStorage.php
@@ -1,18 +1,33 @@
 <?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 storage backends
  */
 interface IStorage
 {
        /**
-        * @brief Get data from backend
+        * Get data from backend
         *
         * @param string $reference Data reference
         *
@@ -21,7 +36,7 @@ interface IStorage
        public function get(string $reference);
 
        /**
-        * @brief Put data in backend as $ref. If $ref is not defined a new reference is created.
+        * Put data in backend as $ref. If $ref is not defined a new reference is created.
         *
         * @param string $data      Data to save
         * @param string $reference Data reference. Optional.
@@ -31,7 +46,7 @@ interface IStorage
        public function put(string $data, string $reference = "");
 
        /**
-        * @brief Remove data from backend
+        * Remove data from backend
         *
         * @param string $reference Data reference
         *
@@ -40,7 +55,7 @@ interface IStorage
        public function delete(string $reference);
 
        /**
-        * @brief Get info about storage options
+        * Get info about storage options
         *
         * @return array
         *
@@ -63,7 +78,7 @@ interface IStorage
         *      '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'
+        *                   // 'select', 'select_raw', 'textarea'
         *
         *      'label',     // Translatable label of the field
         *      'value',     // Current value
@@ -72,7 +87,6 @@ interface IStorage
         *                   // 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
@@ -80,7 +94,7 @@ interface IStorage
        public function getOptions();
 
        /**
-        * @brief Validate and save options
+        * Validate and save options
         *
         * @param array $data Array [optionname => value] to be saved
         *