C# Class _3PA.MainFeatures.Pro.Deployer

Mostra file Open project: jcaillon/3P Class Usage Examples

Private Properties

Property Type Description
DeploySingleFile bool

Public Methods

Method Description
BuildHtmlTableForRules ( List rules ) : string

returns a string containing an html representation of the compilation path table

DeployFiles ( List deployToDo, Action updateDeploymentPercentage = null ) : List

Deploy a given list of files (can reduce the list if there are duplicated items so it returns it)

DeployFilesForStep ( int step, List listOfSourceDir, SearchOption searchOptions, Action updateDeploymentPercentage = null ) : List

Creates a list of files to deploy after a compilation, for each Origin file will correspond one (or more if it's a .cls) .r file, and one .lst if the option has been checked

Deployer ( ProEnvironment proEnv ) : System

Constructor

Deployer ( ProEnvironment proEnv, Deployer deployer ) : System

Hard copy

EditRules ( ) : void
Export ( ) : void
GetFilesList ( List listOfFolderPath, SearchOption searchOptions, int step ) : HashSet

Returns a list of files in the given folders (recursively or not depending on the option), this list is filtered thanks to the rules given (also, for step == 0, only progress files are listed)

GetTargetDirsNeededForFile ( string sourcePath, int step ) : List

This method returns the transfer directories for the given source path, for each : If CompileLocally, returns the directory of the source If the deployment dir is empty and we didn't match an absolute compilation path, returns the source directoy as well

GetTransfersNeededForFile ( string file, int step ) : List

returns the list of transfers needed for a given file

Import ( ) : void

Read the list of compilation Path Items, if the file is present in the Config dir, use it

IsFilePassingFilters ( string filePath, List includeFiltersList, List excludeFiltersList ) : bool

Returns true if the given file path passes the include + exclude filters

Private Methods

Method Description
DeploySingleFile ( FileToDeploy file ) : bool

Transfer a single file

Method Details

BuildHtmlTableForRules() public static method

returns a string containing an html representation of the compilation path table
public static BuildHtmlTableForRules ( List rules ) : string
rules List
return string

DeployFiles() public method

Deploy a given list of files (can reduce the list if there are duplicated items so it returns it)
public DeployFiles ( List deployToDo, Action updateDeploymentPercentage = null ) : List
deployToDo List
updateDeploymentPercentage Action
return List

DeployFilesForStep() public method

Creates a list of files to deploy after a compilation, for each Origin file will correspond one (or more if it's a .cls) .r file, and one .lst if the option has been checked
public DeployFilesForStep ( int step, List listOfSourceDir, SearchOption searchOptions, Action updateDeploymentPercentage = null ) : List
step int
listOfSourceDir List
searchOptions SearchOption
updateDeploymentPercentage Action
return List

Deployer() public method

Constructor
public Deployer ( ProEnvironment proEnv ) : System
proEnv ProEnvironment
return System

Deployer() public method

Hard copy
public Deployer ( ProEnvironment proEnv, Deployer deployer ) : System
proEnv ProEnvironment
deployer Deployer
return System

EditRules() public static method

public static EditRules ( ) : void
return void

Export() public static method

public static Export ( ) : void
return void

GetFilesList() public method

Returns a list of files in the given folders (recursively or not depending on the option), this list is filtered thanks to the rules given (also, for step == 0, only progress files are listed)
public GetFilesList ( List listOfFolderPath, SearchOption searchOptions, int step ) : HashSet
listOfFolderPath List
searchOptions SearchOption
step int
return HashSet

GetTargetDirsNeededForFile() public method

This method returns the transfer directories for the given source path, for each : If CompileLocally, returns the directory of the source If the deployment dir is empty and we didn't match an absolute compilation path, returns the source directoy as well
public GetTargetDirsNeededForFile ( string sourcePath, int step ) : List
sourcePath string
step int
return List

GetTransfersNeededForFile() public method

returns the list of transfers needed for a given file
public GetTransfersNeededForFile ( string file, int step ) : List
file string
step int
return List

Import() public static method

Read the list of compilation Path Items, if the file is present in the Config dir, use it
public static Import ( ) : void
return void

IsFilePassingFilters() public method

Returns true if the given file path passes the include + exclude filters
public IsFilePassingFilters ( string filePath, List includeFiltersList, List excludeFiltersList ) : bool
filePath string
includeFiltersList List
excludeFiltersList List
return bool