Resolve inaccuracies in CRM_Core_BAO_File::attachmentInfo docblock
authorBradley Taylor <hello@brad-taylor.co.uk>
Wed, 26 Jan 2022 20:24:20 +0000 (20:24 +0000)
committerBradley Taylor <hello@brad-taylor.co.uk>
Wed, 26 Jan 2022 20:24:20 +0000 (20:24 +0000)
CRM/Core/BAO/File.php

index cc880339e4bc546c095918fbce11db8c868cace0..6f4401daf1d22c9c86e4ebd90788c57adc522df2 100644 (file)
@@ -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 = '<br />') {
     if (!$entityID) {