CRM_Core_Reference_Interface
in
Interface CRM_Core_Reference_Interface
Table of Contents
Methods
- findReferences() : CRM_Core_DAO|null
- Create a query to find references to a particular record.
- getReferenceCount() : array{type: string, count: int}|null
- Create a query to find references to a particular record.
- getReferenceKey() : mixed
- getReferenceTable() : mixed
- matchesTargetTable() : bool
- Determine if a given table is a target of this reference.
Methods
findReferences()
Create a query to find references to a particular record.
public
findReferences(CRM_Core_DAO $targetDao) : CRM_Core_DAO|null
Parameters
- $targetDao : CRM_Core_DAO
-
The instance for which we want references.
Return values
CRM_Core_DAO|null —a query-handle (like the result of CRM_Core_DAO::executeQuery)
getReferenceCount()
Create a query to find references to a particular record.
public
getReferenceCount(CRM_Core_DAO $targetDao) : array{type: string, count: int}|null
Parameters
- $targetDao : CRM_Core_DAO
-
The instance for which we want references.
Return values
array{type: string, count: int}|null —a record describing the reference; must include the keys:
- 'type': string (not necessarily unique)
- 'count': int
getReferenceKey()
public
getReferenceKey() : mixed
getReferenceTable()
public
getReferenceTable() : mixed
matchesTargetTable()
Determine if a given table is a target of this reference.
public
matchesTargetTable(string $tableName) : bool
Parameters
- $tableName : string