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

Inherits FileOp.

Collaboration diagram for StoreFileOp:

[legend]

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.

	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.

	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.

Protected Member Functions
	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.

	getSourceSha1Base36 ()

	getSourceSize ()

Protected Member Functions inherited from FileOp
	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.

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 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

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 76 of file StoreFileOp.php.

References FileOp\setFlags().

◆ doPrecheck()

StoreFileOp::doPrecheck	(	FileStatePredicates	$opPredicates,
		FileStatePredicates	$batchPredicates )

protected

Do a dry-run precondition check of the operation in the context of op batch.

Updates the batch predicates for all paths this op can change if an OK status is returned

Parameters

FileStatePredicates	$opPredicates	Counterfactual file states for op paths at op start
FileStatePredicates	$batchPredicates	Counterfactual file states for the op batch

Returns: StatusValue

Reimplemented from FileOp.

Definition at line 39 of file StoreFileOp.php.

References FileOp\$destExists, FileStatePredicates\assumeFileExists(), getSourceSha1Base36(), getSourceSize(), and FileOp\precheckDestExistence().

◆ getSourceSha1Base36()

StoreFileOp::getSourceSha1Base36 ( )

protected

Definition at line 95 of file StoreFileOp.php.

Referenced by doPrecheck().

◆ getSourceSize()

StoreFileOp::getSourceSize ( )

protected

Definition at line 87 of file StoreFileOp.php.

Referenced by doPrecheck().

◆ storagePathsChanged()

StoreFileOp::storagePathsChanged ( )

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

Returns: array

Reimplemented from FileOp.

Definition at line 106 of file StoreFileOp.php.

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

includes/libs/filebackend/fileop/StoreFileOp.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ allowedParams()

◆ doAttempt()

◆ doPrecheck()

◆ getSourceSha1Base36()

◆ getSourceSize()

◆ storagePathsChanged()