Plentymarkets interface documentation
Flow
Contracts
UIConfigFormContract
Add fields to config form.
Namespace
Plenty\Modules\Flow\Contracts
Methods
public addDateField($dateField, $key = "key"):voidAdd a date field to the config form
Name |
Type |
Description |
|
||
|
public addTimeField($timeField, $key = "key"):voidAdd a time field to the config form
Name |
Type |
Description |
|
||
|
public addInputField($inputField, $key = "key"):voidAdd an input field to the config form
Name |
Type |
Description |
|
||
|
public addNumberField($numberField, $key = "key"):voidAdd a number input field to the config form
Name |
Type |
Description |
|
||
|
public addDoubleField($doubleField, $key = "key"):voidAdd an double input field to the config form
Name |
Type |
Description |
|
||
|
public addCheckboxField($checkboxField, $key = "key"):voidAdd a checkbox field to the config form
Name |
Type |
Description |
|
||
|
public addSelectboxField($selectboxField, $key = "key"):voidAdd a selectbox field to the config form
Name |
Type |
Description |
|
||
|
public addCheckboxGroupField($checkboxGroupField, $key = "key"):voidAdd a checkboxGroup field to the config form
Name |
Type |
Description |
|
||
|
public addHyperlinkField($hyperlinkField, $key = "key"):voidAdd a hyperlink field to the config form
Name |
Type |
Description |
|
||
|
public addTextAreaField($textAreaField, $key = "key"):voidAdd a text area field to the config form
Name |
Type |
Description |
|
||
|
public getConfigFields():arrayGet the list with the config fields
DataModels
ConfigForm
CheckboxField
The checkbox field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
Methods
public toArray()Returns this model as an array.
CheckboxGroupField
The checkbox group field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
selectBoxValues |
The checkbox values of the field |
|
formGroup |
Group of fields with a shared set of values |
|
formGroupValues |
Shared set of values of the form group |
Methods
public toArray()Returns this model as an array.
CheckboxValue
The checkbox value field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
caption |
The name of the field |
|
value |
The label of the field |
|
translateCaption |
The option to translate caption, default value is true |
Methods
public toArray()Returns this model as an array.
DateField
The date field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
value |
The value of the field |
Methods
public toArray()Returns this model as an array.
DoubleField
The input field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
Methods
public toArray()Returns this model as an array.
FormField
The form field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
name |
The name of the field |
|
label |
The label of the field |
|
value |
The value of the field |
|
type |
The type of the field |
|
isVisible |
The visibility of the form on the config form |
|
isRequired |
The requirement of the form on the config form |
|
condition |
The condition for visibility of the form on the config form |
|
effectedFields |
Fields that will be effected on change |
Methods
public toArray()Returns this model as an array.
HyperlinkField
The hyperlink field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
url |
The url of the field |
Methods
public toArray()Returns this model as an array.
InputField
The input field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
Methods
public toArray()Returns this model as an array.
NumberField
The input field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
Methods
public toArray()Returns this model as an array.
SelectboxField
The selectbox field model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
selectBoxValues |
The selectbox values of the field |
Methods
public toArray()Returns this model as an array.
SelectboxValue
The selectbox value model.
Namespace
Plenty\Modules\Flow\DataModels\ConfigForm
| Name | Type | Description |
|---|---|---|
caption |
The name of the field |
|
value |
The label of the field |
|
translateCaption |
The option to translate caption, default value is true |
Methods
public toArray()Returns this model as an array.
Definitions
Contracts
FilterDefinitionContract
Flow filter
Namespace
Plenty\Modules\Flow\Filters\Definitions\Contracts
Methods
public getIdentifier():stringpublic getName():stringpublic getDescription():stringpublic getUIConfigFields():arraypublic getRequiredInputTypes():arraypublic getOperators():arraypublic getAvailabilities():arraypublic performFilter($inputs, $filterField, $extraParams = []):boolName |
Type |
Description |
|
||
|
||
|
public searchCriteria():stringpublic searchCriteriaValue($value):voidName |
Type |
Description |
|
public isSystemSpecific():boolpublic addOperators($configForm, $key = "key"):Plenty\Modules\Flow\Contracts\UIConfigFormContractReturn type: UIConfigFormContract
Name |
Type |
Description |
|
||
|
public validateConfigFields($configFields):voidName |
Type |
Description |
|
public validateInputs($inputs):voidName |
Type |
Description |
|
public mapFilterFields($filterField):voidName |
Type |
Description |
|
StepActionDefinitionContract
Flow step action
Namespace
Plenty\Modules\Flow\StepActions\Definitions\Contracts
Methods
public getIdentifier():stringpublic getPath():stringpublic getPathIcon():stringpublic getName():stringpublic getIcon():stringpublic getDescription():stringpublic getUIConfigFields():arraypublic getRequiredInputTypes():arraypublic getProvidedOutputTypes():arraypublic getTooltip():stringpublic isSystemSpecific():boolpublic setWorkflowName($workflowName):voidName |
Type |
Description |
|
public getWorkflowName():stringpublic setStepName($stepName):voidName |
Type |
Description |
|
public getStepName():stringpublic performTask($inputs, $configFields, $filter = null, $extraParams = []):arrayName |
Type |
Description |
|
||
|
||
|
||
|
public validateConfigFields($configFields):voidName |
Type |
Description |
|
public validateInputs($inputs):voidName |
Type |
Description |
|
StepControlDefinitionContract
Flow step control
Namespace
Plenty\Modules\Flow\StepControls\Definitions\Contracts
Methods
public getIdentifier():stringpublic getName():stringpublic getDescription():stringpublic getIcon():stringpublic getType():stringpublic getTooltip():stringpublic getUIConfigFields():arraypublic getRequiredInputTypes():arraypublic getProvidedOutputTypes():arraypublic performTask($inputs, $configFields, $filterField = null):voidName |
Type |
Description |
|
||
|
||
|
public setWorkflowName($workflowName):voidName |
Type |
Description |
|
public getWorkflowName():stringpublic setStepName($stepName):voidName |
Type |
Description |
|
public getStepName():stringpublic validateConfigFields($configFields):voidName |
Type |
Description |
|
public validateInputs($inputs):voidName |
Type |
Description |
|
FlowTriggerDefinitionContract
Flow trigger definition
Namespace
Plenty\Modules\Flow\Triggers\Definitions\Contracts
Methods
public getTriggerType():stringpublic getTriggerObject():stringpublic getTriggerIdentifier():stringpublic getTriggerName():stringpublic getTriggerDescription():stringpublic getTriggerPath():stringpublic getUIConfigField():arraypublic isSystemSpecific():boolFlowTriggerPlentyDefinitionContract
Flow trigger plenty definition
Namespace
Plenty\Modules\Flow\Triggers\Definitions\Contracts
Methods
public getAreaName():stringpublic getAreaGroupName():stringpublic getTriggerType():stringpublic getTriggerObject():stringpublic getTriggerIdentifier():stringpublic getTriggerName():stringpublic getTriggerDescription():stringpublic getTriggerPath():stringpublic getUIConfigField():arraypublic isSystemSpecific():boolFlowTriggerPluginDefinitionContract
Flow trigger plugin Definition
Namespace
Plenty\Modules\Flow\Triggers\Definitions\Contracts
Methods
public getPluginName():stringpublic getPluginGroupName():stringpublic getTriggerType():stringpublic getTriggerObject():stringpublic getTriggerIdentifier():stringpublic getTriggerName():stringpublic getTriggerDescription():stringpublic getTriggerPath():stringpublic getUIConfigField():arraypublic isSystemSpecific():boolContainers
FlowTriggerDefinitionContainer
The FlowTriggerDefinitionContainer collects and returns multiple flow trigger definitions .
Namespace
Plenty\Modules\Flow\Triggers\Definitions\Containers
Methods
public getRegisteredTriggers():arrayRetrieves all registered trigger definitions
public register($triggerDefinition):voidRegister new flow trigger definition
Name |
Type |
Description |
|
public getTrigger($identifier):Plenty\Modules\Flow\Triggers\Definitions\Contracts\FlowTriggerDefinitionContractReturn type: FlowTriggerDefinitionContract
Retrieves a trigger definition
Name |
Type |
Description |
|