* Interface CRM_Core_Reference_Interface
*/
interface CRM_Core_Reference_Interface {
+
public function getReferenceTable();
public function getReferenceKey();
public function matchesTargetTable($tableName);
/**
- * Create a query to find references to a particular record
+ * Create a query to find references to a particular record.
*
- * @param CRM_Core_DAO $targetDao the instance for which we want references
+ * @param CRM_Core_DAO $targetDao
+ * The instance for which we want references.
* @return CRM_Core_DAO|NULL a query-handle (like the result of CRM_Core_DAO::executeQuery)
*/
public function findReferences($targetDao);
/**
- * Create a query to find references to a particular record
+ * Create a query to find references to a particular record.
*
- * @param CRM_Core_DAO $targetDao the instance for which we want references
- * @return array a record describing the reference; must include the keys:
- * - 'type': string (not necessarily unique)
- * - 'count': int
+ * @param CRM_Core_DAO $targetDao
+ * The instance for which we want references.
+ * @return array{type: string, count: int}|NULL
+ * a record describing the reference; must include the keys:
+ * - 'type': string (not necessarily unique)
+ * - 'count': int
*/
public function getReferenceCount($targetDao);
+
}