31,003
edits
Universal Search Filter Syntax: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
m (→Syntax of UFS) Tag: 2017 source edit |
mNo edit summary Tag: 2017 source edit |
||
| Line 10: | Line 10: | ||
The Universal Search Filter (also mentioned as USF) is the technical syntax, provided to developers, to define a filter in Dolibarr ERP CRM application. | The Universal Search Filter (also mentioned as USF) is the technical syntax, provided to developers, to define a filter in Dolibarr ERP CRM application. | ||
= When to use the | = When to use the USF = | ||
It is used by developers to: | It is used by developers to: | ||
* build rules to filter some combo list when the define an object dataset (into the property ->fields of an object) | * build rules to filter some combo list when the define an object dataset (into the property ->fields of an object) | ||
| Line 19: | Line 19: | ||
* to propagate securely filters in some tools, for example in the customreport.php tools. | * to propagate securely filters in some tools, for example in the customreport.php tools. | ||
= Why to use the | = Why to use the USF = | ||
The | The USF syntax has been introduced for two main reason: | ||
* To provide a secured way to propagate a filter from a component to another one, with no risk of injections. | * To provide a secured way to propagate a filter from a component to another one, with no risk of injections. | ||
* To provide a generic solution to define a filter that follows structured rules making possible to convert it easily and programmaticaly into the expected language, whatever is this language (most often in SQL but also in PHP or Javascript). | * To provide a generic solution to define a filter that follows structured rules making possible to convert it easily and programmaticaly into the expected language, whatever is this language (most often in SQL but also in PHP or Javascript). | ||