Documentation

Occurrences_GetRelatedMembers_Relation extends Vtiger_GetRelatedList_Relation
in package

Class GetRelatedMembers.

Table of Contents

TABLE_NAME  = 'u_#__relations_members_entity'
Name of the table that stores relations.
$customFields  : array<string|int, mixed>
Field custom list.
create()  : bool
Create relation.
delete()  : bool
Delete relation.
getFields()  : array<string|int, mixed>
Field list.
getQuery()  : mixed
Function adds relation conditions to query object.
getRelationData()  : array<string|int, mixed>
Get relation data.
getRelationType()  : int
Get relation type.
transfer()  : bool
Function moves related records from source to target.
updateRelationData()  : bool
updateRelationData function.

Constants

TABLE_NAME

Name of the table that stores relations.

public mixed TABLE_NAME = 'u_#__relations_members_entity'

Properties

$customFields

Field custom list.

public array<string|int, mixed> $customFields = ['status_rel' => ['label' => 'LBL_STATUS_REL', 'uitype' => 16], 'comment_rel' => ['label' => 'LBL_COMMENT_REL', 'uitype' => 21]]

Methods

create()

Create relation.

public create(int $sourceRecordId, int $destinationRecordId) : bool
Parameters
$sourceRecordId : int

Specifies parent record ID where we add relation

$destinationRecordId : int

Specifies record ID from related module. This record will appear on the list of parent module's related records

Return values
bool

delete()

Delete relation.

public delete(int $sourceRecordId, int $destinationRecordId) : bool
Parameters
$sourceRecordId : int

Specifies parent record ID from where we remove relation

$destinationRecordId : int

Specifies record ID from related module. This record will disappear from the list of parent module's related records

Return values
bool

getFields()

Field list.

public getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getQuery()

Function adds relation conditions to query object.

public getQuery() : mixed
Return values
mixed

getRelationData()

Get relation data.

public getRelationData(int $sourceRecordId, int $destinationRecordId) : array<string|int, mixed>
Parameters
$sourceRecordId : int
$destinationRecordId : int
Return values
array<string|int, mixed>

getRelationType()

Get relation type.

public getRelationType() : int
Return values
int

transfer()

Function moves related records from source to target.

public transfer(int $relatedRecordId, int $fromRecordId, int $toRecordId) : bool
Parameters
$relatedRecordId : int
$fromRecordId : int
$toRecordId : int
Return values
bool

updateRelationData()

updateRelationData function.

public updateRelationData(int $sourceRecordId, int $destinationRecordId, array<string|int, mixed> $updateData) : bool
Parameters
$sourceRecordId : int
$destinationRecordId : int
$updateData : array<string|int, mixed>
Return values
bool

Search results