CRM_Core_EntityReference deprecated

class CRM_Core_EntityReference extends CRM_Core_Reference_Basic

deprecated

This is included for backward compatibility with DAO's generated before 4.5.

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

Methods

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

No description

from CRM_Core_Reference_Basic
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

from CRM_Core_Reference_Basic
array
getReferenceCount(CRM_Core_DAO $targetDao)

No description

from CRM_Core_Reference_Basic

Details

in CRM_Core_Reference_Basic at line 22
__construct($refTable, $refKey, null $targetTable = NULL, string $targetKey = 'id', null $refTypeColumn = NULL)

Parameters

$refTable
$refKey
null $targetTable
string $targetKey
null $refTypeColumn

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

in CRM_Core_Reference_Basic at line 79
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)

in CRM_Core_Reference_Basic at line 105
array getReferenceCount(CRM_Core_DAO $targetDao)

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