Documentation

_ModuleName_ 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
Default fields on the list
$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
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 = ['<_baseTableName_>cf', '<modulename>id']

$def_basicsearch_col

public mixed $def_basicsearch_col = '<entityfieldname>'

$def_detailview_recname

public mixed $def_detailview_recname = '<entityfieldname>'

$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

Default fields on the list

public mixed $list_fields_name = ['<entityfieldlabel>' => '<entityfieldname>', 'Assigned To' => 'assigned_user_id']

$mandatory_fields

public mixed $mandatory_fields = ['<entityfieldname>', 'assigned_user_id']

$popup_fields

public mixed $popup_fields = ['<entityfieldname>']

$search_fields

public mixed $search_fields = [ // Format: Field Label => Array(tablename, columnname) '<entityfieldlabel>' => ['<modulename>', '<entitycolumn>'], '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', '<_baseTableName_>', '<_baseTableName_>cf']

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public mixed $tab_name_index = ['vtiger_crmentity' => 'crmid', '<_baseTableName_>' => '<modulename>id', '<_baseTableName_>cf' => '<modulename>id']

$table_index

public mixed $table_index = '<modulename>id'

$table_name

public mixed $table_name = '<_baseTableName_>'

Methods

__construct()

public __construct() : mixed
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

        

Search results