MediaWiki  REL1_19
Public Member Functions | Protected Member Functions
StoreFileOp Class Reference

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

Inheritance diagram for StoreFileOp:
Inheritance graph
[legend]
Collaboration diagram for StoreFileOp:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 storagePathsChanged ()
 Get a list of storage paths written to 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.

Detailed Description

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

Parameters similar to FileBackendStore::storeInternal(), which include: src : source path on file system dst : destination storage path overwrite : do nothing and pass if an identical file exists at destination overwriteSame : override any existing file at destination

Definition at line 429 of file FileOp.php.

Member Function Documentation

StoreFileOp::allowedParams ( ) [protected]

Get the file operation parameters.

Returns:
Array (required params list, optional params list)

Reimplemented from FileOp.

Definition at line 430 of file FileOp.php.

StoreFileOp::doAttempt ( ) [protected]
Returns:
Status

Reimplemented from FileOp.

Definition at line 459 of file FileOp.php.

References Status\newGood().

Here is the call graph for this function:

StoreFileOp::doPrecheck ( array &$  predicates) [protected]
Returns:
Status

Reimplemented from FileOp.

Definition at line 434 of file FileOp.php.

References Status\newGood(), and FileOp\precheckDestExistence().

Here is the call graph for this function:

StoreFileOp::getSourceSha1Base36 ( ) [protected]

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

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

Returns:
string|false Returns false on failure

Reimplemented from FileOp.

Definition at line 468 of file FileOp.php.

References wfBaseConvert(), wfRestoreWarnings(), and wfSuppressWarnings().

Here is the call graph for this function:

StoreFileOp::storagePathsChanged ( )

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

Returns:
Array

Reimplemented from FileOp.

Definition at line 478 of file FileOp.php.

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