CRM_Core_Reference_OptionValue

class CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic

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

Properties

protected $refTable from CRM_Core_Reference_Basic
protected $refKey from CRM_Core_Reference_Basic
protected $refTypeColumn from CRM_Core_Reference_Basic
protected $targetTable from CRM_Core_Reference_Basic
protected $targetKey from CRM_Core_Reference_Basic
protected string $targetOptionGroupName Option group name.
protected int|null $targetOptionGroupId Target Option Group ID.

Methods

__construct($refTable, $refKey, null $targetTable = NULL, string $targetKey = 'id', null $optionGroupName)

No description

getReferenceTable()

No description

from CRM_Core_Reference_Basic
getReferenceKey()

No description

from CRM_Core_Reference_Basic
null
getTypeColumn()

No description

from CRM_Core_Reference_Basic
null
getTargetTable()

No description

from CRM_Core_Reference_Basic
string
getTargetKey()

No description

from CRM_Core_Reference_Basic
bool
matchesTargetTable(string $tableName)

No description

from CRM_Core_Reference_Basic
CRM_Core_DAO|NULL
findReferences(CRM_Core_DAO $targetDao)

No description

array
getReferenceCount(CRM_Core_DAO $targetDao)

Get Reference Count.

int
getTargetOptionGroupId()

Get target option group ID.

Details

at line 28
__construct($refTable, $refKey, null $targetTable = NULL, string $targetKey = 'id', null $optionGroupName)

Parameters

$refTable
$refKey
null $targetTable
string $targetKey
null $optionGroupName

in CRM_Core_Reference_Basic at line 33
getReferenceTable()

in CRM_Core_Reference_Basic at line 40
getReferenceKey()

in CRM_Core_Reference_Basic at line 47
null getTypeColumn()

Return Value

null

in CRM_Core_Reference_Basic at line 54
null getTargetTable()

Return Value

null

in CRM_Core_Reference_Basic at line 61
string getTargetKey()

Return Value

string

in CRM_Core_Reference_Basic at line 70
bool matchesTargetTable(string $tableName)

Parameters

string $tableName

Return Value

bool

at line 39
CRM_Core_DAO|NULL findReferences(CRM_Core_DAO $targetDao)

Parameters

CRM_Core_DAO $targetDao The instance for which we want references.

Return Value

CRM_Core_DAO|NULL a query-handle (like the result of CRM_Core_DAO::executeQuery)

Exceptions

CRM_Core_Exception

at line 59
array getReferenceCount(CRM_Core_DAO $targetDao)

Get Reference Count.

Parameters

CRM_Core_DAO $targetDao The instance for which we want references.

Return Value

array a record describing the reference; must include the keys: - 'type': string (not necessarily unique) - 'count': int

Exceptions

CRM_Core_Exception

at line 76
int getTargetOptionGroupId()

Get target option group ID.

Return Value

int