CGProductBuilder 1.2
\
CGProductBuilder

\CGProductBuilderdisposition

An abstract class to define a disposition.

Summary

Methods
Properties
Constants
get_friendlyname()
get_buttontext()
compatible()
ready()
dispose()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

get_friendlyname()

get_friendlyname() : string

Get the friendly name for this disposition.

Returns

string

get_buttontext()

get_buttontext() : string

Get the button text for this disposition.

The button text is used on the final summary view of the product builder so that the customer can select a disposition.

Returns

string

compatible()

compatible() : bool

Test if this disposition is compatible with the current install of CMSMS.

Typically this would check if certain modules are installed and properly configured.

Returns

bool

ready()

ready() : bool

Test if this disposition is ready to be used to disposing a form.

Normally this involves checking if email sending is properly setup, or the user is logged in to FEU etc.

Returns

bool

dispose()

dispose(\CGProductBuilder\ProductSpec $productSpec) : string

Dispose (handle) the product specification.

Parameters

\CGProductBuilder\ProductSpec $productSpec

Returns

string —

Optional text to display after disposing of the form.