PropertiesDialog
Table of Contents
Methods
- __construct() : mixed
- __toString() : mixed
- getActivityFile() : string
- getActivityName() : string|null
- getContext() : array<string|int, mixed>
- getCurrentValue() : mixed
- getCurrentValues() : array<string|int, mixed>
- getDialogFileName() : string
- getDocumentType() : array<string|int, mixed>|null
- getFieldTypeObject() : null|FieldType
- getFormName() : string|null
- getMap() : array<string|int, mixed>
- getRuntimeData() : array<string|int, mixed>
- Get runtime data
- getSiteId() : string|null
- getTemplateExpressions() : array<string|int, mixed>
- getWorkflowConstants() : array<string|int, mixed>
- getWorkflowParameters() : array<string|int, mixed>|null
- getWorkflowTemplate() : array<string|int, mixed>|null
- getWorkflowVariables() : array<string|int, mixed>|null
- renderFieldControl() : mixed
- setActivityFile() : self
- setActivityName() : PropertiesDialog
- setContext() : PropertiesDialog
- setCurrentValues() : $this
- setDialogFileName() : PropertiesDialog
- setDocumentType() : $this
- setFormName() : $this
- setMap() : $this
- setMapCallback() : $this
- setRenderer() : mixed
- setRuntimeData() : PropertiesDialog
- Set runtime data
- setSiteId() : mixed
- setWorkflowConstants() : static
- setWorkflowParameters() : $this
- setWorkflowTemplate() : PropertiesDialog
- setWorkflowVariables() : $this
Methods
__construct()
public
__construct(mixed $activityFile[, array<string|int, mixed> $data = null ]) : mixed
Parameters
- $activityFile : mixed
- $data : array<string|int, mixed> = null
__toString()
public
__toString() : mixed
getActivityFile()
public
getActivityFile() : string
Return values
stringgetActivityName()
public
getActivityName() : string|null
Return values
string|nullgetContext()
public
getContext() : array<string|int, mixed>
Return values
array<string|int, mixed> —Context data.
getCurrentValue()
public
getCurrentValue(mixed $valueKey[, null $default = null ]) : mixed
Parameters
- $valueKey : mixed
- $default : null = null
-
Optional default value.
getCurrentValues()
public
getCurrentValues([bool $compatible = false ]) : array<string|int, mixed>
Parameters
- $compatible : bool = false
Return values
array<string|int, mixed>getDialogFileName()
public
getDialogFileName() : string
Return values
stringgetDocumentType()
public
getDocumentType() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetFieldTypeObject()
public
getFieldTypeObject(array<string|int, mixed> $field) : null|FieldType
Parameters
- $field : array<string|int, mixed>
Return values
null|FieldTypegetFormName()
public
getFormName() : string|null
Return values
string|nullgetMap()
public
getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>getRuntimeData()
Get runtime data
public
getRuntimeData() : array<string|int, mixed>
Return values
array<string|int, mixed>getSiteId()
public
getSiteId() : string|null
Return values
string|nullgetTemplateExpressions()
public
getTemplateExpressions() : array<string|int, mixed>
Return values
array<string|int, mixed>getWorkflowConstants()
public
getWorkflowConstants() : array<string|int, mixed>
Return values
array<string|int, mixed>getWorkflowParameters()
public
getWorkflowParameters() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetWorkflowTemplate()
public
getWorkflowTemplate() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetWorkflowVariables()
public
getWorkflowVariables() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullrenderFieldControl()
public
renderFieldControl(mixed $field[, mixed $value = null ][, mixed $allowSelection = true ][, mixed $renderMode = FieldType::RENDER_MODE_PUBLIC ]) : mixed
Parameters
- $field : mixed
- $value : mixed = null
- $allowSelection : mixed = true
- $renderMode : mixed = FieldType::RENDER_MODE_PUBLIC
setActivityFile()
public
setActivityFile(string $file) : self
Parameters
- $file : string
Return values
selfsetActivityName()
public
setActivityName(string $activityName) : PropertiesDialog
Parameters
- $activityName : string
Return values
PropertiesDialogsetContext()
public
setContext(array<string|int, mixed> $context) : PropertiesDialog
Parameters
- $context : array<string|int, mixed>
-
Context data.
Return values
PropertiesDialogsetCurrentValues()
public
setCurrentValues(mixed $currentValues) : $this
Parameters
- $currentValues : mixed
Return values
$thissetDialogFileName()
public
setDialogFileName(string $dialogFileName) : PropertiesDialog
Parameters
- $dialogFileName : string
Return values
PropertiesDialogsetDocumentType()
public
setDocumentType(mixed $documentType) : $this
Parameters
- $documentType : mixed
Return values
$thissetFormName()
public
setFormName(string $formName) : $this
Parameters
- $formName : string
Return values
$thissetMap()
public
setMap(array<string|int, mixed> $map) : $this
Parameters
- $map : array<string|int, mixed>
Return values
$thissetMapCallback()
public
setMapCallback(callable $callback) : $this
Parameters
- $callback : callable
Tags
Return values
$thissetRenderer()
public
setRenderer(mixed $callable) : mixed
Parameters
- $callable : mixed
setRuntimeData()
Set runtime data
public
setRuntimeData(array<string|int, mixed> $runtimeData) : PropertiesDialog
Parameters
- $runtimeData : array<string|int, mixed>
Return values
PropertiesDialogsetSiteId()
public
setSiteId(mixed $siteId) : mixed
Parameters
- $siteId : mixed
setWorkflowConstants()
public
setWorkflowConstants(array<string|int, mixed> $workflowConstants) : static
Parameters
- $workflowConstants : array<string|int, mixed>
Return values
staticsetWorkflowParameters()
public
setWorkflowParameters(array<string|int, mixed> $workflowParameters) : $this
Parameters
- $workflowParameters : array<string|int, mixed>
Return values
$thissetWorkflowTemplate()
public
setWorkflowTemplate(array<string|int, mixed> $workflowTemplate) : PropertiesDialog
Parameters
- $workflowTemplate : array<string|int, mixed>
Return values
PropertiesDialogsetWorkflowVariables()
public
setWorkflowVariables(array<string|int, mixed> $workflowVariables) : $this
Parameters
- $workflowVariables : array<string|int, mixed>