Tiny File Manager | setup-steps-tracking-route.php

Back Back Up Advanced Editor

<?php

// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
namespace Yoast\WP\SEO\Dashboard\User_Interface\Tracking;

use Exception;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
use Yoast\WP\SEO\Conditionals\No_Conditionals;
use Yoast\WP\SEO\Dashboard\Infrastructure\Tracking\Setup_Steps_Tracking_Repository_Interface;
use Yoast\WP\SEO\Helpers\Capability_Helper;
use Yoast\WP\SEO\Main;
use Yoast\WP\SEO\Routes\Route_Interface;

/**
 * Registers a route to keep track of the Site Kit usage.
 *
 * @makePublic
 *
 * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded
 */
class Setup_Steps_Tracking_Route implements Route_Interface {

use No_Conditionals;

/**
	 *  The namespace for this route.
	 *
	 * @var string
	 */
	public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;

/**
	 *  The prefix for this route.
	 *
	 * @var string
	 */
	public const ROUTE_PREFIX = '/setup_steps_tracking';

/**
	 * Holds the repository instance.
	 *
	 * @var Setup_Steps_Tracking_Repository_Interface
	 */
	private $setup_steps_tracking_repository;

/**
	 * Holds the capability helper instance.
	 *
	 * @var Capability_Helper
	 */
	private $capability_helper;

/**
	 * Constructs the class.
	 *
	 * @param Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository The repository.
	 * @param Capability_Helper                         $capability_helper               The capability helper.
	 */
	public function __construct(
		Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository,
		Capability_Helper $capability_helper
	) {
		$this->setup_steps_tracking_repository = $setup_steps_tracking_repository;
		$this->capability_helper               = $capability_helper;
	}

/**
	 * Registers routes with WordPress.
	 *
	 * @return void
	 */
	public function register_routes() {
		\register_rest_route(
			self::ROUTE_NAMESPACE,
			self::ROUTE_PREFIX,
			[
				[
					'methods'             => 'POST',
					'callback'            => [ $this, 'track_setup_steps' ],
					'permission_callback' => [ $this, 'check_capabilities' ],
					'args'                => [
						'setup_widget_loaded' => [
							'required'          => false,
							'type'              => 'string',
							'enum'              => [ 'yes', 'no' ],
						],
						'first_interaction_stage' => [
							'required'          => false,
							'type'              => 'string',
							'enum'              => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
						],
						'last_interaction_stage' => [
							'required'          => false,
							'type'              => 'string',
							'enum'              => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
						],
						'setup_widget_temporarily_dismissed' => [
							'required'          => false,
							'type'              => 'string',
							'enum'              => [ 'yes', 'no' ],
						],
						'setup_widget_permanently_dismissed' => [
							'required'          => false,
							'type'              => 'string',
							'enum'              => [ 'yes', 'no' ],
						],
					],
				],
			],
		);
	}

/**
	 * Stores tracking information.
	 *
	 * @param WP_REST_Request $request The request object.
	 *
	 * @return WP_REST_Response|WP_Error The success or failure response.
	 */
	public function track_setup_steps( WP_REST_Request $request ) {
			$data = [
				'setup_widget_loaded'                => $request->get_param( 'setupWidgetLoaded' ),
				'first_interaction_stage'            => $request->get_param( 'firstInteractionStage' ),
				'last_interaction_stage'             => $request->get_param( 'lastInteractionStage' ),
				'setup_widget_temporarily_dismissed' => $request->get_param( 'setupWidgetTemporarilyDismissed' ),
				'setup_widget_permanently_dismissed' => $request->get_param( 'setupWidgetPermanentlyDismissed' ),
			];

// Filter out null values from the data array.
			$data = \array_filter(
				$data,
				static function ( $value ) {
					return $value !== null;
				},
			);

// Check if all values are null then return an error that no valid params were passed.
		if ( empty( $data ) ) {
			return new WP_Error(
				'wpseo_set_site_kit_usage_tracking',
				\__( 'No valid parameters were passed.', 'wordpress-seo' ),
				[ 'status' => 400 ],
			);
		}

$result = true;
		foreach ( $data as $key => $value ) {
			try {
				$result = $this->setup_steps_tracking_repository->set_setup_steps_tracking_element( $key, $value );
			} catch ( Exception $exception ) {
				return new WP_Error(
					'wpseo_set_site_kit_usage_tracking',
					$exception->getMessage(),
					(object) [],
				);
			}
			if ( ! $result ) {
				break;
			}
		}

return new WP_REST_Response(
			[
				'success' => $result,
			],
			( $result ) ? 200 : 400,
		);
	}

/**
	 * Checks if the current user has the required capabilities.
	 *
	 * @return bool
	 */
	public function check_capabilities() {
		return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
	}
}