Class MOXMAN_Vfs_BasicFileMetaDataProvider

InheritanceMOXMAN_Vfs_BasicFileMetaDataProvider
ImplementsMOXMAN_Vfs_IFileMetaDataProvider

This is to be implemented by file meta data provider instances. A meta data provider provides meta data instances for specific files.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructs a new basic file meta data provider. MOXMAN_Vfs_BasicFileMetaDataProvider
dispose() Disposes the instance. MOXMAN_Vfs_BasicFileMetaDataProvider
getMetaData() Returns MOXMAN_Vfs_IFileMetaData instance. MOXMAN_Vfs_BasicFileMetaDataProvider
loadMetaData() Loads meta data for the specified file and returns the result. MOXMAN_Vfs_BasicFileMetaDataProvider
saveMetaData() Saves meta data for the specified file. MOXMAN_Vfs_BasicFileMetaDataProvider

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getMetaFile() Returns the meta data file instance used to store meta information. MOXMAN_Vfs_BasicFileMetaDataProvider

Method Details

__construct() public method

Constructs a new basic file meta data provider.

public void __construct ( MOXMAN_Vfs_FileSystem $fileSystem )
$fileSystem MOXMAN_Vfs_FileSystem

File system instance for the meta data provider.

dispose() public method

Disposes the instance.

public void dispose ( )
getMetaData() public method

Returns MOXMAN_Vfs_IFileMetaData instance.

public \MOXMAN_Vfs_IFileMetaData getMetaData ( MOXMAN_Vfs_IFile $file )
$file MOXMAN_Vfs_IFile

File instance to get meta data for.

return \MOXMAN_Vfs_IFileMetaData

Meta data instance.

getMetaFile() protected method

Returns the meta data file instance used to store meta information.

protected MOXMAN_Vfs_IFile getMetaFile ( MOXMAN_Vfs_IFile $file )
$file MOXMAN_Vfs_IFile

File instance to get the meta data file for.

return MOXMAN_Vfs_IFile

Meta data file.

loadMetaData() public method

Loads meta data for the specified file and returns the result.

public Array loadMetaData ( MOXMAN_Vfs_IFile $file )
$file MOXMAN_Vfs_IFile

File to get the meta data from.

return Array

Name/value array with meta data.

saveMetaData() public method

Saves meta data for the specified file.

public void saveMetaData ( MOXMAN_Vfs_IFile $file, $items )
$file MOXMAN_Vfs_IFile

File to save the meta data for.

$items