Merge pull request #22035 from eileenmcnaughton/campaign

[civicrm-core.git] / CRM / Core / Reference / Interface.php

diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php
index 6eb7193dc29a224915cf0ce6314fb444fb42661e..c5ee1fff58af78c20059bda123d78def2743f01c 100644 (file)
--- a/CRM/Core/Reference/Interface.php
+++ b/CRM/Core/Reference/Interface.php
@@ -4,6 +4,7 @@
  * Interface CRM_Core_Reference_Interface
  */
 interface CRM_Core_Reference_Interface {
+
   public function getReferenceTable();
 
   public function getReferenceKey();
@@ -17,7 +18,7 @@ interface CRM_Core_Reference_Interface {
   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.
@@ -26,11 +27,11 @@ interface CRM_Core_Reference_Interface {
   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
+   * @return array{type: string, count: int}|NULL
    *   a record describing the reference; must include the keys:
    *   - 'type': string (not necessarily unique)
    *   - 'count': int