Interface Class Reference

Additional inteface for source control extensions to implement to plug in to module lifecycles. More...

Static Public Member Functions
_.Library.Status	Configure ()
	Invoked after zpm "init" to configure settings for this source control class. More...
_.Library.Status	OnAfterBuild (_.Library.Boolean pIsDev, _.Library.Boolean pSuccessful)
	Invoked after build process runs.
_.Library.Status	OnBeforeBuild (_.Library.Boolean pIsDev)
	Invoked before build process runs.
_.Library.Status	OnChangeModuleRoot (_.IPM.Storage.Module pModule)
	Invoked when an existing module is reloaded from a different directory than its known module root.
_.Library.Status	OnMakeModuleEditable (_.IPM.Storage.Module pModule)
	Invoked when the user has attempted to edit a module document reported by the active Studio extension as read-only (i.e., because it is not checked out)

Static Public Attributes
	SETTINGSPAGE = None
	Name of page to help configure source control on a per-module basis.

Static Private Member Functions
_.Library.Status	OnAfterBuild (_.Library.Boolean pIsDev, _.Library.Boolean pSuccessful)
	Invoked after running build processes. More...
_.Library.Status	OnBeforeBuild (_.Library.Boolean pIsDev)
	Invoked prior to running build processes.
_.Library.Status	SourceControlMethod (pMethod, pArgs)
	Follows a similar pattern to Studio.SourceControl.Interface, but permits all methods defined in the current Studio extension. More...

Detailed Description

Additional inteface for source control extensions to implement to plug in to module lifecycles.

Member Function Documentation

OnAfterBuild()

_.Library.Status OnAfterBuild ( _.Library.Boolean  pIsDev, _.Library.Boolean  pSuccessful  )

staticprivate

Invoked after running build processes.

Should be called even if the build fails

SourceControlMethod()

_.Library.Status SourceControlMethod (   pMethod,   pArgs  )

staticprivate

Follows a similar pattern to Studio.SourceControl.Interface, but permits all methods defined in the current Studio extension.

Moves SourceControl (which must be defined!) to a different variable name, New's SourceControl, then runs pMethod of that object with pArgs.... If expected to return a value, will return what this method does (most often a Status); otherwise, will just do $method. Much low-level (^apiOBJ, etc.) import/export code behaves differently when SourceControl is defined, so this is typically necessary and always safest.

Configure()

_.Library.Status Configure ( )

static

Invoked after zpm "init" to configure settings for this source control class.

Default implementation is a no-op