includes/libs/filebackend/fileophandle/FileBackendStoreOpHandle.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup FileBackend
  20  */
  21
  22 /**
  23  * FileBackendStore helper class for performing asynchronous file operations.
  24  *
  25  * For example, calling FileBackendStore::createInternal() with the "async"
  26  * param flag may result in a StatusValue that contains this object as a value.
  27  * This class is largely backend-specific and is mostly just "magic" to be
  28  * passed to FileBackendStore::executeOpHandlesInternal().
  29  */
  30 abstract class FileBackendStoreOpHandle {
  31         /** @var array */
  32         public $params = []; // params to caller functions
  33         /** @var FileBackendStore */
  34         public $backend;
  35         /** @var array */
  36         public $resourcesToClose = [];
  37
  38         public $call; // string; name that identifies the function called
  39
  40         /**
  41          * Close all open file handles
  42          */
  43         public function closeResources() {
  44                 array_map( 'fclose', $this->resourcesToClose );
  45         }
  46 }