3 * @copyright Copyright (C) 2010-2022, 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\Core\Storage\Capability;
24 use Friendica\Core\Storage\Exception\ReferenceStorageException;
25 use Friendica\Core\Storage\Exception\StorageException;
28 * Interface for writable storage backends
30 * Used for storages with CRUD functionality, mainly used for user data (e.g. photos, attachements).
31 * There's only one active writable storage possible. This type of storage is selectable by the current administrator.
33 interface ICanWriteToStorage extends ICanReadFromStorage
36 * Put data in backend as $ref. If $ref is not defined a new reference is created.
38 * @param string $data Data to save
39 * @param string $reference Data reference. Optional.
41 * @return string Saved data reference
43 * @throws StorageException in case there's an unexpected error
45 public function put(string $data, string $reference = ""): string;
48 * Remove data from backend
50 * @param string $reference Data reference
52 * @throws StorageException in case there's an unexpected error
53 * @throws ReferenceStorageException in case the reference doesn't exist
55 public function delete(string $reference);