Class MOXMAN_AmazonS3_FileSystem

InheritanceMOXMAN_AmazonS3_FileSystem » MOXMAN_Vfs_FileSystem

This class returns file instances for the AmazonS3 File system.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructs a new AmazonS3 instance. MOXMAN_AmazonS3_FileSystem
close() Closes the file system. This will release any resources used by the file system. MOXMAN_AmazonS3_FileSystem
createSignedRequest() MOXMAN_AmazonS3_FileSystem
exportTo() Exports the specified Amazon S3 path to the specified local path. MOXMAN_AmazonS3_FileSystem
getBucketOption() Returns a bucket option by name or the default value if it isn't defined. MOXMAN_AmazonS3_FileSystem
getCache() MOXMAN_AmazonS3_FileSystem
getConfig() Config instance for the file system. MOXMAN_Vfs_FileSystem
getFile() Returns a MOXMAN_Vfs_IFile file instance for the specified path. MOXMAN_AmazonS3_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
getStatCache() MOXMAN_AmazonS3_FileSystem
importFrom() Imports a local file into the Amazon S3 file system. MOXMAN_AmazonS3_FileSystem
isCacheable() Returns the true/false if the file system can be cached or not. MOXMAN_AmazonS3_FileSystem
logHttpClient() Logs HTTP client messages to log file with a specific prefix. MOXMAN_AmazonS3_FileSystem
sendRequest() MOXMAN_AmazonS3_FileSystem
sendXmlRequest() Sends a XML request to the S3 rest API. MOXMAN_AmazonS3_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

Method Details

__construct() public method

Constructs a new AmazonS3 instance.

public void __construct ( $scheme, $config, $root )
$scheme String

File system protocol scheme.

$config MOXMAN_Util_Config

Config instance for file system.

$root String

Root path for file system.

close() public method

Closes the file system. This will release any resources used by the file system.

public void close ( )
createSignedRequest() public method

public void createSignedRequest ( $params )
$params
exportTo() public method

Exports the specified Amazon S3 path to the specified local path.

public void exportTo ( $path, $localPath )
$path String

Path to S3 file in bucket.

$localPath String

Local file system path to save file to.

getBucketOption() public method

Returns a bucket option by name or the default value if it isn't defined.

public mixed getBucketOption ( $name, $default "" )
$name String

Name of the option to get.

$default mixed

Default value to return if the option isn't defined.

return mixed

Option value or default value if it doesn't exist.

getCache() public method

public void getCache ( )
getFile() public method

Returns a MOXMAN_Vfs_IFile file instance for the specified path.

public MOXMAN_Vfs_IFile getFile ( $path )
$path String

Path of the file to get from file system.

return MOXMAN_Vfs_IFile

File instance for the specified path.

getStatCache() public method

public void getStatCache ( )
importFrom() public method

Imports a local file into the Amazon S3 file system.

public void importFrom ( $localPath, $path )
$localPath String

Local file system path to import.

$path String

Path of S3 path to store the file at.

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.

logHttpClient() public method

Logs HTTP client messages to log file with a specific prefix.

public void logHttpClient ( $str )
$str mixed

String to log.

sendRequest() public method

public void sendRequest ( $params )
$params
sendXmlRequest() public method

Sends a XML request to the S3 rest API.

public SimpleXMLElement sendXmlRequest ( $params )
$params Array

Name/value array of query string parameters.

return SimpleXMLElement

Simple XML element of the response body.