# force-refresh/2.10.1/includes/api/classes/class-api-handler-admin-schedule-refresh-site.php

Force Refresh, version 2.10.1. 185 lines.

- Page: https://pluginprobe.com/plugins/force-refresh/2.10.1/code/includes/api/classes/class-api-handler-admin-schedule-refresh-site.php
- Raw: https://pluginprobe.com/plugins/force-refresh/2.10.1/raw/includes/api/classes/class-api-handler-admin-schedule-refresh-site.php
- Modified: 2023-11-10T20:59:12+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/force-refresh/2.10.1/code/includes/api/classes/class-api-handler-admin-schedule-refresh-site.php#L10-L20`.

```php
<?php
/**
 * Our API calls responsible for handling requests from admins requesting a scheduled refresh.
 *
 * @package ForceRefresh
 */

namespace JordanLeven\Plugins\ForceRefresh\Api;

use JordanLeven\Plugins\ForceRefresh\Api\Api_Handler_Admin;
use JordanLeven\Plugins\ForceRefresh\Api\Interfaces\Api_Handler_Admin_Interface;
use JordanLeven\Plugins\ForceRefresh\Services\Versions_Storage_Service;

/**
 * Main class controller.
 */
class Api_Handler_Admin_Schedule_Refresh_Site extends Api_Handler_Admin implements Api_Handler_Admin_Interface {

    /**
     * The path for this endpoint.
     *
     * @var string
     */
    const ENDPOINT_PATH = '/schedule-site-version';

    /**
     * The version for this endpoint.
     *
     * @var int
     */
    const ENDPOINT_VERSION = 1;

    const ACTION_NAME_SCHEDULE_REFRESH_SITE = 'force_refresh_scheduled_site_refresh';

    /**
     * Method for registering the endpoints for this class.
     *
     * @return void
     */
    public function register_routes(): void {
        self::register_rest_endpoint(
            self::ENDPOINT_PATH,
            self::ENDPOINT_VERSION,
            array(
                'methods'             => \WP_REST_Server::EDITABLE,
                'callback'            => array( $this, 'schedule_refresh_site' ),
                'permission_callback' => array( $this, 'user_is_able_to_admin_force_refresh' ),
            ),
        );

        self::register_rest_endpoint(
            self::ENDPOINT_PATH,
            self::ENDPOINT_VERSION,
            array(
                'methods'             => \WP_REST_Server::ALLMETHODS,
                'callback'            => array( $this, 'delete_schedule_refresh_site' ),
                'permission_callback' => array( $this, 'user_is_able_to_admin_force_refresh' ),
            ),
        );
    }

    /**
     * Method for registering all of our actions.
     *
     * @return  void
     */
    public function register_actions(): void {
        add_action( self::ACTION_NAME_SCHEDULE_REFRESH_SITE, array( $this, 'executeSiteRefresh' ) );
    }

    /**
     * Method for executing a scheduled site refresh.
     *
     * @param string $time The scheduled time.
     *
     * @return  void
     */
    public function executeSiteRefresh( $time ): void {
        $site_version = Versions_Storage_Service::get_new_version();
        Versions_Storage_Service::set_site_version( $site_version );
    }

    /**
     * Method to get all scheduled refreshes from a cron event.
     *
     * @param array $cron_event The cron event.
     *
     * @return array The scheduled refreshes
     */
    public static function get_scheduled_refreshes_from_cron_event( array $cron_event ) {
        $scheduled_refreshes = array();
        foreach ( $cron_event as $event_name => $event_data ) {
            if ( self::ACTION_NAME_SCHEDULE_REFRESH_SITE === $event_name ) {
                array_push(
                    $scheduled_refreshes,
                    array(
                        'timestamp' => $timestamp,
                    )
                );
            }
        }

        return $scheduled_refreshes;
    }

    /**
     * Method for getting all scheduled refresh.
     *
     * @return mixed The scheduled events.
     */
    public static function get_scheduled_refreshes() {
        $scheduled_refreshes = array();
        $cron                = get_option( 'cron' );

        if ( ! is_array( $cron ) ) {
            return $scheduled_refreshes;
        }

        foreach ( $cron as $timestamp => $cron_event ) {
            if ( ! is_array( $cron_event ) ) {
                continue;
            }

            $scheduled_refreshes = array_merge(
                $scheduled_refreshes,
                self::get_scheduled_refreshes_from_cron_event( $cron_event ),
            );
        }

        return $scheduled_refreshes;
    }

    /**
     * Method for deleting a scheduled refresh.
     *
     * @param \WP_REST_Request $request The request object.
     *
     * @return void
     */
    public function delete_schedule_refresh_site( \WP_REST_Request $request ): void {
        $scheduled_refresh = (int) $request->get_param( 'schedule_refresh_timestamp' ) ?? null;

        wp_clear_scheduled_hook( self::ACTION_NAME_SCHEDULE_REFRESH_SITE, array( $scheduled_refresh ) );

        $this->return_api_response(
            202,
            'You\'ve successfully deleted a site refresh.',
            array(
                'scheduled_refresh_time' => $scheduled_refresh,
            )
        );
    }

    /**
     * Method for refreshing the site version.
     *
     * @param \WP_REST_Request $request The request object.
     *
     * @return void
     */
    public function schedule_refresh_site( \WP_REST_Request $request ): void {
        $scheduled_refresh      = $request->get_param( 'schedule_refresh_timestamp' ) ?? null;
        $scheduled_refresh_time = strtotime( $scheduled_refresh );

        wp_schedule_single_event( $scheduled_refresh_time, self::ACTION_NAME_SCHEDULE_REFRESH_SITE, array( $scheduled_refresh_time ) );

        $this->return_api_response(
            201,
            'You\'ve successfully scheduled a site refresh.',
            array(
                'scheduled_refresh_time' => $scheduled_refresh_time,
            )
        );
    }

    /**
     * Method for getting the endpoint for this service.
     *
     * @return  string  The service endpoint.
     */
    public static function get_rest_endpoint(): string {
        return self::get_formatted_rest_endpoint( self::ENDPOINT_PATH, self::ENDPOINT_VERSION );
    }
}

```