Documentation

CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic
in package

Description of a one-way link between an option-value and an entity

Table of Contents

Properties

$refKey  : mixed
$refTable  : mixed
$refTypeColumn  : mixed
$targetKey  : mixed
$targetOptionGroupId  : int|null
Target Option Group ID.
$targetOptionGroupName  : string
Option group name.
$targetTable  : mixed

Methods

__construct()  : mixed
findReferences()  : null|object
Create a query to find references to a particular record.
getReferenceCount()  : array<string|int, mixed>|null
Get Reference Count.
getReferenceKey()  : string
getReferenceTable()  : string
getTargetEntities()  : array<string|int, mixed>
getTargetKey()  : string
getTargetOptionGroupId()  : int
Get target option group ID.
getTargetTable()  : string
getTypeColumn()  : string|null
CRM_Core_Reference_Basic returns NULL.
matchesTargetTable()  : bool
Determine if a given table is a target of this reference.

Properties

$refKey

protected mixed $refKey

$refTable

protected mixed $refTable

$refTypeColumn

protected mixed $refTypeColumn

$targetKey

protected mixed $targetKey

$targetOptionGroupId

Target Option Group ID.

protected int|null $targetOptionGroupId

$targetOptionGroupName

Option group name.

protected string $targetOptionGroupName

$targetTable

protected mixed $targetTable

Methods

__construct()

public __construct(mixed $refTable, mixed $refKey, null $targetTable, string $targetKey, null $optionGroupName) : mixed
Parameters
$refTable : mixed
$refKey : mixed
$targetTable : null
$targetKey : string
$optionGroupName : null

getReferenceKey()

public getReferenceKey() : string
Return values
string

getReferenceTable()

public getReferenceTable() : string
Return values
string

getTargetEntities()

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

[table_name => EntityName]

getTargetKey()

public getTargetKey() : string
Return values
string

getTargetOptionGroupId()

Get target option group ID.

public getTargetOptionGroupId() : int
Return values
int

getTargetTable()

public getTargetTable() : string
Return values
string

getTypeColumn()

CRM_Core_Reference_Basic returns NULL.

public getTypeColumn() : string|null

CRM_Core_Reference_Dynamic returns the name of the dynamic column e.g. "entity_table".

Return values
string|null

matchesTargetTable()

Determine if a given table is a target of this reference.

public matchesTargetTable(string $tableName) : bool
Parameters
$tableName : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results