SaaS CMS has officially launched! Learn more now.

Class VirtualPathVersioningProvider

The virtual path provider that handles Versioning file system

Inheritance
System.Object
VirtualPathVersioningProvider
Implements
Inherited Members
Namespace: EPiServer.Web.Hosting
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class VirtualPathVersioningProvider : VirtualPathUnifiedProvider, IFileResolver

Constructors

VirtualPathVersioningProvider(String, NameValueCollection)

Initializes a new instance of the VirtualPathVersioningProvider class.

Declaration
public VirtualPathVersioningProvider(string name, NameValueCollection configParameters)
Parameters
Type Name Description
System.String name

The name of the provider

System.Collections.Specialized.NameValueCollection configParameters

The config parameters for the provider

VirtualPathVersioningProvider(String, NameValueCollection, IContentLoader, IContentProviderManager, IPageQuickSearch)

Default constructor.

Declaration
public VirtualPathVersioningProvider(string name, NameValueCollection configParameters, IContentLoader contentQueryable, IContentProviderManager pageProviderManager, IPageQuickSearch pageQuickSearch)
Parameters
Type Name Description
System.String name

The name of the provider

System.Collections.Specialized.NameValueCollection configParameters

configuration parameters for the provider

IContentLoader contentQueryable

The content queryable.

IContentProviderManager pageProviderManager

The page enterprise service.

IPageQuickSearch pageQuickSearch

The page quick search.

Properties

PhysicalBasePath

Declaration
public DirectoryInfo PhysicalBasePath { get; }
Property Value
Type Description
System.IO.DirectoryInfo

Methods

DirectoryExists(String)

Checks if this VPP has knowlegde in existance of directory under virtualPath. If not passes the query to the next provider in chain (if any).

Declaration
public override bool DirectoryExists(string virtualPath)
Parameters
Type Name Description
System.String virtualPath

The virtual path to check for existence

Returns
Type Description
System.Boolean

FileExists(String)

Checks if this VPP has knowlegde in existance of file under virtualPath. If not passes the query to the next provider in chain (if any).

Declaration
public override bool FileExists(string virtualPath)
Parameters
Type Name Description
System.String virtualPath
Returns
Type Description
System.Boolean

GetDirectory(String)

Gets the virtualPath directory. If it doesn't exists under this providers responibillity it transfers the request to the next provider in chain.

Declaration
public override VirtualDirectory GetDirectory(string virtualPath)
Parameters
Type Name Description
System.String virtualPath
Returns
Type Description
System.Web.Hosting.VirtualDirectory

VirtualDirectory or null

GetFile(String)

Gets the virtualPath file. If it doesn't exists under this providers responibillity it transfers the request to the next provider in chain.

Declaration
public override VirtualFile GetFile(string virtualPath)
Parameters
Type Name Description
System.String virtualPath
Returns
Type Description
System.Web.Hosting.VirtualFile

VirtualFile or null.

InitializeVersioningFileSystem()

Initialize the versioning file system

Declaration
public void InitializeVersioningFileSystem()

ResolveFile(Guid)

Resolves the virtual path for the VersioningFile with passed in id. If passed in guid is not id for an VersioningFile null is returned.

Declaration
public string ResolveFile(Guid guid)
Parameters
Type Name Description
System.Guid guid

The GUID.

Returns
Type Description
System.String

ResolveFile(String, out Guid)

Resolves the guid based identifier for the VersioningFile with passed in virtualpath. If passed in virtualPath is not an VersioningFile Guid.Empty is returned

Declaration
public string ResolveFile(string virtualPath, out Guid guid)
Parameters
Type Name Description
System.String virtualPath

The virtual path.

System.Guid guid

The GUID.

Returns
Type Description
System.String

Test(Boolean)

Tests the specified is true.

Declaration
[Obsolete("This method is not being used")]
public bool Test(bool isTrue)
Parameters
Type Name Description
System.Boolean isTrue

if set to true [is true].

Returns
Type Description
System.Boolean

Implements

Extension Methods