/**
* Function to get the values in stuctured format
* @return <array> - values in structure array('block'=>array(fieldinfo));
*/
public function getStructure($FieldDataType = false)
{
if ($FieldDataType) {
$this->no_skip = false;
}
if (!empty($this->structuredValues) && $this->no_skip == true) {
return $this->structuredValues;
}
$recordModel = $this->getWorkFlowModel();
$recordId = $recordModel->getId();
$values = array();
$baseModuleModel = $moduleModel = $this->getModule();
$blockModelList = $moduleModel->getBlocks();
foreach ($blockModelList as $blockLabel => $blockModel) {
$fieldModelList = $blockModel->getFields();
if (!empty($fieldModelList)) {
$values[$blockLabel] = array();
foreach ($fieldModelList as $fieldName => $fieldModel) {
$DataType = true;
if ($FieldDataType && $fieldModel->getFieldDataType() != $FieldDataType) {
$DataType = false;
}
if ($fieldModel->isViewable() && $DataType) {
if ($moduleModel->getName() == "Documents" && $fieldName == "filename") {
continue;
}
if (in_array($moduleModel->getName(), array('Calendar', 'Events')) && $fieldModel->getDisplayType() == 3) {
/* Restricting the following fields(Event module fields) for "Calendar" module
* time_start, time_end, eventstatus, activitytype, visibility, duration_hours,
* duration_minutes, reminder_time, recurringtype, notime
*/
continue;
}
if (!empty($recordId)) {
//Set the fieldModel with the valuetype for the client side.
$fieldValueType = $recordModel->getFieldFilterValueType($fieldName);
$fieldInfo = $fieldModel->getFieldInfo();
$fieldInfo['workflow_valuetype'] = $fieldValueType;
$fieldModel->setFieldInfo($fieldInfo);
}
switch ($fieldModel->getFieldDataType()) {
case 'date':
if ($moduleName === 'Events' && in_array($fieldName, array('date_start', 'due_date')) || $moduleName === 'Calendar' && $fieldName === 'date_start') {
$fieldName = $fieldName . ' ($(general : (__VtigerMeta__) usertimezone))';
} else {
$fieldName = $fieldName . ' ($_DATE_FORMAT_)';
}
break;
case 'datetime':
$fieldName = $fieldName . ' ($(general : (__VtigerMeta__) usertimezone))';
break;
default:
$fieldName;
}
// This will be used during editing task like email, sms etc
$fieldModel->set('workflow_columnname', $fieldName)->set('workflow_columnlabel', vtranslate($fieldModel->get('label'), $moduleModel->getName()));
// This is used to identify the field belongs to source module of workflow
$fieldModel->set('workflow_sourcemodule_field', true);
$fieldModel->set('selectOption', $fieldName);
$values[$blockLabel][$fieldName] = clone $fieldModel;
}
}
}
}
if ($moduleModel->isCommentEnabled()) {
$commentFieldModelsList = Settings_Workflows_Field_Model::getCommentFieldsListForTasks($moduleModel);
$labelName = vtranslate($moduleModel->getSingularLabelKey(), $moduleModel->getName()) . ' ' . vtranslate('LBL_COMMENTS', $moduleModel->getName());
foreach ($commentFieldModelsList as $commentFieldName => $commentFieldModel) {
switch ($commentFieldModel->getFieldDataType()) {
case 'date':
$commentFieldName = $commentFieldName . ' ($_DATE_FORMAT_)';
break;
case 'datetime':
$commentFieldName = $commentFieldName . ' ($(general : (__VtigerMeta__) usertimezone)_)';
break;
default:
$commentFieldName;
}
$commentFieldModel->set('workflow_columnname', $commentFieldName)->set('workflow_columnlabel', vtranslate($commentFieldModel->get('label'), $moduleModel->getName()))->set('workflow_sourcemodule_field', true);
$values[$labelName][$commentFieldName] = $commentFieldModel;
}
}
//All the reference fields should also be sent
$fields = $moduleModel->getFieldsByType(array('reference', 'owner', 'multireference'));
foreach ($fields as $parentFieldName => $field) {
$type = $field->getFieldDataType();
$referenceModules = $field->getReferenceList();
if ($type == 'owner') {
$referenceModules = array('Users');
}
foreach ($referenceModules as $refModule) {
$moduleModel = Vtiger_Module_Model::getInstance($refModule);
$blockModelList = $moduleModel->getBlocks();
foreach ($blockModelList as $blockLabel => $blockModel) {
$fieldModelList = $blockModel->getFields();
if (!empty($fieldModelList)) {
foreach ($fieldModelList as $fieldName => $fieldModel) {
$DataType = true;
if ($FieldDataType && $fieldModel->getFieldDataType() != $FieldDataType) {
$DataType = false;
}
if ($fieldModel->isViewable() && $DataType) {
$name = "({$parentFieldName} : ({$refModule}) {$fieldName})";
$label = vtranslate($field->get('label'), $baseModuleModel->getName()) . ' : (' . vtranslate($refModule, $refModule) . ') ' . vtranslate($fieldModel->get('label'), $refModule);
switch ($fieldModel->getFieldDataType()) {
case 'date':
if ($moduleName === 'Events' && in_array($fieldName, array('date_start', 'due_date')) || $moduleName === 'Calendar' && $fieldName === 'date_start') {
$workflowColumnName = $name . ' ($(general : (__VtigerMeta__) usertimezone))';
} else {
$workflowColumnName = $name . ' ($_DATE_FORMAT_)';
}
break;
case 'datetime':
$workflowColumnName = $name . ' ($(general : (__VtigerMeta__) usertimezone))';
break;
default:
$workflowColumnName = $name;
}
$fieldModel->set('workflow_columnname', $workflowColumnName)->set('workflow_columnlabel', $label);
if (!empty($recordId)) {
$fieldValueType = $recordModel->getFieldFilterValueType($name);
$fieldInfo = $fieldModel->getFieldInfo();
$fieldInfo['workflow_valuetype'] = $fieldValueType;
$fieldModel->setFieldInfo($fieldInfo);
}
$fieldModel->set('selectOption', $parentFieldName . '=' . $refModule . '=' . $fieldName);
$values[$field->get('label')][$name] = clone $fieldModel;
}
}
}
}
$commentFieldModelsList = array();
if ($moduleModel->isCommentEnabled() && $FieldDataType == false) {
$labelName = vtranslate($moduleModel->getSingularLabelKey(), $moduleModel->getName()) . ' ' . vtranslate('LBL_COMMENTS', $moduleModel->getName());
$commentFieldModelsList = Settings_Workflows_Field_Model::getCommentFieldsListForTasks($moduleModel);
foreach ($commentFieldModelsList as $commentFieldName => $commentFieldModel) {
$name = "({$parentFieldName} : ({$refModule}) {$commentFieldName})";
$label = vtranslate($field->get('label'), $baseModuleModel->getName()) . ' : (' . vtranslate($refModule, $refModule) . ') ' . vtranslate($commentFieldModel->get('label'), $refModule);
$commentFieldModel->set('workflow_columnname', $name)->set('workflow_columnlabel', $label);
$values[$labelName][$name] = $commentFieldModel;
}
}
}
}
if ($FieldDataType === false) {
$this->no_skip = true;
}
$this->structuredValues = $values;
return $values;
}
