Documentation

MultiCompany 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
$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
__construct()  : mixed
getChild()  : 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.
getParent()  : mixed
Function to Recursively get all the upper sales of a given.

Properties

$column_fields

public mixed $column_fields = []

$customFieldTable

Mandatory table for supporting custom fields.

public mixed $customFieldTable = ['u_yf_multicompanycf', 'multicompanyid']

$def_basicsearch_col

public mixed $def_basicsearch_col = 'company_name'

$def_detailview_recname

public mixed $def_detailview_recname = 'company_name'

$default_sort_order

public mixed $default_sort_order = 'ASC'

$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 'FL_COMPANY_NAME' => 'company_name', 'FL_STATUS' => 'mulcomp_status', 'FL_EMAIL_1' => 'email1', 'FL_PHONE' => 'phone', 'FL_VATID' => 'vat', 'AddressLevel5' => 'addresslevel5a', ]

$mandatory_fields

public mixed $mandatory_fields = ['company_name', 'assigned_user_id']

$popup_fields

public mixed $popup_fields = ['company_name']

$search_fields

public mixed $search_fields = [ // Format: Field Label => Array(tablename, columnname) // tablename should not have prefix 'vtiger_' 'FL_COMPANY_NAME' => ['multicompany', 'company_name'], 'FL_STATUS' => ['multicompany', 'mulcomp_status'], 'FL_EMAIL_1' => ['multicompany', 'email1'], 'FL_PHONE' => ['multicompany', 'phone'], 'FL_VATID' => ['multicompany', 'vat'], 'AddressLevel5' => ['multicompany', 'addresslevel5a'], 'Assigned To' => ['crmentity', 'smownerid'], ]

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

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public mixed $tab_name_index = ['vtiger_crmentity' => 'crmid', 'u_yf_multicompany' => 'multicompanyid', 'u_yf_multicompanycf' => 'multicompanyid']

$table_index

public mixed $table_index = 'multicompanyid'

$table_name

public mixed $table_name = 'u_yf_multicompany'

Methods

__construct()

public __construct() : mixed
Return values
mixed

getChild()

Function to Recursively get all the child sales of a given Sale.

public getChild(int $id, array<string|int, mixed> &$childRow, int $depthBase) : mixed
Parameters
$id : int
  • multicompanyid
$childRow : 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 multicompanyid in array format
Tags
YTTODO

to rebuild

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

returns hierarchy in array format

$getRawData : mixed = false
$getLinks : mixed = true
Tags
YTTODO

to rebuild

Return values
mixed

getHierarchyData()

Function to create array of all the sales in the hierarchy.

public getHierarchyData(int $id, array<string|int, mixed> $baseInfo, int $recordId, array<string|int, mixed> &$listviewEntries[, mixed $getRawData = false ][, mixed $getLinks = true ]) : mixed
Parameters
$id : int
  • Id of the record highest in hierarchy
$baseInfo : array<string|int, mixed>
$recordId : int
  • id
$listviewEntries : array<string|int, mixed>

returns All the parent sales of the given Sale in array format

$getRawData : mixed = false
$getLinks : mixed = true
Tags
YTTODO

to rebuild

Return values
mixed

getParent()

Function to Recursively get all the upper sales of a given.

public getParent(int $id, array<string|int, mixed> &$parent, mixed &$encountered, mixed $depthBase) : mixed
Parameters
$id : int
  • multicompanyid
$parent : array<string|int, mixed>
  • Array of all the parent sales returns All the parent f the given multicompanyid in array format
$encountered : mixed
$depthBase : mixed
Tags
YTTODO

to rebuild

Return values
mixed

        

Search results