Documentation

OSSEmployees 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.
__getChildEmployees()  : mixed
__getParentEmployees()  : mixed
getEmployeeHierarchy()  : mixed
Function to get Employees hierarchy of the given Employees.
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
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

$customFieldTable

Mandatory table for supporting custom fields.

public mixed $customFieldTable = ['vtiger_ossemployeescf', 'ossemployeesid']

$def_basicsearch_col

public mixed $def_basicsearch_col = 'last_name'

$def_detailview_recname

public mixed $def_detailview_recname = 'last_name'

$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_NAME' => 'name', 'LBL_LASTNAME' => 'last_name', 'LBL_BUSINESSPHONE' => 'business_phone', 'LBL_BUSINESSMAIL' => 'business_mail', 'Assigned To' => 'assigned_user_id', 'FL_POSITION' => 'position', ]

$mandatory_fields

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

$popup_fields

public mixed $popup_fields = ['last_name']

$relationFields

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

List of fields in the RelationListView

$search_fields

public mixed $search_fields = ['LBL_LASTNAME' => ['ossemployees', 'last_name'], 'LBL_NAME' => ['ossemployees', 'name'], 'LBL_BUSINESSPHONE' => ['ossemployees', 'business_phone'], 'LBL_BUSINESSMAIL' => ['ossemployees', 'business_mail'], 'Assigned To' => ['crmentity', 'smownerid'], 'FL_POSITION' => ['crmentity', 'position']]

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

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public mixed $tab_name_index = ['vtiger_crmentity' => 'crmid', 'vtiger_ossemployees' => 'ossemployeesid', 'vtiger_ossemployeescf' => 'ossemployeesid', 'vtiger_entity_stats' => 'crmid']

$table_index

public mixed $table_index = 'ossemployeesid'

$table_name

public mixed $table_name = 'vtiger_ossemployees'

$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

__getChildEmployees()

public __getChildEmployees(mixed $id, mixed &$childAccounts, mixed $depth) : mixed
Parameters
$id : mixed
$childAccounts : mixed
$depth : mixed
Return values
mixed

__getParentEmployees()

public __getParentEmployees(mixed $id, mixed &$parentAccounts, mixed &$encounteredAccounts) : mixed
Parameters
$id : mixed
$parentAccounts : mixed
$encounteredAccounts : mixed
Return values
mixed

getEmployeeHierarchy()

Function to get Employees hierarchy of the given Employees.

public getEmployeeHierarchy(int $id) : mixed
Parameters
$id : int
  • employeeid returns Employees hierarchy 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()

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

        

Search results