Documentation

RecycleBin extends Vtiger_CRMEntity
in package

Class RecycleBin.

Table of Contents

$column_fields  : mixed
$db  : mixed
$def_basicsearch_col  : string
For Alphabetical search.
$default_order_by  : string
Default order by.
$default_sort_order  : string
Default sort order.
$IsCustomModule  : mixed
Indicator if this is a custom module or standard module
$list_fields_name  : array<string|int, mixed>
List fields name.
$special_functions  : mixed
$tab_name_index  : array<string|int, mixed>
$tableJoinClause  : array<string|int, string>
__construct()  : mixed
Constructor which will set the column_fields in this object.
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
{@inheritdoc}
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 = []

$def_basicsearch_col

For Alphabetical search.

public string $def_basicsearch_col = ''

$default_order_by

Default order by.

public string $default_order_by = ''

$default_sort_order

Default sort order.

public string $default_sort_order = ''

$IsCustomModule

Indicator if this is a custom module or standard module

public mixed $IsCustomModule = \true

$list_fields_name

List fields name.

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

$special_functions

public mixed $special_functions = ['set_import_assigned_user']

$tab_name_index

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

$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

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()

{@inheritdoc}

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