StoreFileOp Class Reference

Store a file into the backend from a file on the file system. More...

Inheritance diagram for StoreFileOp:

Collaboration diagram for StoreFileOp:

Public Member Functions
	storagePathsChanged ()
	Get a list of storage paths written to for this operation.
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.
	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.
	getJournalEntries (array $oPredicates, array $nPredicates)
	Get the file journal entries for this file operation.
	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 (array &$predicates)
	Check preconditions of the operation without writing anything.
	setBatchId ( $batchId)
	Set the batch UUID this operation belongs to.
	storagePathsRead ()
	Get a list of storage paths read from for this operation.

Protected Member Functions
	allowedParams ()
	Get the file operation parameters.
	doAttempt ()
	doPrecheck (array &$predicates)
	getSourceSha1Base36 ()
	precheckDestExistence() helper function to get the source file SHA-1.
Protected Member Functions inherited from FileOp
	fileExists ( $source, array $predicates)
	Check if a file will exist in storage when this operation is attempted.
	fileSha1 ( $source, array $predicates)
	Get the SHA-1 hash a file in storage will have when this operation is attempted.
	precheckDestExistence (array $predicates)
	Check for errors with regards to the destination file already existing.
	setFlags (array $params)
	Adjust params to FileBackendStore internal file calls.

Additional Inherited Members
Static Public Member Functions inherited from FileOp
static	newDependencies ()
	Get a new empty dependency tracking array for paths read/written to.
static	newPredicates ()
	Get a new empty predicates array for precheck()
Public Attributes inherited from FileOp
const	STATE_ATTEMPTED = 3
const	STATE_CHECKED = 2
const	STATE_NEW = 1
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
FileBackendStore	$backend
string	$batchId
bool	$destExists
bool	$doOperation = true
	Operation is not a no-op.
bool	$failed = false
LoggerInterface	$logger
bool	$overwriteSameCase
array	$params = []
string	$sourceSha1
int	$state = self::STATE_NEW

Detailed Description

Store a file into the backend from a file on the file system.

Parameters for this operation are outlined in FileBackend::doOperations().

Definition at line 30 of file StoreFileOp.php.

Member Function Documentation

allowedParams()

StoreFileOp::allowedParams ( )

protected

Get the file operation parameters.

Returns

array (required params list, optional params list, list of params that are paths)

Reimplemented from FileOp.

Definition at line 31 of file StoreFileOp.php.

doAttempt()

StoreFileOp::doAttempt ( )

protected

Returns

StatusValue

Reimplemented from FileOp.

Definition at line 67 of file StoreFileOp.php.

References FileOp\setFlags().

doPrecheck()

StoreFileOp::doPrecheck ( array &  $predicates )

protected

Parameters

array

&$predicates

Returns

StatusValue

Reimplemented from FileOp.

Definition at line 39 of file StoreFileOp.php.

References FileOp\$destExists, FileOp\$sourceSha1, and FileOp\precheckDestExistence().

getSourceSha1Base36()

StoreFileOp::getSourceSha1Base36 ( )

protected

precheckDestExistence() helper function to get the source file SHA-1.

Subclasses should overwride this if the source is not in storage.

Returns

string|bool Returns false on failure

Reimplemented from FileOp.

Definition at line 78 of file StoreFileOp.php.

storagePathsChanged()

StoreFileOp::storagePathsChanged

(

)

Get a list of storage paths written to for this operation.

Returns

array

Reimplemented from FileOp.

Definition at line 89 of file StoreFileOp.php.

---

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

• includes/libs/filebackend/fileop/StoreFileOp.php