includes/libs/filebackend/fileophandle/SwiftFileOpHandle.php

   1 <?php
   2 /**
   3  * OpenStack Swift based file backend.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup FileBackend
  22  * @author Russ Nelson
  23  */
  24
  25 namespace Wikimedia\FileBackend\FileOpHandle;
  26
  27 use Closure;
  28 use Wikimedia\FileBackend\SwiftFileBackend;
  29
  30 class SwiftFileOpHandle extends FileBackendStoreOpHandle {
  31         /** @var array[] List of HTTP request maps for SwiftFileBackend::requestWithAuth */
  32         public $httpOp;
  33         /** @var Closure Function to run after each HTTP request finishes */
  34         public $callback;
  35
  36         /** @var int Class CONTINUE_* constant */
  37         public $state = self::CONTINUE_IF_OK;
  38
  39         /** @var int Continue with the next requests stages if no errors occurred */
  40         public const CONTINUE_IF_OK = 0;
  41         /** @var int Cancel the next requests stages */
  42         public const CONTINUE_NO = 1;
  43
  44         /**
  45          * Construct a handle to be use with SwiftFileOpHandle::doExecuteOpHandlesInternal()
  46          *
  47          * The callback returns a class CONTINUE_* constant and takes the following parameters:
  48          *   - An HTTP request map array with 'response' filled
  49          *   - A StatusValue instance to be updated as needed
  50          *
  51          * @param SwiftFileBackend $backend
  52          * @param Closure $callback
  53          * @param array $httpOp Request to send via SwiftFileBackend::requestWithAuth()
  54          */
  55         public function __construct( SwiftFileBackend $backend, Closure $callback, array $httpOp ) {
  56                 $this->backend = $backend;
  57                 $this->callback = $callback;
  58                 $this->httpOp = $httpOp;
  59         }
  60 }
  61
  62 /** @deprecated class alias since 1.43 */
  63 class_alias( SwiftFileOpHandle::class, 'SwiftFileOpHandle' );