\CloudMunchAppAbstract

Class AppAbstract

Summary

Methods
Properties
Constants
process()
getInput()
setAppContext()
getAppContext()
getCloudmunchServerHelper()
getCloudmunchService()
setParameterObject()
getParameterObject()
initialize()
getProcessInput()
performAppcompletion()
outputPipelineVariables()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$appContext
$parameterObject
$stime
N/A

Properties

$appContext

$appContext : 

AppContext

Type

$parameterObject

$parameterObject : 

String containing input parameters.

Type

$stime

$stime : 

Strat time of the plugin execution.

Type

Methods

process()

process(array  $processparameters) 

This is an abstract method to be implemented by every plugin.

Parameters

array $processparameters

This array contains the two entries , appInput and integrationdetails

getInput()

getInput() 

This method read and process the input parameters.

setAppContext()

setAppContext(  $appContext) 

This method sets the plugin context object that contains all environment variables.

Parameters

$appContext

getAppContext()

getAppContext() : \CloudMunch\AppContext

This method returns the plugin context object that contains all environment variables.

Returns

\CloudMunch\AppContext —

appContext List of environment variables that can be retreived be retreived from App context are, 1.MasterURL: This is the cloudmunch service URL. 2.cloudproviders: This is a json object that has reference to the integrations. 3.domain: Domain to which your project belongs to. 4.ProjectName: Name of the current project. 5.JobName: Name of the current job.

getCloudmunchServerHelper()

getCloudmunchServerHelper() : \CloudMunch\ServerHelper

This method gives reference to ServerHelper,this helper class has all the methods to get/set data on servers registered with cloudmunch.

Returns

\CloudMunch\ServerHelper —

serverhelper

getCloudmunchService()

getCloudmunchService() : \CloudMunch\CloudmunchService

This method returns reference to CloudmunchService,this helper class has all the methods to get/set data to cloudmunch service.

Returns

\CloudMunch\CloudmunchService

setParameterObject()

setParameterObject(  $params) 

Set parameter object.

Parameters

$params

getParameterObject()

getParameterObject() : string

Get parameter object.

Returns

string —

parameterObject : String in json format ,containing plugin input.

initialize()

initialize() 

This is a lifecycle method that is invoked on the plugin to initialize itself with the incoming data.

getProcessInput()

getProcessInput() : array

This is a lifecycle method to process input.

Returns

array —

processparameters : Array containing pluginiput parameters and integration details if any.

performAppcompletion()

performAppcompletion() 

This is a lifecycle method invoked at the completion of the plugin to capture some data.

outputPipelineVariables()

outputPipelineVariables(  $variablename,   $variable) 

This method outputs variables from the plugin

Parameters

$variablename
$variable