{"type":"doc","content":[{"type":"paragraph","content":[{"text":"You can develop custom rule conditions. Developing these requires adept programming skills.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"How to develop custom rule conditions","type":"text"}]},{"type":"paragraph","content":[{"text":"You develop a rule condition type and set up a list of conditions of that type. It is similar to the example conditions you see in the rule editor. These serve no actual purpose, but illustrate how it is done.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":100.0},"content":[{"type":"media","attrs":{"width":977,"id":"8042061e-4a60-406a-8efc-a4b1a2fc5993","collection":"contentId-202539043","type":"file","height":351}}]},{"type":"paragraph","content":[{"text":"You add a PHP class in the folder for custom rule conditions. The folder is in the ","type":"text"},{"text":"customization directory","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Filesystem directories for ConfigBox","versionAtSave":"2"},"href":"/wiki/spaces/CD/pages/202571795"}}]},{"text":" in","type":"text"}]},{"type":"paragraph","content":[{"text":"/","type":"text"},{"text":"rule_condition_types","type":"text","marks":[{"type":"strong"}]},{"text":"/","type":"text"}]},{"type":"paragraph","content":[{"text":"You pick a name for your condition type (like ‘Example’). The PHP class needs to be called CustomCondition followed by your type name. So for type ‘Example’ you got ","type":"text"},{"text":"CustomConditionExample","type":"text","marks":[{"type":"strong"}]},{"text":". The file name is called the same (CustomConditionExample.php). The class extends ConfigboxCondition. So you got ","type":"text"},{"text":"class CustomConditionExample extends ConfigboxCondition","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"There are a few methods that need to be implemented.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CustomConditionExample::getConditionsPanelHtml()","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CustomConditionExample::getConditionHtml($conditionData, $forEditing = true)","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CustomConditionExample::getEvaluationResult($conditionData, $selections)","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"getConditionsPanelHtml()","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Each type gets a panel in the rule editor. This method returns the HTML to use for it. It contains a list of conditions (the HTML of each condition has a certain structure, you will see more about that in the method getConditionHtml().","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"getConditionHtml($conditionData, $forEditing = true)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This method takes the ","type":"text"},{"text":"Condition Data","type":"text","marks":[{"type":"strong"}]},{"text":" as parameter and returns the HTML for the condition. Depending on $forEditing, it returns HTML suitable for the editor or just visual HTML for the form’s property. You see an example of the HTML in Example’s PHP class, method CustomConditionExample::readMe(). The HTML structure is essentially this:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A wrapping with the CSS classes item and condition","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Condition data in form of data attributes in that (attribute data-type is required, rest is up to implementation of the condition type)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optionally elements that add to the Condition Data. They must have the CSS class ‘input' and a data attribute ‘data-data-key’ that holds the Condition Data Item’s key and an attribute ‘value’ that holds the value (and facilitates user input in the rule editor) ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You add any HTML as you see fit to make the condition practical for the administrator","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"html"},"content":[{"text":"\n ...\n","type":"text"}]},{"type":"paragraph","content":[{"text":"See notes about data-operator later.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"html"},"content":[{"text":"\n ...\n ...\n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]},{"text":": The .condition-operator is special - the rule editor JS takes care of displaying the choices on click and storing the choice in the .condition’s data attribute ‘data-operator’. Making use of the operator is optional.","type":"text"}]},{"type":"paragraph","content":[{"text":"The example uses … for simplicity. Use the $conditionData array which contains key/value pairs of all condition data.","type":"text"}]},{"type":"paragraph","content":[{"text":"How does all that play out","type":"text","marks":[{"type":"strong"}]},{"text":"? When the admin saves the rule, the system will scan through the conditions that it finds in the rule area, processes the data attributes in the , processes the .input text fields within and and creates so called ‘","type":"text"},{"text":"Condition Data","type":"text","marks":[{"type":"strong"}]},{"text":"’. Together with the data of combinators (OR, AND) and the parentheses, it creates ‘","type":"text"},{"text":"Rule Data","type":"text","marks":[{"type":"strong"}]},{"text":"’ - essentially a JS array of objects that eventually will be saved as a JSON string.","type":"text"}]},{"type":"paragraph","content":[{"text":"See CustomConditionExample::readMe() for a line-by-line explanation of the HTML structure.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"getEvaluationResult($conditionData, $selections)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This method is called when the condition is evaluated as part of the whole rule. $conditionData contains everything that was set as Condition Data in the previous method. $selections holds a standardised array with the current configuration that is tested.","type":"text"}]},{"type":"paragraph","content":[{"text":"The method has to return true or false. Developers need to take great care about performance of this method. Cache/Memoize where you can since this method may be called multiple times each time a customer makes a selection in the configurator.","type":"text"}]},{"type":"paragraph","content":[{"text":"See CustomConditionExample::readMe() for the concrete structure of both parameters.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"What is Condition Data","type":"text"}]},{"type":"paragraph","content":[{"text":"Condition data is an array that has all the data to evaluate the condition during the configuration (via getEvaluationResult()). In the rule editor each value is written as HTML 5 data attribute in the conditions HTML (in getConditionHtml()).","type":"text"}]},{"type":"paragraph","content":[{"text":"Condition data in the Example type:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"Data Key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"Data Value","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"type (required)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"Example","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"The name of your condition’s type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"Condition 1, Condition 2, Condition 3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"Only used for display","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"fieldname","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"field_1, field_2, field_3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"Arbitrary values to use in evaluating the condition","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"operator","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"==","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"The default operator for evaluating the condition","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"shouldValue","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[292.0]},"content":[{"type":"paragraph","content":[{"text":"(empty) – will be populated by the user in the editor","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[325.0]},"content":[{"type":"paragraph","content":[{"text":"The value the thing to test for should have for the condition to be met","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"You can make as many condition data items in your condition type as you see fit. The data will be available to you in the method getEvaluationResult().","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported