Documentation

ModComments_GetRelatedRecord_Relation
in package
implements RelationInterface

ModTracker_GetRelatedRecord_Relation class.

Interfaces, Classes and Traits

RelationInterface
RelationInterface interface.

Table of Contents

$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.
getRelationType()  : int
Get relation type.
transfer()  : bool
Function moves related records from source to target.

Properties

$customFields

Field custom list.

public array<string|int, mixed> $customFields = ['children_count' => ['label' => 'LBL_CHILDREN_COUNT', 'uitype' => 7]]

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

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

        

Search results