IPM
All Classes Namespaces Functions Variables Pages
Base Class Reference
Inheritance diagram for Base:
Inheritance graph

Public Member Functions

_.Library.String GetResourceRelativePath (_.Library.String pResource, _.Library.String pExtension)
 Helper method to get the relative path to the file corresponding to a resource (used in Reload/Export). More...
 
_.Library.Status OnAfterResourceProcessing (_.Library.String pPhase, pParams)
 This method can be overrided to include any action that needs to be executed. More...
 
_.Library.Status OnBeforeResourceProcessing (_.Library.String pPhase, pParams)
 This method can be overrided to include any action that needs to be executed. More...
 
_.Library.Status OnBeforeVerifyLoad (pParams)
 Allows for subclasses to do additional setup or modify pParams before the "verify" phase runs.
 

Static Public Member Functions

_.Library.List GetCompletePhases (_.Library.List pPhases)
 This method defines what a complete phase means for a given list of phases.
 
_.Library.List GetCompletePhasesForOne (_.Library.String pOnePhase)
 This method defines what a complete phase means for a given phase.
 
 GetDefaultParameters (pParams, _.Library.List pPhases)
 Merges default parameters into pParams. More...
 
_.Dictionary.Classname GetDefaultResourceProcessor (_.Library.String pResourceName)
 Returns the default resource processor class to use for a given resource name.
 
_.Library.String MatchSinglePhase (_.Library.String pOnePhase)
 Match single inputted phase to the correctly CamelCased lifecycle phase

 

Public Attributes

 HasDeployedResources
   More...
 
 PhaseList
   More...
 

Static Public Attributes

 PHASES = None
 $ListBuild list of phases in this lifecycle. More...
 

Private Member Functions

_.Library.Status Export (pParams, _.Library.String pTargetDirectory, pDependencyGraph)
 Note: This is a utility method, and not a full lifecycle phase at this point. More...
 

Private Attributes

 __Installer
   More...
 
 __Module
   More...
 
 __Payload
   More...
 

Member Function Documentation

◆ Export()

_.Library.Status Export (   pParams,
_.Library.String  pTargetDirectory,
  pDependencyGraph 
)
private

Note: This is a utility method, and not a full lifecycle phase at this point.

This method exports the module's resources, based on the mappings defined in ^Sources (by Reload), to the specified directory. If no directory is provided, a new temp directory is created (returned by reference). If dependencies are to be exported, pDependencyGraph is augmented with a "Location" subscript with the relative path within pTargetDirectory in which the module's contents have been exported.

◆ GetDefaultParameters()

GetDefaultParameters (   pParams,
_.Library.List  pPhases 
)
static

Merges default parameters into pParams.

For now, just looks at ^SYS("PackageManager","DefaultParameters")

◆ GetResourceRelativePath()

_.Library.String GetResourceRelativePath ( _.Library.String  pResource,
_.Library.String  pExtension 
)

Helper method to get the relative path to the file corresponding to a resource (used in Reload/Export).

If pExtension is empty, then pResource is interpreted as having an extension. If pExtension is specified, then pResource is intrepreted as not having an extension. Note: does not support .PKG Note: does not yet support CSP/static files resources

◆ OnAfterResourceProcessing()

_.Library.Status OnAfterResourceProcessing ( _.Library.String  pPhase,
  pParams 
)

This method can be overrided to include any action that needs to be executed.

after the process of module's lifecycle, and also after notifying resource processors

◆ OnBeforeResourceProcessing()

_.Library.Status OnBeforeResourceProcessing ( _.Library.String  pPhase,
  pParams 
)

This method can be overrided to include any action that needs to be executed.

before the process of module's lifecycle, and also before notifying resource processors

Member Data Documentation

◆ PHASES

PHASES = None
static

$ListBuild list of phases in this lifecycle.


For each phase name, an instance method named "%<phase name>" must be defined in the class with a return type of Status.

◆ HasDeployedResources

HasDeployedResources

 

 

◆ __Installer

__Installer
private

 

 

◆ __Module

__Module
private

 

 

◆ __Payload

__Payload
private

 

 

◆ PhaseList

PhaseList