Documentation

Vtiger_GetRelatedList_Relation extends RelationAbstraction
in package

Vtiger_GetRelatedList_Relation class.

Table of Contents

TABLE_NAME  = 'vtiger_crmentityrel'
$relationModel  : Vtiger_Relation_Model
Relation model instance.
create()  : bool
{@inheritdoc}
delete()  : bool
{@inheritdoc}
getQuery()  : mixed
{@inheritdoc}
getRelationType()  : int
{@inheritdoc}
loadAdvancedConditionsByColumns()  : void
Load advanced conditions relationship by custom column.
loadAdvancedConditionsByRelationId()  : void
Load advanced conditions for filtering related records.
transfer()  : bool
{@inheritdoc}

Constants

TABLE_NAME

public string TABLE_NAME = 'vtiger_crmentityrel'

Name of the table that stores relations.

Properties

Methods

create()

{@inheritdoc}

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

delete()

{@inheritdoc}

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

getQuery()

{@inheritdoc}

public getQuery() : mixed
Return values
mixed

getRelationType()

{@inheritdoc}

public getRelationType() : int
Return values
int

loadAdvancedConditionsByColumns()

Load advanced conditions relationship by custom column.

public loadAdvancedConditionsByColumns(QueryGenerator $queryGenerator, array<string|int, mixed> $searchParam) : void
Parameters
$queryGenerator : QueryGenerator

QueryGenerator for the list of records to be tapered based on the relationship

$searchParam : array<string|int, mixed>

Related record for which we are filtering the list of records

Return values
void

loadAdvancedConditionsByRelationId()

Load advanced conditions for filtering related records.

public loadAdvancedConditionsByRelationId(QueryGenerator $queryGenerator) : void
Parameters
$queryGenerator : QueryGenerator

QueryGenerator for the list of records to be tapered based on the relationship

Return values
void

transfer()

{@inheritdoc}

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

        

Search results