src/Model/Storage/IStorage.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 basic storage backends
  26  */
  27 interface IStorage
  28 {
  29         /**
  30          * Get data from backend
  31          *
  32          * @param string $reference Data reference
  33          *
  34          * @return string
  35          *
  36          * @throws StorageException in case there's an unexpected error
  37          * @throws ReferenceStorageException in case the reference doesn't exist
  38          */
  39         public function get(string $reference): string;
  40
  41         /**
  42          * The name of the backend
  43          *
  44          * @return string
  45          */
  46         public function __toString();
  47
  48         /**
  49          * The name of the backend
  50          *
  51          * @return string
  52          */
  53         public static function getName(): string;
  54 }