Documentation

ModComments extends ModCommentsCore
in package

ModComments main class.

Table of Contents

$customFieldTable  : mixed
Mandatory table for supporting custom fields.
$def_basicsearch_col  : mixed
$def_detailview_recname  : mixed
$default_order_by  : mixed
$default_sort_order  : mixed
$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
addWidgetTo()  : mixed
Add widget to other module.
getAsCommentModel()  : mixed
Wrap this instance as a model.
getWidget()  : bool
Get widget instance by name.
moduleHandler()  : mixed
Invoked when special actions are performed on the module.
removeWidgetFrom()  : mixed
Remove widget from other modules.
transferRecords()  : mixed
Transfer the comment records from one parent record to another.

Properties

$customFieldTable

Mandatory table for supporting custom fields.

public mixed $customFieldTable = ['vtiger_modcommentscf', 'modcommentsid']

$def_basicsearch_col

public mixed $def_basicsearch_col = 'commentcontent'

$def_detailview_recname

public mixed $def_detailview_recname = 'commentcontent'

$list_fields_name

public mixed $list_fields_name = [ // Format: Field Label => fieldname 'Comment' => 'commentcontent', 'Assigned To' => 'assigned_user_id', ]

$mandatory_fields

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

$search_fields

public mixed $search_fields = [ // Format: Field Label => Array(tablename, columnname) // tablename should not have prefix 'vtiger_' 'Comment' => ['modcomments', 'commentcontent'], ]

$search_fields_name

public mixed $search_fields_name = [ // Format: Field Label => fieldname 'Comment' => 'commentcontent', ]

$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_modcomments', 'vtiger_modcommentscf']

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public mixed $tab_name_index = ['vtiger_crmentity' => 'crmid', 'vtiger_modcomments' => 'modcommentsid', 'vtiger_modcommentscf' => 'modcommentsid']

Methods

addWidgetTo()

Add widget to other module.

public static addWidgetTo(string $moduleNames[, string $widgetType = 'DETAILVIEWWIDGET' ][, string $widgetName = 'DetailViewBlockCommentWidget' ]) : mixed
Parameters
$moduleNames : string
$widgetType : string = 'DETAILVIEWWIDGET'
$widgetName : string = 'DetailViewBlockCommentWidget'
Return values
mixed

getAsCommentModel()

Wrap this instance as a model.

public getAsCommentModel() : mixed
Return values
mixed

getWidget()

Get widget instance by name.

public static getWidget(string $name) : bool
Parameters
$name : string
Return values
bool

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

removeWidgetFrom()

Remove widget from other modules.

public static removeWidgetFrom(string $moduleNames[, string $widgetType = 'DETAILVIEWWIDGET' ][, string $widgetName = 'DetailViewBlockCommentWidget' ]) : mixed
Parameters
$moduleNames : string
$widgetType : string = 'DETAILVIEWWIDGET'
$widgetName : string = 'DetailViewBlockCommentWidget'
Return values
mixed

transferRecords()

Transfer the comment records from one parent record to another.

public static transferRecords(int $currentParentId, int $targetParentId) : mixed
Parameters
$currentParentId : int

Source parent record id

$targetParentId : int

Target parent record id

Return values
mixed

        

Search results