From 206f019872ee73b1f738e8e65ebe927c4838122a Mon Sep 17 00:00:00 2001 From: Chris Burgess Date: Thu, 15 Dec 2016 13:11:41 +1300 Subject: [PATCH] Document inconsistent function signature. --- CRM/Utils/Token.php | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index c40c0da6ab..a23e9f3313 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -1418,6 +1418,15 @@ class CRM_Utils_Token { /** * Replace existing greeting tokens in message/subject. * + * This function operates by reference, modifying the first parameter. Other + * methods for token replacement in this class return the modified string. + * This leads to inconsistency in how these methods must be applied. + * + * @TODO Remove that inconsistency in usage. + * + * ::replaceContactTokens() may need to be called after this method, to + * replace tokens supplied from this method. + * * @param string $tokenString * @param array $contactDetails * @param int $contactId -- 2.25.1