Abstract Class MOXMAN_Vfs_FileSystem
Abstract base class for a file system. This provides common logic and can be used as a base for FileSystem implementations.
Protected Properties
Public 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
Method Details
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. |
Closes the file system.
public void close ( ) |
Config instance for the file system.
public MOXMAN_Util_Config getConfig ( ) | ||
return | MOXMAN_Util_Config | Config instance. |
---|
Returns the config provider instance.
public MOXMAN_Vfs_IFileConfigProvider getFileConfigProvider ( ) | ||
return | MOXMAN_Vfs_IFileConfigProvider | Config provider instance. |
---|
Returns the meta data provider instance.
public MOXMAN_Vfs_IFileMetaDataProvider getFileMetaDataProvider ( ) | ||
return | MOXMAN_Vfs_IFileMetaDataProvider | Meta data provider instance. |
---|
Returns the url provider instance.
public MOXMAN_Vfs_IFileUrlProvider getFileUrlProvider ( ) | ||
return | MOXMAN_Vfs_IFileUrlProvider | File url provider. |
---|
Returns the url resolver instance.
public MOXMAN_Vfs_IFileUrlResolver getFileUrlResolver ( ) | ||
return | MOXMAN_Vfs_IFileUrlResolver | File url resolver. |
---|
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. |
---|
Returns the name of the root for the file system.
public String getRootName ( ) | ||
return | String | Name of the root for the file system. |
---|
Returns the path of the root for the file system.
public String getRootPath ( ) | ||
return | String | Path for the root of the file system. |
---|
Returns the file system scheme for example "local".
public String getScheme ( ) | ||
return | String | File system scheme. |
---|
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. |
---|
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. |
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. |
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. |
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. |