Version 4.0.1

July 10, 2024

Added

  • Add support for orderSite for PDF URLs.

Changed

  • Update English translations.
  • Switch session handler to use Craft’s Session helper.

Fixed

  • Fix an error when saving a new site.
  • Fix session-handling to check for console requests.
  • Fix vouchers always being re-saved when updating a site or force-applying project config.

Version 4.0.0

May 27, 2024

Changed

  • Now requires PHP 8.2.0+.
  • Now requires Craft 5.0.0+.
  • Now requires Craft Commerce 5.0.0+.

Version 3.0.13

July 10, 2024

Added

  • Add support for orderSite for PDF URLs.

Changed

  • Update English translations.
  • Switch session handler to use Craft’s Session helper.

Fixed

  • Fix an error when saving a new site.
  • Fix session-handling to check for console requests.
  • Fix vouchers always being re-saved when updating a site or force-applying project config.

Version 3.0.12

March 4, 2024

Added

  • Add support for programatically setting a code’s codeKey.

Fixed

  • Fix order of operations when uninstalling the plugin.

Version 3.0.11

January 30, 2024

Added

  • PDFs now support using the current site’s locale language and formatting.

Version 3.0.10

December 8, 2023

Added

  • Add currently-applied voucher codes to manage for modal when editing an order in the control panel.
  • Add codeKey as an available variable for the voucherCodesPdfFilenameFormat setting.

Changed

  • Voucher modal now shows message instead of refreshing, ensuring unsaved changes to the order aren’t discarded.

Fixed

  • Fix “enter” key not submitting the gift voucher modal when editing an order in the control panel.
  • Fix codeKey reference when rendering PDFs.

Version 3.0.9

October 25, 2023

Fixed

  • Implement Element::trackChanges() for Blitz compatibility.

Version 3.0.8

October 8, 2023

Fixed

  • Fix an issue when creating new sites and not propagating voucher types correctly.

Version 3.0.7

March 9, 2023

Changed

  • Only admins are now allowed to access plugin settings.

Fixed

  • Fix an error when creating a voucher of custom value with no value provided.
  • Fix an error when creating a voucher code. (thanks @darinlarimore).

Version 3.0.6

December 25, 2022

Fixed

  • Fix an error when viewing a voucher code with no order associated with it.

Version 3.0.5

November 30, 2022

Fixed

  • Fix permissions check for managing Vouchers and Codes.
  • Fix voucher and code element indexes not providing edit links due to Craft 4.3.2 changes.
  • Fix cannot assign Dompdf\Options to property PdfRenderOptionsEvent::$options. (thanks @CMeldgaard).
  • Fix an error when saving vouchers containing commas in price.

Version 3.0.4

November 15, 2022

Fixed

  • Fix an error when trying to generate a PDF for a voucher in the control panel.
  • Fix issues with int type check, and error checking in tabs. (thanks @darinlarimore).

Version 3.0.3

November 10, 2022

Fixed

  • Fix an error when trying to edit a Code object in the control panel.

Version 3.0.2

October 23, 2022

Added

  • Add tabs for codes not working correctly in the control panel.

Version 3.0.1

October 21, 2022

Fixed

  • Fix an error when combining a Commerce discount and Gift Voucher code with stopProcessing enabled.
  • Fix an error when saving a voucher without an SKU.
  • Fix an error when applying a Craft discount code.
  • Fix codeStorage type.
  • Fix an error running resave console commands.

Version 3.0.0

August 25, 2022

Added

  • Add missing English translations.
  • Add dateCreated, dateUpdated and uid to Redemption model.

Changed

  • Now requires PHP ^8.0.2.
  • Now requires Craft ^4.0.0.
  • Now requires Craft Commerce ^4.0.0.
  • Replace deprecated Craft.postActionRequest() for JS.

Fixed

  • Fix an error when uninstalling.
  • Fix redemptions table showing the order date instead of the date of the redemption date.
  • Fix an error when viewing a redemption without and order in the control panel.
  • Fix an error fetching new redemption records.
  • Fix a type error with redemption codes.

Version 2.7.6

March 8, 2024

Added

  • Add support for programatically setting a code’s codeKey.

Fixed

  • Fix order of operations when uninstalling the plugin.

Version 2.7.5

December 8, 2023

Added

  • Add currently-applied voucher codes to manage for modal when editing an order in the control panel.

Changed

  • Voucher modal now shows message instead of refreshing, ensuring unsaved changes to the order aren’t discarded.

Fixed

  • Fix “enter” key not submitting the gift voucher modal when editing an order in the control panel.

Version 2.7.4

October 8, 2023

Fixed

  • Fix an issue when creating new sites and not propagating voucher types correctly.

Version 2.7.3

October 23, 2022

Added

  • Add tabs for codes not working correctly in the control panel.

Version 2.7.2

August 25, 2022

Added

  • Add dateCreated, dateUpdated and uid to Redemption model.

Fixed

  • Fix redemptions table showing the order date instead of the date of the redemption date.
  • Fix an error when viewing a redemption without and order in the control panel.

Version 2.7.1

June 10, 2022

Fixed

  • Fix an error when trying to redeem a voucher code, when the linked voucher has been deleted.
  • Fix being unable to modify a code’s voucher in the control panel.
  • Fix Swiftmailer dropping message after attaching voucher PDF.
  • Fix an error in Postgres when resaving a voucher code.
  • Fix PDF generation URLs not being correct in headless environments.

Version 2.7.0

December 12, 2021

Added

  • Added resave/gift-voucher-codes and resave/gift-voucher-vouchers console commands.
  • Added orderReference to the searchable attributes for voucher codes.

Changed

  • Reverted adjuster behaviour back to 2.5.x version, fixing many issues.
  • Voucher adjusters not use a voucher type instead of discount to fix many issues.

Fixed

  • Fix an error when clicking "New voucher" when adding a voucher in the Bulk Generate Codes function.
  • Fix a hard-error shown when saving a voucher with no price.
  • Fix "Voucher Type" column not displaying correctly for the codes element index.
  • Fix "All voucher types" not appearing in the control panel for codes element index.

Version 2.6.3

October 30, 2021

Changed

  • Extend voucher expiry from 24 to 36 months.

Version 2.6.2

October 6, 2021

Fixed

  • Fix when attaching the PDF to an email, clears the body content of the email.
  • Fix an override warning message not showing for the attachPdfToEmails config setting in the control panel.
  • Fix debug console output in the control panel.

Version 2.6.1

August 23, 2021

Fixed

  • Fix shipping discount being applied when total amount already redeemed (introduced in 2.6.0).

Version 2.6.0

August 22, 2021

Changed

  • Major refactor of discount adjuster, which is used when applying a voucher code on an order. This change fixes a few issues with Commerce 3.4+.
  • Discounts are now spread over all line items, when applying a voucher code. This is inline with Craft Commerce's discount adjusters are handled.
  • Now requires Craft Commerce 3.4+.

Fixed

  • Fixed duplicate discounts being applied to orders when redeeming a code, in some instances.
  • Fixed some cases when tax on a shipping method was being charged, despite the discount being applied to a shipping methods' cost.

Version 2.5.10

July 8, 2021

Added

  • Add EVENT_BEFORE_MATCH_CODE event for adding custom code matching logic. (thanks @superbigco).

Fixed

  • Fix an error when generating PDFs and custom fonts, where the temporary folder isn’t writable (or created).
  • Ensure we register the discount adjuster via EVENT_REGISTER_DISCOUNT_ADJUSTERS to fix some compatibility issues.
  • Fix vouchers being applied to new orders, when creating new orders in the control panel.

Version 2.5.9

March 29, 2021

Added

  • Add bulk voucher code generation page. (thanks @jerome2710).
  • Add EVENT_MODIFY_RENDER_OPTIONS event for modifying the DomPDF options during render.

Fixed

  • Fix incorrectly using fieldLayoutId for plugin settings, when fetching Codes’ field layouts. This could lead to some installs not generating voucher codes correctly upon checkout.

Version 2.5.8

February 13, 2021

Added

  • Add promotable and availableForPurchase options to vouchers.

Version 2.5.7

January 22, 2021

Fixed

  • Fix gift vouchers attaching to emails, even when disabled.
  • Change logging from error to info when an order doesn’t contain a gift voucher.

Version 2.5.6

December 12, 2020

Added

  • Add more logging around post-checkout functionality.

Changed

  • Post-checkout functionality is now performed on EVENT_AFTER_COMPLETE_ORDER rather than EVENT_BEFORE_COMPLETE_ORDER.

Fixed

  • Fix permission translation error.

Version 2.5.5

November 26, 2020

Fixed

  • Ensure critical errors are logged during the order complete event.
  • Fix critical errors preventing orders from completing correctly.

Version 2.5.4

November 7, 2020

Fixed

  • Fix potential error with isVoucher and line item purchasables.

Version 2.5.3

November 6, 2020

Added

  • Add support to apply gift voucher from the control panel, when editing an incomplete order.
  • Add ability to attach gift voucher PDFs to Commerce emails.

Fixed

  • Fix an error when no code is found when applying voucher codes.

Version 2.5.2

October 8, 2020

Changed

  • Custom fields are no longer serialized in the snapshot of a voucher. Please use EVENT_AFTER_CAPTURE_VOUCHER_SNAPSHOT and EVENT_BEFORE_CAPTURE_VOUCHER_SNAPSHOT events to opt-in any custom fields you want serialized in the snapshot. This follows Commerce's behaviour.

Fixed

  • Fix incorrectly serializing Super Table queries when taking a snapshot of Gift Vouchers when adding to the cart.
  • Fix EVENT_AFTER_CAPTURE_VOUCHER_SNAPSHOT event not actually doing much.
  • Prevent code field layout ID from being creating multiple times when saving plugin settings.

Version 2.5.1

September 18, 2020
Critical

Fixed

  • Fix a potential security vulnerability where the last-created voucher could be redeemed by any user.
  • Replace hard coded currency with order currency. (thanks @yingban).

Version 2.5.0

August 31, 2020

Added

  • Add support for Craft 3.5 field designer for code elements.
  • Add support for Craft 3.5 field designer for voucher elements.

Changed

  • Now requires Craft 3.5+.
  • Now requires Craft Commerce 3.2+.

Version 2.4.3

August 20, 2020

Fixed

  • Fix getEditableVoucherTypeIds not returning correctly.

Version 2.4.2.1

July 30, 2020

Fixed

  • Fix ErrorException from undefined variable uid. (thanks @jmauzyk).

Version 2.4.2

July 29, 2020

Fixed

  • Fix voucher site dropdown not working for multi-sites.
  • Fix share and preview button alignment for vouchers.
  • Fix live preview not working for vouchers.
  • Fix save-as-new-voucher not working correctly.
  • Fix voucher permissions to use UID instead of ID.

Version 2.4.1

June 22, 2020

Fixed

  • Add migration for potentially missing code field layout.
  • Fix usage of deprecated saleAmount.
  • Return cart errors for ajax-applying of voucher codes.

Version 2.4.0

June 18, 2020

Please note a breaking change in removing fieldsPath. If you use this setting to add custom field content to your voucher codes when adding to the cart, you will need to change this. Please see the docs - https://verbb.io/craft-plugins/gift-voucher/docs/template-guides/single-voucher#line-item-options

Changed

  • Removed fieldsPath config setting. If you are using this setting for adding custom field content to your voucher codes, please update your templates. Use input type="text" name="options[fieldHandle]" instead of input type="text" name="options[<fieldsPath>][fieldHandle]".

Version 2.3.1

June 15, 2020

Fixed

  • Fix potential error when trying to save a voucher code without an amount.
  • Fix incorrect handling for code field layout.

Version 2.3.0

May 10, 2020

Added

  • Add project config support for voucher types.

Fixed

  • Check to ensure Klaviyo Connect plugin is installed before doing any more checks. (thanks @brianjhanson)

Version 2.2.4

April 16, 2020

Fixed

  • Fix logging error Call to undefined method setFileLogging().

Version 2.2.3

April 15, 2020

Changed

  • File logging now checks if the overall Craft app uses file logging.
  • Log files now only include GET and POST additional variables.

Fixed

  • Only allow editing of voucher types if editable.

Version 2.2.2

March 16, 2020

Fixed

  • Fix order and voucher columns showing incorrect values in the voucher codes element index.
  • Add “Original Amount” to voucher codes element index.
  • Fix currency symbol in voucher codes element index in some cases.

Version 2.2.1

February 13, 2020

Fixed

  • Fix missing order properties for PDFs generated in CP. (thanks @jmauzyk).
  • Fix populateLineItem to work with Commerce 3.x.

Version 2.2.0

January 29, 2020

Added

  • Craft 3.4 compatibility.
  • Commerce 3.0 compatibility.

Version 2.1.2

January 9, 2020

Fixed

  • Fix registerAdjuster = afterTax not working correctly.

Version 2.1.1

January 9, 2020

Added

  • Add registerAdjuster plugin setting to control when the adjuster should be applied. Valid options are beforeTax (default) and afterTax.

Version 2.1.0

January 4, 2020

Added

  • Add the ability to set field layouts for Voucher Codes. (thanks @Anubarak).
  • Add a field layout designer to the settings for Voucher Codes. (thanks @Anubarak).
  • Add an event PopulateCodeFromLineItemEvent to set additional fields/properties when a new Code is created based on a Voucher/LineItem. (thanks @Anubarak).
  • Add an event to validate LineItem options for custom fields in the Code. (thanks @Anubarak).
  • Add a migration to include an initial empty content record for all existing Voucher Codes. (thanks @Anubarak).
  • Add a new setting fieldsPath that represents the path of custom fields in the LineItems options. (thanks @Anubarak).
  • Add additional Tabs for custom fields in the Voucher Code if there are any. (thanks @Anubarak).
  • Add a component codeStorage for storing and receiving codes that are used. (thanks @Anubarak).
  • Add an interface for codeStorage and the possibility to use custom classes/components. (thanks @Anubarak).
  • Add a class Session for storing the used codes for an order in the session. (thanks @Anubarak).
  • Add a class Order for storing the used codes for an order in the field layout in a Codes field. (thanks @Anubarak).
  • Add a new Code relation field type. (thanks @Anubarak).
  • Add template hook cp.gift-voucher.voucher.edit.details (thanks @samuelbirch).

Changed

  • All codeKeys are now grabbed via GiftVoucher::getInstance()->getCodeStorage()->getCodeKeys($order);. (thanks @Anubarak).
  • All codeKeys are now set via GiftVoucher::getInstance()->getCodeStorage()->set($codeKeys, $order); or the add or remove function.
  • This will make sure you can add a VoucherCode in the CP. (thanks @Anubarak).
  • Use a custom controller to store the plugins settings ensuring the new Field Layout setting is stored properly. (thanks @Anubarak).

Fixed

  • Fixed minor session issue. (thanks @Anubarak).
  • Display inactive Vouchers in the CP. (thanks @Anubarak).
  • Fixed a Bug that could occur when re-saving an order via job, Craft already closes the session before running the job -> the adjuster has no valid session. (thanks @Anubarak).
  • Fix missing date columns in code element index.
  • Fix voucher discount being applied after tax.
  • Fix incorrect multi-site URL redirection when switching sites for a voucher.

Version 2.0.13

August 25, 2019

Fixed

  • Fix incorrect migration.

Version 2.0.12.1

August 25, 2019

Fixed

  • Fix namespacing issue.

Version 2.0.12

August 25, 2019

Added

  • Add support for Klaviyo Connect plugin.
  • Add support for Commerce 3.

Changed

  • Adjust template functions vouchers() and codes() to allow criteria as params.

Fixed

  • Incorrect permission for voucher types.
  • Fix anonymous requests to gift voucher previewing.
  • Fix missing Commerce requirement.
  • Fix missing expiryDate column.
  • Fix voucher search indexes.
  • Fix lack of registering Code as an element type.
  • Add codeKey to searchable attributes.
  • Fix legacy codes (from Craft 2) not correctly being elements.
  • Fix lack of integrity constraint on codes.

Version 2.0.11

June 1, 2019

Added

  • Add override notice for settings fields.

Fixed

  • Fix missing sku and price query params.
  • Fix error in element HUD.

Version 2.0.10

February 27, 2019

Fixed

  • Fix multiple tabs for voucher types not showing.
  • Fix “New voucher” layout issue when switching voucher types

Version 2.0.9

February 19, 2019

Added

  • Added “Don’t allow voucher codes to be used if discounts are applied on the order”. By default, discount codes and voucher codes can be applied to an order together, which may not always be desired. This setting honours the "Don’t apply subsequent discounts if this discount is applied" for discounts.

Version 2.0.8

February 17, 2019

Fixed

  • Fix migration issue from Craft 2 to Craft 3.

Version 2.0.7

December 26, 2018

Fixed

  • Include translation of Adjuster description. Thanks (@Anubarak).
  • Set the codeKey to the element after storing the record to use it directly after the Code is created. Thanks (@Anubarak).
  • Add PDF config settings, rather than from Commerce.
  • Fix PDF paper orientation and size not changing from defaults.
  • Bring back missing format and attach params for PDF.

Version 2.0.6

December 14, 2018

Changed

  • Use beforeCompleteOrder as the event to generate codes, ensuring they can be used in emails.

Version 2.0.5

December 14, 2018

Added

  • Add afterVoucherAdjustmentsCreated.

Fixed

  • Fix querying codes by voucherId not working.
  • Fix codes not being generated correctly after checkout completion.
  • Fix redemptions not being generated correctly after checkout completion.

Version 2.0.4

December 1, 2018

Added

  • Add beforeCaptureVoucherSnapshot and afterCaptureVoucherSnapshot.

Fixed

  • Fix permissions for vouchers and codes.
  • Fix error occuring when installing plugin via command line

Version 2.0.3

November 10, 2018

Added

  • Allow PDFs to be generated for single voucher codes.
  • Add type to snapshot data.

Fixed

  • Fix Gift Voucher element field name.
  • Fix error when deleting a voucher.
  • Fix querying by voucherId on a code.
  • Fix error when querying and saving vouchers.

Version 2.0.2

October 26, 2018

Added

  • Add product method for voucher for easy commerce compatibility
  • Add field data to line item snapshot

Changed

  • Codes are now generated after the order is paid, instead of when complete
  • Bring back getPdfUrl() and getOrderPdfUrl()

Fixed

  • Fix welcome redirect
  • Fix empty strings being able to validate vouchers (oops)

Version 2.0.1

October 18, 2018

Fixed

  • Fixed some deprecation notices
  • Fix redemption error for new codes

Version 2.0.0

October 17, 2018
  • Craft 3 release.

Version 1.0.1

January 17, 2017

Added

  • Redeeming multiple vouchers.
  • Added possibility to return Ajax in frontend controller.

Changed

  • Redeemed code managing.
  • Change DiscountAdjuster order to apply after tax discount.

Fixed

  • Adjuster showing proper discount amount.

Version 1.0.0

December 18, 2017
  • Initial release.