Documentation

Accounts extends CRMEntity
in package

Table of Contents

$column_fields  : mixed
$customFieldTable  : mixed
Mandatory table for supporting custom fields.
$def_basicsearch_col  : mixed
$default_order_by  : mixed
$default_sort_order  : mixed
$emailTemplate_defaultFields  : mixed
$entity_table  : mixed
$list_fields_name  : mixed
$mandatory_fields  : mixed
$relationFields  : array<string|int, string>
$search_fields  : mixed
$search_fields_name  : mixed
$tab_name  : mixed
$tab_name_index  : array<string|int, mixed>
$table_index  : mixed
$table_name  : mixed
$tableJoinClause  : array<string|int, string>
__construct()  : mixed
Constructor which will set the column_fields in this object.
__getChildAccounts()  : mixed
Function to Recursively get all the child accounts of a given Account.
__getParentAccounts()  : mixed
Function to Recursively get all the upper accounts of a given Account.
getAccountHierarchy()  : mixed
Function to get Account hierarchy of the given Account.
getHierarchyData()  : mixed
Function to create array of all the accounts 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.
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 = ['vtiger_accountscf', 'accountid']

$def_basicsearch_col

public mixed $def_basicsearch_col = 'accountname'

$default_order_by

public mixed $default_order_by = ''

$default_sort_order

public mixed $default_sort_order = 'ASC'

$emailTemplate_defaultFields

public mixed $emailTemplate_defaultFields = ['accountname', 'account_type', 'industry', 'annualrevenue', 'phone', 'email1', 'rating', 'website', 'fax']

$entity_table

public mixed $entity_table = 'vtiger_crmentity'

$list_fields_name

public mixed $list_fields_name = ['Account Name' => 'accountname', 'Assigned To' => 'assigned_user_id', 'FL_STATUS' => 'accounts_status', 'Type' => 'accounttype', 'Vat ID' => 'vat_id']

$mandatory_fields

public mixed $mandatory_fields = ['assigned_user_id', 'createdtime', 'modifiedtime', 'accountname']

$relationFields

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

List of fields in the RelationListView

$search_fields

public mixed $search_fields = ['Account Name' => ['vtiger_account' => 'accountname'], 'Assigned To' => ['vtiger_crmentity' => 'smownerid'], 'FL_STATUS' => ['vtiger_account' => 'accounts_status'], 'Type' => ['vtiger_account' => 'accounttype'], 'Vat ID' => ['vtiger_account' => 'vat_id']]

$search_fields_name

public mixed $search_fields_name = []

$tab_name

public mixed $tab_name = ['vtiger_crmentity', 'vtiger_account', 'vtiger_accountaddress', 'vtiger_accountscf', 'vtiger_entity_stats']

$tab_name_index

public array<string|int, mixed> $tab_name_index = ['vtiger_crmentity' => 'crmid', 'vtiger_account' => 'accountid', 'vtiger_accountaddress' => 'accountaddressid', 'vtiger_accountscf' => 'accountid', 'vtiger_entity_stats' => 'crmid']

$table_index

public mixed $table_index = 'accountid'

$table_name

public mixed $table_name = 'vtiger_account'

$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 —

__getChildAccounts()

Function to Recursively get all the child accounts of a given Account.

public __getChildAccounts(int $id, array<string|int, mixed> &$childAccounts, mixed $depthBase) : mixed
Parameters
$id : int
  • accountid
$childAccounts : array<string|int, mixed>
  • Array of all the child accounts
$depthBase : mixed
Return values
mixed —

__getParentAccounts()

Function to Recursively get all the upper accounts of a given Account.

public __getParentAccounts(int $id, array<string|int, mixed> &$parentAccounts, mixed &$encounteredAccounts, mixed $depthBase) : mixed
Parameters
$id : int
  • accountid
$parentAccounts : array<string|int, mixed>
  • Array of all the parent accounts returns All the parent accounts of the given accountid in array format
$encounteredAccounts : mixed
$depthBase : mixed
Return values
mixed —

getAccountHierarchy()

Function to get Account hierarchy of the given Account.

public getAccountHierarchy(int $id[, mixed $listColumns = false ]) : mixed
Parameters
$id : int
  • accountid returns Account hierarchy in array format
$listColumns : mixed = false
Return values
mixed —

getHierarchyData()

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

public getHierarchyData(int $id, array<string|int, mixed> $accountInfoBase, int $accountId, array<string|int, mixed> &$listViewEntries) : mixed
Parameters
$id : int
  • Id of the record highest in hierarchy
$accountInfoBase : array<string|int, mixed>
$accountId : int
  • accountid
$listViewEntries : array<string|int, mixed>

returns All the parent accounts of the given accountid in array format

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

Module name

$eventType : string

Event Type (module.postinstall, module.disabled, module.enabled, module.preuninstall)

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([bool|string $secModule = false ]) : array<string|int, mixed>
Parameters
$secModule : bool|string = false

secondary module name

Return values
array<string|int, mixed> —

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
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results