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 selectable storage backends
27 interface ISelectableStorage extends IStorage
30 * Put data in backend as $ref. If $ref is not defined a new reference is created.
32 * @param string $data Data to save
33 * @param string $reference Data reference. Optional.
35 * @return string Saved data reference
37 * @throws StorageException in case there's an unexpected error
39 public function put(string $data, string $reference = ""): string;
42 * Remove data from backend
44 * @param string $reference Data reference
46 * @throws StorageException in case there's an unexpected error
47 * @throws ReferenceStorageException in case the reference doesn't exist
49 public function delete(string $reference);
52 * Get info about storage options
56 * This method return an array with informations about storage options
57 * from which the form presented to the user is build.
59 * The returned array is:
62 * 'option1name' => [ ..info.. ],
63 * 'option2name' => [ ..info.. ],
67 * An empty array can be returned if backend doesn't have any options
69 * The info array for each option MUST be as follows:
72 * 'type', // define the field used in form, and the type of data.
73 * // one of 'checkbox', 'combobox', 'custom', 'datetime',
74 * // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
75 * // 'select', 'select_raw', 'textarea'
77 * 'label', // Translatable label of the field
78 * 'value', // Current value
79 * 'help text', // Translatable description for the field
80 * extra data // Optional. Depends on 'type':
81 * // select: array [ value => label ] of choices
82 * // intcheckbox: value of input element
83 * // select_raw: prebuild html string of < option > tags
86 * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
88 public function getOptions(): array;
91 * Validate and save options
93 * @param array $data Array [optionname => value] to be saved
95 * @return array Validation errors: [optionname => error message]
97 * Return array must be empty if no error.
99 public function saveOptions(array $data): array;