<?php
/**
* The REST API handler for the Onboarding Wizard.
* Cleverly named...API.
*
* @since 6.8.4
*
* @package TEC\Events\Admin\Onboarding
*/
namespace TEC\Events\Admin\Onboarding;
use WP_REST_Request as Request;
use WP_REST_Server as Server;
use WP_Error;
use WP_REST_Response;
use TEC\Events\Admin\Onboarding\Data;
/**
* Class API
*
* @since 6.8.4
*
* @package TEC\Events\Admin\Onboarding
*/
class API {
/**
* The action for this nonce.
*
* @since 6.8.4
*
* @var string
*/
public const NONCE_ACTION = '_tec_wizard';
/**
* Rest Endpoint namespace
*
* @since 6.8.4
*
* @var string
*/
protected const ROOT_NAMESPACE = 'tec/v2/onboarding';
/**
* Register the endpoint.
*
* @since 6.8.4
*
* @return bool If we registered the endpoint.
*/
public function register(): bool {
return register_rest_route(
self::ROOT_NAMESPACE,
'/wizard',
[
'methods' => [ Server::CREATABLE ],
'callback' => [ $this, 'handle' ],
'permission_callback' => [ $this, 'check_permissions' ],
'args' => [
'action_nonce' => [
'type' => 'string',
'description' => __( 'The action nonce for the request.', 'the-events-calendar' ),
'required' => true,
'validate_callback' => [ $this, 'check_nonce' ],
],
],
]
);
}
/**
* Check the nonce.
*
* @since 6.8.4
*
* @param string $nonce The nonce.
*
* @return bool|WP_Error True if the nonce is valid, WP_Error if not.
*/
public function check_nonce( $nonce ) {
$verified = wp_verify_nonce( $nonce, self::NONCE_ACTION );
if ( $verified ) {
return true;
}
return new WP_Error(
'tec_invalid_nonce',
__( 'Invalid nonce.', 'the-events-calendar' ),
[ 'status' => 403 ]
);
}
/**
* Check the permissions.
*
* @since 6.8.4
*
* @return bool If the user has the correct permissions.
*/
public function check_permissions(): bool {
$required_permission = 'manage_options';
/**
* Filter the required permission for the onboarding wizard.
*
* @since 6.8.4
*
* @param string $required_permission The required permission.
* @param API $api The api object.
*
* @return string The required permission.
*/
$required_permission = (string) apply_filters( 'tec_events_onboarding_wizard_permissions', $required_permission, $this );
return current_user_can( $required_permission );
}
/**
* Handle the request.
*
* @since 6.8.4
*
* @param Request $request The request object.
*
* @return WP_REST_Response The response.
*/
public function handle( Request $request ): WP_REST_Response {
/**
* Each step hooks in here and potentially modifies the response.
*
* @since 6.8.4
*
* @param WP_REST_Response $response The response object.
* @param Request $request The request object.
*/
return apply_filters( 'tec_events_onboarding_wizard_handle', $this->set_tab_records( $request ), $request );
}
/**
* Passes the request and data to the handler.
*
* @since 6.8.4
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The response.
*/
protected function set_tab_records( $request ): WP_REST_Response {
$params = $request->get_params();
$begun = $params['begun'] ?? false;
$finished = $params['finished'] ?? false;
$skipped = $params['skippedTabs'] ?? [];
$complete = $params['completedTabs'] ?? [];
$current = $params['currentTab'] ?? 0;
// Remove any elements in $completed from $skipped.
$skipped = array_values( array_diff( $skipped, $complete ) );
if ( $begun ) {
$complete = array_merge( $complete, [ 0 ] );
}
// Add current tab to completed if it's not in skipped.
if ( ! in_array( $current, $skipped, true ) ) {
$complete = array_merge( $complete, [ $current ] );
}
if ( $finished ) {
$begun = true;
}
// Set up our data for a single save.
$settings = tribe( Data::class )->get_wizard_settings();
$settings['begun'] = $begun;
$settings['finished'] = $finished;
$settings['current_tab'] = $current;
$settings['completed_tabs'] = $this->normalize_tabs( $complete );
$settings['skipped_tabs'] = $this->normalize_tabs( $skipped );
// Stuff we don't want/need to store in the settings.
unset(
$params['timezones'],
$params['countries'],
$params['currencies'],
$params['action_nonce'],
$params['_wpnonce']
);
// Merge the new params with existing last_send data instead of overwriting.
$settings['last_send'] = array_merge( $settings['last_send'] ?? [], $params );
// Update the option.
$updated = tribe( Data::class )->update_wizard_settings( $settings );
// We want to record the issue but we *don't* want to send back a failure since this part is not required for the user.
return new WP_REST_Response(
[
'success' => true,
'message' => $updated ? [ __( 'Onboarding wizard step completed successfully.', 'the-events-calendar' ) ] : [ __( 'Failed to update wizard settings.', 'the-events-calendar' ) ],
],
200
);
}
/**
* Normalize the tabs. Remove duplicates
*
* @since 6.9.0
*
* @param array<int> $tabs An array of tab indexes (int).
*
* @return array
*/
protected function normalize_tabs( $tabs ): array {
// Filter out duplicates.
$tabs = array_unique( (array) $tabs, SORT_NUMERIC );
// Reindex the array.
return array_values( $tabs );
}
}