Skip to content

gw-coupons-exclude-products.php: Added functionality to exclude discounts on options of a product field. #1038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 12, 2025
Merged

gw-coupons-exclude-products.php: Added functionality to exclude discounts on options of a product field. #1038

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92b8cec
`gw-coupons-exclude-products.php`: Added functionality to exclude dis…
saifsultanc Mar 3, 2025
156046d
`gw-coupons-exclude-products.php`: Added functionality to exclude dis…
saifsultanc Mar 3, 2025
ce9b829
`gw-coupons-exclude-products.php`: Added functionality to exclude dis…
saifsultanc Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 47 additions & 16 deletions gravity-forms/gw-coupons-exclude-products.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*
* Requires Gravity Forms Coupons v1.1
*
* @version 1.3
* @version 1.4
*/
class GW_Coupons_Exclude_Products {

Expand All @@ -19,10 +19,11 @@ public function __construct( $args ) {

// set our default arguments, parse against the provided arguments, and store for use throughout the class
$this->_args = wp_parse_args( $args, array(
'form_id' => false,
'exclude_fields' => array(),
'exclude_fields_by_form' => array(),
'skip_for_100_percent' => false,
'form_id' => false,
'exclude_fields' => array(),
'exclude_fields_without_options' => array(),
'exclude_fields_by_form' => array(),
'skip_for_100_percent' => false,
) );

// do version check in the init to make sure if GF is going to be loaded, it is already loaded
Expand Down Expand Up @@ -102,10 +103,11 @@ function output_script() {

function getExcludedAmount( formId ) {

var excludeFields = gf_global.gfcep[ formId ],
amount = 0;
var excludeFields = gf_global.gfcep[ formId ].exclude_fields,
excludeFieldsWithoutOptions = gf_global.gfcep[ formId ].exclude_fields_without_options,
amount = 0;

if( ! excludeFields ) {
if( ! excludeFields && ! excludeFieldsWithoutOptions ) {
return 0;
}

Expand All @@ -114,6 +116,13 @@ function getExcludedAmount( formId ) {
amount += productAmount;
}

for( var i = 0; i < excludeFieldsWithoutOptions.length; i++ ) {
var productAmount = gformCalculateProductPrice( formId, excludeFieldsWithoutOptions[ i ] );
var price = gformGetBasePrice( formId, excludeFieldsWithoutOptions[ i ] );
var quantity = gformGetProductQuantity( formId, excludeFieldsWithoutOptions[ i ] );
amount += ( productAmount - ( price * quantity ) );
}

return amount;
}

Expand All @@ -133,14 +142,18 @@ function add_init_script( $form ) {
return;
}

$base_json = json_encode( array( 'skipFor100Percent' => $this->_args['skip_for_100_percent'] ) );
$exclude_fields_json = json_encode( $this->_args['exclude_fields'] );
$base_json = json_encode( array( 'skipFor100Percent' => $this->_args['skip_for_100_percent'] ) );
$exclude_fields_json = json_encode( $this->_args['exclude_fields'] );
$exclude_fields_without_options_json = json_encode( $this->_args['exclude_fields_without_options'] );

$script = "if( typeof gf_global != 'undefined' ) {
if( typeof gf_global.gfcep == 'undefined' ) {
gf_global.gfcep = {$base_json};
}
gf_global.gfcep[ {$this->_args['form_id']} ] = {$exclude_fields_json};
gf_global.gfcep[ {$this->_args['form_id']} ] = {
exclude_fields: {$exclude_fields_json},
exclude_fields_without_options: {$exclude_fields_without_options_json}
};
}";

GFFormDisplay::add_init_script( $this->_args['form_id'], 'gfcep', GFFormDisplay::ON_PAGE_RENDER, $script );
Expand All @@ -159,6 +172,9 @@ function stash_excluded_total( $product_data, $form ) {
if ( in_array( $field_id, $this->_args['exclude_fields'] ) ) {
$this->excluded_total += GFCommon::to_number( $data['price'] );
}
if ( in_array( $field_id, $this->_args['exclude_fields_without_options'] ) ) {
$this->excluded_total += GFCommon::to_number( $data['price'] );
}
}

return $product_data;
Expand All @@ -170,11 +186,18 @@ function modify_coupon_discount_amount( $discount, $coupon, $price ) {
return $discount;
}

$price = $price - $this->excluded_total;
$currency = new RGCurrency( GFCommon::get_currency() );
$amount = $currency->to_number( $coupon['amount'] );
$orig_price = $price;
$price = $price - $this->excluded_total;
$currency = new RGCurrency( GFCommon::get_currency() );
$amount = $currency->to_number( $coupon['amount'] );

if ( $coupon['type'] == 'percentage' && ! ( $amount == 100 && $this->_args['skip_for_100_percent'] ) ) {
if ( $this->_args['exclude_fields_without_options'] ) {
if ( $coupon['type'] == 'percentage' && ! ( $amount == 100 && $this->_args['skip_for_100_percent'] ) ) {
$discount = $discount - ( $price * ( $amount / 100 ) );
} else {
$discount = $this->excluded_total;
}
} elseif ( $coupon['type'] == 'percentage' && ! ( $amount == 100 && $this->_args['skip_for_100_percent'] ) ) {
$discount = $price * ( $amount / 100 );
} elseif ( $coupon['type'] == 'flat' ) {
$discount = $amount;
Expand Down Expand Up @@ -207,7 +230,7 @@ function is_applicable_form( $form ) {

/**
* Configuration
* - for a single form, set form_id to your form ID, and exclude_fields to an array of the fields you wish to exclude
* - for a single form, set form_id to your form ID, and exclude_fields to an array of the fields you wish to exclude or use exclude_fields_without_options for fields without options
* - for multiple forms, set exclude_fields_by_form to an array with form IDs as its keys, and arrays of field IDs as its values
* - set skip_for_100_percent to true to ignore these exclusions when a 100% off coupon is used
*/
Expand All @@ -220,6 +243,14 @@ function is_applicable_form( $form ) {
'skip_for_100_percent' => false,
) );

// Single form (exclude fields without options)

new GW_Coupons_Exclude_Products( array(
'form_id' => 123,
'exclude_fields_without_options' => array( 6 ),
'skip_for_100_percent' => false,
) );

// Multiple forms

new GW_Coupons_Exclude_Products( array(
Expand Down
Loading