Abstract Class MOXMAN_Vfs_FileSystem

All Classes | Properties | Methods

Inheritance	MOXMAN_Vfs_FileSystem
Subclasses	MOXMAN_AmazonS3_FileSystem, MOXMAN_Azure_FileSystem, MOXMAN_Favorites_FileSystem, MOXMAN_Ftp_FileSystem, MOXMAN_History_FileSystem, MOXMAN_Uploaded_FileSystem, MOXMAN_Vfs_Cache_FileSystem, MOXMAN_Vfs_Local_FileSystem, MOXMAN_Vfs_Memory_FileSystem

Abstract base class for a file system. This provides common logic and can be used as a base for FileSystem implementations.

Protected Properties

Hide inherited properties

Property	Type	Defined By
$config	MOXMAN_Util_Config	MOXMAN_Vfs_FileSystem
$configProvider	MOXMAN_Vfs_IFileConfigProvider	MOXMAN_Vfs_FileSystem
$metaDataProvider	MOXMAN_Vfs_IFileMetaDataProvider	MOXMAN_Vfs_FileSystem
$rootName	string	MOXMAN_Vfs_FileSystem
$rootPath	string	MOXMAN_Vfs_FileSystem
$scheme	string	MOXMAN_Vfs_FileSystem
$urlProvider	MOXMAN_Vfs_IFileUrlProvider	MOXMAN_Vfs_FileSystem
$urlResolver	MOXMAN_Vfs_IFileUrlResolver	MOXMAN_Vfs_FileSystem

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()	Constructs a new file system with a scheme, config and root.	MOXMAN_Vfs_FileSystem
close()	Closes the file system.	MOXMAN_Vfs_FileSystem
getConfig()	Config instance for the file system.	MOXMAN_Vfs_FileSystem
getFileConfigProvider()	Returns the config provider instance.	MOXMAN_Vfs_FileSystem
getFileMetaDataProvider()	Returns the meta data provider instance.	MOXMAN_Vfs_FileSystem
getFileUrlProvider()	Returns the url provider instance.	MOXMAN_Vfs_FileSystem
getFileUrlResolver()	Returns the url resolver instance.	MOXMAN_Vfs_FileSystem
getRootFile()	Returns the a file object for the root of the file system.	MOXMAN_Vfs_FileSystem
getRootName()	Returns the name of the root for the file system.	MOXMAN_Vfs_FileSystem
getRootPath()	Returns the path of the root for the file system.	MOXMAN_Vfs_FileSystem
getScheme()	Returns the file system scheme for example "local".	MOXMAN_Vfs_FileSystem
isCacheable()	Returns the true/false if the file system can be cached or not.	MOXMAN_Vfs_FileSystem
setFileConfigProvider()	Sets the config provider for the filesystem.	MOXMAN_Vfs_FileSystem
setFileMetaDataProvider()	Sets the meta data provider instance.	MOXMAN_Vfs_FileSystem
setFileUrlProvider()	Sets the url provider instance.	MOXMAN_Vfs_FileSystem
setFileUrlResolver()	Sets the url resolver instance.	MOXMAN_Vfs_FileSystem

Property Details

$config protected property

protected MOXMAN_Util_Config $config = null

$configProvider protected property

protected MOXMAN_Vfs_IFileConfigProvider $configProvider = null

$metaDataProvider protected property

protected MOXMAN_Vfs_IFileMetaDataProvider $metaDataProvider = null

$rootName protected property

protected string $rootName = null

$rootPath protected property

protected string $rootPath = null

$scheme protected property

protected string $scheme = null

$urlProvider protected property

protected MOXMAN_Vfs_IFileUrlProvider $urlProvider = null

$urlResolver protected property

protected MOXMAN_Vfs_IFileUrlResolver $urlResolver = null

Method Details

__construct() public method

Constructs a new file system with a scheme, config and root.

public void __construct ( $scheme, $config, $root )
$scheme	string	Scheme to use for the file system.
$config	MOXMAN_Util_Config	Config instance to use for the file system.
$root	string	Root path for the file system.

close() public method

Closes the file system.

public void close ( )

getConfig() public method

Config instance for the file system.

public MOXMAN_Util_Config getConfig ( )
return	MOXMAN_Util_Config	Config instance.

getFileConfigProvider() public method

Returns the config provider instance.

public MOXMAN_Vfs_IFileConfigProvider getFileConfigProvider ( )
return	MOXMAN_Vfs_IFileConfigProvider	Config provider instance.

getFileMetaDataProvider() public method

Returns the meta data provider instance.

public MOXMAN_Vfs_IFileMetaDataProvider getFileMetaDataProvider ( )
return	MOXMAN_Vfs_IFileMetaDataProvider	Meta data provider instance.

getFileUrlProvider() public method

Returns the url provider instance.

public MOXMAN_Vfs_IFileUrlProvider getFileUrlProvider ( )
return	MOXMAN_Vfs_IFileUrlProvider	File url provider.

getFileUrlResolver() public method

Returns the url resolver instance.

public MOXMAN_Vfs_IFileUrlResolver getFileUrlResolver ( )
return	MOXMAN_Vfs_IFileUrlResolver	File url resolver.

getRootFile() public method

Returns the a file object for the root of the file system.

public MOXMAN_Vfs_IFile getRootFile ( )
return	MOXMAN_Vfs_IFile	Root file for the file system.

getRootName() public method

Returns the name of the root for the file system.

public String getRootName ( )
return	String	Name of the root for the file system.

getRootPath() public method

Returns the path of the root for the file system.

public String getRootPath ( )
return	String	Path for the root of the file system.

getScheme() public method

Returns the file system scheme for example "local".

public String getScheme ( )
return	String	File system scheme.

isCacheable() public method

Returns the true/false if the file system can be cached or not.

public \True/false isCacheable ( )
return	\True/false	If the file system is cacheable or not.

setFileConfigProvider() public method

Sets the config provider for the filesystem.

public void setFileConfigProvider ( MOXMAN_Vfs_IFileConfigProvider $provider )
$provider	MOXMAN_Vfs_IFileConfigProvider	Config provider instance to use for the file system.

setFileMetaDataProvider() public method

Sets the meta data provider instance.

public void setFileMetaDataProvider ( MOXMAN_Vfs_IFileMetaDataProvider $provider )
$provider	MOXMAN_Vfs_IFileMetaDataProvider	Provider instance to use for the file system.

setFileUrlProvider() public method

Sets the url provider instance.

public void setFileUrlProvider ( MOXMAN_Vfs_IFileUrlProvider $provider )
$provider	MOXMAN_Vfs_IFileUrlProvider	File Url provider to use to resolve files into urls.

setFileUrlResolver() public method

Sets the url resolver instance.

public void setFileUrlResolver ( MOXMAN_Vfs_IFileUrlResolver $resolver )
$resolver	MOXMAN_Vfs_IFileUrlResolver	File Url resolver to use to resolve urls into files.