Use a const for the POPOVER_ID in interactive tasks

Author: aristath

classes/suggested-tasks/providers/class-email-sending.php

@@ -40,6 +40,13 @@ class Email_Sending extends Tasks {
 	 */
 	const IS_INTERACTIVE = true;
 
+	/**
+	 * The popover ID.
+	 *
+	 * @var string
+	 */
+	const POPOVER_ID = 'sending-email';
+
 	/**
 	 * Whether the task is dismissable.
 	 *
@@ -54,13 +61,6 @@ class Email_Sending extends Tasks {
 	 */
 	protected $priority = 1;
 
-	/**
-	 * The popover ID.
-	 *
-	 * @var string
-	 */
-	protected $popover_id = 'sending-email';
-
 	/**
 	 * The email title.
 	 *
@@ -288,7 +288,7 @@ public function the_popover_content() {
 		\progress_planner()->the_view(
 			'popovers/email-sending.php',
 			[
-				'prpl_popover_id'                      => $this->popover_id,
+				'prpl_popover_id'                      => static::POPOVER_ID,
 				'prpl_provider_id'                     => $this->get_provider_id(),
 				'prpl_email_subject'                   => $this->email_subject,
 				'prpl_email_error'                     => $this->email_error,
@@ -306,7 +306,7 @@ public function the_popover_content() {
 	 * @return array
 	 */
 	protected function modify_injection_task_data( $task_data ) {
-		$task_data['popover_id'] = 'prpl-popover-' . $this->popover_id;
+		$task_data['popover_id'] = 'prpl-popover-' . static::POPOVER_ID;
 
 		return $task_data;
 	}

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

@@ -56,6 +56,13 @@ abstract class Tasks implements Tasks_Interface {
 	 */
 	const IS_INTERACTIVE = false;
 
+	/**
+	 * The popover ID for interactive tasks.
+	 *
+	 * @var string
+	 */
+	const POPOVER_ID = '';
+
 	/**
 	 * Whether the task is repetitive.
 	 *
@@ -126,13 +133,6 @@ abstract class Tasks implements Tasks_Interface {
 	 */
 	protected $data_collector = null;
 
-	/**
-	 * The popover ID for interactive tasks.
-	 *
-	 * @var string
-	 */
-	protected $popover_id = '';
-
 	/**
 	 * Constructor.
 	 *
@@ -581,7 +581,7 @@ protected function transform_collector_data( array $data ): array {
 	 */
 	public function add_popover() {
 		?>
-		<div id="prpl-popover-<?php echo \esc_attr( $this->popover_id ); ?>" class="prpl-popover prpl-popover-interactive" popover>
+		<div id="prpl-popover-<?php echo \esc_attr( static::POPOVER_ID ); ?>" class="prpl-popover prpl-popover-interactive" popover>
 			<?php $this->the_popover_content(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
 		</div>
 		<?php
@@ -594,9 +594,9 @@ public function add_popover() {
 	 */
 	public function the_popover_content() {
 		\progress_planner()->the_view(
-			"popovers/{$this->popover_id}.php",
+			'popovers/' . static::POPOVER_ID . '.php',
 			[
-				'prpl_popover_id'  => $this->popover_id,
+				'prpl_popover_id'  => static::POPOVER_ID,
 				'prpl_provider_id' => $this->get_provider_id(),
 			]
 		);