Class MOXMAN_Vfs_Memory_File

InheritanceMOXMAN_Vfs_Memory_File » MOXMAN_Vfs_BaseFile
ImplementsMOXMAN_Vfs_IFile

Memory file instance.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Creates a new absolute file. MOXMAN_Vfs_BaseFile
canRead() Returns true if the files is readable. MOXMAN_Vfs_Memory_File
canWrite() Returns true if the files is writable. MOXMAN_Vfs_Memory_File
copyTo() Copies this file to the specified file instance. MOXMAN_Vfs_Memory_File
delete() Deletes the file. MOXMAN_Vfs_Memory_File
exists() Returns true if the file exists. MOXMAN_Vfs_Memory_File
exportTo() Exports the file to a local path. This is used by some operations that can be done in memory. MOXMAN_Vfs_Memory_File
getConfig() Returns a config instance for the current file. The config is provided by the FileConfigProvider specified for the file system. MOXMAN_Vfs_BaseFile
getEntry() MOXMAN_Vfs_Memory_File
getFileSystem() Returns the file system that created the file. MOXMAN_Vfs_BaseFile
getLastModified() Returns last modification date in ms as an long. MOXMAN_Vfs_Memory_File
getMetaData() Returns a meta data instance for the current file. MOXMAN_Vfs_BaseFile
getName() Returns the file name of a file. MOXMAN_Vfs_BaseFile
getParent() Returns the parent files absolute path or an empty string if there is no parent. MOXMAN_Vfs_BaseFile
getParentFile() Returns the parent files File instance. MOXMAN_Vfs_BaseFile
getPath() Returns the absolute path of the file. MOXMAN_Vfs_BaseFile
getPublicLinkPath() Returns the public path of a file that this file points to. MOXMAN_Vfs_BaseFile
getPublicPath() Returns the public path for a file. A public path is a path that is safe to pass to the client side since it doesn't show the systems full path. MOXMAN_Vfs_BaseFile
getSize() Returns file size as an long. MOXMAN_Vfs_Memory_File
getUrl() Returns the URL of the memory file. MOXMAN_Vfs_Memory_File
importFrom() Imports a local file into the file system. MOXMAN_Vfs_Memory_File
isDirectory() Returns true if the file is a directory. MOXMAN_Vfs_BaseFile
isFile() Returns true if the file is a file. MOXMAN_Vfs_Memory_File
isHidden() Returns true if the file is hidden. MOXMAN_Vfs_BaseFile
listFiles() Returns an array of File instances. MOXMAN_Vfs_BaseFile
listFilesFiltered() Returns an array of BaseFile instances based on the specified filter instance. MOXMAN_Vfs_Memory_File
mkdir() Creates a new directory. MOXMAN_Vfs_Memory_File
moveTo() Renames/Moves this file to the specified file instance. MOXMAN_Vfs_Memory_File
open() Opens a file stream by the specified mode. The default mode is rb. MOXMAN_Vfs_Memory_File
setLastModified() Sets the last modified time. MOXMAN_Vfs_Memory_File

Method Details

canRead() public method

Returns true if the files is readable.

public boolean canRead ( )
return boolean

True if the files is readable.

canWrite() public method

Returns true if the files is writable.

public boolean canWrite ( )
return boolean

True if the files is writable.

copyTo() public method

Copies this file to the specified file instance.

public void copyTo ( MOXMAN_Vfs_IFile $dest )
$dest MOXMAN_Vfs_IFile

File to copy to.

delete() public method

Deletes the file.

public void delete ( $deep false )
$deep boolean

If this option is enabled files will be deleted recurive.

exists() public method

Returns true if the file exists.

public boolean exists ( )
return boolean

True if the file exists.

exportTo() public method

Exports the file to a local path. This is used by some operations that can be done in memory.

public string exportTo ( $localPath )
$localPath string

Local path to export file to.

return string

Local path that the file was exported to.

getEntry() public method

public void getEntry ( )
getLastModified() public method

Returns last modification date in ms as an long.

public \long getLastModified ( )
return \long

Last modification date in ms as an long.

getSize() public method

Returns file size as an long.

public \long getSize ( )
return \long

File size as an long.

getUrl() public method

Returns the URL of the memory file.

public String getUrl ( )
return String

Memory file URL.

importFrom() public method

Imports a local file into the file system.

public void importFrom ( $localPath )
$localPath string

Local file system path to import.

isFile() public method

Returns true if the file is a file.

public boolean isFile ( )
return boolean

True if the file is a file.

listFilesFiltered() public method

Returns an array of BaseFile instances based on the specified filter instance.

public MOXMAN_Vfs_FileList listFilesFiltered ( MOXMAN_Vfs_IFileFilter $filter )
$filter MOXMAN_Vfs_IFileFilter

FileFilter instance to filter files by.

return MOXMAN_Vfs_FileList

List of MOXMAN_Vfs_IFile instances.

mkdir() public method

Creates a new directory.

public void mkdir ( )
moveTo() public method

Renames/Moves this file to the specified file instance.

public void moveTo ( MOXMAN_Vfs_IFile $dest )
$dest MOXMAN_Vfs_IFile

File to rename/move to.

open() public method

Opens a file stream by the specified mode. The default mode is rb.

public \MOXMAN_Vfs_IStream open ( $mode = \MOXMAN_Vfs_IStream::READ )
$mode string

Mode to open file by, r, rb, w, wb etc.

return \MOXMAN_Vfs_IStream

File stream implementation for the file system.

setLastModified() public method

Sets the last modified time.

public void setLastModified ( $time )
$time \long

Last modification date in ms as an long.