X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FFileSearchInterface.php;h=dd41550b1cc89145d2c20ae3f5ea1cce41721ff1;hb=2e2605fe44474eb861c337eeeedc1717b7bcc84f;hp=e1267968c51fe57b598e37a918224e3250a9dc03;hpb=6a0b768e17b6b5271ee014b4ac30066376de1f52;p=civicrm-core.git

diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php
index e1267968c5..dd41550b1c 100644
--- a/CRM/Core/FileSearchInterface.php
+++ b/CRM/Core/FileSearchInterface.php
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Interface CRM_Core_FileSearchInterface
+ */
 interface CRM_Core_FileSearchInterface {
   const DEFAULT_SEARCH_LIMIT = 20;
   const DEFAULT_SEARCH_OFFSET = 0;
@@ -6,19 +10,21 @@ interface CRM_Core_FileSearchInterface {
   /**
    * @param array $query
    *   Any of the following:.
-   *  - text: string, plain text to search for
-   *  - parent_table: string - entity to which file is directly attached
-   *  - parent_id: int - entity to which file is directly attached
-   *  - xparent_table: string - business-entity to which file is attached (directly or indirectly)
-   *  - xparent_id: int - business-entity to which file is attached (directly or indirectly)
+   *   - text: string, plain text to search for
+   *   - parent_table: string - entity to which file is directly attached
+   *   - parent_id: int - entity to which file is directly attached
+   *   - xparent_table: string - business-entity to which file is attached (directly or indirectly)
+   *   - xparent_id: int - business-entity to which file is attached (directly or indirectly)
    * @param int $limit
    * @param int $offset
-   * @return array each item has keys:
-   *  - file_id: int
-   *  - parent_table: string - entity to which file is directly attached
-   *  - parent_id: int - entity to which file is directly attached
-   *  - xparent_table: string - business-entity to which file is attached (directly or indirectly)
-   *  - xparent_id: int - business-entity to which file is attached (directly or indirectly)
+   * @return array
+   *   each item has keys:
+   *   - file_id: int
+   *   - parent_table: string - entity to which file is directly attached
+   *   - parent_id: int - entity to which file is directly attached
+   *   - xparent_table: string - business-entity to which file is attached (directly or indirectly)
+   *   - xparent_id: int - business-entity to which file is attached (directly or indirectly)
    */
   public function search($query, $limit = self::DEFAULT_SEARCH_LIMIT, $offset = self::DEFAULT_SEARCH_OFFSET);
+
 }