C# Class Orchard.FileSystems.Media.FileSystemStorageProvider

Inheritance: IStorageProvider
Mostra file Open project: ucdavis/Orchard Class Usage Examples

Public Methods

Method Description
Combine ( string path1, string path2 ) : string

Combines to paths.

CreateFile ( string path ) : IStorageFile

Creates a file in the storage provider.

CreateFolder ( string path ) : void

Creates a folder in the storage provider.

DeleteFile ( string path ) : void

Deletes a file in the storage provider.

DeleteFolder ( string path ) : void

Deletes a folder in the storage provider.

FileSystemStorageProvider ( ShellSettings settings ) : System
GetFile ( string path ) : IStorageFile

Retrieves a file within the storage provider.

GetPublicUrl ( string path ) : string

Retrieves the public URL for a given file within the storage provider.

ListFiles ( string path ) : IEnumerable

Lists the files within a storage provider's path.

ListFolders ( string path ) : IEnumerable

Lists the folders within a storage provider's path.

RenameFile ( string oldPath, string newPath ) : void

Renames a file in the storage provider.

RenameFolder ( string oldPath, string newPath ) : void

Renames a folder in the storage provider.

SaveStream ( string path, Stream inputStream ) : void

Saves a stream in the storage provider.

TryCreateFolder ( string path ) : bool

Tries to create a folder in the storage provider.

TrySaveStream ( string path, Stream inputStream ) : bool

Tries to save a stream in the storage provider.

Private Methods

Method Description
Fix ( string path ) : string
IsHidden ( FileSystemInfo di ) : bool
MapPublic ( string path ) : string

Maps a relative path into the public path.

MapStorage ( string path ) : string

Maps a relative path into the storage path.

Method Details

Combine() public method

Combines to paths.
public Combine ( string path1, string path2 ) : string
path1 string The parent path.
path2 string The child path.
return string

CreateFile() public method

Creates a file in the storage provider.
If the file already exists.
public CreateFile ( string path ) : IStorageFile
path string The relative path to the file to be created.
return IStorageFile

CreateFolder() public method

Creates a folder in the storage provider.
If the folder already exists.
public CreateFolder ( string path ) : void
path string The relative path to the folder to be created.
return void

DeleteFile() public method

Deletes a file in the storage provider.
If the file doesn't exist.
public DeleteFile ( string path ) : void
path string The relative path to the file to be deleted.
return void

DeleteFolder() public method

Deletes a folder in the storage provider.
If the folder doesn't exist.
public DeleteFolder ( string path ) : void
path string The relative path to the folder to be deleted.
return void

FileSystemStorageProvider() public method

public FileSystemStorageProvider ( ShellSettings settings ) : System
settings Orchard.Environment.Configuration.ShellSettings
return System

GetFile() public method

Retrieves a file within the storage provider.
If the file is not found.
public GetFile ( string path ) : IStorageFile
path string The relative path to the file within the storage provider.
return IStorageFile

GetPublicUrl() public method

Retrieves the public URL for a given file within the storage provider.
public GetPublicUrl ( string path ) : string
path string The relative path within the storage provider.
return string

ListFiles() public method

Lists the files within a storage provider's path.
public ListFiles ( string path ) : IEnumerable
path string The relative path to the folder which files to list.
return IEnumerable

ListFolders() public method

Lists the folders within a storage provider's path.
public ListFolders ( string path ) : IEnumerable
path string The relative path to the folder which folders to list.
return IEnumerable

RenameFile() public method

Renames a file in the storage provider.
public RenameFile ( string oldPath, string newPath ) : void
oldPath string The relative path to the file to be renamed.
newPath string The relative path to the new file.
return void

RenameFolder() public method

Renames a folder in the storage provider.
public RenameFolder ( string oldPath, string newPath ) : void
oldPath string The relative path to the folder to be renamed.
newPath string The relative path to the new folder.
return void

SaveStream() public method

Saves a stream in the storage provider.
If the stream can't be saved due to access permissions.
public SaveStream ( string path, Stream inputStream ) : void
path string The relative path to the file to be created.
inputStream Stream The stream to be saved.
return void

TryCreateFolder() public method

Tries to create a folder in the storage provider.
public TryCreateFolder ( string path ) : bool
path string The relative path to the folder to be created.
return bool

TrySaveStream() public method

Tries to save a stream in the storage provider.
public TrySaveStream ( string path, Stream inputStream ) : bool
path string The relative path to the file to be created.
inputStream Stream The stream to be saved.
return bool