MediaWiki master
Public Member Functions | Public Attributes | List of all members
SwiftFileOpHandle Class Reference

Inherits FileBackendStoreOpHandle.

Collaboration diagram for SwiftFileOpHandle:
Collaboration graph
[legend]

Public Member Functions

 __construct (SwiftFileBackend $backend, Closure $callback, array $httpOp)
 Construct a handle to be use with SwiftFileOpHandle::doExecuteOpHandlesInternal()
 
- Public Member Functions inherited from FileBackendStoreOpHandle
 closeResources ()
 Close all open file handles.
 

Public Attributes

Closure $callback
 Function to run after each HTTP request finishes.
 
array[] $httpOp
 List of HTTP request maps for SwiftFileBackend::requestWithAuth.
 
int $state = self::CONTINUE_IF_OK
 Class CONTINUE_* constant.
 
- Public Attributes inherited from FileBackendStoreOpHandle
FileBackendStore $backend
 
callable $call
 name that identifies the function called
 
array $params = []
 
array $resourcesToClose = []
 

Detailed Description

Definition at line 25 of file SwiftFileOpHandle.php.

Constructor & Destructor Documentation

◆ __construct()

SwiftFileOpHandle::__construct ( SwiftFileBackend $backend,
Closure $callback,
array $httpOp )

Construct a handle to be use with SwiftFileOpHandle::doExecuteOpHandlesInternal()

The callback returns a class CONTINUE_* constant and takes the following parameters:

  • An HTTP request map array with 'response' filled
  • A StatusValue instance to be updated as needed
Parameters
SwiftFileBackend$backend
Closure$callback
array$httpOpRequest to send via SwiftFileBackend::requestWithAuth()

Definition at line 50 of file SwiftFileOpHandle.php.

References FileBackendStoreOpHandle\$backend, $callback, and $httpOp.

Member Data Documentation

◆ $callback

Closure SwiftFileOpHandle::$callback

Function to run after each HTTP request finishes.

Definition at line 29 of file SwiftFileOpHandle.php.

Referenced by __construct().

◆ $httpOp

array [] SwiftFileOpHandle::$httpOp

List of HTTP request maps for SwiftFileBackend::requestWithAuth.

Definition at line 27 of file SwiftFileOpHandle.php.

Referenced by __construct().

◆ $state

int SwiftFileOpHandle::$state = self::CONTINUE_IF_OK

Class CONTINUE_* constant.

Definition at line 32 of file SwiftFileOpHandle.php.

The documentation for this class was generated from the following file: