src/Model/Storage/IWritableStorage.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\Model\Storage;
  23
  24 /**
  25  * Interface for writable storage backends
  26  *
  27  * Used for storages with CRUD functionality, mainly used for user data (e.g. photos, attachements).
  28  * There's only one active writable storage possible. This type of storage is selectable by the current administrator.
  29  */
  30 interface IWritableStorage extends IStorage
  31 {
  32         /**
  33          * Put data in backend as $ref. If $ref is not defined a new reference is created.
  34          *
  35          * @param string $data      Data to save
  36          * @param string $reference Data reference. Optional.
  37          *
  38          * @return string Saved data reference
  39          *
  40          * @throws StorageException in case there's an unexpected error
  41          */
  42         public function put(string $data, string $reference = ""): string;
  43
  44         /**
  45          * Remove data from backend
  46          *
  47          * @param string $reference Data reference
  48          *
  49          * @throws StorageException in case there's an unexpected error
  50          * @throws ReferenceStorageException in case the reference doesn't exist
  51          */
  52         public function delete(string $reference);
  53 }