SSalesProcesses
extends Vtiger_CRMEntity
in package
Table of Contents
- $column_fields : mixed
- $customFieldTable : mixed
- Mandatory table for supporting custom fields.
- $db : mixed
- $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 : mixed
- Mandatory for Saving, Include tablename and tablekey columnname here.
- $table_index : mixed
- $table_name : mixed
- $tableJoinClause : array<string|int, string>
- $lockFields : mixed
- __construct() : mixed
- Constructor which will set the column_fields in this object.
- getChildSales() : mixed
- Function to Recursively get all the child sales of a given Sale.
- getHierarchy() : mixed
- Function to get sales hierarchy of the given Sale.
- getHierarchyData() : mixed
- Function to create array of all the sales in the hierarchy.
- getInstance() : self
- Get CRMEntity instance.
- getJoinClause() : string
- Get table join clause by table name.
- getLockFields() : array<string|int, mixed>
- Gets fields to locking record.
- getParentSales() : mixed
- Function to Recursively get all the upper sales of a given Sales.
- 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.
- 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
= ['u_yf_ssalesprocessescf', 'ssalesprocessesid']
$db
public
mixed
$db
$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
'LBL_SUBJECT' => 'subject',
'Assigned To' => 'assigned_user_id',
]
$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_'
'LBL_SUBJECT' => ['ssalesprocesses', 'subject'],
'Assigned To' => ['vtiger_crmentity', 'assigned_user_id'],
]
$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', 'u_yf_ssalesprocesses', 'u_yf_ssalesprocessescf', 'vtiger_entity_stats']
$tab_name_index
Mandatory for Saving, Include tablename and tablekey columnname here.
public
mixed
$tab_name_index
= ['vtiger_crmentity' => 'crmid', 'u_yf_ssalesprocesses' => 'ssalesprocessesid', 'u_yf_ssalesprocessescf' => 'ssalesprocessesid', 'vtiger_entity_stats' => 'crmid']
$table_index
public
mixed
$table_index
= 'ssalesprocessesid'
$table_name
public
mixed
$table_name
= 'u_yf_ssalesprocesses'
$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.
$lockFields
protected
mixed
$lockFields
= []
Methods
__construct()
Constructor which will set the column_fields in this object.
public
__construct() : mixed
Return values
mixed —getChildSales()
Function to Recursively get all the child sales of a given Sale.
public
getChildSales(int $id, array<string|int, mixed> &$childSalesProcesses, int $depthBase) : mixed
Parameters
- $id : int
-
- ssalesprocessesid
- $childSalesProcesses : array<string|int, mixed>
-
- Array of all the child sales
- $depthBase : int
-
- Depth at which the particular sales has to be placed in the hierarchy returns All the child sales of the given ssalesprocessesid in array format
Return values
mixed —getHierarchy()
Function to get sales hierarchy of the given Sale.
public
getHierarchy(int $id[, mixed $getRawData = false ][, mixed $getLinks = true ]) : mixed
Parameters
- $id : int
-
- ssalesprocessesid returns Sales hierarchy in array format
- $getRawData : mixed = false
- $getLinks : mixed = true
Return values
mixed —getHierarchyData()
Function to create array of all the sales in the hierarchy.
public
getHierarchyData(int $id, array<string|int, mixed> $salesProcessesInfoBase, int $salesProcessesId, array<string|int, mixed> &$listviewEntries[, mixed $getRawData = false ][, mixed $getLinks = true ]) : mixed
Parameters
- $id : int
-
- Id of the record highest in hierarchy
- $salesProcessesInfoBase : array<string|int, mixed>
- $salesProcessesId : int
-
- ssalesprocessesid
- $listviewEntries : array<string|int, mixed>
-
returns All the parent sales of the given Sale in array format
- $getRawData : mixed = false
- $getLinks : mixed = true
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> —getParentSales()
Function to Recursively get all the upper sales of a given Sales.
public
getParentSales(int $id, array<string|int, mixed> &$parentSSalesProcesses, mixed &$encounteredSalesProcesses, mixed $depthBase) : mixed
Parameters
- $id : int
-
- ssalesprocessesid
- $parentSSalesProcesses : array<string|int, mixed>
-
- Array of all the parent sales returns All the parent Sales of the given ssalesprocessesid in array format
- $encounteredSalesProcesses : mixed
- $depthBase : mixed
Return values
mixed —moduleHandler()
Invoked when special actions are performed on the module.
public
moduleHandler(mixed $moduleName, mixed $eventType) : mixed
Parameters
- $moduleName : mixed
- $eventType : mixed
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 —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