Documentation

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
$lockFields  : mixed
__construct()  : mixed
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.
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.

Properties

$column_fields

public mixed $column_fields = []

$customFieldTable

Mandatory table for supporting custom fields.

public mixed $customFieldTable = ['u_yf_ssalesprocessescf', 'ssalesprocessesid']

$def_detailview_recname

public mixed $def_detailview_recname = 'subject'

$IsCustomModule

Indicator if this is a custom module or standard module

public mixed $IsCustomModule = rue

$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']

$relationFields

public array<string|int, string> $relationFields = []

$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'], ]

$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']

Methods

__construct()

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

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

Search results