MockFileBackend Class Reference
Class simulating a backend store. More...
Inheritance diagram for MockFileBackend:
Collaboration diagram for MockFileBackend:
Protected Member Functions | |
| doGetLocalCopyMulti (array $params) | |
 Protected Member Functions inherited from MemoryFileBackend | |
| directoriesAreVirtual () | |
| Is this a key/value store where directories are just virtual? Virtual directories exists in so much as files exists that are prefixed with the directory path followed by a forward slash. | |
| doCopyInternal (array $params) | |
| doCreateInternal (array $params) | |
| doDeleteInternal (array $params) | |
| doDirectoryExists ( $container, $dir, array $params) | |
| doGetFileStat (array $params) | |
| doStoreInternal (array $params) | |
| resolveHashKey ( $storagePath) | |
| Get the absolute file system path for a storage path. | |
| Protected Member Functions inherited from FileBackendStore | |
| deleteContainerCache ( $container) | |
| Delete the cached info for a container. | |
| deleteFileCache ( $path) | |
| Delete the cached stat info for a file path. | |
| doClean (array $params) | |
| doCleanInternal ( $container, $dir, array $params) | |
| doClearCache (array $paths=null) | |
| Clears any additional stat caches for storage paths. | |
| doConcatenate (array $params) | |
| doDescribeInternal (array $params) | |
| doExecuteOpHandlesInternal (array $fileOpHandles) | |
| doGetFileContentsMulti (array $params) | |
| doGetFileSha1Base36 (array $params) | |
| doGetFileStatMulti (array $params) | |
| Get file stat information (concurrently if possible) for several files. | |
| doGetFileXAttributes (array $params) | |
| doGetLocalReferenceMulti (array $params) | |
| doMoveInternal (array $params) | |
| doOperationsInternal (array $ops, array $opts) | |
| doPrepare (array $params) | |
| doPrepareInternal ( $container, $dir, array $params) | |
| doPrimeContainerCache (array $containerInfo) | |
| Fill the backend-specific process cache given an array of resolved container names and their corresponding cached info. | |
| doPublish (array $params) | |
| doPublishInternal ( $container, $dir, array $params) | |
| doQuickOperationsInternal (array $ops) | |
| doSecure (array $params) | |
| doSecureInternal ( $container, $dir, array $params) | |
| doStreamFile (array $params) | |
| fullContainerName ( $container) | |
| Get the full container name, including the wiki ID prefix. | |
| getContainerHashLevels ( $container) | |
| Get the sharding config for a container. | |
| getContainerShard ( $container, $relPath) | |
| Get the container name shard suffix for a given path. | |
| getContainerSuffixes ( $container) | |
| Get a list of full container shard suffixes for a container. | |
| getContentType ( $storagePath, $content, $fsPath) | |
| Get the content type to use in HEAD/GET requests for a file. | |
| primeContainerCache (array $items) | |
| Do a batch lookup from cache for container stats for all containers used in a list of container names or storage paths objects. | |
| primeFileCache (array $items) | |
| Do a batch lookup from cache for file stats for all paths used in a list of storage paths or FileOp objects. | |
| resolveContainerName ( $container) | |
| Resolve a container name, checking if it's allowed by the backend. | |
| resolveContainerPath ( $container, $relStoragePath) | |
| Resolve a relative storage path, checking if it's allowed by the backend. | |
| resolveStoragePath ( $storagePath) | |
| Splits a storage path into an internal container name, an internal relative file name, and a container shard suffix. | |
| resolveStoragePathReal ( $storagePath) | |
| Like resolveStoragePath() except null values are returned if the container is sharded and the shard could not be determined or if the path ends with '/'. | |
| sanitizeOpHeaders (array $op) | |
| Normalize and filter HTTP headers from a file operation. | |
| setConcurrencyFlags (array $opts) | |
| Set the 'concurrency' option from a list of operation options. | |
| setContainerCache ( $container, array $val) | |
| Set the cached info for a container. | |
| setFileCache ( $path, array $val) | |
| Set the cached stat info for a file path. | |
| Protected Member Functions inherited from FileBackend | |
| newStatus () | |
| Yields the result of the status wrapper callback on either: | |
| resetOutputBuffer () | |
| resolveFSFileObjects (array $ops) | |
| Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile) | |
| scopedProfileSection ( $section) | |
| wrapStatus (StatusValue $sv) | |
Additional Inherited Members | |
| Public Member Functions inherited from MemoryFileBackend | |
| getDirectoryListInternal ( $container, $dir, array $params) | |
| Do not call this function from places outside FileBackend. | |
| getFeatures () | |
| Get the a bitfield of extra features supported by the backend medium. | |
| getFileListInternal ( $container, $dir, array $params) | |
| Do not call this function from places outside FileBackend. | |
| isPathUsableInternal ( $storagePath) | |
| Check if a file can be created or changed at a given storage path. | |
| Public Member Functions inherited from FileBackendStore | |
| __construct (array $config) | |
| clearCache (array $paths=null) | |
| Invalidate any in-process file stat and property cache. | |
| concatenate (array $params) | |
| Concatenate a list of storage files into a single file system file. | |
| copyInternal (array $params) | |
| Copy a file from one storage path to another in the backend. | |
| createInternal (array $params) | |
| Create a file in the backend with the given contents. | |
| deleteInternal (array $params) | |
| Delete a file at the storage path. | |
| describeInternal (array $params) | |
| Alter metadata for a file at the storage path. | |
| directoryExists (array $params) | |
| Check if a directory exists at a given storage path. | |
| executeOpHandlesInternal (array $fileOpHandles) | |
| Execute a list of FileBackendStoreOpHandle handles in parallel. | |
| fileExists (array $params) | |
| Check if a file exists at a storage path in the backend. | |
| getDirectoryList (array $params) | |
| Get an iterator to list all directories under a storage directory. | |
| getFileContentsMulti (array $params) | |
| Like getFileContents() except it takes an array of storage paths and returns a map of storage paths to strings (or null on failure). | |
| getFileHttpUrl (array $params) | |
| getFileList (array $params) | |
| Get an iterator to list all stored files under a storage directory. | |
| getFileProps (array $params) | |
| Get the properties of the file at a storage path in the backend. | |
| getFileSha1Base36 (array $params) | |
| Get a SHA-1 hash of the file at a storage path in the backend. | |
| getFileSize (array $params) | |
| Get the size (bytes) of a file at a storage path in the backend. | |
| getFileStat (array $params) | |
| Get quick information about a file at a storage path in the backend. | |
| getFileTimestamp (array $params) | |
| Get the last-modified timestamp of the file at a storage path. | |
| getFileXAttributes (array $params) | |
| Get metadata about a file at a storage path in the backend. | |
| getLocalCopyMulti (array $params) | |
| Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to TempFSFile objects (or null on failure). | |
| getLocalReferenceMulti (array $params) | |
| Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths to FSFile objects (or null on failure). | |
| getOperationsInternal (array $ops) | |
| Return a list of FileOp objects from a list of operations. | |
| getPathsToLockForOpsInternal (array $performOps) | |
| Get a list of storage paths to lock for a list of operations Returns an array with LockManager::LOCK_UW (shared locks) and LockManager::LOCK_EX (exclusive locks) keys, each corresponding to a list of storage paths to be locked. | |
| getScopedLocksForOps (array $ops, StatusValue $status) | |
| Get an array of scoped locks needed for a batch of file operations. | |
| isSingleShardPathInternal ( $storagePath) | |
| Check if a storage path maps to a single shard. | |
| maxFileSizeInternal () | |
| Get the maximum allowable file size given backend medium restrictions and basic performance constraints. | |
| moveInternal (array $params) | |
| Move a file from one storage path to another in the backend. | |
| nullInternal (array $params) | |
| No-op file operation that does nothing. | |
| preloadCache (array $paths) | |
| Preload persistent file stat cache and property cache into in-process cache. | |
| preloadFileStat (array $params) | |
| Preload file stat information (concurrently if possible) into in-process cache. | |
| storeInternal (array $params) | |
| Store a file into the backend from a file on disk. | |
| streamFile (array $params) | |
| Stream the file at a storage path in the backend. | |
| Public Member Functions inherited from FileBackend | |
| clean (array $params) | |
| Delete a storage directory if it is empty. | |
| copy (array $params, array $opts=[]) | |
| Performs a single copy operation. | |
| create (array $params, array $opts=[]) | |
| Performs a single create operation. | |
| delete (array $params, array $opts=[]) | |
| Performs a single delete operation. | |
| describe (array $params, array $opts=[]) | |
| Performs a single describe operation. | |
| doOperation (array $op, array $opts=[]) | |
| Same as doOperations() except it takes a single operation. | |
| doOperations (array $ops, array $opts=[]) | |
| This is the main entry point into the backend for write operations. | |
| doQuickOperation (array $op) | |
| Same as doQuickOperations() except it takes a single operation. | |
| doQuickOperations (array $ops, array $opts=[]) | |
| Perform a set of independent file operations on some files. | |
| getContainerStoragePath ( $container) | |
| Get the storage path for the given container for this backend. | |
| getDomainId () | |
| Get the domain identifier used for this backend (possibly empty). | |
| getFileContents (array $params) | |
| Get the contents of a file at a storage path in the backend. | |
| getJournal () | |
| Get the file journal object for this backend. | |
| getLocalCopy (array $params) | |
| Get a local copy on disk of the file at a storage path in the backend. | |
| getLocalReference (array $params) | |
| Returns a file system file, identical to the file at a storage path. | |
| getName () | |
| Get the unique backend name. | |
| getReadOnlyReason () | |
| Get an explanatory message if this backend is read-only. | |
| getRootStoragePath () | |
| Get the root storage path of this backend. | |
| getScopedFileLocks (array $paths, $type, StatusValue $status, $timeout=0) | |
| Lock the files at the given storage paths in the backend. | |
| getTopDirectoryList (array $params) | |
| Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the given directory. | |
| getTopFileList (array $params) | |
| Same as FileBackend::getFileList() except only lists files that are immediately under the given directory. | |
| getWikiId () | |
| Alias to getDomainId() | |
| hasFeatures ( $bitfield) | |
| Check if the backend medium supports a field of extra features. | |
| isReadOnly () | |
| Check if this backend is read-only. | |
| lockFiles (array $paths, $type, $timeout=0) | |
| Lock the files at the given storage paths in the backend. | |
| move (array $params, array $opts=[]) | |
| Performs a single move operation. | |
| prepare (array $params) | |
| Prepare a storage directory for usage. | |
| publish (array $params) | |
| Remove measures to block web access to a storage directory and the container it belongs to. | |
| quickCopy (array $params) | |
| Performs a single quick copy operation. | |
| quickCreate (array $params) | |
| Performs a single quick create operation. | |
| quickDelete (array $params) | |
| Performs a single quick delete operation. | |
| quickDescribe (array $params) | |
| Performs a single quick describe operation. | |
| quickMove (array $params) | |
| Performs a single quick move operation. | |
| quickStore (array $params) | |
| Performs a single quick store operation. | |
| secure (array $params) | |
| Take measures to block web access to a storage directory and the container it belongs to. | |
| setLogger (LoggerInterface $logger) | |
| store (array $params, array $opts=[]) | |
| Performs a single store operation. | |
| unlockFiles (array $paths, $type) | |
| Unlock the files at the given storage paths in the backend. | |
| Static Public Member Functions inherited from FileBackend | |
| static | extensionFromPath ( $path, $case='lowercase') |
| Get the final extension from a storage or FS path. | |
| static | isPathTraversalFree ( $path) |
| Check if a relative path has no directory traversals. | |
| static | isStoragePath ( $path) |
| Check if a given path is a "mwstore://" path. | |
| static | makeContentDisposition ( $type, $filename='') |
| Build a Content-Disposition header value per RFC 6266. | |
| static | normalizeStoragePath ( $storagePath) |
| Normalize a storage path by cleaning up directory separators. | |
| static | parentStoragePath ( $storagePath) |
| Get the parent storage directory of a storage path. | |
| static | splitStoragePath ( $storagePath) |
| Split a storage path into a backend name, a container name, and a relative file path. | |
| Public Attributes inherited from FileBackendStore | |
| const | CACHE_CHEAP_SIZE = 500 |
| const | CACHE_EXPENSIVE_SIZE = 5 |
| const | CACHE_TTL = 10 |
| Public Attributes inherited from FileBackend | |
| const | ATTR_HEADERS = 1 |
| Bitfield flags for supported features. | |
| const | ATTR_METADATA = 2 |
| const | ATTR_UNICODE_PATHS = 4 |
| Static Protected Member Functions inherited from FileBackendStore | |
| static | isValidContainerName ( $container) |
| Check if a full container name is valid. | |
| static | isValidShortContainerName ( $container) |
| Check if a short container name is valid. | |
| static | normalizeXAttributes (array $xattr) |
| Normalize file headers/metadata to the FileBackend::getFileXAttributes() format. | |
| Static Protected Member Functions inherited from FileBackend | |
| static | normalizeContainerPath ( $path) |
| Validate and normalize a relative storage path. | |
| Protected Attributes inherited from MemoryFileBackend | |
| array | $files = [] |
| Map of (file path => (data,mtime) | |
| Protected Attributes inherited from FileBackendStore | |
| MapCacheLRU | $cheapCache |
| Map of paths to small (RAM/disk) cache items. | |
| MapCacheLRU | $expensiveCache |
| Map of paths to large (RAM/disk) cache items. | |
| $maxFileSize = 4294967296 | |
| WANObjectCache | $memCache |
| callable | $mimeCallback |
| Method to get the MIME type of files. | |
| array | $shardViaHashLevels = [] |
| Map of container names to sharding config. | |
| BagOStuff | $srvCache |
| Protected Attributes inherited from FileBackend | |
| int | $concurrency |
| How many operations can be done in parallel. | |
| string | $domainId |
| Unique domain name. | |
| FileJournal | $fileJournal |
| LockManager | $lockManager |
| LoggerInterface | $logger |
| string | $name |
| Unique backend name. | |
| callable | $obResetFunc |
| string | $parallelize |
| When to do operations in parallel. | |
| callable null | $profiler |
| string | $readOnly |
| Read-only explanation message. | |
| callable | $statusWrapper |
| callable | $streamMimeFunc |
| string | $tmpDirectory |
| Temporary file directory. | |
Detailed Description
Member Function Documentation
◆ doGetLocalCopyMulti()
|
protected |
- Parameters
-
array $params
- Returns
- array
Reimplemented from MemoryFileBackend.
Definition at line 32 of file MockFileBackend.php.
References $params, as, wfRandomString(), and wfTempDir().
The documentation for this class was generated from the following file:
- tests/phpunit/mocks/filebackend/MockFileBackend.php
