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 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         public function get(string $reference);
  37
  38         /**
  39          * Put data in backend as $ref. If $ref is not defined a new reference is created.
  40          *
  41          * @param string $data      Data to save
  42          * @param string $reference Data reference. Optional.
  43          *
  44          * @return string Saved data reference
  45          */
  46         public function put(string $data, string $reference = "");
  47
  48         /**
  49          * Remove data from backend
  50          *
  51          * @param string $reference Data reference
  52          *
  53          * @return boolean  True on success
  54          */
  55         public function delete(string $reference);
  56
  57         /**
  58          * Get info about storage options
  59          *
  60          * @return array
  61          *
  62          * This method return an array with informations about storage options
  63          * from which the form presented to the user is build.
  64          *
  65          * The returned array is:
  66          *
  67          *    [
  68          *      'option1name' => [ ..info.. ],
  69          *      'option2name' => [ ..info.. ],
  70          *      ...
  71          *    ]
  72          *
  73          * An empty array can be returned if backend doesn't have any options
  74          *
  75          * The info array for each option MUST be as follows:
  76          *
  77          *    [
  78          *      'type',      // define the field used in form, and the type of data.
  79          *                   // one of 'checkbox', 'combobox', 'custom', 'datetime',
  80          *                   // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
  81          *                   // 'select', 'select_raw', 'textarea'
  82          *
  83          *      'label',     // Translatable label of the field
  84          *      'value',     // Current value
  85          *      'help text', // Translatable description for the field
  86          *      extra data   // Optional. Depends on 'type':
  87          *                   // select: array [ value => label ] of choices
  88          *                   // intcheckbox: value of input element
  89          *                   // select_raw: prebuild html string of < option > tags
  90          *    ]
  91          *
  92          * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
  93          */
  94         public function getOptions();
  95
  96         /**
  97          * Validate and save options
  98          *
  99          * @param array $data Array [optionname => value] to be saved
 100          *
 101          * @return array  Validation errors: [optionname => error message]
 102          *
 103          * Return array must be empty if no error.
 104          */
 105         public function saveOptions(array $data);
 106
 107         /**
 108          * The name of the backend
 109          *
 110          * @return string
 111          */
 112         public function __toString();
 113
 114         /**
 115          * The name of the backend
 116          *
 117          * @return string
 118          */
 119         public static function getName();
 120 }