mirror of https://github.com/friendica/friendica
57 lines
1.9 KiB
PHP
57 lines
1.9 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2023, 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\Core\Storage\Capability;
|
|
|
|
use Friendica\Core\Storage\Exception\ReferenceStorageException;
|
|
use Friendica\Core\Storage\Exception\StorageException;
|
|
|
|
/**
|
|
* Interface for writable storage backends
|
|
*
|
|
* Used for storages with CRUD functionality, mainly used for user data (e.g. photos, attachments).
|
|
* There's only one active writable storage possible. This type of storage is selectable by the current administrator.
|
|
*/
|
|
interface ICanWriteToStorage extends ICanReadFromStorage
|
|
{
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return string Saved data reference
|
|
*
|
|
* @throws StorageException in case there's an unexpected error
|
|
*/
|
|
public function put(string $data, string $reference = ""): string;
|
|
|
|
/**
|
|
* Remove data from backend
|
|
*
|
|
* @param string $reference Data reference
|
|
*
|
|
* @throws StorageException in case there's an unexpected error
|
|
* @throws ReferenceStorageException in case the reference doesn't exist
|
|
*/
|
|
public function delete(string $reference);
|
|
}
|