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
  54         /**
  55          * Get info about storage options
  56          *
  57          * @return array
  58          *
  59          * This method return an array with informations about storage options
  60          * from which the form presented to the user is build.
  61          *
  62          * The returned array is:
  63          *
  64          *    [
  65          *      'option1name' => [ ..info.. ],
  66          *      'option2name' => [ ..info.. ],
  67          *      ...
  68          *    ]
  69          *
  70          * An empty array can be returned if backend doesn't have any options
  71          *
  72          * The info array for each option MUST be as follows:
  73          *
  74          *    [
  75          *      'type',      // define the field used in form, and the type of data.
  76          *                   // one of 'checkbox', 'combobox', 'custom', 'datetime',
  77          *                   // 'input', 'intcheckbox', 'password', 'radio', 'richtext'
  78          *                   // 'select', 'select_raw', 'textarea'
  79          *
  80          *      'label',     // Translatable label of the field
  81          *      'value',     // Current value
  82          *      'help text', // Translatable description for the field
  83          *      extra data   // Optional. Depends on 'type':
  84          *                   // select: array [ value => label ] of choices
  85          *                   // intcheckbox: value of input element
  86          *                   // select_raw: prebuild html string of < option > tags
  87          *    ]
  88          *
  89          * See https://github.com/friendica/friendica/wiki/Quick-Template-Guide
  90          */
  91         public function getOptions(): array;
  92
  93         /**
  94          * Validate and save options
  95          *
  96          * @param array $data Array [optionname => value] to be saved
  97          *
  98          * @return array  Validation errors: [optionname => error message]
  99          *
 100          * Return array must be empty if no error.
 101          */
 102         public function saveOptions(array $data): array;
 103 }