CRM_Core_Reference_Interface

interface CRM_Core_Reference_Interface

Interface CRM_Core_Reference_Interface

Methods

getReferenceTable()

No description

getReferenceKey()

No description

bool
matchesTargetTable(string $tableName)

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

CRM_Core_DAO|NULL
findReferences(CRM_Core_DAO $targetDao)

Create a query to find references to a particular record.

array
getReferenceCount(CRM_Core_DAO $targetDao)

Create a query to find references to a particular record.

Details

at line 8
getReferenceTable()

at line 10
getReferenceKey()

at line 18
bool matchesTargetTable(string $tableName)

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

Parameters

string $tableName

Return Value

bool

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

Create a query to find references to a particular record.

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)

at line 39
array getReferenceCount(CRM_Core_DAO $targetDao)

Create a query to find references to a particular record.

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