Documentation

Competition extends Vtiger_CRMEntity
in package

Class Competition.

Table of Contents

$column_fields  : mixed
$customFieldTable  : array<string|int, mixed>
Mandatory table for supporting custom fields.
$db  : mixed
$def_basicsearch_col  : string
For Alphabetical search.
$def_detailview_recname  : string
Column value to use on detail view record text display.
$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.
$mandatory_fields  : array<string|int, mixed>
Used when enabling/disabling the mandatory fields for the module.
$popup_fields  : array<string|int, mixed>
For Popup window record selection.
$relationFields  : array<string|int, string>
List of fields in the RelationListView.
$search_fields  : array<string|int, mixed>
For Popup listview and UI type support.
$search_fields_name  : array<string|int, mixed>
Search fields name.
$special_functions  : mixed
$tab_name  : array<string|int, mixed>
Mandatory for Saving, Include tables related to this module.
$tab_name_index  : array<string|int, mixed>
Mandatory for Saving, Include tablename and tablekey columnname here.
$table_index  : string
Table index.
$table_name  : string
Table name.
$tableJoinClause  : array<string|int, string>
__construct()  : mixed
Constructor which will set the column_fields in this object.
getChild()  : array<string|int, mixed>
Function to Recursively get all the child.
getHierarchy()  : array<string|int, mixed>
Function to get competition hierarchy.
getHierarchyData()  : array<string|int, mixed>
Function to create array of all the competition 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()  : array<string|int, mixed>
Function to Recursively get all the parent.
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 array<string|int, mixed> $customFieldTable = ['u_yf_competitioncf', 'competitionid']

$def_basicsearch_col

For Alphabetical search.

public string $def_basicsearch_col = 'subject'

$def_detailview_recname

Column value to use on detail view record text display.

public string $def_detailview_recname = 'subject'

$default_order_by

Default order by.

public string $default_order_by = ''

$default_sort_order

Default sort order.

public string $default_sort_order = 'ASC'

$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 = [ // Format: Field Label => fieldname 'LBL_SUBJECT' => 'subject', 'Assigned To' => 'assigned_user_id', ]

$mandatory_fields

Used when enabling/disabling the mandatory fields for the module.

public array<string|int, mixed> $mandatory_fields = ['subject', 'assigned_user_id']

Refers to vtiger_field.fieldname values.

$popup_fields

For Popup window record selection.

public array<string|int, mixed> $popup_fields = ['subject']

$relationFields

List of fields in the RelationListView.

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

$search_fields

For Popup listview and UI type support.

public array<string|int, mixed> $search_fields = [ // Format: Field Label => Array(tablename, columnname) // tablename should not have prefix 'vtiger_' 'LBL_SUBJECT' => ['competition', 'subject'], 'Assigned To' => ['vtiger_crmentity', 'assigned_user_id'], ]

$search_fields_name

Search fields name.

public array<string|int, 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 array<string|int, mixed> $tab_name = ['vtiger_crmentity', 'u_yf_competition', 'u_yf_competitioncf', 'u_yf_competition_address', 'vtiger_entity_stats']

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public array<string|int, mixed> $tab_name_index = ['vtiger_crmentity' => 'crmid', 'u_yf_competition' => 'competitionid', 'u_yf_competitioncf' => 'competitionid', 'u_yf_competition_address' => 'competitionaddressid', 'vtiger_entity_stats' => 'crmid']

$table_index

Table index.

public string $table_index = 'competitionid'

$table_name

Table name.

public string $table_name = 'u_yf_competition'

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

public getChild(int $id, array<string|int, mixed> &$childRow, int $depthBase) : array<string|int, mixed>
Parameters
$id : int
$childRow : array<string|int, mixed>
$depthBase : int
Return values
array<string|int, mixed> —

getHierarchy()

Function to get competition hierarchy.

public getHierarchy(int $id[, bool $getRawData = false ][, bool $getLinks = true ]) : array<string|int, mixed>
Parameters
$id : int
$getRawData : bool = false
$getLinks : bool = true
Return values
array<string|int, mixed> —

getHierarchyData()

Function to create array of all the competition in the hierarchy.

public getHierarchyData(int $id, array<string|int, mixed> $baseInfo, int $recordId, array<string|int, mixed> &$listviewEntries[, bool $getRawData = false ][, bool $getLinks = true ]) : array<string|int, mixed>
Parameters
$id : int
$baseInfo : array<string|int, mixed>
$recordId : int
  • id
$listviewEntries : array<string|int, mixed>
$getRawData : bool = false
$getLinks : bool = true
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 parent.

public getParent(int $id, array<string|int, mixed> &$parent, array<string|int, mixed> &$encountered, int $depthBase) : array<string|int, mixed>
Parameters
$id : int
$parent : array<string|int, mixed>
$encountered : array<string|int, mixed>
$depthBase : int
Return values
array<string|int, 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