convert "set valuable post types" to interactive

Author: ilicfilip

assets/css/page-widgets/suggested-tasks.css

@@ -596,3 +596,18 @@
 		}
 	}
 }
+
+/*------------------------------------*\
+	Post types selection.
+\*------------------------------------*/
+.prpl-post-types-selection {
+
+	label {
+		display: block;
+		margin-top: 0.75rem;
+
+		&:first-child {
+			margin-top: 0;
+		}
+	}
+}

assets/js/recommendations/set-valuable-post-types.js

@@ -0,0 +1,49 @@
+/* global prplInteractiveTaskFormListener, progressPlanner */
+
+/*
+ * Set valuable post types.
+ *
+ * Dependencies: progress-planner/recommendations/interactive-task
+ */
+
+prplInteractiveTaskFormListener.customSubmit( {
+	taskId: 'set-valuable-post-types',
+	popoverId: 'prpl-popover-set-valuable-post-types',
+	callback: () => {
+		return new Promise( ( resolve, reject ) => {
+			const postTypes = document.querySelectorAll(
+				'#prpl-popover-set-valuable-post-types input[name="prpl-post-types-include[]"]:checked'
+			);
+
+			if ( ! postTypes.length ) {
+				reject( {
+					success: false,
+					error: new Error( 'No post types selected' ),
+				} );
+				return;
+			}
+
+			const postTypesValues = Array.from( postTypes ).map(
+				( type ) => type.value
+			);
+
+			fetch( progressPlanner.ajaxUrl, {
+				method: 'POST',
+				headers: {
+					'Content-Type': 'application/x-www-form-urlencoded',
+				},
+				body: new URLSearchParams( {
+					action: 'prpl_interactive_task_submit_set-valuable-post-types',
+					nonce: progressPlanner.nonce,
+					'prpl-post-types-include': postTypesValues,
+				} ),
+			} )
+				.then( ( response ) => {
+					resolve( { response, success: true } );
+				} )
+				.catch( ( error ) => {
+					reject( { success: false, error } );
+				} );
+		} );
+	},
+} );

classes/admin/class-page-settings.php

@@ -146,8 +146,14 @@ public function store_settings_form_options() {
 			$this->set_page_values( $pages );
 		}
 
+		// It's possible that none of the post types are selected, so we need to handle that case.
+		$post_types = isset( $_POST['prpl-post-types-include'] )
+		? \array_map( 'sanitize_text_field', \wp_unslash( $_POST['prpl-post-types-include'] ) ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Missing
+		: [];
+
+		$this->save_post_types( $post_types );
+
 		$this->save_settings();
-		$this->save_post_types();
 
 		\do_action( 'progress_planner_settings_form_options_stored' );
 
@@ -221,13 +227,13 @@ public function save_settings() {
 	/**
 	 * Save the post types.
 	 *
+	 * @param array $post_types The post types.
+	 *
 	 * @return void
 	 */
-	public function save_post_types() {
-		// Nonce is already checked in store_settings_form_options() which calls this method.
-		$include_post_types = isset( $_POST['prpl-post-types-include'] ) // phpcs:ignore WordPress.Security.NonceVerification.Missing
-			? \array_map( 'sanitize_text_field', \wp_unslash( $_POST['prpl-post-types-include'] ) ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Missing
-			// If no post types are selected, use the default post types (post and page can be deregistered).
+	public function save_post_types( $post_types = [] ) {
+		$include_post_types = ! empty( $post_types )
+			? $post_types
 			: \array_intersect( [ 'post', 'page' ], \progress_planner()->get_settings()->get_public_post_types() );
 
 		\progress_planner()->get_settings()->set( 'include_post_types', $include_post_types );

classes/suggested-tasks/providers/class-set-valuable-post-types.php

@@ -10,7 +10,7 @@
 /**
  * Add tasks for settings saved.
  */
-class Set_Valuable_Post_Types extends Tasks {
+class Set_Valuable_Post_Types extends Tasks_Interactive {
 
 	/**
 	 * The provider ID.
@@ -19,6 +19,13 @@ class Set_Valuable_Post_Types extends Tasks {
 	 */
 	protected const PROVIDER_ID = 'set-valuable-post-types';
 
+	/**
+	 * The provider ID.
+	 *
+	 * @var string
+	 */
+	public const POPOVER_ID = 'set-valuable-post-types';
+
 	/**
 	 * Whether the task is an onboarding task.
 	 *
@@ -56,6 +63,7 @@ protected function get_url() {
 	 */
 	public function init() {
 		\add_action( 'progress_planner_settings_form_options_stored', [ $this, 'remove_upgrade_option' ] );
+		\add_action( 'wp_ajax_prpl_interactive_task_submit_set-valuable-post-types', [ $this, 'handle_interactive_task_specific_submit' ] );
 	}
 
 	/**
@@ -119,6 +127,77 @@ public function is_task_completed( $task_id = '' ) {
 		return false === \get_option( 'progress_planner_set_valuable_post_types', false );
 	}
 
+	/**
+	 * Handle the interactive task submit.
+	 *
+	 * @return void
+	 */
+	public function handle_interactive_task_specific_submit() {
+		// Check if the user has the necessary capabilities.
+		if ( ! \current_user_can( 'manage_options' ) ) {
+			\wp_send_json_error( [ 'message' => \esc_html__( 'You do not have permission to update settings.', 'progress-planner' ) ] );
+		}
+
+		// Check the nonce.
+		if ( ! \check_ajax_referer( 'progress_planner', 'nonce', false ) ) {
+			\wp_send_json_error( [ 'message' => \esc_html__( 'Invalid nonce.', 'progress-planner' ) ] );
+		}
+
+		if ( ! isset( $_POST['prpl-post-types-include'] ) ) {
+			\wp_send_json_error( [ 'message' => \esc_html__( 'Missing post types.', 'progress-planner' ) ] );
+		}
+
+		$post_types = \wp_unslash( $_POST['prpl-post-types-include'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- array elements are sanitized below.
+		$post_types = explode( ',', $post_types );
+		$post_types = array_map( 'sanitize_text_field', $post_types );
+
+		\progress_planner()->get_admin__page_settings()->save_post_types( $post_types );
+
+		\wp_send_json_success( [ 'message' => \esc_html__( 'Setting updated.', 'progress-planner' ) ] );
+	}
+
+	/**
+	 * Print the popover instructions.
+	 *
+	 * @return void
+	 */
+	public function print_popover_instructions() {
+		echo '<p>';
+		\esc_html_e( 'You\'re in control of what counts as valuable content. We\'ll track and reward activity only for the post types you select here.', 'progress-planner' );
+		echo '</p>';
+	}
+
+	/**
+	 * Print the popover form contents.
+	 *
+	 * @return void
+	 */
+	public function print_popover_form_contents() {
+		$prpl_saved_settings = \progress_planner()->get_settings()->get_post_types_names();
+		$prpl_post_types     = \progress_planner()->get_settings()->get_public_post_types();
+
+		// Early exit if there are no public post types.
+		if ( empty( $prpl_post_types ) ) {
+			return;
+		}
+		?>
+		<div class="prpl-post-types-selection">
+			<?php foreach ( $prpl_post_types as $prpl_post_type ) : ?>
+			<label>
+				<input
+					type="checkbox"
+					name="prpl-post-types-include[]"
+					value="<?php echo \esc_attr( $prpl_post_type ); ?>"
+					<?php \checked( \in_array( $prpl_post_type, $prpl_saved_settings, true ) ); ?>
+				/>
+				<?php echo \esc_html( \get_post_type_object( $prpl_post_type )->labels->name ); // @phpstan-ignore-line property.nonObject ?>
+			</label>
+			<?php endforeach; ?>
+		</div>
+		<?php
+		$this->print_submit_button( \__( 'Set', 'progress-planner' ) );
+	}
+
 	/**
 	 * Add task actions specific to this task.
 	 *
@@ -130,7 +209,7 @@ public function is_task_completed( $task_id = '' ) {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a class="prpl-tooltip-action-text" href="' . \admin_url( 'admin.php?page=progress-planner-settings' ) . '" target="_self">' . \esc_html__( 'Go to the settings page', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Set', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;