Merge pull request #5078 from eileenmcnaughton/comment-full-stops

[civicrm-core.git] / CRM / Core / FileSearchInterface.php

diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php
index 8ee91ca04200a0be0c7aa4ec27448daddb137138..dd41550b1cc89145d2c20ae3f5ea1cce41721ff1 100644 (file)
--- a/CRM/Core/FileSearchInterface.php
+++ b/CRM/Core/FileSearchInterface.php
@@ -1,23 +1,30 @@
 <?php
+
+/**
+ * Interface CRM_Core_FileSearchInterface
+ */
 interface CRM_Core_FileSearchInterface {
   const DEFAULT_SEARCH_LIMIT = 20;
   const DEFAULT_SEARCH_OFFSET = 0;
 
   /**
-   * @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)
+   * @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)
    * @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)
    */
-  function search($query, $limit = self::DEFAULT_SEARCH_LIMIT, $offset = self::DEFAULT_SEARCH_OFFSET);
-}
\ No newline at end of file
+  public function search($query, $limit = self::DEFAULT_SEARCH_LIMIT, $offset = self::DEFAULT_SEARCH_OFFSET);
+
+}