src/Core/Storage/Capability/ICanWriteToStorage.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Storage\Capability;
  23
  24 use Friendica\Core\Storage\Exception\ReferenceStorageException;
  25 use Friendica\Core\Storage\Exception\StorageException;
  26
  27 /**
  28  * Interface for writable storage backends
  29  *
  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.
  32  */
  33 interface ICanWriteToStorage extends ICanReadFromStorage
  34 {
  35         /**
  36          * Put data in backend as $ref. If $ref is not defined a new reference is created.
  37          *
  38          * @param string $data      Data to save
  39          * @param string $reference Data reference. Optional.
  40          *
  41          * @return string Saved data reference
  42          *
  43          * @throws StorageException in case there's an unexpected error
  44          */
  45         public function put(string $data, string $reference = ""): string;
  46
  47         /**
  48          * Remove data from backend
  49          *
  50          * @param string $reference Data reference
  51          *
  52          * @throws StorageException in case there's an unexpected error
  53          * @throws ReferenceStorageException in case the reference doesn't exist
  54          */
  55         public function delete(string $reference);
  56 }