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. | |
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 for this operation are outlined in FileBackend::doOperations().
Definition at line 510 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 511 of file FileOp.php.
| StoreFileOp::doAttempt | ( | ) | [protected] |
| StoreFileOp::doPrecheck | ( | array &$ | predicates | ) | [protected] |
| 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 553 of file FileOp.php.
Get a list of storage paths written to for this operation.
- Returns:
- Array
Reimplemented from FileOp.
Definition at line 563 of file FileOp.php.
The documentation for this class was generated from the following file:
- includes/filebackend/FileOp.php
