ServiceContracts
extends CRMEntity
in package
ServiceContracts CRMEntity class.
Tags
Table of Contents
- $column_fields : mixed
- $customFieldTable : mixed
- Mandatory table for supporting custom fields.
- $def_basicsearch_col : mixed
- $def_detailview_recname : mixed
- $default_order_by : mixed
- $default_sort_order : mixed
- $IsCustomModule : mixed
- Indicator if this is a custom module or standard module
- $list_fields_name : mixed
- $mandatory_fields : mixed
- $popup_fields : mixed
- $relationFields : array<string|int, string>
- $search_fields : mixed
- $search_fields_name : mixed
- $special_functions : mixed
- $tab_name : mixed
- Mandatory for Saving, Include tables related to this module.
- $tab_name_index : array<string|int, mixed>
- Mandatory for Saving, Include tablename and tablekey columnname here.
- $table_index : mixed
- $table_name : mixed
- $tableJoinClause : array<string|int, string>
- __construct() : mixed
- Constructor which will set the column_fields in this object.
- calculateProgress() : mixed
- Function to Calculate the End Date, Planned Duration, Actual Duration and Progress of a Service Contract.
- computeUsedUnits() : mixed
- getInstance() : self
- Get CRMEntity instance.
- getJoinClause() : string
- Get table join clause by table name.
- getLockFields() : array<string|int, mixed>
- Gets fields to locking record.
- moduleHandler() : mixed
- Invoked when special actions are performed on the module.
- retrieveEntityInfo() : mixed
- Retrieve record information of the module.
- setRelationTables() : array<string|int, mixed>
- Function to get the relation tables for related modules.
- trackLinkedInfo() : mixed
- Function to track when a new record is linked to a given record.
- trackUnLinkedInfo() : mixed
- Function to track when a record is unlinked to a given record.
- updateHelpDeskRelatedTo() : mixed
- Function to Update the parent_id of HelpDesk with sc_related_to of ServiceContracts if the parent_id is not set.
- updateServiceContractState() : mixed
- updateUsedUnits() : mixed
- Function to Upate the Used Units of the Service Contract.
- createColumnAliasForField() : string
- Function returns the column alias for a field.
- init() : void
- Loading the system configuration.
Properties
$column_fields
public
mixed
$column_fields
= []
$customFieldTable
Mandatory table for supporting custom fields.
public
mixed
$customFieldTable
= ['vtiger_servicecontractscf', 'servicecontractsid']
$def_basicsearch_col
public
mixed
$def_basicsearch_col
= 'subject'
$def_detailview_recname
public
mixed
$def_detailview_recname
= 'subject'
$default_order_by
public
mixed
$default_order_by
= ''
$default_sort_order
public
mixed
$default_sort_order
= 'ASC'
$IsCustomModule
Indicator if this is a custom module or standard module
public
mixed
$IsCustomModule
= \true
$list_fields_name
public
mixed
$list_fields_name
= [
// Format: Field Label => fieldname
'Subject' => 'subject',
'Assigned To' => 'assigned_user_id',
'Related To' => 'sc_related_to',
'Status' => 'contract_status',
'Used Units' => 'used_units',
'Total Units' => 'total_units',
'Contract No' => 'contract_no',
]
$mandatory_fields
public
mixed
$mandatory_fields
= ['subject', 'assigned_user_id']
$popup_fields
public
mixed
$popup_fields
= ['subject']
$relationFields
public
array<string|int, string>
$relationFields
= []
List of fields in the RelationListView
$search_fields
public
mixed
$search_fields
= [
// Format: Field Label => Array(tablename, columnname)
// tablename should not have prefix 'vtiger_'
'Subject' => ['servicecontracts', 'subject'],
'Status' => ['servicecontracts', 'contract_status'],
'Due Date' => ['servicecontracts', 'due_date'],
'Start Date' => ['servicecontracts', 'start_date'],
'Type' => ['servicecontracts', 'contract_type'],
'Related to' => ['servicecontracts', 'sc_related_to'],
'Used Units' => ['servicecontracts', 'used_units'],
'Total Units' => ['servicecontracts', 'total_units'],
'Assigned To' => ['crmentity', 'smownerid'],
'Contract No' => ['servicecontracts', 'contract_no'],
]
$search_fields_name
public
mixed
$search_fields_name
= []
$special_functions
public
mixed
$special_functions
= ['set_import_assigned_user']
$tab_name
Mandatory for Saving, Include tables related to this module.
public
mixed
$tab_name
= ['vtiger_crmentity', 'vtiger_servicecontracts', 'vtiger_servicecontractscf', 'vtiger_entity_stats']
$tab_name_index
Mandatory for Saving, Include tablename and tablekey columnname here.
public
array<string|int, mixed>
$tab_name_index
= ['vtiger_crmentity' => 'crmid', 'vtiger_servicecontracts' => 'servicecontractsid', 'vtiger_servicecontractscf' => 'servicecontractsid', 'vtiger_entity_stats' => 'crmid']
$table_index
public
mixed
$table_index
= 'servicecontractsid'
$table_name
public
mixed
$table_name
= 'vtiger_servicecontracts'
$tableJoinClause
public
array<string|int, string>
$tableJoinClause
= ['vtiger_entity_stats' => 'LEFT JOIN', 'u_yf_openstreetmap' => 'LEFT JOIN', 'u_yf_wapro_records_map' => 'LEFT JOIN']
Tables join clause.
Methods
__construct()
Constructor which will set the column_fields in this object.
public
__construct() : mixed
Return values
mixed —calculateProgress()
Function to Calculate the End Date, Planned Duration, Actual Duration and Progress of a Service Contract.
public
calculateProgress() : mixed
Return values
mixed —computeUsedUnits()
public
computeUsedUnits(mixed $ticketData[, mixed $operator = '+' ]) : mixed
Parameters
- $ticketData : mixed
- $operator : mixed = '+'
Return values
mixed —getInstance()
Get CRMEntity instance.
public
static getInstance(string $module) : self
Parameters
- $module : string
Return values
self —getJoinClause()
Get table join clause by table name.
public
getJoinClause(string $tableName) : string
Parameters
- $tableName : string
Return values
string —getLockFields()
Gets fields to locking record.
public
getLockFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —moduleHandler()
Invoked when special actions are performed on the module.
public
moduleHandler(string $moduleName, string $eventType) : mixed
Parameters
- $moduleName : string
- $eventType : string
Return values
mixed —retrieveEntityInfo()
Retrieve record information of the module.
public
retrieveEntityInfo(int $record, string $module) : mixed
Parameters
- $record : int
-
- crmid of record
- $module : string
-
- module name
Return values
mixed —setRelationTables()
Function to get the relation tables for related modules.
public
setRelationTables([string $secModule = false ]) : array<string|int, mixed>
Parameters
- $secModule : string = false
-
- $secmodule secondary module name
Return values
array<string|int, mixed> —returns the array with table names and fieldnames storing relations between module and this module
trackLinkedInfo()
Function to track when a new record is linked to a given record.
public
static trackLinkedInfo(mixed $crmId) : mixed
Parameters
- $crmId : mixed
Return values
mixed —trackUnLinkedInfo()
Function to track when a record is unlinked to a given record.
public
trackUnLinkedInfo(int $crmId) : mixed
Parameters
- $crmId : int
Return values
mixed —updateHelpDeskRelatedTo()
Function to Update the parent_id of HelpDesk with sc_related_to of ServiceContracts if the parent_id is not set.
public
updateHelpDeskRelatedTo(int $focusId, int $entityIds) : mixed
Parameters
- $focusId : int
- $entityIds : int
Return values
mixed —updateServiceContractState()
public
updateServiceContractState(mixed $focusId) : mixed
Parameters
- $focusId : mixed
Return values
mixed —updateUsedUnits()
Function to Upate the Used Units of the Service Contract.
public
updateUsedUnits(float $usedUnits) : mixed
Parameters
- $usedUnits : float
Return values
mixed —createColumnAliasForField()
Function returns the column alias for a field.
protected
createColumnAliasForField(array<string|int, mixed> $fieldInfo) : string
Parameters
- $fieldInfo : array<string|int, mixed>
-
- field information
Return values
string —field value
init()
Loading the system configuration.
protected
init() : void