Differences

This shows you the differences between two versions of the page.

--- mantisbt:class_based_filter_api [2008/08/04 17:59] – daryn
+++ mantisbt:class_based_filter_api [2008/10/29 04:25] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== Requirements for Class based Filter API ======
+   * **Author**: Daryn Warriner (daryn)
+   * **Status**: Draft
+   * **Associated Issues**:
+     *http://www.mantisbt.org/bugs/view.php?id=3858
+     *http://www.mantisbt.org/bugs/view.php?id=7183
+     *http://www.mantisbt.org/bugs/view.php?id=9398
+     *http://www.mantisbt.org/bugs/view.php?id=7889
+     *http://www.mantisbt.org/bugs/view.php?id=4843
+===== Introduction =====
+The codebase for filter api is overly complicated and confusing both from a users perspective and a developers perspective.  A class based filter api would:
+   * Simplify the codebase
+   * Increase maintainability
+   * Enable greater filter customization
+   * Allow a simpler user interface
+===== Implementation Notes =====
+   * The default simple filter would be a Google-like single textbox.
+     * It __may__ include a select list of fields to search.
+     * Alternatively, administrators __may__ be able to choose lists of fields to search/display for simple/advanced filters
+     * The current search field searches the summary, description, steps to reproduce, additional information, issue bugnotes, bug id, and bugnote id fields.
+     * The new search may include those fields as well as text based custom fields, tags, and in the future, expand to other fields.
+   * Simple stored queries would be converted to advanced queries
+   * hide status would be removed in favour of explicit show status in advanced query
+   * Advanced filter would look similar to the current advanced filter with multi select fields
+   * The text search would employ google-like syntax
+     * A B C - search for issue with A and B and C
+     * "A B C" - search for issue with the phrase "A B C"
+     * A -B - search for issue with A and not with B
+     * desc:A - search only the issue description for A
+==== Database Changes ====
+  * Alter/Create/Drop ''<mantis_XXX_table>''
+    * Add/Drop ''<column> <type>''
+==== Hookable Events ====
+  * ''<event_name>'' (<type>)
+    * Description
+    * Parameters
+    * Return value
+==== Configuration ====
+  * ''$g_var'' indicates something
+==== Implementation Log ====
+===== Other Changes =====
+===== Feedback =====
+  * Please provide feedback