gw-conditional-logic-operator-does-not-contain.php: Added snippet for does not contain conditional logic comparison.
#1073
Conversation
…or does not contain conditional logic comparison.
WalkthroughA new PHP class, Changes
Sequence Diagram(s)sequenceDiagram
participant Init as "WordPress Init"
participant GF as "Gravity Forms System"
participant CLO as "GF_CLO_Does_Not_Contain"
participant Admin as "Admin Interface"
participant Form as "Form Frontend"
participant DB as "Database"
Init->>CLO: Instantiate on init action
CLO->>GF: Register filters (operator whitelist, script output, evaluation logic)
GF->>Admin: Request inline script output
CLO->>Admin: Output JS variable & function for "does not contain" operator
GF->>Form: Check if form supports conditional logic
Form->>CLO: Call load_form_script to attach necessary scripts
Form->>CLO: Evaluate condition with evaluate_operator
CLO->>CLO: Execute "does not contain" logic check
CLO->>DB: Convert operator to SQL ("NOT LIKE") format for field filters
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
gravity-forms/gw-conditional-logic-operator-does-not-contain.php (5)
34-50: Consider adding admin capability check for additional securityWhile the current page check provides some protection, consider also checking for appropriate admin capabilities before outputting the script.
public function output_admin_inline_script() { - if ( ! GFForms::get_page() && ! is_admin() && ! in_array( rgget( 'page' ), array( 'gp-email-users' ) ) ) { + if ( ( ! GFForms::get_page() && ! is_admin() && ! in_array( rgget( 'page' ), array( 'gp-email-users' ) ) ) || ! current_user_can( 'manage_options' ) ) { return; }
119-133: Consider adding type checking for more robust evaluationThe operator evaluation could be more defensive by ensuring both values are strings before performing the string operation.
// If the field contains the target value, it's not a match. -$is_match = strpos( $field_value, $target_value ) === false; +$is_match = is_string( $field_value ) && is_string( $target_value ) ? + strpos( (string) $field_value, (string) $target_value ) === false : + true;
106-109: Add option for case-insensitive matchingConsider adding an option for case-insensitive matching, which would be useful in many scenarios.
This would require modifications to both the JavaScript and PHP evaluation functions to support a case-insensitive option, potentially using
toLowerCase()in JavaScript andstripos()in PHP.
158-160: Consider making the class instantiation filterableFor maximum flexibility, consider wrapping the class instantiation in a conditional that can be filtered.
# Configuration - -new GF_CLO_Does_Not_Contain(); +if ( apply_filters( 'gw_enable_clo_does_not_contain', true ) ) { + new GF_CLO_Does_Not_Contain(); +}
127-128: Add documentation for the evaluation logicWhile the comment is helpful, consider adding more detailed documentation to explain the evaluation logic, especially for developers who might extend this functionality.
-// If the field contains the target value, it's not a match. +/** + * Evaluate if the field value does NOT contain the target value. + * + * strpos() returns false when the needle is not found in the haystack. + * Therefore, if strpos() returns false, it means the target value is not + * contained in the field value, which is what we want for "does not contain". + */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
gravity-forms/gw-conditional-logic-operator-does-not-contain.php(1 hunks)
🔇 Additional comments (3)
gravity-forms/gw-conditional-logic-operator-does-not-contain.php (3)
1-15: Well-structured plugin header with clear documentationThe plugin header follows WordPress standards and provides clear information about the functionality. Including the Loom instruction video link is a thoughtful addition for users who prefer visual instructions.
16-32: Good initialization with proper hook registrationThe class is properly initialized with appropriate hooks into Gravity Forms' conditional logic system. The hook structure follows WordPress best practices.
135-151: Good SQL conversion for the new operatorThe conversion to SQL-compatible field filters is well-implemented, properly adding wildcards for the LIKE operator and converting to NOT LIKE for the containment check.
| <script type="text/javascript"> | ||
| ( function( $ ) { | ||
|
|
||
| window.GWCLODoesNotContain = function( args ) { | ||
|
|
||
| var self = this; | ||
|
|
||
| for ( var prop in args ) { | ||
| if ( args.hasOwnProperty( prop ) ) { | ||
| self[ prop ] = args[ prop ]; | ||
| } | ||
| } | ||
|
|
||
| self.init = function() { | ||
| gform.addFilter( 'gform_is_value_match', function( isMatch, formId, rule ) { | ||
|
|
||
| if ( rule.operator !== 'does_not_contain' ) { | ||
| return isMatch; | ||
| } | ||
|
|
||
| var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val(); | ||
| isMatch = fieldValue.indexOf( rule.value ) === -1; | ||
|
|
||
| return isMatch; | ||
| } ); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add type checking to prevent JavaScript errors
The JavaScript code assumes fieldValue is always a string. Add type checking to prevent potential errors when handling null or undefined values.
var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val();
-isMatch = fieldValue.indexOf( rule.value ) === -1;
+isMatch = typeof fieldValue === 'string' && fieldValue.indexOf( rule.value ) === -1;📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <script type="text/javascript"> | |
| ( function( $ ) { | |
| window.GWCLODoesNotContain = function( args ) { | |
| var self = this; | |
| for ( var prop in args ) { | |
| if ( args.hasOwnProperty( prop ) ) { | |
| self[ prop ] = args[ prop ]; | |
| } | |
| } | |
| self.init = function() { | |
| gform.addFilter( 'gform_is_value_match', function( isMatch, formId, rule ) { | |
| if ( rule.operator !== 'does_not_contain' ) { | |
| return isMatch; | |
| } | |
| var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val(); | |
| isMatch = fieldValue.indexOf( rule.value ) === -1; | |
| return isMatch; | |
| } ); | |
| <script type="text/javascript"> | |
| ( function( $ ) { | |
| window.GWCLODoesNotContain = function( args ) { | |
| var self = this; | |
| for ( var prop in args ) { | |
| if ( args.hasOwnProperty( prop ) ) { | |
| self[ prop ] = args[ prop ]; | |
| } | |
| } | |
| self.init = function() { | |
| gform.addFilter( 'gform_is_value_match', function( isMatch, formId, rule ) { | |
| if ( rule.operator !== 'does_not_contain' ) { | |
| return isMatch; | |
| } | |
| var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val(); | |
| isMatch = typeof fieldValue === 'string' && fieldValue.indexOf( rule.value ) === -1; | |
| return isMatch; | |
| } ); |
| var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val(); | ||
| isMatch = fieldValue.indexOf( rule.value ) === -1; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve form field value retrieval for complex field types
The current implementation only handles simple input fields. Consider enhancing to support complex field types like checkboxes, radio buttons, and multi-selects.
-var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val();
+var fieldValue = '';
+var $field = $( '#input_' + formId + '_' + rule.fieldId );
+
+// Handle different field types
+if ( $field.is(':checkbox') || $field.is(':radio') ) {
+ fieldValue = $field.filter(':checked').map(function() {
+ return this.value;
+ }).get().join(',');
+} else if ( $field.is('select[multiple]') ) {
+ fieldValue = $field.val() ? $field.val().join(',') : '';
+} else {
+ fieldValue = $field.val() || '';
+}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| var fieldValue = $( '#input_' + formId + '_' + rule.fieldId ).val(); | |
| isMatch = fieldValue.indexOf( rule.value ) === -1; | |
| var fieldValue = ''; | |
| var $field = $( '#input_' + formId + '_' + rule.fieldId ); | |
| // Handle different field types | |
| if ( $field.is(':checkbox') || $field.is(':radio') ) { | |
| fieldValue = $field.filter(':checked').map(function() { | |
| return this.value; | |
| }).get().join(','); | |
| } else if ( $field.is('select[multiple]') ) { | |
| fieldValue = $field.val() ? $field.val().join(',') : ''; | |
| } else { | |
| fieldValue = $field.val() || ''; | |
| } | |
| isMatch = fieldValue.indexOf( rule.value ) === -1; |
Context
⛑️ Ticket(s): https://secure.helpscout.net/conversation/2901482497/81913
Summary
Snippet that adds 'does not contain' operator for conditional logic comparison
Inspired from https://gravitywiz.com/snippet-library/gw-conditional-logic-operator-is-in/
Loom Demo:
https://www.loom.com/share/8e1b27ec47b341dbb4f0da2bec6a960b