Documentation

IStorages 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
__construct()  : mixed
getChildIStorages()  : mixed
Function to Recursively get all the child storages of a given Storage.
getHierarchy()  : mixed
Function to get storages hierarchy of the given Storage.
getHierarchyData()  : mixed
Function to create array of all the storages in the hierarchy.
getParentIStorages()  : mixed
Function to Recursively get all the upper storages of a given Storage.

Properties

$column_fields

public mixed $column_fields = []

$customFieldTable

Mandatory table for supporting custom fields.

public mixed $customFieldTable = ['u_yf_istoragescf', 'istorageid']

$def_basicsearch_col

public mixed $def_basicsearch_col = 'subject'

$def_detailview_recname

public mixed $def_detailview_recname = 'subject'

$default_order_by

public mixed $default_order_by = ''

$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

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

$mandatory_fields

public mixed $mandatory_fields = ['subject', 'assigned_user_id']

$popup_fields

public mixed $popup_fields = ['subject']

$relationFields

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

List of fields in the RelationListView

$search_fields

public mixed $search_fields = [ // Format: Field Label => Array(tablename, columnname) // tablename should not have prefix 'vtiger_' 'subject' => ['istorages', 'subject'], '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', 'u_yf_istorages', 'u_yf_istoragescf', 'u_yf_istorages_address']

$tab_name_index

Mandatory for Saving, Include tablename and tablekey columnname here.

public mixed $tab_name_index = ['vtiger_crmentity' => 'crmid', 'u_yf_istorages' => 'istorageid', 'u_yf_istoragescf' => 'istorageid', 'u_yf_istorages_address' => 'istorageaddressid']

$table_index

public mixed $table_index = 'istorageid'

$table_name

public mixed $table_name = 'u_yf_istorages'

Methods

__construct()

public __construct() : mixed
Return values
mixed

getChildIStorages()

Function to Recursively get all the child storages of a given Storage.

public getChildIStorages(int $id, array<string|int, mixed> &$childIStorages, mixed $depthBase) : mixed
Parameters
$id : int
  • istorageid
$childIStorages : array<string|int, mixed>
  • Array of all the child storages
$depthBase : mixed
Return values
mixed

getHierarchy()

Function to get storages hierarchy of the given Storage.

public getHierarchy(int $id[, bool $getRawData = false ][, bool $getLinks = true ]) : mixed
Parameters
$id : int
  • istorageid returns Storage hierarchy in array format
$getRawData : bool = false
$getLinks : bool = true
Return values
mixed

getHierarchyData()

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

public getHierarchyData(int $id, array<string|int, mixed> $iStorageInfoBase, int $iStorageId, array<string|int, mixed> &$listviewEntries[, bool $getRawData = false ][, bool $getLinks = true ]) : mixed
Parameters
$id : int
  • Id of the record highest in hierarchy
$iStorageInfoBase : array<string|int, mixed>
$iStorageId : int
  • istorageid
$listviewEntries : array<string|int, mixed>

returns All the parent storages of the given Storage in array format

$getRawData : bool = false
$getLinks : bool = true
Return values
mixed

getParentIStorages()

Function to Recursively get all the upper storages of a given Storage.

public getParentIStorages(int $id, array<string|int, mixed> &$parentIStorages, array<string|int, mixed> &$encounteredIStorages, int $depthBase) : mixed
Parameters
$id : int
  • istorageid
$parentIStorages : array<string|int, mixed>
  • Array of all the parent storages returns All the parent Storages of the given istorageid in array format
$encounteredIStorages : array<string|int, mixed>
$depthBase : int
Return values
mixed

        

Search results