Documentation

Partners 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>
__construct()  : mixed
Constructor which will set the column_fields in this object.
getChild()  : mixed
Function to Recursively get all the child entries of a given record.
getHierarchy()  : array<string|int, mixed>
Function to get hierarchy.
getHierarchyData()  : array<string|int, mixed>
Function to create array of all the data 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.
getParent()  : mixed
Function to Recursively get all the upper records of a given.
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_partnerscf', 'partnersid']

$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' => ['partners', '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_partners', 'u_yf_partnerscf', 'u_yf_partners_address', '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_partners' => 'partnersid', 'u_yf_partnerscf' => 'partnersid', 'u_yf_partners_address' => 'partneraddressid', 'vtiger_entity_stats' => 'crmid']

$table_index

public mixed $table_index = 'partnersid'

$table_name

public mixed $table_name = 'u_yf_partners'

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

getChild()

Function to Recursively get all the child entries of a given record.

public getChild(int $id, array<string|int, mixed> &$childRow, int $depthBase) : mixed
Parameters
$id : int
  • partnersid
$childRow : array<string|int, mixed>
  • Array of all the child records
$depthBase : int
  • Depth at which the particular record has to be placed in the hierarchy returns All the child records of the given partnersid in array format
Tags
YTTODO

to rebuild

Return values
mixed —

getHierarchy()

Function to get hierarchy.

public getHierarchy(int $id[, mixed $getRawData = false ][, mixed $getLinks = true ]) : array<string|int, mixed>
Parameters
$id : int
$getRawData : mixed = false
$getLinks : mixed = true
Tags
YTTODO

to rebuild

Return values
array<string|int, mixed> —

hierarchy in array format

getHierarchyData()

Function to create array of all the data 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 ]) : array<string|int, mixed>
Parameters
$id : int
  • Id of the record highest in hierarchy
$baseInfo : array<string|int, mixed>
$recordId : int
  • id
$listviewEntries : array<string|int, mixed>
$getRawData : mixed = false
$getLinks : mixed = true
Tags
YTTODO

to rebuild

Return values
array<string|int, 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> —

getParent()

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

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

to rebuild

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

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