MediaWiki master
NullFileOp Class Reference

Placeholder operation that has no params and does nothing. More...

Inherits FileOp.

Collaboration diagram for NullFileOp:

Additional Inherited Members

- Public Member Functions inherited from FileOp
 __construct (FileBackendStore $backend, array $params, LoggerInterface $logger)
 Build a new batch file operation transaction.
 
 applyDependencies (array $deps)
 Update a dependency tracking array to account for this operation.
 
 attempt ()
 Attempt the operation.
 
 attemptAsync ()
 Attempt the operation in the background.
 
 attemptAsyncQuick ()
 Attempt the operation in the background without regards to prechecks.
 
 attemptQuick ()
 Attempt the operation without regards to prechecks.
 
 dependsOn (array $deps)
 Check if this operation changes files listed in $paths.
 
 failed ()
 Check if this operation failed precheck() or attempt()
 
 getBackend ()
 Get the backend this operation is for.
 
 getParam ( $name)
 Get the value of the parameter with the given name.
 
 logFailure ( $action)
 Log a file operation failure and preserve any temp files.
 
 precheck (FileStatePredicates $predicates)
 Do a dry-run precondition check of the operation in the context of op batch.
 
 storagePathsChanged ()
 Get a list of storage paths written to for this operation.
 
 storagePathsRead ()
 Get a list of storage paths read from for this operation.
 
 storagePathsReadOrChanged ()
 Get a list of storage paths read from or written to for this operation.
 
- Static Public Member Functions inherited from FileOp
static newDependencies ()
 Get a new empty dependency tracking array for paths read/written to.
 
- Protected Member Functions inherited from FileOp
 allowedParams ()
 Get the file operation parameters.
 
 doAttempt ()
 
 doPrecheck (FileStatePredicates $opPredicates, FileStatePredicates $batchPredicates)
 Do a dry-run precondition check of the operation in the context of op batch.
 
 precheckDestExistence (FileStatePredicates $opPredicates, $sourceSize, $sourceSha1)
 Check for errors with regards to the destination file already existing.
 
 resolveFileExistence ( $source, FileStatePredicates $opPredicates)
 Check if a file will exist in storage when this operation is attempted.
 
 resolveFileSha1Base36 ( $source, FileStatePredicates $opPredicates)
 Get the SHA-1 of a file in storage when this operation is attempted.
 
 resolveFileSize ( $source, FileStatePredicates $opPredicates)
 Get the size a file in storage will have when this operation is attempted.
 
 setFlags (array $params)
 Adjust params to FileBackendStore internal file calls.
 
- Static Protected Member Functions inherited from FileOp
static normalizeIfValidStoragePath ( $path)
 Normalize a string if it is a valid storage path.
 
- Protected Attributes inherited from FileOp
bool $async = false
 Whether the operation is part of a concurrent sub-batch of operation.
 
FileBackendStore $backend
 
bool null $destExists
 
bool $failed = false
 Whether the operation pre-check or attempt stage failed.
 
LoggerInterface $logger
 
bool $noOp = false
 Whether the operation pre-check stage marked the attempt stage as a no-op.
 
bool null $overwriteSameCase
 
array $params = []
 
int $state = self::STATE_NEW
 Stage in the operation life-cycle.
 

Detailed Description

Placeholder operation that has no params and does nothing.

Definition at line 27 of file NullFileOp.php.


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