From f939667be5b183d2c829011cddb5f4f1d9581d0f Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Mon, 14 Jan 2019 16:01:26 -0800 Subject: [PATCH] (NFC) Cleanup new docblocks --- CRM/Core/PrevNextCache/Interface.php | 5 ++++- CRM/Core/PrevNextCache/Sql.php | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CRM/Core/PrevNextCache/Interface.php b/CRM/Core/PrevNextCache/Interface.php index aa6772c99b..6c355050e7 100644 --- a/CRM/Core/PrevNextCache/Interface.php +++ b/CRM/Core/PrevNextCache/Interface.php @@ -41,8 +41,11 @@ interface CRM_Core_PrevNextCache_Interface { * A SQL query. The query *MUST* be a SELECT statement which yields * the following columns (in order): cacheKey, entity_id1, data * @param array $sqlParams - * An array of SQLParams to be used with the $sql + * An array of parameters to be used with $sql. + * Use the same interpolation format as CRM_Core_DAO (composeQuery/executeQuery). + * Ex: [1 => ['foo', 'String']] * @return bool + * @see CRM_Core_DAO::composeQuery */ public function fillWithSql($cacheKey, $sql, $sqlParams = []); diff --git a/CRM/Core/PrevNextCache/Sql.php b/CRM/Core/PrevNextCache/Sql.php index 38cd490f1b..efa1756a02 100644 --- a/CRM/Core/PrevNextCache/Sql.php +++ b/CRM/Core/PrevNextCache/Sql.php @@ -39,9 +39,12 @@ class CRM_Core_PrevNextCache_Sql implements CRM_Core_PrevNextCache_Interface { * A SQL query. The query *MUST* be a SELECT statement which yields * the following columns (in order): cacheKey, entity_id1, data * @param array $sqlParams - * An array of Parameters to be used on the Insert Query + * An array of parameters to be used with $sql. + * Use the same interpolation format as CRM_Core_DAO (composeQuery/executeQuery). + * Ex: [1 => ['foo', 'String']] * @return bool * @throws CRM_Core_Exception + * @see CRM_Core_DAO::composeQuery */ public function fillWithSql($cacheKey, $sql, $sqlParams = []) { $insertSQL = " -- 2.25.1