Wikimedia\FileBackend\MemoryFileBackend Class Reference

Simulation of a backend storage in memory. More...

Inherits Wikimedia\FileBackend\FileBackendStore.

Collaboration diagram for Wikimedia\FileBackend\MemoryFileBackend:

Public Member Functions
	getDirectoryListInternal ( $fullCont, $dirRel, array $params)
	Do not call this function from places outside FileBackend. See also FileBackendStore::getDirectoryList() Parameters string $fullCont Resolved container name string $dirRel Resolved path relative to container array $params Returns Traversable|array|null Iterable list or null (error)
	getFeatures ()
	Get the a bitfield of extra features supported by the backend medium. Stability: stable to override Returns int Bitfield of FileBackend::ATTR_* flags Since 1.23
	getFileListInternal ( $fullCont, $dirRel, array $params)
	Do not call this function from places outside FileBackend. See also FileBackendStore::getFileList() Parameters string $fullCont Resolved container name string $dirRel Resolved path relative to container array $params Returns Traversable|string[]|null Iterable list or null (error)
	isPathUsableInternal ( $storagePath)
	Check if a file can be created or changed at a given storage path in the backend.FS backends should check that the parent directory exists, files can be written under it, and that any file already there is both readable and writable. Backends using key/value stores should check if the container exists. Parameters string $storagePath Returns bool
Public Member Functions inherited from Wikimedia\FileBackend\FileBackendStore
	__construct (array $config)
	addShellboxInputFile (BoxedCommand $command, string $boxedName, array $params)
	Add a file to a Shellbox command as an input file. Parameters BoxedCommand $command string $boxedName array $params Parameters include: src : source storage path latest : use the latest available data Returns StatusValue Since 1.43
	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.The target path should refer to a file that is already locked or otherwise safe from modification from other processes. Normally, the file will be a new temp file, which should be adequate. Parameters array $params Operation parameters, include: srcs : ordered source storage paths (e.g. chunk1, chunk2, ...) dst : file system path to 0-byte temp file parallelize : try to do operations in parallel when possible Returns StatusValue
	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.For backends using key/value stores, a directory is said to exist whenever there exist any files with paths using the given directory path as a prefix followed by a forward slash. For example, if there is a file called "mwstore://backend/container/dir/path.svg" then directories are said to exist at "mwstore://backend/container" and "mwstore://backend/container/dir". These can be thought of as "virtual" directories.Backends that directly use a filesystem layer might enumerate empty directories. The clean() method should always be used when files are deleted or moved if this is a concern. This is a trade-off to avoid write amplication/contention on file changes or read amplification when calling this method.Storage backends with eventual consistency might return stale data. See also FileBackend::EXISTENCE_ERROR FileBackend::clean() Parameters array $params Parameters include: dir : storage directory Returns bool|null Whether a directory exists or null (I/O error) Since 1.20
	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.This returns false if only a directory exists at the path.Callers that only care if a file is readily accessible can use non-strict comparisons on the result. If "does not exist" and "existence is unknown" must be distinguished, then strict comparisons to true/null should be used. See also FileBackend::EXISTENCE_ERROR FileBackend::directoryExists() Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns bool|null Whether the file exists or null (I/O error)
	getDirectoryList (array $params)
	Get an iterator to list all directories under a storage directory.If the directory is of the form "mwstore://backend/container", then all directories in the container will be listed. If the directory is of form "mwstore://backend/container/dir", then all directories directly under that directory will be listed. Results will be storage directories relative to the given directory.Storage backends with eventual consistency might return stale data.Failures during iteration can result in FileBackendError exceptions (since 1.22). See also FileBackend::LIST_ERROR FileBackend::directoryExists() Parameters array $params Parameters include: dir : storage directory topOnly : only return direct child dirs of the directory Returns \Traversable|array|null Directory list enumerator or null (initial I/O error) Since 1.20
	getFileContentsMulti (array $params)
	Like getFileContents() except it takes an array of storage paths and returns an order preserved map of storage paths to their content. See also FileBackend::getFileContents() Parameters array $params Parameters include: srcs : list of source storage paths latest : use the latest available data parallelize : try to do operations in parallel when possible Returns string[]|false[] Map of (path name => file content or false on failure) Since 1.20
	getFileHttpUrl (array $params)
	getFileList (array $params)
	Get an iterator to list all stored files under a storage directory.If the directory is of the form "mwstore://backend/container", then all files in the container will be listed. If the directory is of form "mwstore://backend/container/dir", then all files under that directory will be listed. Results will be storage paths relative to the given directory.Storage backends with eventual consistency might return stale data.Failures during iteration can result in FileBackendError exceptions (since 1.22). See also FileBackend::LIST_ERROR Parameters array $params Parameters include: dir : storage directory topOnly : only return direct child files of the directory (since 1.20) adviseStat : set to true if stat requests will be made on the files (since 1.22) forWrite : true if the list will inform a write operations (since 1.41) Returns \Traversable|array|null File list enumerator or null (initial I/O error)
	getFileProps (array $params)
	Get the properties of the content of the file at a storage path in the backend.This gives the result of FSFile::getProps() on a local copy of the file. Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns array Properties map; FSFile::placeholderProps() if file missing or on I/O error
	getFileSha1Base36 (array $params)
	Get a SHA-1 hash of the content of the file at a storage path in the backend. See also FileBackend::SHA1_FAIL Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns string|false Hash string or false (missing file or I/O error)
	getFileSize (array $params)
	Get the size (bytes) of a file at a storage path in the backend. See also FileBackend::SIZE_FAIL Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns int|false File size in bytes or false (missing file or I/O error)
	getFileStat (array $params)
	Get quick information about a file at a storage path in the backend.If the file does not exist, then this returns false. Otherwise, the result is an associative array that includes: mtime : the last-modified timestamp (TS::MW) size : the file size (bytes) Additional values may be included for internal use only. See also FileBackend::STAT_ABSENT FileBackend::STAT_ERROR Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns array|false|null Attribute map, false (missing file), or null (I/O error)
	getFileTimestamp (array $params)
	Get the last-modified timestamp of the file at a storage path. See also FileBackend::TIMESTAMP_FAIL Parameters array $params Parameters include: src : source storage path latest : use the latest available data Returns string|false TS::MW timestamp or false (missing file or I/O error)
	getFileXAttributes (array $params)
	Get metadata about a file at a storage path in the backend.If the file does not exist, then this returns false. Otherwise, the result is an associative array that includes: headers : map of HTTP headers used for GET/HEAD requests (name => value) metadata : map of file metadata (name => value) Metadata keys and headers names will be returned in all lower-case. Additional values may be included for internal use only. Use FileBackend::hasFeatures() to check how well this is supported. See also FileBackend::XATTRS_FAIL Parameters array $params $params include: src : source storage path latest : use the latest available data Returns array|false File metadata array or false (missing file or I/O error) Since 1.23
	getLocalCopyMulti (array $params)
	Like getLocalCopy() except it takes an array of storage paths and yields an order preserved-map of storage paths to temporary local file copies.Multiple calls to this method for the same path will create new copies. See also FileBackend::getLocalCopy() Parameters array $params Parameters include: srcs : list of source storage paths latest : use the latest available data parallelize : try to do operations in parallel when possible Returns array Map of (path name => TempFSFile or false (missing) or null (error)) Since 1.20
	getLocalReferenceMulti (array $params)
	Like getLocalReference() except it takes an array of storage paths and yields an order-preserved map of storage paths to temporary local file copies.Never modify the returned files since they might be originals, they might be shared among multiple callers of this method, or the backend might internally keep FSFile references for deferred operations. See also FileBackend::getLocalReference() Parameters array $params Parameters include: srcs : list of source storage paths latest : use the latest available data parallelize : try to do operations in parallel when possible Returns array Map of (path name => FSFile or false (missing) or null (error)) Since 1.20
	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.Normally, FileBackend::doOperations() handles locking, unless the 'nonLocking' param is passed in. This function is useful if you want the files to be locked for a broader scope than just when the files are changing. For example, if you need to update DB metadata, you may want to keep the files locked until finished. See also FileBackend::doOperations() Parameters array $ops List of file operations to FileBackend::doOperations() StatusValue $status StatusValue to update on lock/unlock Returns ScopedLock|null RAII-style self-unlocking lock or null on failure Since 1.20
	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.This should be used when stat calls will be made on a known list of a many files. This does not make use of the persistent file stat cache. See also FileBackend::getFileStat() Parameters array $params Parameters include: srcs : list of source storage paths latest : use the latest available data Returns bool Whether all requests proceeded without I/O errors (since 1.24) Since 1.23
	storeInternal (array $params)
	Store a file into the backend from a file on disk.
	streamFile (array $params)
	Stream the content of the file at a storage path in the backend.If the file does not exists, an HTTP 404 error will be given. Appropriate HTTP headers (Status, Content-Type, Content-Length) will be sent if streaming began, while none will be sent otherwise. Implementations should flush the output buffer before sending data. Parameters array $params Parameters include: src : source storage path headers : list of additional HTTP headers to send if the file exists options : HTTP request header map with lower case keys (since 1.28). Supports: range : format is "bytes=(\\d*-\\d*)" if-modified-since : format is an HTTP date headless : do not send HTTP headers (including those of "headers") (since 1.28) latest : use the latest available data allowOB : preserve any output buffers (since 1.28) Returns StatusValue
Public Member Functions inherited from Wikimedia\FileBackend\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, array $opts=[])
	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.
	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 in content 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.
	getStreamerOptions ()
	Return options for use with HTTPFileStreamer.
	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, array $opts=[])
	Performs a single quick copy operation.
	quickCreate (array $params, array $opts=[])
	Performs a single quick create operation.
	quickDelete (array $params, array $opts=[])
	Performs a single quick delete operation.
	quickDescribe (array $params, array $opts=[])
	Performs a single quick describe operation.
	quickMove (array $params, array $opts=[])
	Performs a single quick move operation.
	quickStore (array $params, array $opts=[])
	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.

Protected Member Functions
	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. Returns bool
	doCopyInternal (array $params)
	See also FileBackendStore::copyInternal() Parameters array $params Returns StatusValue
	doCreateInternal (array $params)
	See also FileBackendStore::createInternal() Parameters array $params Returns StatusValue
	doDeleteInternal (array $params)
	See also FileBackendStore::deleteInternal() Parameters array $params Returns StatusValue
	doDirectoryExists ( $fullCont, $dirRel, array $params)
	See also FileBackendStore::directoryExists() Parameters string $fullCont Resolved container name string $dirRel Resolved path relative to container array $params Returns bool|null
	doGetFileStat (array $params)
	See also FileBackendStore::getFileStat() Parameters array $params Returns array|false|null
	doGetLocalCopyMulti (array $params)
	See also FileBackendStore::getLocalCopyMulti() Parameters array $params Returns string[]|bool[]|null[] Map of (path => TempFSFile, false (missing), or null (error))
	doMoveInternal (array $params)
	See also FileBackendStore::moveInternal() Parameters array $params Returns StatusValue
	doStoreInternal (array $params)
	See also FileBackendStore::storeInternal() Parameters array $params Returns StatusValue
	resolveHashKey ( $storagePath)
	Get the absolute file system path for a storage path.
Protected Member Functions inherited from Wikimedia\FileBackend\FileBackendStore
	deleteContainerCache ( $container)
	Delete the cached info for a container.
	deleteFileCache ( $path)
	Delete the cached stat info for a file path.
	doClean (array $params)
	See also FileBackend::clean() Parameters array $params Returns StatusValue
	doCleanInternal ( $fullCont, $dirRel, 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)
	doOperationsInternal (array $ops, array $opts)
	See also FileBackend::doOperations() Parameters array $ops array $opts Returns StatusValue
	doPrepare (array $params)
	See also FileBackend::prepare() Parameters array $params Returns StatusValue Good status without value for success, fatal otherwise.
	doPrepareInternal ( $fullCont, $dirRel, 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)
	See also FileBackend::publish() Parameters array $params Returns StatusValue
	doPublishInternal ( $fullCont, $dirRel, array $params)
	doQuickOperationsInternal (array $ops, array $opts)
	See also FileBackend::doQuickOperations() Parameters array $ops array $opts Returns StatusValue Since 1.20
	doSecure (array $params)
	See also FileBackend::secure() Parameters array $params Returns StatusValue
	doSecureInternal ( $fullCont, $dirRel, array $params)
	doStreamFile (array $params)
	fullContainerName ( $container)
	Get the full container name, including the domain 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.
	ingestFreshFileStats (array $stats, $latest)
	Ingest file stat entries that just came from querying the backend (not cache)
	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 Wikimedia\FileBackend\FileBackend
	callNowOrLater (callable $update)
	header ( $header)
	newStatus ( $message=null,... $params)
	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)

Protected Attributes
array	$files = []
	Map of (file path => (data,mtime)
Protected Attributes inherited from Wikimedia\FileBackend\FileBackendStore
MapCacheLRU	$cheapCache
	In-memory map of paths to small (RAM/disk) cache items.
MapCacheLRU	$expensiveCache
	In-memory map of paths to large (RAM/disk) cache items.
int	$maxFileSize = 32 * 1024 * 1024 * 1024
	Size in bytes, defaults to 32 GiB.
	$memCache
callable null	$mimeCallback
	Method to get the MIME type of files.
array< string, array >	$shardViaHashLevels = []
	Map of container names to sharding config.
BagOStuff	$srvCache
	Persistent local server/host cache (e.g.
WANObjectCache	$wanCache
	Persistent cache accessible to all relevant datacenters.
WANObjectCache	$wanStatCache
	Cache used for persistent file/container stat entries.
const	CACHE_CHEAP_SIZE = 500
const	CACHE_EXPENSIVE_SIZE = 5
const	CACHE_TTL = 10
Protected Attributes inherited from Wikimedia\FileBackend\FileBackend
int	$concurrency
	How many operations can be done in parallel.
string	$domainId
	Unique domain name.
LockManager	$lockManager
LoggerInterface	$logger
string	$name
	Unique backend name.
string	$parallelize
	When to do operations in parallel.
callable null	$profiler
string	$readOnly
	Read-only explanation message.
callable null	$statusWrapper
array	$streamerOptions
	Option map for use with HTTPFileStreamer.
TempFSFileFactory	$tmpFileFactory

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\FileBackend\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	resetOutputBufferTheDefaultWay ()
	Default behavior of resetOutputBuffer().
static	splitStoragePath ( $storagePath)
	Split a storage path into a backend name, a container name, and a relative file path.
Public Attributes inherited from Wikimedia\FileBackend\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 Wikimedia\FileBackend\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 Wikimedia\FileBackend\FileBackend
static	normalizeContainerPath ( $path)
	Validate and normalize a relative storage path.

Detailed Description

Simulation of a backend storage in memory.

All data in the backend is automatically deleted at the end of PHP execution. Since the data stored here is volatile, this is only useful for staging or testing.

Since

1.23

Definition at line 25 of file MemoryFileBackend.php.

Member Function Documentation

directoriesAreVirtual()

Wikimedia\FileBackend\MemoryFileBackend::directoriesAreVirtual ( )

protected

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.

Returns

bool

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 267 of file MemoryFileBackend.php.

doCopyInternal()

Wikimedia\FileBackend\MemoryFileBackend::doCopyInternal ( array $params )

protected

See also

FileBackendStore::copyInternal()

Parameters

array

$params

Returns

StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 87 of file MemoryFileBackend.php.

doCreateInternal()

Wikimedia\FileBackend\MemoryFileBackend::doCreateInternal ( array $params )

protected

See also

FileBackendStore::createInternal()

Parameters

array

$params

Returns

StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 40 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

doDeleteInternal()

Wikimedia\FileBackend\MemoryFileBackend::doDeleteInternal ( array $params )

protected

See also

FileBackendStore::deleteInternal()

Parameters

array

$params

Returns

StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 139 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

doDirectoryExists()

Wikimedia\FileBackend\MemoryFileBackend::doDirectoryExists ( $fullCont, $dirRel, array $params )

protected

See also

FileBackendStore::directoryExists()

Parameters

string	$fullCont	Resolved container name
string	$dirRel	Resolved path relative to container
array	$params

Returns

bool|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 206 of file MemoryFileBackend.php.

References $path.

doGetFileStat()

Wikimedia\FileBackend\MemoryFileBackend::doGetFileStat ( array $params )

protected

See also

FileBackendStore::getFileStat()

Parameters

array

$params

Returns

array|false|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 163 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

doGetLocalCopyMulti()

Wikimedia\FileBackend\MemoryFileBackend::doGetLocalCopyMulti ( array $params )

protected

See also

FileBackendStore::getLocalCopyMulti()

Parameters

array

$params

Returns

string[]|bool[]|null[] Map of (path => TempFSFile, false (missing), or null (error))

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 180 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\extensionFromPath(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

doMoveInternal()

Wikimedia\FileBackend\MemoryFileBackend::doMoveInternal ( array $params )

protected

See also

FileBackendStore::moveInternal()

Parameters

array

$params

Returns

StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 92 of file MemoryFileBackend.php.

doStoreInternal()

Wikimedia\FileBackend\MemoryFileBackend::doStoreInternal ( array $params )

protected

See also

FileBackendStore::storeInternal()

Parameters

array

$params

Returns

StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 59 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

getDirectoryListInternal()

Wikimedia\FileBackend\MemoryFileBackend::getDirectoryListInternal	(		$fullCont,
			$dirRel,
		array	$params )

Do not call this function from places outside FileBackend.

See also

FileBackendStore::getDirectoryList()

Parameters

string	$fullCont	Resolved container name
string	$dirRel	Resolved path relative to container
array	$params

Returns

Traversable|array|null Iterable list or null (error)

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 218 of file MemoryFileBackend.php.

References $path.

getFeatures()

Wikimedia\FileBackend\MemoryFileBackend::getFeatures

(

)

Get the a bitfield of extra features supported by the backend medium.

Stability: stable

to override

Returns

int Bitfield of FileBackend::ATTR_* flags

Since

1.23

Reimplemented from Wikimedia\FileBackend\FileBackend.

Definition at line 30 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\ATTR_UNICODE_PATHS.

getFileListInternal()

Wikimedia\FileBackend\MemoryFileBackend::getFileListInternal	(		$fullCont,
			$dirRel,
		array	$params )

Do not call this function from places outside FileBackend.

See also

FileBackendStore::getFileList()

Parameters

string	$fullCont	Resolved container name
string	$dirRel	Resolved path relative to container
array	$params

Returns

Traversable|string[]|null Iterable list or null (error)

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 246 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\$files, and $path.

isPathUsableInternal()

Wikimedia\FileBackend\MemoryFileBackend::isPathUsableInternal

(

$storagePath

)

Check if a file can be created or changed at a given storage path in the backend.FS backends should check that the parent directory exists, files can be written under it, and that any file already there is both readable and writable. Backends using key/value stores should check if the container exists.

Parameters

string

$storagePath

Returns

bool

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 35 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

resolveHashKey()

Wikimedia\FileBackend\MemoryFileBackend::resolveHashKey ( $storagePath )

protected

Get the absolute file system path for a storage path.

Parameters

string

$storagePath

Returns

string|null

Definition at line 277 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackendStore\resolveStoragePathReal().

Referenced by Wikimedia\FileBackend\MemoryFileBackend\doCreateInternal(), Wikimedia\FileBackend\MemoryFileBackend\doDeleteInternal(), Wikimedia\FileBackend\MemoryFileBackend\doGetFileStat(), Wikimedia\FileBackend\MemoryFileBackend\doGetLocalCopyMulti(), Wikimedia\FileBackend\MemoryFileBackend\doStoreInternal(), and Wikimedia\FileBackend\MemoryFileBackend\isPathUsableInternal().

Member Data Documentation

$files

array Wikimedia\FileBackend\MemoryFileBackend::$files = []

protected

Map of (file path => (data,mtime)

Definition at line 27 of file MemoryFileBackend.php.

Referenced by Wikimedia\FileBackend\MemoryFileBackend\getFileListInternal().

---

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

• includes/libs/FileBackend/MemoryFileBackend.php