From 67d1de5a047a5019c75d542f9b8006b2ff6526fe Mon Sep 17 00:00:00 2001
From: tschuettler <tschuettler@oxfam.de>
Date: Thu, 23 Nov 2017 15:23:59 +0100
Subject: [PATCH] Add description for report filter option default_op
---
docs/framework/civireport.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/framework/civireport.md b/docs/framework/civireport.md
index 32325323..b43b2581 100644
--- a/docs/framework/civireport.md
+++ b/docs/framework/civireport.md
@@ -81,6 +81,7 @@ filters is a list of filters related to the table that the user can use to filte
| `title` | text | The caption/label |
| `default` | text | The default value of the filter |
| `operatorType` | `CRM_Report_Form::OP_XXX` | The widget type. Look in `CRM_Report_Form` for the possible values. Note that some like `DATE` have some built-in functionality for you. Also note that some filters have built-in functionality even without a type, like the `sort_name` in the example above gives the user a choice of "contains", "starts with", etc... |
+| `default_op` | text | The default operator of the filter, e.g `'eq'` for `CRM_Utils_Type::T_INT` |
| `options` | array | For widgets that have a selection of values. Pass in an array with value as the key and label as the value, e.g. `array('1'=>'Low', '2'=>'Medium', '3'=>'High')` |
| `group` | true/false | Used for group related form fields for e.g `group_id`. A true value for this flag, makes the query include the condition inside the main `WHERE` clause like a normal query. If false, condition is excluded from main clause. |
| `no_display` | true/false | When set for a filter makes the filter hidden but can still be used in the query. Required for cases when filter is expected from url and not be present on the form |
--
GitLab