-
Model.model:add
-
Model.model:drop
-
Description
After a node of the model has been removed
Parameters
Name Type Description nodeNode Details
-
Model.model:move
-
Model.model:update
-
Description
After a value of the model changed
Parameters
Name Type Description nodeNode fieldstring value* previousValue* Details
-
plugins.ChangeFilters.changer:setFilters
-
Description
Modifies the filters before
module:plugins.ChangeFilters.setFiltersmethodParameters
Name Type Description filtersArray.<QueryBuilder.Filter> Returns
Details
-
plugins.ChangeFilters.afterSetFilters
-
Description
After
module:plugins.ChangeFilters.setFiltersmethodParameters
Name Type Description filtersArray.<QueryBuilder.Filter> Details
-
plugins.Invert.afterInvert
-
Description
After
module:plugins.Invert.invertmethodParameters
Name Type Description nodeNode the main group or rule that has been modified
optionsobject Details
-
plugins.MongoDbSupport.changer:getMongoDBField
-
Description
Modifies the MongoDB field used by a rule
Parameters
Name Type Description fieldstring ruleRule Returns
Details
-
plugins.MongoDbSupport.changer:getMongoDBFieldID
-
Description
Returns a filter identifier from the MongoDB field
Parameters
Name Type Description fieldstring value* Returns
Details
-
plugins.MongoDbSupport.changer:groupToMongo
-
Description
Modifies the MongoDB expression generated for a group
Parameters
Name Type Description expressionobject groupGroup Returns
Details
-
plugins.MongoDbSupport.changer:mongoToGroup
-
Description
Modifies the group generated from the MongoDB expression
Parameters
Name Type Description groupobject expressionobject Returns
Details
-
plugins.MongoDbSupport.changer:mongoToRule
-
Description
Modifies the rule generated from the MongoDB expression
Parameters
Name Type Description ruleobject expressionobject Returns
Details
-
plugins.MongoDbSupport.changer:parseMongoNode
-
Description
Custom parsing of a MongoDB expression, you can return a sub-part of the expression, or a well formed group or rule JSON
Parameters
Name Type Description expressionobject Returns
Details
-
plugins.MongoDbSupport.changer:ruleToMongo
-
Description
Modifies the MongoDB expression generated for a rul
Parameters
Name Type Description expressionobject ruleRule value* valueWrapperfunction function that takes the value and adds the operator
Returns
Details
-
plugins.NotGroup.afterUpdateGroupNot
-
Description
After the group's not flag has been modified
Parameters
Name Type Description groupGroup Details
-
plugins.Sortable.afterMove
-
Description
After a node has been moved with
module:plugins.SortableParameters
Name Type Description nodeNode Details
-
plugins.SqlSupport.changer:getSQLField
-
Description
Modifies the SQL field used by a rule
Parameters
Name Type Description fieldstring ruleRule Returns
Details
-
plugins.SqlSupport.changer:getSQLFieldID
-
Description
Returns a filter identifier from the SQL field
Parameters
Name Type Description fieldstring value* Returns
Details
-
plugins.SqlSupport.changer:groupToSQL
-
Description
Modifies the SQL generated for a group
Parameters
Name Type Description expressionstring groupGroup Returns
Details
-
plugins.SqlSupport.changer:parseSQLNode
-
Description
Custom parsing of an AST node generated by SQLParser, you can return a sub-part of the tree, or a well formed group or rule JSON
Parameters
Name Type Description ASTobject node
Returns
Details
-
plugins.SqlSupport.changer:ruleToSQL
-
Description
Modifies the SQL generated for a rule
Parameters
Name Type Description expressionstring ruleRule value* valueWrapperfunction function that takes the value and adds the operator
Returns
Details
-
plugins.SqlSupport.changer:sqlGroupsDistinct
-
Description
Given an existing group and an AST node, determines if a sub-group must be created
Parameters
Name Type Description createboolean true by default if the group condition is different
groupobject ASTobject currentint group level
Returns
Details
-
plugins.SqlSupport.changer:sqlToGroup
-
Description
Modifies the group generated from the SQL expression (this is called before the group is filled with rules)
Parameters
Name Type Description groupobject ASTobject Returns
Details
-
plugins.SqlSupport.changer:sqlToRule
-
Description
Modifies the rule generated from the SQL expression
Parameters
Name Type Description ruleobject ASTobject Returns
Details
-
QueryBuilder.changer:displayError
-
Description
Modifies an error message before display
Parameters
Name Type Description errorMessagestring the error message (translated and formatted)
errorarray the raw error array (error code and optional arguments)
nodeNode Returns
Details
-
QueryBuilder.changer:getDefaultFilter
-
Description
Modifies the default filter for a rule
Parameters
Name Type Description filterQueryBuilder.Filter ruleRule Returns
Details
-
QueryBuilder.changer:getGroupTemplate
-
Description
Modifies the raw HTML of a group
Parameters
Name Type Description htmlstring levelint Returns
Details
-
QueryBuilder.changer:getOperators
-
Description
Modifies the operators available for a filter
Parameters
Name Type Description operatorsArray.<QueryBuilder.Operator> filterQueryBuilder.Filter Returns
Details
-
QueryBuilder.changer:getRuleFilters
-
Description
Modifies the list a filters available for a rule
Parameters
Name Type Description filtersArray.<QueryBuilder.Filter> ruleRule Returns
Details
-
QueryBuilder.changer:getRuleFilterSelect
-
Description
Modifies the raw HTML of the rule's filter dropdown
Parameters
Name Type Description htmlstring ruleRule filtersArray.<QueryBuilder.Filter> Returns
Details
-
QueryBuilder.changer:getRuleInput
-
Description
Modifies the raw HTML of the rule's input
Parameters
Name Type Description htmlstring ruleRule namestring the name that the input must have
Returns
Details
-
QueryBuilder.changer:getRuleOperatorSelect
-
Description
Modifies the raw HTML of the rule's operator dropdown
Parameters
Name Type Description htmlstring ruleRule operatorsArray.<QueryBuilder.Operator> Returns
Details
-
QueryBuilder.changer:getRules
-
Description
Modifies the result of the
QueryBuilder#getRulesmethodParameters
Name Type Description jsonobject Returns
Details
-
QueryBuilder.changer:getRuleTemplate
-
Description
Modifies the raw HTML of a rule
Parameters
Name Type Description htmlstring Returns
Details
-
QueryBuilder.changer:getRuleValue
-
Description
Modifies the rule's value grabbed from the DOM
Parameters
Name Type Description value* ruleRule Returns
Details
-
QueryBuilder.changer:getRuleValueSelect
-
Description
Modifies the raw HTML of the rule's value dropdown (in case of a "select filter)
Parameters
Name Type Description htmlstring string}name
ruleRule Returns
Details
-
QueryBuilder.changer:groupToJson
-
Description
Modifies the JSON generated from a Group object
Parameters
Name Type Description jsonobject groupGroup Returns
Details
-
QueryBuilder.changer:jsonToGroup
-
Description
Modifies the Group object generated from the JSON
Parameters
Name Type Description groupGroup jsonobject Returns
Details
-
QueryBuilder.changer:jsonToRule
-
Description
Modifies the Rule object generated from the JSON
Parameters
Name Type Description ruleRule jsonobject Returns
Details
-
QueryBuilder.changer:parseGroupFlags
-
Description
Modifies the consolidated group's flags
Parameters
Name Type Description flagsobject groupobject not a Group object
Returns
Details
-
QueryBuilder.changer:parseRuleFlags
-
Description
Modifies the consolidated rule's flags
Parameters
Name Type Description flagsobject ruleobject not a Rule object
Returns
Details
-
QueryBuilder.changer:ruleToJson
-
Description
Modifies the JSON generated from a Rule object
Parameters
Name Type Description jsonobject ruleRule Returns
Details
-
QueryBuilder.changer:setRules
-
Description
Modifies data before the
QueryBuilder#setRulesmethodParameters
Name Type Description jsonobject optionsobject Returns
Details
-
QueryBuilder.changer:translate
-
Description
Modifies the translated label
Parameters
Name Type Attributes Description translationstring keystring | object categorystring <optional> Returns
Details
-
QueryBuilder.changer:validate
-
Description
Modifies the result of the
QueryBuilder#validatemethodParameters
Name Type Description validboolean Returns
Details
-
QueryBuilder.changer:validateValue
-
Description
Modifies the result of the rule validation method
Parameters
Name Type Description resultarray | boolean true or an error array
value* ruleRule Returns
Details
-
QueryBuilder.afterAddGroup
-
QueryBuilder.afterAddRule
-
QueryBuilder.afterApplyGroupFlags
-
Description
After group's flags has been applied
Parameters
Name Type Description groupGroup Details
-
QueryBuilder.afterApplyRuleFlags
-
QueryBuilder.afterClear
-
Description
After the
QueryBuilder#clearmethodDetails
-
QueryBuilder.afterCreateRuleFilters
-
Description
After creating the dropdown for filters
Parameters
Name Type Description ruleRule Details
-
QueryBuilder.afterCreateRuleInput
-
Description
After creating the input for a rule and initializing optional plugin
Parameters
Name Type Description ruleRule Details
-
QueryBuilder.afterCreateRuleOperators
-
Description
After creating the dropdown for operators
Parameters
Name Type Description ruleRule operatorsArray.<QueryBuilder.Operator> allowed operators for this rule
Details
-
QueryBuilder.afterDeleteGroup
-
Description
Just after deleting a group
Details
-
QueryBuilder.afterDeleteRule
-
Description
Just after deleting a rule
Details
-
QueryBuilder.afterInit
-
Description
When the initilization is done, just before creating the root group
Details
-
QueryBuilder.afterReset
-
Description
After the
QueryBuilder#resetmethodDetails
-
QueryBuilder.afterSetRules
-
Description
After the
QueryBuilder#setRulesmethodDetails
-
QueryBuilder.afterUpdateGroupCondition
-
Description
After the group condition has been modified
Parameters
Name Type Description groupGroup previousConditionobject Details
-
QueryBuilder.afterUpdateRuleFilter
-
Description
After the filter has been updated and the operators and input re-created
Parameters
Name Type Description ruleRule previousFilterobject Details
-
QueryBuilder.afterUpdateRuleOperator
-
Description
After the operator has been updated and the input optionally re-created
Parameters
Name Type Description ruleRule previousOperatorobject Details
-
QueryBuilder.afterUpdateRuleValue
-
Description
After the rule value has been modified
Parameters
Name Type Description ruleRule previousValue* Details
-
QueryBuilder.beforeAddGroup
-
Description
Just before adding a group, can be prevented.
Parameters
Name Type Description parentGroup addRuleboolean if an empty rule will be added in the group
levelint nesting level of the group, 1 is the root group
Details
-
QueryBuilder.beforeAddRule
-
Description
Just before adding a rule, can be prevented
Parameters
Name Type Description parentGroup Details
-
QueryBuilder.beforeClear
-
Description
Before the
QueryBuilder#clearmethod, can be preventedDetails
-
QueryBuilder.beforeDeleteGroup
-
Description
Just before deleting a group, can be prevented
Parameters
Name Type Description parentGroup Details
-
QueryBuilder.beforeDeleteRule
-
Description
Just before deleting a rule, can be prevented
Parameters
Name Type Description ruleRule Details
-
QueryBuilder.beforeDestroy
-
Description
Before the
QueryBuilder#destroymethodDetails
-
QueryBuilder.beforeReset
-
Description
Before the
QueryBuilder#resetmethod, can be preventedDetails
-
QueryBuilder.rulesChanged
-
Description
After any change in the rules
Details
-
QueryBuilder.validationError
-
Description
Fired when a validation error occurred, can be prevented
Parameters
Name Type Description nodeNode errorstring value* Details