3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model\Storage;
25 * Interface for storage backends
27 * @todo Split this interface into "IStorage" for get() operations (including Resource fetching) and "IUserStorage" for real user backends including put/delete/options
32 * Get data from backend
34 * @param string $reference Data reference
38 public function get(string $reference);
41 * Put data in backend as $ref. If $ref is not defined a new reference is created.
43 * @param string $data Data to save
44 * @param string $reference Data reference. Optional.
46 * @return string Saved data reference
48 public function put(string $data, string $reference = "");
51 * Remove data from backend
53 * @param string $reference Data reference
55 * @return boolean True on success
57 public function delete(string $reference);
60 * Get info about storage options
64 * This method return an array with informations about storage options
65 * from which the form presented to the user is build.
67 * The returned array is:
70 * 'option1name' => [ ..info.. ],
71 * 'option2name' => [ ..info.. ],
75 * An empty array can be returned if backend doesn't have any options
77 * The info array for each option MUST be as follows:
80 * 'type', // define the field used in form, and the type of data.
81 * // one of 'checkbox', 'combobox', 'custom', 'datetime',
82 * // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
83 * // 'select', 'select_raw', 'textarea'
85 * 'label', // Translatable label of the field
86 * 'value', // Current value
87 * 'help text', // Translatable description for the field
88 * extra data // Optional. Depends on 'type':
89 * // select: array [ value => label ] of choices
90 * // intcheckbox: value of input element
91 * // select_raw: prebuild html string of < option > tags
94 * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
96 public function getOptions();
99 * Validate and save options
101 * @param array $data Array [optionname => value] to be saved
103 * @return array Validation errors: [optionname => error message]
105 * Return array must be empty if no error.
107 public function saveOptions(array $data);
110 * The name of the backend
114 public function __toString();
117 * The name of the backend
121 public static function getName();