Documentation

Occurrences_GetRelatedMembers_Relation extends Vtiger_GetRelatedList_Relation
in package

Class GetRelatedMembers.

Table of Contents

TABLE_NAME  = 'u_#__relations_members_entity'
$customFields  : array<string|int, mixed>
Field custom list.
$relationModel  : Vtiger_Relation_Model
Relation model instance.
create()  : bool
{@inheritdoc}
delete()  : bool
{@inheritdoc}
getFields()  : array<string|int, mixed>
Field list.
getQuery()  : mixed
{@inheritdoc}
getRelationData()  : array<string|int, mixed>
Get relation data.
getRelationType()  : int
{@inheritdoc}
loadAdvancedConditionsByColumns()  : void
Load advanced conditions relationship by custom column.
loadAdvancedConditionsByRelationId()  : void
Load advanced conditions for filtering related records.
transfer()  : bool
{@inheritdoc}
updateRelationData()  : bool
updateRelationData function.

Constants

TABLE_NAME

public string TABLE_NAME = 'u_#__relations_members_entity'

Name of the table that stores relations.

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, 'maximumlength' => 65535], 'rel_created_user' => ['label' => 'LBL_RELATION_CREATED_USER', 'uitype' => 52, 'displaytype' => 10]]

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 —

getFields()

Field list.

public getFields([bool $editable = false ]) : array<string|int, mixed>
Parameters
$editable : bool = false
Return values
array<string|int, 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()

{@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 —

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