FileCopy Class Reference

Inheritance diagram for FileCopy:

Public Member Functions
	GetSource ()
	Prefixes the path to the module root if it does not start with a $ variable.
_.Library.Status	OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled)
	Called as phase pPhase is executed for the resource. More...
Public Member Functions inherited from Abstract
	OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
	Subclasses may override to customize the studio project. More...
	OnGetUniqueName (pUniqueName)
	Returns a unique name for this resource. More...
_.Library.String	OnItemRelativePath (_.Library.String pItemName)
	Returns the path relative to the module root for item pItemName within this resource.

Public Attributes
	CSPApplication
	Optional hint to source control class: which CSP application path do these files map to? More...
	Defer
	If true, the files will be copied at the end of the Activate phase rather than at the beginning. More...
	InstallDirectory
	Path to which the directory or file (a full filename, in that case) should be copied upon installation; may contain expressions. More...
	Name
	More...
	Overlay
	If true, the files should be added to the target location (rather than fully replacing it, causing other files there to be deleted) More...
Public Attributes inherited from Abstract
	Params
	More...

Static Public Attributes
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)
Static Public Attributes inherited from Abstract
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)

Member Function Documentation

OnPhase()

_.Library.Status OnPhase	(	_.Library.String	pPhase,
			pParams,
		_.Library.Boolean	pResourceHandled
	)

Called as phase pPhase is executed for the resource.

If pResourceHandled is set to true,

then the default behavior for that resource will be bypassed in the current phase. Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses. TODO: Implement for standard database resources (.INC, .CLS, etc.)

Reimplemented from Abstract.

Member Data Documentation

CSPApplication

CSPApplication

Optional hint to source control class: which CSP application path do these files map to?

For use cases where the CSPApplication resource processor is too heavy-handed - e.g., /csp/xslt Of course, this is only relevant for files that need to be copied to a CSP application. Note that this may be a full CSP file path, not only the name of a CSP application.  

Defer

Defer

If true, the files will be copied at the end of the Activate phase rather than at the beginning.

The default is to copy the files at the beginning of the Activate phase. Use this for build artifacts.  

InstallDirectory

InstallDirectory

Path to which the directory or file (a full filename, in that case) should be copied upon installation; may contain expressions.

 

Name

Name

 

 

Overlay

Overlay

If true, the files should be added to the target location (rather than fully replacing it, causing other files there to be deleted)

Relevant for directories only.