Class DirectoryHelper

Namespace

CMS.IO

Assembly

CMS.IO.dll

Directory management methods.

public class DirectoryHelper : AbstractHelper<DirectoryHelper>

Inheritance

object

CoreMethods

AbstractHelper

AbstractHelper<DirectoryHelper>

DirectoryHelper

Inherited Members

AbstractHelper<DirectoryHelper>.HelperObject

AbstractHelper<DirectoryHelper>.SetAsDefaultHelper()

CoreMethods.GetString(string, string)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

AllowCheckIOPermissions

Allow checking IO permissions?

public static bool AllowCheckIOPermissions { get; }

Property Value

bool

IsWebRootWritable

Returns whether web root is writable.

public static bool IsWebRootWritable { get; }

Property Value

bool

Methods

CheckPermissions(CheckPermissionsSettings)

Check write permissions.

public static bool CheckPermissions(CheckPermissionsSettings permissionsSettings)

Parameters

permissionsSettings CheckPermissionsSettings

Returns

bool

Remarks

Permissions are checked only on Windows platform. The check passes by default on other platforms.

CheckPermissions(string)

Check permissions (checks read and write permissions).

public static bool CheckPermissions(string path)

Parameters

path string

Directory path

Returns

bool

Remarks

Permissions are checked only on Windows platform. The check passes by default on other platforms.

CheckPermissions(string, bool, bool, bool, bool)

Check write permissions.

public static bool CheckPermissions(string path, bool checkRead, bool checkWrite, bool checkModify, bool checkDelete)

Parameters

path string

Directory path

checkRead bool

If read permissions should be checked

checkWrite bool

If write permissions should be checked

checkModify bool

If modify permissions should be checked

checkDelete bool

If delete permissions should be checked

Returns

bool

Remarks

Permissions are checked only on Windows platform. The check passes by default on other platforms.

CheckPermissionsInternal(CheckPermissionsSettings)

Check write permissions.

protected virtual bool CheckPermissionsInternal(CheckPermissionsSettings permissionsSettings)

Parameters

permissionsSettings CheckPermissionsSettings

Returns

bool

Remarks

Permissions are checked only on Windows platform. The check passes by default on other platforms.

CheckPermissionsInternal(string, bool, bool, bool, bool)

Check write permissions.

protected virtual bool CheckPermissionsInternal(string path, bool checkRead, bool checkWrite, bool checkModify, bool checkDelete)

Parameters

path string

Directory path

checkRead bool

If read permissions should be checked

checkWrite bool

If write permissions should be checked

checkModify bool

If modify permissions should be checked

checkDelete bool

If delete permissions should be checked

Returns

bool

Remarks

Permissions are checked only on Windows platform. The check passes by default on other platforms.

CombinePath(params string[])

Combines parts of one path together, handles slashes. Path ends without DirectorySeparatorChar.

public static string CombinePath(params string[] paths)

Parameters

paths string[]

Parts to combine

Returns

string

CombinePathInternal(params string[])

Combines parts of one path together, handles back slashes.

protected virtual string CombinePathInternal(params string[] paths)

Parameters

paths string[]

Parts to combine

Returns

string

CopyDirectoryInternal(string, string)

Copies specified directory including its subdirectories and all underlying files.

protected virtual void CopyDirectoryInternal(string sourcePath, string targetPath)

Parameters

sourcePath string

Full disk path of the source directory

targetPath string

Full disk path of the new copy of the directory including its name

CopyFile(string, string)

Copies the file.

public static void CopyFile(string sourcePath, string targetPath)

Parameters

sourcePath string

Source path

targetPath string

Target directory

CopyFileInternal(string, string)

Copies the file.

protected virtual void CopyFileInternal(string sourcePath, string targetPath)

Parameters

sourcePath string

Source path

targetPath string

Target directory

CreateDirectory(string)

Creates directory. It works also in a shared hosting environment.

public static DirectoryInfo CreateDirectory(string path)

Parameters

path string

Full disk path of the new directory

Returns

DirectoryInfo

Returns DirectoryInfo representing the new directory.

CreateDirectoryInternal(string)

Creates directory. It works also in a shared hosting environment.

protected virtual DirectoryInfo CreateDirectoryInternal(string path)

Parameters

path string

Full disk path of the new directory

Returns

DirectoryInfo

Returns DirectoryInfo representing the new directory.

DeleteDirectory(string)

Deletes the directory. It works also in a shared hosting environment.

public static void DeleteDirectory(string path)

Parameters

path string

Full disk path of the directory to delete

DeleteDirectory(string, bool)

Deletes the directory. It works also in a shared hosting environment.

public static void DeleteDirectory(string path, bool recursive)

Parameters

path string

Full disk path of the directory to delete

recursive bool

If true, the directory is deleted recursively

DeleteDirectoryInternal(string)

Deletes the directory. It works also in a shared hosting environment.

protected virtual void DeleteDirectoryInternal(string path)

Parameters

path string

Full disk path of the directory to delete

DeleteDirectoryInternal(string, bool)

Deletes the directory. It works also in a shared hosting environment.

protected virtual void DeleteDirectoryInternal(string path, bool recursive)

Parameters

path string

Full disk path of the directory to delete

recursive bool

If true, the directory is deleted recursively

DeleteDirectoryStructure(string)

Deletes the directory structure. It works also in a shared hosting environment.

public static void DeleteDirectoryStructure(string path)

Parameters

path string

Full disk path of the directory to delete

DeleteDirectoryStructureInternal(string)

Deletes the directory structure. It works also in a shared hosting environment.

protected virtual void DeleteDirectoryStructureInternal(string path)

Parameters

path string

Full disk path of the directory to delete

EnsureDiskPath(string, string)

Checks if all folders of the given path exist and if not, it creates them.

public static void EnsureDiskPath(string path, string startingPath)

Parameters

path string

Full disk path of the file including file name

startingPath string

Starting path (subset of file path) that will not be checked

EnsureDiskPathInternal(string, string)

Checks if all folders of the given path exist and if not, it creates them.

protected virtual void EnsureDiskPathInternal(string path, string startingPath)

Parameters

path string

Full disk path of the file including file name

startingPath string

Starting path (subset of file path) that will not be checked

EnsurePathSlashInternal(string)

This method ensures that path will end with one DirectorySeparatorChar.

protected virtual string EnsurePathSlashInternal(string path)

Parameters

path string

Path to ensure

Returns

string