Only add in the additional metadata if we are also adding them to the form
[civicrm-core.git] / CRM / Core / FileSearchInterface.php
index 274f2b019e5eca28db0261e138b9046adcafb1d8..dd41550b1cc89145d2c20ae3f5ea1cce41721ff1 100644 (file)
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Interface CRM_Core_FileSearchInterface
+ */
 interface CRM_Core_FileSearchInterface {
   const DEFAULT_SEARCH_LIMIT = 20;
   const DEFAULT_SEARCH_OFFSET = 0;
@@ -7,20 +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)
+   *   - 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);
+
 }