Merge pull request #607 from ProgressPlanner/convert-meta/prpl_popover_id

Stop saving `prpl_popover_id` as a post-meta

Author: aristath

classes/admin/widgets/class-todo.php

@@ -86,13 +86,13 @@ public function the_todo_list() {
 				<button id="todo-list-completed-delete-all-cancel" onclick="prplTodoWidget.closeDeleteAllPopover()">
 					<?php
 					/* translators: %1$s is the strong tag, %2$s is the closing strong tag. */
-					printf( \esc_html__( '%1$sNo%2$s, keep this list', 'progress-planner' ), '<strong>', '</strong>' );
+					\printf( \esc_html__( '%1$sNo%2$s, keep this list', 'progress-planner' ), '<strong>', '</strong>' );
 					?>
 				</button>
 				<button id="todo-list-completed-delete-all-confirm" onclick="prplTodoWidget.deleteAllCompletedTasksAndClosePopover()">
 					<?php
 					/* translators: %1$s is the strong tag, %2$s is the closing strong tag. */
-					printf( \esc_html__( '%1$sYes%2$s, delete all completed tasks', 'progress-planner' ), '<strong>', '</strong>' );
+					\printf( \esc_html__( '%1$sYes%2$s, delete all completed tasks', 'progress-planner' ), '<strong>', '</strong>' );
 					?>
 				</button>
 			</div>

classes/class-suggested-tasks-db.php

@@ -175,7 +175,6 @@ public function update_recommendation( $id, $data ) {
 			switch ( $key ) {
 				case 'points':
 				case 'prpl_points':
-				case 'prpl_popover_id':
 				case 'prpl_external_link_url':
 					$update_meta[ 'prpl_' . \str_replace( 'prpl_', '', (string) $key ) ] = $value;
 					break;

classes/class-suggested-tasks.php

@@ -314,11 +314,6 @@ public function register_post_type() {
 				'show_in_rest' => true,
 				'default'      => 0,
 			],
-			'prpl_popover_id'        => [
-				'type'         => 'string',
-				'single'       => true,
-				'show_in_rest' => true,
-			],
 			'prpl_external_link_url' => [
 				'type'         => 'string',
 				'single'       => true,
@@ -450,6 +445,9 @@ public function rest_prepare_recommendation( $response, $post ) {
 				? \esc_url( (string) $response->data['meta']['prpl_url'] )
 				: '';
 
+			$response->data['prpl_popover_id'] = $provider->get_popover_id();
+
+			// This has to be the last item to be added because actions use data from previous items.
 			$response->data['prpl_task_actions'] = $provider->get_task_actions( $response->data );
 		}
 

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

@@ -104,6 +104,13 @@ public function is_repetitive();
 	 */
 	public function get_task_actions( $data = [] );
 
+	/**
+	 * Get the popover ID.
+	 *
+	 * @return string
+	 */
+	public function get_popover_id();
+
 	/**
 	 * Add task actions specific to this task.
 	 *

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

@@ -134,7 +134,7 @@ class="regular-text"
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Set tagline', '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 tagline', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;

classes/suggested-tasks/providers/class-disable-comment-pagination.php

@@ -131,7 +131,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Disable pagination', '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__( 'Disable pagination', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;

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

@@ -162,7 +162,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Disable comments', '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__( 'Disable comments', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;

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

@@ -321,7 +321,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Test email sending', '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__( 'Test email sending', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;

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

@@ -164,7 +164,7 @@ protected function get_enqueue_data() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Delete', '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__( 'Delete', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;

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

@@ -163,7 +163,7 @@ protected function get_enqueue_data() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Delete', '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__( 'Delete', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;