Merge pull request #556 from ProgressPlanner/filip/select-timezone

New task provider: Select site timezone

Author: aristath

CHANGELOG.md

@@ -1,5 +1,8 @@
 = 1.7.0 =
 
+Added these recommendations from Ravi:
+* Select site timezone.
+
 Bugs we fixed:
 
 * Fix issue where "Perform all updates" task was incorrectly marked as completed.

assets/js/recommendations/select-timezone.js

@@ -0,0 +1,14 @@
+/* global prplInteractiveTaskFormListener */
+
+/*
+ * Set the site timezone.
+ *
+ * Dependencies: progress-planner/recommendations/interactive-task
+ */
+
+prplInteractiveTaskFormListener.siteSettings( {
+	settingAPIKey: 'timezone',
+	setting: 'timezone',
+	taskId: 'select-timezone',
+	popoverId: 'prpl-popover-select-timezone',
+} );

classes/suggested-tasks/class-task.php

@@ -90,11 +90,13 @@ public function update( array $data ): void {
 	 * @return void
 	 */
 	public function delete(): void {
-		$this->data = [];
 		// Delete only if the task is already saved in the database.
 		if ( $this->ID ) {
 			\progress_planner()->get_suggested_tasks_db()->delete_recommendation( $this->ID );
 		}
+
+		// Clear the data.
+		$this->data = [];
 	}
 
 	/**

classes/suggested-tasks/class-tasks-manager.php

@@ -33,6 +33,7 @@
 use Progress_Planner\Suggested_Tasks\Providers\Update_Term_Description;
 use Progress_Planner\Suggested_Tasks\Providers\Unpublished_Content;
 use Progress_Planner\Suggested_Tasks\Providers\Collaborator;
+use Progress_Planner\Suggested_Tasks\Providers\Select_Timezone;
 
 /**
  * Tasks_Manager class.
@@ -76,6 +77,7 @@ public function __construct() {
 			new Update_Term_Description(),
 			new Unpublished_Content(),
 			new Collaborator(),
+			new Select_Timezone(),
 		];
 
 		// Add the plugin integration.

classes/suggested-tasks/providers/class-select-timezone.php

@@ -0,0 +1,136 @@
+<?php
+/**
+ * Add task to select the site timezone.
+ *
+ * @package Progress_Planner
+ */
+
+namespace Progress_Planner\Suggested_Tasks\Providers;
+
+/**
+ * Add task to select the site locale.
+ */
+class Select_Timezone extends Tasks_Interactive {
+
+	/**
+	 * The provider ID.
+	 *
+	 * @var string
+	 */
+	protected const PROVIDER_ID = 'select-timezone';
+
+	/**
+	 * The popover ID.
+	 *
+	 * @var string
+	 */
+	const POPOVER_ID = 'select-timezone';
+
+	/**
+	 * Whether the task is dismissable.
+	 *
+	 * @var bool
+	 */
+	protected $is_dismissable = true;
+
+	/**
+	 * Get the task URL.
+	 *
+	 * @return string
+	 */
+	protected function get_url() {
+		return \admin_url( 'options-general.php?pp-focus-el=' . $this->get_task_id() );
+	}
+
+	/**
+	 * Get the link setting.
+	 *
+	 * @return array
+	 */
+	public function get_link_setting() {
+		return [
+			'hook'   => 'options-general.php',
+			'iconEl' => 'label[for="timezone_string"]',
+		];
+	}
+
+	/**
+	 * Get the task title.
+	 *
+	 * @return string
+	 */
+	protected function get_title() {
+		return \esc_html__( 'Set site timezone', 'progress-planner' );
+	}
+
+	/**
+	 * Get the task description.
+	 *
+	 * @return string
+	 */
+	protected function get_description() {
+		return \esc_html__( 'Set site timezone to ensure scheduled posts and pages are published at desired time.', 'progress-planner' );
+	}
+
+	/**
+	 * Check if the task should be added.
+	 *
+	 * @return bool
+	 */
+	public function should_add_task() {
+		$timezone_activity = \progress_planner()->get_activities__query()->query_activities(
+			[
+				'category' => 'suggested_task',
+				'data_id'  => static::PROVIDER_ID,
+			]
+		);
+
+		return ! $timezone_activity;
+	}
+
+	/**
+	 * Get the popover instructions.
+	 *
+	 * @return void
+	 */
+	public function print_popover_instructions() {
+		?>
+		<p><?php \esc_html_e( 'Set site timezone to ensure scheduled posts and pages are published at desired time.', 'progress-planner' ); ?></p>
+		<?php
+	}
+
+	/**
+	 * Print the popover input field for the form.
+	 *
+	 * @return void
+	 */
+	public function print_popover_form_contents() {
+		$current_offset = \get_option( 'gmt_offset' );
+		$tzstring       = \get_option( 'timezone_string' );
+
+		// Remove old Etc mappings. Fallback to gmt_offset.
+		if ( str_contains( $tzstring, 'Etc/GMT' ) ) {
+			$tzstring = '';
+		}
+
+		if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists.
+			if ( 0 === (int) $current_offset ) {
+				$tzstring = 'UTC+0';
+			} elseif ( $current_offset < 0 ) {
+				$tzstring = 'UTC' . $current_offset;
+			} else {
+				$tzstring = 'UTC+' . $current_offset;
+			}
+		}
+		?>
+		<label>
+			<select id="timezone" name="timezone">
+				<?php echo \wp_timezone_choice( $tzstring, \get_user_locale() ); ?>
+			</select>
+		</label>
+		<button type="submit" class="prpl-button prpl-button-primary" style="color: #fff;">
+			<?php \esc_html_e( 'Set site timezone', 'progress-planner' ); ?>
+		</button>
+		<?php
+	}
+}