src/Model/Storage/ISelectableStorage.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 selectable storage backends
  26  */
  27 interface ISelectableStorage extends IStorage
  28 {
  29         /**
  30          * Put data in backend as $ref. If $ref is not defined a new reference is created.
  31          *
  32          * @param string $data      Data to save
  33          * @param string $reference Data reference. Optional.
  34          *
  35          * @return string Saved data reference
  36          *
  37          * @throws StorageException in case there's an unexpected error
  38          */
  39         public function put(string $data, string $reference = ""): string;
  40
  41         /**
  42          * Remove data from backend
  43          *
  44          * @param string $reference Data reference
  45          *
  46          * @throws StorageException in case there's an unexpected error
  47          * @throws ReferenceStorageException in case the reference doesn't exist
  48          */
  49         public function delete(string $reference);
  50
  51         /**
  52          * Get info about storage options
  53          *
  54          * @return array
  55          *
  56          * This method return an array with informations about storage options
  57          * from which the form presented to the user is build.
  58          *
  59          * The returned array is:
  60          *
  61          *    [
  62          *      'option1name' => [ ..info.. ],
  63          *      'option2name' => [ ..info.. ],
  64          *      ...
  65          *    ]
  66          *
  67          * An empty array can be returned if backend doesn't have any options
  68          *
  69          * The info array for each option MUST be as follows:
  70          *
  71          *    [
  72          *      'type',      // define the field used in form, and the type of data.
  73          *                   // one of 'checkbox', 'combobox', 'custom', 'datetime',
  74          *                   // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
  75          *                   // 'select', 'select_raw', 'textarea'
  76          *
  77          *      'label',     // Translatable label of the field
  78          *      'value',     // Current value
  79          *      'help text', // Translatable description for the field
  80          *      extra data   // Optional. Depends on 'type':
  81          *                   // select: array [ value => label ] of choices
  82          *                   // intcheckbox: value of input element
  83          *                   // select_raw: prebuild html string of < option > tags
  84          *    ]
  85          *
  86          * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
  87          */
  88         public function getOptions(): array;
  89
  90         /**
  91          * Validate and save options
  92          *
  93          * @param array $data Array [optionname => value] to be saved
  94          *
  95          * @return array  Validation errors: [optionname => error message]
  96          *
  97          * Return array must be empty if no error.
  98          */
  99         public function saveOptions(array $data): array;
 100 }