Documentation

HelpDesk_Module_Model extends Vtiger_Module_Model
in package

Table of Contents

getChild()  : array<string|int, mixed>
Function to Recursively get all the child records of a given record.
getChildIds()  : array<string|int, mixed>
Function to Recursively get all the child records id of a given record.
getHierarchy()  : array<string|int, mixed>
Function to get records hierarchy in array format.
getHierarchyData()  : array<string|int, mixed>
Function to create array of all the records in the hierarchy.
getHierarchyIds()  : array<string|int, mixed>
Function to return hierarchy ids of given parent record.
getParent()  : array<string|int, mixed>
Function to Recursively get all the upper records of a given.
getQueryByModuleField()  : mixed
Function to get list view query for popup window.
massUpdateStatus()  : bool
Function to mass update status for given parent record.

Methods

getChild()

Function to Recursively get all the child records of a given record.

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>

getChildIds()

Function to Recursively get all the child records id of a given record.

public getChildIds(int $id[, array<string|int, mixed> &$childIds = [] ]) : array<string|int, mixed>
Parameters
$id : int
$childIds : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getHierarchy()

Function to get records hierarchy in array format.

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 records 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
$listviewEntries : array<string|int, mixed>
$getRawData : bool = false
$getLinks : bool = true
Tags
throws
ReflectionException
Return values
array<string|int, mixed>

getHierarchyIds()

Function to return hierarchy ids of given parent record.

public getHierarchyIds(int $id[, string $selectedRecords = 'all' ]) : array<string|int, mixed>
Parameters
$id : int
$selectedRecords : string = 'all'
Return values
array<string|int, mixed>

getParent()

Function to Recursively get all the upper records of a given.

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

getQueryByModuleField()

Function to get list view query for popup window.

public getQueryByModuleField(string $sourceModule, string $field, string $record, QueryGenerator $queryGenerator) : mixed
Parameters
$sourceModule : string

Parent module

$field : string

parent fieldname

$record : string

parent id

$queryGenerator : QueryGenerator
Return values
mixed

massUpdateStatus()

Function to mass update status for given parent record.

public massUpdateStatus(int $recordId, string $recordsType, string $status) : bool
Parameters
$recordId : int
$recordsType : string
$status : string
Return values
bool

Search results