src/Core/Storage/Capability/ICanReadFromStorage.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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 basic storage backends
  29  */
  30 interface ICanReadFromStorage
  31 {
  32         /**
  33          * Get data from backend
  34          *
  35          * @param string $reference Data reference
  36          *
  37          * @return string
  38          *
  39          * @throws StorageException in case there's an unexpected error
  40          * @throws ReferenceStorageException in case the reference doesn't exist
  41          */
  42         public function get(string $reference): string;
  43
  44         /**
  45          * The name of the backend
  46          *
  47          * @return string
  48          */
  49         public function __toString(): string;
  50
  51         /**
  52          * The name of the backend
  53          *
  54          * @return string
  55          */
  56         public static function getName(): string;
  57 }