VTUpdateRelatedFieldTask
extends VTTask
in package
VTiger workflow VTTask class.
Table of Contents
- RECORD_EVENT_ACTIVE = 0
- RECORD_EVENT_DOUBLE_MODE = 2
- RECORD_EVENT_INACTIVE = 1
- $contents : Vtiger_Record_Model
- Task contents.
- $executeImmediately : mixed
- $recordEventState : bool
- doTask() : mixed
- Execute task.
- formatTimeForTimePicker() : string
- Return formatted time for timepicker.
- getContents() : bool
- Function to get contents of this task.
- getFieldNames() : mixed
- Return field names.
- getTimeFieldList() : array<string|int, mixed>
- Return time field list.
- hasContents() : bool
- Check if has contents.
- setContents() : mixed
- Set contents.
- setDataFromRequest() : mixed
- Sets data from request.
- updateRecords() : bool
- Update related records by releted module.
Constants
RECORD_EVENT_ACTIVE
public
int
RECORD_EVENT_ACTIVE
= 0
RECORD_EVENT_DOUBLE_MODE
public
int
RECORD_EVENT_DOUBLE_MODE
= 2
RECORD_EVENT_INACTIVE
public
int
RECORD_EVENT_INACTIVE
= 1
Properties
$contents
Task contents.
public
Vtiger_Record_Model
$contents
$executeImmediately
public
mixed
$executeImmediately
= \false
$recordEventState
public
bool
$recordEventState
= self::RECORD_EVENT_ACTIVE
The record event.
Methods
doTask()
Execute task.
public
doTask(Vtiger_Record_Model $recordModel) : mixed
Parameters
- $recordModel : Vtiger_Record_Model
Return values
mixed —formatTimeForTimePicker()
Return formatted time for timepicker.
public
formatTimeForTimePicker(string $time) : string
Parameters
- $time : string
Return values
string —getContents()
Function to get contents of this task.
public
getContents(Vtiger_Record_Model $recordModel) : bool
Parameters
- $recordModel : Vtiger_Record_Model
Return values
bool —contents
getFieldNames()
Return field names.
public
getFieldNames() : mixed
Return values
mixed —getTimeFieldList()
Return time field list.
public
getTimeFieldList() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasContents()
Check if has contents.
public
hasContents(Vtiger_Record_Model $recordModel) : bool
Parameters
- $recordModel : Vtiger_Record_Model
Return values
bool —setContents()
Set contents.
public
setContents(Vtiger_Record_Model $recordModel) : mixed
Parameters
- $recordModel : Vtiger_Record_Model
Return values
mixed —setDataFromRequest()
Sets data from request.
public
setDataFromRequest(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —updateRecords()
Update related records by releted module.
private
updateRecords(Vtiger_Record_Model $recordModel, array<string|int, string> $relatedData, string $fieldValue) : bool
Parameters
- $recordModel : Vtiger_Record_Model
- $relatedData : array<string|int, string>
- $fieldValue : string