Make historical import field disabled when the value is 'Yes'

Author: phatsk

src/View/Admin/Field/ImportHistoricalData.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * Field for allowing the import of historical data.
+ *
+ * @since 2019-06-05
+ * @author Zach Owen <zach@webdevstudios>
+ * @package cc-woo-view-admin-field
+ */
+
+namespace WebDevStudios\CCForWoo\View\Admin\Field;
+
+/**
+ * ImportHistoricalData clss
+ *
+ * @since 2019-06-05
+ * @author Zach Owen <zach@webdevstudios>
+ * @package cc-woo-view-admin-field
+ */
+class ImportHistoricalData {
+	/**
+	 * Historical customer data import field.
+	 *
+	 * @since 2019-03-12
+	 */
+	const OPTION_FIELD_NAME = 'cc_woo_customer_data_allow_import';
+
+	/**
+	 * Returns the form field configuration.
+	 *
+	 * @since 2019-06-05
+	 * @author Zach Owen <zach@webdevstudios>
+	 * @return array.
+	 */
+	public function get_form_field() : array {
+		return [
+			'title'             => esc_html__( 'Import historical customer data', 'cc-woo' ),
+			'desc'              => $this->get_description(),
+			'type'              => 'select',
+			'id'                => self::OPTION_FIELD_NAME,
+			'default'           => '',
+			'custom_attributes' => $this->get_custom_attributes(),
+			'options'           => [
+				''      => '----',
+				'false' => esc_html__( 'No', 'cc-woo' ),
+				'true'  => esc_html__( 'Yes', 'cc-woo' ),
+			],
+		];
+	}
+
+	/**
+	 * Get the field's custom attribute configuration.
+	 *
+	 * @TODO "$configuration" should probably be an object.
+	 * @since 2019-06-05
+	 * @author Zach Owen <zach@webdevstudios>
+	 *
+	 * @return array
+	 */
+	private function get_custom_attributes() : array {
+		$attributes = [];
+
+		if ( $this->is_required() ) {
+			$attributes['required'] = true;
+		}
+
+		if ( $this->is_readonly() ) {
+			$attributes['readonly'] = 'readonly';
+			$attributes['disabled'] = 'disabled';
+		}
+
+		return $attributes;
+	}
+
+	/**
+	 * Return whether the field is required.
+	 *
+	 * @since 2019-06-05
+	 * @author Zach Owen <zach@webdevstudios>
+	 * @return bool
+	 */
+	protected function is_required() : bool {
+		return true;
+	}
+
+	/**
+	 * Returns the value of the field option.
+	 *
+	 * @since 2019-06-05
+	 * @author Zach Owen <zach@webdevstudios>
+	 * @return bool
+	 */
+	protected function is_readonly() : bool {
+		return 'true' === get_option( self::OPTION_FIELD_NAME, 'false' );
+	}
+
+	/**
+	 * Get the field description based on the option's readonly state.
+	 *
+	 * @since 2019-06-05
+	 * @author Zach Owen <zach@webdevstudios>
+	 * @return string
+	 */
+	private function get_description() : string {
+		return $this->is_readonly() ? '' : esc_html__( 'Selecting Yes here will enable the ability to import your historical customer information to Constant Contact.', 'cc-woo' );
+	}
+}

src/View/Admin/WooTab.php

@@ -76,13 +76,6 @@ class WooTab extends WC_Settings_Page implements Hookable {
 	 */
 	const EMAIL_FIELD = 'cc_woo_store_information_contact_email';
 
-	/**
-	 * Historical customer data import field.
-	 *
-	 * @since 2019-03-12
-	 */
-	const ALLOW_HISTORICAL_CUSTOMER_IMPORT_FIELD = 'cc_woo_customer_data_allow_import';
-
 	/**
 	 * Settings section ID.
 	 *
@@ -503,32 +496,26 @@ private function get_customer_data_settings() {
 				'title' => '',
 				'type'  => 'title',
 				'desc'  => esc_html__( 'All contacts must agree to receive marketing messages in order to be added to your mailing list.  Therefore, when you import contacts, you are agreeing that you have permission to send them marketing messages.', 'cc-woo' ),
-			],
+			]
+		];
+
+		$historical_import_field = new \WebDevStudios\CCForWoo\View\Admin\Field\ImportHistoricalData();
+
+		$settings[] = array_merge(
+			$settings,
+			$historical_import_field->get_form_field(),
 			[
-				'title'             => esc_html__( 'Import historical customer data', 'cc-woo' ),
-				'desc'              => esc_html__( 'Selecting Yes here will enable the ability to import your historical customer information to Constant Contact.', 'cc-woo' ),
-				'type'              => 'select',
-				'id'                => self::ALLOW_HISTORICAL_CUSTOMER_IMPORT_FIELD,
-				'default'           => '',
-				'custom_attributes' => [
-					'required' => true,
+				[
+					'title' => '',
+					'type'  => 'cc_woo_anti_spam_notice',
+					'id'    => 'anti-spam-notice',
 				],
-				'options'           => [
-					''      => '----',
-					'false' => esc_html__( 'No', 'cc-woo' ),
-					'true'  => esc_html__( 'Yes', 'cc-woo' ),
+				[
+					'type' => 'sectionend',
+					'id'   => 'cc_woo_customer_data_settings',
 				],
-			],
-			[
-				'title' => '',
-				'type'  => 'cc_woo_anti_spam_notice',
-				'id'    => 'anti-spam-notice',
-			],
-			[
-				'type' => 'sectionend',
-				'id'   => 'cc_woo_customer_data_settings',
-			],
-		];
+			]
+		);
 
 		return $settings;
 	}