Merge pull request #21992 from colemanw/searchKitImageAndDefault

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

diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php
index 169de419d2e3c6fbd8a7075ad8f9e5a3cfc2bb28..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,20 +18,24 @@ 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
+   * @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);
+
 }