Move setting registration logic

Lozrus · Lozrus · commit 31621112809a · 2021-02-17T16:27:10.000Z
Add mailchimp default keys to ignore list
Printing empty item footer message is more efficient
Delete all options when uninstalled
diff --git a/create-settings.php b/create-settings.php
@@ -8,14 +8,6 @@ function star_cloudprnt_is_woo_activated()
 
 	function star_cloudprnt_settings()
 	{
-
-		/* Attempt to set the default print job trigger to "status_processing" for new installs, but "thankyou" for sites that have
-		   already been running with the plugin - to avoid potentially breaking thos sites after upgrading the plugin, since some sites use
-			 other plugins to change the default order status.
-			 */
-		$trigger_default = "status_processing";						// Recommended default for new sites, at which time users can choose another option if preferred
-		if(get_option('star-cloudprnt-select') != "")
-			$trigger_default = "thankyou";
 		
 		add_settings_section("star_cloudprnt_setup_section", "CloudPRNT Setup", "star_cloudprnt_setup_section_info", "star_cloudprnt_setup");
 		add_settings_field("star-cloudprnt-select", "CloudPRNT", "star_cloudprnt_select_display", "star_cloudprnt_setup", "star_cloudprnt_setup_section");  
@@ -35,6 +27,17 @@ function star_cloudprnt_settings()
 		add_settings_field("star-cloudprnt-order-fields", "Additional Order Fields", "star_cloudPRNT_order_fields_display", "star_cloudprnt_setup", "star_cloudprnt_design_section");
 		add_settings_field("star-cloudprnt-logo", "Logo", "star_cloudPRNT_print_logo_display", "star_cloudprnt_setup", "star_cloudprnt_design_section");
 
+	}
+	
+	function star_cloudprnt_register_settings()
+	{
+		/* Attempt to set the default print job trigger to "status_processing" for new installs, but "thankyou" for sites that have
+		   already been running with the plugin - to avoid potentially breaking thos sites after upgrading the plugin, since some sites use
+			 other plugins to change the default order status.
+			 */
+			$trigger_default = "status_processing";						// Recommended default for new sites, at which time users can choose another option if preferred
+			if(get_option('star-cloudprnt-select') != false)
+				$trigger_default = "thankyou";
 
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-select");
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-printer-select");
@@ -51,7 +54,7 @@ function star_cloudprnt_settings()
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-order-meta-cb");
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-order-meta-reformat-keys", array("default" => "on"));
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-order-meta-hidden", array("default" => "off"));
-		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-order-meta-exclusions", array("default" => "is_vat_exempt,"));
+		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-order-meta-exclusions", array("default" => "is_vat_exempt, mailchimp_woocommerce_campaign_id, mailchimp_woocommerce_landing_site"));
 
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-logo-top-cb");
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-print-logo-top-input");
@@ -61,7 +64,8 @@ function star_cloudprnt_settings()
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-buzzer-start", array("default" => ""));
 		register_setting("star_cloudprnt_setup_section", "star-cloudprnt-buzzer-end", array("default" => ""));
 	}
-	
+
+
 	function star_cloudprnt_menu_item()
 	{
 		add_submenu_page("options-general.php", "Star CloudPRNT for WooCommerce", "Star CloudPRNT for WooCommerce", "manage_options", "star-cloudprnt-settings-admin", "star_cloudprnt_page"); 
diff --git a/order-handler.php b/order-handler.php
@@ -167,6 +167,8 @@ function star_cloudprnt_print_address($printer, $selectedPrinter, $order, $order
 		$postcode = $gkv('_shipping_postcode');
 		$tel = $gkv('_billing_phone');
 		
+		$printer->add_new_line(1);
+
 		$printer->set_text_emphasized();
 		if ($a1 == '')
 		{
@@ -286,9 +288,12 @@ function star_cloudprnt_print_items_footer(&$printer, &$selectedPrinter, &$order
 	{
 		$item_footer_message = get_option('star-cloudprnt-print-items-footer-message');
 
+		if(empty($item_footer_message))
+			return;
+
 		$printer->add_new_line(1);
 		$printer->add_text_line(wordwrap($item_footer_message, $selectedPrinter['columns'], "\n", true));
-		$printer->add_new_line(1);
+		
 	}
 
 	// Print info below items list
diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Tags: star, printing, printers, automated, e-commerce, store, sales, downloadabl
 Requires at least: 5.0
 Tested up to: 5.6
 Requires PHP: 7.2
-Stable tag: 2.0.0
+Stable tag: 2.0.1
 License: MIT
 
 Star CloudPRNT for WooCommerce enables Cloud printing technology with your Star Receipt printer.
@@ -85,12 +85,12 @@ If issues continue, then please check the quality of your printers internet conn
 
 This means that you printer is unable to connect with your server, and can have many potential causes:
 
-# As a first step, if you are using an mC-Print2 or mC-Print3 model printer, the please update your printer firmware to version 3.0 or later to ensure compatibility with web hosts that have stronger TLS encryption.
+  As a first step, if you are using an mC-Print2 or mC-Print3 model printer, the please update your printer firmware to version 3.0 or later to ensure compatibility with web hosts that have stronger TLS encryption.
   Firmware can be updated using the Star "mC-Print Utility" app, available via Google Play, or Apple App stores.
 
-# Check that the printer has a working outgoing internet connection. Star tech support may be able to help with this if needed.
+  Check that the printer has a working outgoing internet connection. Star tech support may be able to help with this if needed.
 
-# Ensure that your your hosting does not have a traffic filter that may be blocking the printer from connecting to your web site or aggressively caching responses to your sites CloudPRNT URL. It may be necessary to ask your hosting provided to set up a rule to allow your printer to connect to your sites CloudPRNT URL. They must allow at least GET and POST requests without caching responses.
+  Ensure that your your hosting does not have a traffic filter that may be blocking the printer from connecting to your web site or aggressively caching responses to your sites CloudPRNT URL. It may be necessary to ask your hosting provided to set up a rule to allow your printer to connect to your sites CloudPRNT URL. They must allow at least GET and POST requests without caching responses.
 
 
 == Screenshots ==
@@ -110,6 +110,12 @@ This means that you printer is unable to connect with your server, and can have
 
 == Changelog ==
 
+= 2.0.1 =
+* Do not print any blank lines if the items footer text is empty
+* Add some mailchimp metadata key names to the defailt exclusions list
+* Change the timing for registering settings, to avoid reported issue with accessing settings with their default value.
+* Remove all settings when uninstalled
+
 = 2.0.0 =
 * Make printing trigger method user configurable
 * Clean-up settings page design
diff --git a/star-cloudprnt-for-woocommerce.php b/star-cloudprnt-for-woocommerce.php
@@ -3,7 +3,7 @@
 	 * Plugin Name: Star CloudPRNT for WooCommerce
 	 * Plugin URI: http://www.star-emea.com
 	 * Description: Star CloudPRNT for WooCommerce enables cloud printing technology with your Star Receipt printer.
-	 * Version: 2.0.0
+	 * Version: 2.0.1 beta 01
 	 * Author: lawrenceowen, athompson1, gcubero, fmahmood
 	 * Author URI: http://www.star-emea.com/support
 	 * Requires at least: 5.0
@@ -24,6 +24,8 @@
 	include_once(plugin_dir_path(__FILE__).star_cloudprnt_get_os_path('create-settings.php'));
 	include_once(plugin_dir_path(__FILE__).star_cloudprnt_get_os_path('order-handler.php'));
 	
+	star_cloudprnt_register_settings();
+	
 	// Run page setup and woo commerce hooks
 	star_cloudprnt_create_settings_page();
 	star_cloudprnt_setup_order_handler();
diff --git a/uninstall.php b/uninstall.php
@@ -28,4 +28,23 @@ function rrmdir($dir)
 	delete_option('star-cloudprnt-print-logo-top-input');
 	delete_option('star-cloudprnt-print-logo-bottom-cb');
 	delete_option('star-cloudprnt-print-logo-bottom-input');
+
+	delete_option("star-cloudprnt-printer-encoding-select");
+	delete_option("star-cloudprnt-print-copies-input");
+
+	delete_option("star-cloudprnt-trigger");
+
+	delete_option("star-cloudprnt-print-header-title");
+
+	delete_option("star-cloudprnt-print-items-footer-message");
+
+	delete_option("star_cloudprnt_setup_section");
+	delete_option("star-cloudprnt-print-order-meta-reformat-keys");
+	delete_option("star-cloudprnt-print-order-meta-hidden");
+	delete_option("star-cloudprnt-print-order-meta-exclusions");
+
+	delete_option("star-cloudprnt-buzzer-start");
+	delete_option( "star-cloudprnt-buzzer-end");
+
+
 ?>

Original file line number	Diff line number	Diff line change
`@@ -167,6 +167,8 @@ function star_cloudprnt_print_address($printer, $selectedPrinter, $order, $order`
`167`	`167`	`$postcode = $gkv('_shipping_postcode');`
`168`	`168`	`$tel = $gkv('_billing_phone');`
`169`	`169`
	`170`	`+ $printer->add_new_line(1);`
	`171`	`+`
`170`	`172`	`$printer->set_text_emphasized();`
`171`	`173`	`if ($a1 == '')`
`172`	`174`	`{`
`@@ -286,9 +288,12 @@ function star_cloudprnt_print_items_footer(&$printer, &$selectedPrinter, &$order`
`286`	`288`	`{`
`287`	`289`	`$item_footer_message = get_option('star-cloudprnt-print-items-footer-message');`
`288`	`290`
	`291`	`+ if(empty($item_footer_message))`
	`292`	`+ return;`
	`293`	`+`
`289`	`294`	`$printer->add_new_line(1);`
`290`	`295`	`$printer->add_text_line(wordwrap($item_footer_message, $selectedPrinter['columns'], "\n", true));`
`291`		`- $printer->add_new_line(1);`
	`296`	`+`
`292`	`297`	`}`
`293`	`298`
`294`	`299`	`// Print info below items list`