C# Class BlogEngine.Core.Providers.XmlFileSystemProvider

XmlBlogProvider Parial class for manageing all FileSystem methods

Inheritance: BlogFileSystemProvider

Show file Open project: rasmuskl/ReSharperCourse Class Usage Examples

Public Methods

Method	Description
ClearFileSystem ( ) : void	Clears a file system. This will delete all files and folders recursivly. Handle with care... Possibly an internal method?
DeleteDirectory ( string VirtualPath ) : void	Deletes a spefic directory from a virtual path Virtual path is the path starting from the /files/ containers The entity is queried against to current blog id
DeleteFile ( string VirtualPath ) : void	deletes a file by virtual path
DirectoryExists ( string VirtualPath ) : bool	Returns wether or not the specific directory by virtual path exists
FileExists ( string VirtualPath ) : bool	boolean wether a file exists by its virtual path
GetDirectories ( FileSystem BaseDirectory ) : IEnumerable	gets all the directories underneath a base directory. Only searches one level.
GetDirectory ( FileSystem BaseDirectory ) : FileSystem.Directory	gets a directory by a basedirectory and a string array of sub path tree
GetDirectory ( FileSystem BaseDirectory, bool CreateNew ) : FileSystem.Directory	gets a directory by a basedirectory and a string array of sub path tree
GetDirectory ( string VirtualPath ) : FileSystem.Directory	gets a directory by the virtual path
GetDirectory ( string VirtualPath, bool CreateNew ) : FileSystem.Directory
GetFile ( string VirtualPath ) : FileSystem.File	gets a specific file by virtual path
GetFiles ( FileSystem BaseDirectory ) : IEnumerable	gets all the files in a directory, only searches one level
ImageThumbnail ( string VirtualPath, int MaximumSize ) : FileSystem.Image
UploadFile ( byte FileBinary, string FileName, FileSystem BaseDirectory ) : FileSystem.File	uploads a file to the provider container
UploadFile ( byte FileBinary, string FileName, FileSystem BaseDirectory, bool Overwrite ) : FileSystem.File	uploads a file to the provider container

Private Methods

Method	Description
BlogAbsolutePath ( string VirtualPath ) : string	gets the absolute file path from a virtual path.
CreateDirectory ( string VirtualPath ) : FileSystem.Directory	Creates a directory at a specific path Virtual path is the path starting from the /files/ containers The entity is created against the current blog id
FileToByteArray ( string FilePath ) : byte[]	Converts a file path to a byte array for handler processing
GetFileContents ( FileSystem BaseFile ) : FileSystem.File	gets the file contents via Lazy load, however in the DbProvider the Contents are loaded when the initial object is created to cut down on DbReads
RelativeFilePath ( string VirtualPath ) : string

Method Details

ClearFileSystem() public method

Clears a file system. This will delete all files and folders recursivly.

Handle with care... Possibly an internal method?

public ClearFileSystem ( ) : void
return	void

DeleteDirectory() public method

Deletes a spefic directory from a virtual path

Virtual path is the path starting from the /files/ containers The entity is queried against to current blog id

public DeleteDirectory ( string VirtualPath ) : void
VirtualPath	string	The path to delete
return	void

DeleteFile() public method

deletes a file by virtual path

public DeleteFile ( string VirtualPath ) : void
VirtualPath	string	virtual path
return	void

DirectoryExists() public method

Returns wether or not the specific directory by virtual path exists

public DirectoryExists ( string VirtualPath ) : bool
VirtualPath	string	The virtual path to query
return	bool

FileExists() public method

boolean wether a file exists by its virtual path

public FileExists ( string VirtualPath ) : bool
VirtualPath	string	the virtual path
return	bool

GetDirectories() public method

gets all the directories underneath a base directory. Only searches one level.

public GetDirectories ( FileSystem BaseDirectory ) : IEnumerable
BaseDirectory	System.IO.FileSystem	the base directory
return	IEnumerable

GetDirectory() public method

gets a directory by a basedirectory and a string array of sub path tree

public GetDirectory ( FileSystem BaseDirectory ) : FileSystem.Directory
BaseDirectory	System.IO.FileSystem	the base directory object
return	FileSystem.Directory

GetDirectory() public method

gets a directory by a basedirectory and a string array of sub path tree

public GetDirectory ( FileSystem BaseDirectory, bool CreateNew ) : FileSystem.Directory
BaseDirectory	System.IO.FileSystem	the base directory object
CreateNew	bool	if set will create the directory structure
return	FileSystem.Directory

GetDirectory() public method

gets a directory by the virtual path

public GetDirectory ( string VirtualPath ) : FileSystem.Directory
VirtualPath	string	the virtual path
return	FileSystem.Directory

GetDirectory() public method

public GetDirectory ( string VirtualPath, bool CreateNew ) : FileSystem.Directory
VirtualPath	string
CreateNew	bool
return	FileSystem.Directory

GetFile() public method

gets a specific file by virtual path

public GetFile ( string VirtualPath ) : FileSystem.File
VirtualPath	string	the virtual path of the file
return	FileSystem.File

GetFiles() public method

gets all the files in a directory, only searches one level

public GetFiles ( FileSystem BaseDirectory ) : IEnumerable
BaseDirectory	System.IO.FileSystem	the base directory
return	IEnumerable

ImageThumbnail() public method

public ImageThumbnail ( string VirtualPath, int MaximumSize ) : FileSystem.Image
VirtualPath	string
MaximumSize	int
return	FileSystem.Image

UploadFile() public method

uploads a file to the provider container

public UploadFile ( byte FileBinary, string FileName, FileSystem BaseDirectory ) : FileSystem.File
FileBinary	byte	file contents as byte array
FileName	string	the file name
BaseDirectory	System.IO.FileSystem	directory object that is the owner
return	FileSystem.File

UploadFile() public method

uploads a file to the provider container

public UploadFile ( byte FileBinary, string FileName, FileSystem BaseDirectory, bool Overwrite ) : FileSystem.File
FileBinary	byte	the contents of the file as a byte array
FileName	string	the file name
BaseDirectory	System.IO.FileSystem	the directory object that is the owner
Overwrite	bool	boolean wether to overwrite the file if it exists.
return	FileSystem.File