From 11a3487e4b4367306f8f944fd0a395c8e8ac0a43 Mon Sep 17 00:00:00 2001 From: Bradley Taylor Date: Wed, 26 Jan 2022 20:24:20 +0000 Subject: [PATCH] Resolve inaccuracies in CRM_Core_BAO_File::attachmentInfo docblock --- CRM/Core/BAO/File.php | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index cc880339e4..6f4401daf1 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -496,8 +496,9 @@ AND CEF.entity_id = %2"; } /** - * Return a clean url string and the number of attachment for a - * given entityTable, entityID + * Return a HTML string, separated by $separator, + * where each item is an anchor link to the file, + * with the filename as the link text. * * @param string $entityTable * The entityTable to which the file is attached. @@ -506,8 +507,8 @@ AND CEF.entity_id = %2"; * @param string $separator * The string separator where to implode the urls. * - * @return array - * An array with 2 elements. The string and the number of attachments + * @return string|null + * HTML list of attachment links, or null if no attachments */ public static function attachmentInfo($entityTable, $entityID, $separator = '
') { if (!$entityID) { -- 2.25.1