(dev/core#217) PrevNext - Sanitize the `getSelection()` contract

1. Improve docblock formatting
2. The `$entity_table` is never passed in. You can see this by grepping universe for `getSelection`.

diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php
index 95b90b8e9d6439e0fcd01ee7cc5849f7dacab8d4..8b19aef5818029353642b3cf9affe906ba5bea2d 100644 (file)
--- a/CRM/Core/BAO/PrevNextCache.php
+++ b/CRM/Core/BAO/PrevNextCache.php
@@ -448,8 +448,8 @@ AND        c.created_date < date_sub( NOW( ), INTERVAL %2 day )
    * @deprecated
    * @see CRM_Core_PrevNextCache_Sql::getSelection()
    */
-  public static function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact') {
-    return Civi::service('prevnext')->getSelection($cacheKey, $action, $entity_table);
+  public static function getSelection($cacheKey, $action = 'get') {
+    return Civi::service('prevnext')->getSelection($cacheKey, $action);
   }
 
   /**

diff --git a/CRM/Core/PrevNextCache/Interface.php b/CRM/Core/PrevNextCache/Interface.php
index 212482fbd62569349514d853b8ba2d4dbc76d067..364e0b402b96b05c81678595edf63fec71829067 100644 (file)
--- a/CRM/Core/PrevNextCache/Interface.php
+++ b/CRM/Core/PrevNextCache/Interface.php
@@ -76,14 +76,12 @@ interface CRM_Core_PrevNextCache_Interface {
    * @param string $cacheKey
    *   Cache key.
    * @param string $action
-   *   Action.
-   *  $action : get - get only selection records
-   *            getall - get all the records of the specified cache key
-   * @param string $entity_table
-   *   Entity table.
+   *   One of the following:
+   *   - 'get' - get only selection records
+   *   - 'getall' - get all the records of the specified cache key
    *
    * @return array|NULL
    */
-  public function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact');
+  public function getSelection($cacheKey, $action = 'get');
 
 }

diff --git a/CRM/Core/PrevNextCache/Sql.php b/CRM/Core/PrevNextCache/Sql.php
index 9f7d99dc4e64344ff324c71f70f0afe78a597686..5febfe2fedc47abe7f055f95459031198b3e26a5 100644 (file)
--- a/CRM/Core/PrevNextCache/Sql.php
+++ b/CRM/Core/PrevNextCache/Sql.php
@@ -138,15 +138,15 @@ WHERE  cacheKey LIKE %1 AND is_selected = 1
    * @param string $cacheKey
    *   Cache key.
    * @param string $action
-   *   Action.
-   *  $action : get - get only selection records
-   *            getall - get all the records of the specified cache key
-   * @param string $entity_table
-   *   Entity table.
+   *   One of the following:
+   *   - 'get' - get only selection records
+   *   - 'getall' - get all the records of the specified cache key
    *
    * @return array|NULL
    */
-  public function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact') {
+  public function getSelection($cacheKey, $action = 'get') {
+    $entity_table = 'civicrm_contact';
+
     if (!$cacheKey) {
       return NULL;
     }