insideout10 / wordlift-plugin

src/modules/food-kg/load.php

Indentation +81 added lines, -81 removed lines

@@ -19,7 +19,7 @@ 
 use Wordlift\Task\Single_Call_Task;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 define( 'WL_FOOD_KG_FILE', __FILE__ );
@@ -27,86 +27,86 @@ 
 
 function __wl_foodkg__load() {
 
-	// Autoloader for plugin itself.
-	if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
-		require __DIR__ . '/vendor/autoload.php';
-	}
-
-	$container_builder = new ContainerBuilder();
-	$loader            = new YamlFileLoader( $container_builder, new FileLocator( __DIR__ ) );
-	$loader->load( 'services.yml' );
-	$container_builder->compile();
-
-	$notices = $container_builder->get( 'Wordlift\Modules\Food_Kg\Notices' );
-	$notices->register_hooks();
-
-	/**
-	 * @var Preconditions $preconditions
-	 */
-	$preconditions = $container_builder->get( 'Wordlift\Modules\Food_Kg\Preconditions' );
-	if ( ! $preconditions->pass() ) {
-		return;
-	}
-
-	// Meta Box.
-	$meta_box = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Meta_Box' );
-	$meta_box->register_hooks();
-
-	$module = $container_builder->get( 'Wordlift\Modules\Food_Kg\Module' );
-	$module->register_hooks();
-
-	/** @var Jsonld $jsonld */
-	$jsonld = $container_builder->get( 'Wordlift\Modules\Food_Kg\Jsonld' );
-	$jsonld->register_hooks();
-
-	/**
-	 * Ingredients API.
-	 */
-	$ingredients_api = $container_builder->get( 'Wordlift\Modules\Food_Kg\Ingredients_API' );
-	$ingredients_api->register_hooks();
-
-	/** @var Main_Ingredient_Jsonld $jsonld */
-	$main_ingredient_jsonld = $container_builder->get( 'Wordlift\Modules\Food_Kg\Main_Ingredient_Jsonld' );
-	$main_ingredient_jsonld->register_hooks();
-
-	// Main Ingredient Background Task.
-	$main_ingredient_recipe_lift = $container_builder->get( 'Wordlift\Modules\Food_Kg\Main_Ingredient_Recipe_Lift_Strategy' );
-	Background_Task_Factory::create_action_scheduler_task(
-		'wl_main_ingredient_sync',
-		'wordlift',
-		new All_Posts_Task(
-			array( $main_ingredient_recipe_lift, 'process' ),
-			'wprm_recipe',
-			'sync-main-ingredient'
-		),
-		'/main-ingredient',
-		'sync-main-ingredient',
-		__( 'Synchronize Main Ingredient', 'wordlift' )
-	);
-
-	// Ingredients Taxonomy Background Task.
-	$ingredients_taxonomy_recipe_lift = $container_builder->get( 'Wordlift\Modules\Food_Kg\Ingredients_Taxonomy_Recipe_Lift_Strategy' );
-	Background_Task_Factory::create(
-		new Single_Call_Task(
-			array( $ingredients_taxonomy_recipe_lift, 'run' ),
-			'sync-ingredients-taxonomy'
-		),
-		'/sync-ingredients-taxonomy',
-		'sync-ingredients-taxonomy',
-		__( 'Synchronize Ingredients Taxonomy', 'wordlift' )
-	);
-
-	if ( is_admin() ) {
-		$page = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Page' );
-		$page->register_hooks();
-
-		$page = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Ingredients_Taxonomy_Page' );
-		$page->register_hooks();
-
-		// Download Ingredients Data.
-		$download_ingredients_data = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Download_Ingredients_Data' );
-		$download_ingredients_data->register_hooks();
-	}
+    // Autoloader for plugin itself.
+    if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
+        require __DIR__ . '/vendor/autoload.php';
+    }
+
+    $container_builder = new ContainerBuilder();
+    $loader            = new YamlFileLoader( $container_builder, new FileLocator( __DIR__ ) );
+    $loader->load( 'services.yml' );
+    $container_builder->compile();
+
+    $notices = $container_builder->get( 'Wordlift\Modules\Food_Kg\Notices' );
+    $notices->register_hooks();
+
+    /**
+     * @var Preconditions $preconditions
+     */
+    $preconditions = $container_builder->get( 'Wordlift\Modules\Food_Kg\Preconditions' );
+    if ( ! $preconditions->pass() ) {
+        return;
+    }
+
+    // Meta Box.
+    $meta_box = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Meta_Box' );
+    $meta_box->register_hooks();
+
+    $module = $container_builder->get( 'Wordlift\Modules\Food_Kg\Module' );
+    $module->register_hooks();
+
+    /** @var Jsonld $jsonld */
+    $jsonld = $container_builder->get( 'Wordlift\Modules\Food_Kg\Jsonld' );
+    $jsonld->register_hooks();
+
+    /**
+     * Ingredients API.
+     */
+    $ingredients_api = $container_builder->get( 'Wordlift\Modules\Food_Kg\Ingredients_API' );
+    $ingredients_api->register_hooks();
+
+    /** @var Main_Ingredient_Jsonld $jsonld */
+    $main_ingredient_jsonld = $container_builder->get( 'Wordlift\Modules\Food_Kg\Main_Ingredient_Jsonld' );
+    $main_ingredient_jsonld->register_hooks();
+
+    // Main Ingredient Background Task.
+    $main_ingredient_recipe_lift = $container_builder->get( 'Wordlift\Modules\Food_Kg\Main_Ingredient_Recipe_Lift_Strategy' );
+    Background_Task_Factory::create_action_scheduler_task(
+        'wl_main_ingredient_sync',
+        'wordlift',
+        new All_Posts_Task(
+            array( $main_ingredient_recipe_lift, 'process' ),
+            'wprm_recipe',
+            'sync-main-ingredient'
+        ),
+        '/main-ingredient',
+        'sync-main-ingredient',
+        __( 'Synchronize Main Ingredient', 'wordlift' )
+    );
+
+    // Ingredients Taxonomy Background Task.
+    $ingredients_taxonomy_recipe_lift = $container_builder->get( 'Wordlift\Modules\Food_Kg\Ingredients_Taxonomy_Recipe_Lift_Strategy' );
+    Background_Task_Factory::create(
+        new Single_Call_Task(
+            array( $ingredients_taxonomy_recipe_lift, 'run' ),
+            'sync-ingredients-taxonomy'
+        ),
+        '/sync-ingredients-taxonomy',
+        'sync-ingredients-taxonomy',
+        __( 'Synchronize Ingredients Taxonomy', 'wordlift' )
+    );
+
+    if ( is_admin() ) {
+        $page = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Page' );
+        $page->register_hooks();
+
+        $page = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Ingredients_Taxonomy_Page' );
+        $page->register_hooks();
+
+        // Download Ingredients Data.
+        $download_ingredients_data = $container_builder->get( 'Wordlift\Modules\Food_Kg\Admin\Download_Ingredients_Data' );
+        $download_ingredients_data->register_hooks();
+    }
 }
 
 add_action( 'plugins_loaded', '__wl_foodkg__load' );

src/wordlift/task/action-scheduler/class-context.php

Indentation +117 added lines, -117 removed lines

@@ -4,122 +4,122 @@
 
 class Context {
 
-	private $count;
-	private $offset;
-	private $started;
-	private $updated;
-
-	/**
-	 * @param $count
-	 * @param $offset
-	 * @param $started
-	 * @param $updated
-	 */
-	public function __construct( $count, $offset, $started, $updated ) {
-		$this->count   = $count;
-		$this->offset  = $offset;
-		$this->started = $started;
-		$this->updated = $updated;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function get_count() {
-		return $this->count;
-	}
-
-	/**
-	 * @param int $count
-	 *
-	 * @return Context
-	 */
-	public function set_count( $count ) {
-		$this->count = $count;
-
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function get_offset() {
-		return $this->offset;
-	}
-
-	/**
-	 * @param int $offset
-	 *
-	 * @return Context
-	 */
-	public function set_offset( $offset ) {
-		$this->offset = $offset;
-
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function get_started() {
-		return $this->started;
-	}
-
-	/**
-	 * @param int $started
-	 *
-	 * @return Context
-	 */
-	public function set_started( $started ) {
-		$this->started = $started;
-
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function get_updated() {
-		return $this->updated;
-	}
-
-	/**
-	 * @param int $updated
-	 *
-	 * @return Context
-	 */
-	public function set_updated( $updated ) {
-		$this->updated = $updated;
-
-		return $this;
-	}
-
-	public function get_data() {
-		return array(
-			'count'   => $this->count,
-			'updated' => $this->updated,
-			'started' => $this->started,
-			'offset'  => $this->offset,
-			'index'   => $this->offset,
-		);
-	}
-
-	/**
-	 * @param $count int
-	 *
-	 * @return Context
-	 */
-	public static function from( $count ) {
-		return new self( $count, 0, time(), time() );
-	}
-
-	/**
-	 * @param $data array
-	 *
-	 * @return Context
-	 */
-	public static function from_data( $data ) {
-		return new self( $data['count'], $data['offset'], $data['started'], $data['updated'] );
-	}
+    private $count;
+    private $offset;
+    private $started;
+    private $updated;
+
+    /**
+     * @param $count
+     * @param $offset
+     * @param $started
+     * @param $updated
+     */
+    public function __construct( $count, $offset, $started, $updated ) {
+        $this->count   = $count;
+        $this->offset  = $offset;
+        $this->started = $started;
+        $this->updated = $updated;
+    }
+
+    /**
+     * @return int
+     */
+    public function get_count() {
+        return $this->count;
+    }
+
+    /**
+     * @param int $count
+     *
+     * @return Context
+     */
+    public function set_count( $count ) {
+        $this->count = $count;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function get_offset() {
+        return $this->offset;
+    }
+
+    /**
+     * @param int $offset
+     *
+     * @return Context
+     */
+    public function set_offset( $offset ) {
+        $this->offset = $offset;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function get_started() {
+        return $this->started;
+    }
+
+    /**
+     * @param int $started
+     *
+     * @return Context
+     */
+    public function set_started( $started ) {
+        $this->started = $started;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function get_updated() {
+        return $this->updated;
+    }
+
+    /**
+     * @param int $updated
+     *
+     * @return Context
+     */
+    public function set_updated( $updated ) {
+        $this->updated = $updated;
+
+        return $this;
+    }
+
+    public function get_data() {
+        return array(
+            'count'   => $this->count,
+            'updated' => $this->updated,
+            'started' => $this->started,
+            'offset'  => $this->offset,
+            'index'   => $this->offset,
+        );
+    }
+
+    /**
+     * @param $count int
+     *
+     * @return Context
+     */
+    public static function from( $count ) {
+        return new self( $count, 0, time(), time() );
+    }
+
+    /**
+     * @param $data array
+     *
+     * @return Context
+     */
+    public static function from_data( $data ) {
+        return new self( $data['count'], $data['offset'], $data['started'], $data['updated'] );
+    }
 
 }

src/wordlift/task/background/class-background-task-route.php

Indentation +90 added lines, -90 removed lines

@@ -8,95 +8,95 @@
 
 class Background_Task_Route {
 
-	const VERSION_STRING = 'wordlift/v1';
-
-	/**
-	 * @var Background_Route_Task
-	 */
-	private $background_task;
-
-	/**
-	 * @var string
-	 */
-	private $route_name;
-
-	public function __construct( $background_task, $route_name ) {
-		$this->background_task = $background_task;
-		$this->route_name      = $route_name;
-	}
-
-	public static function create( $task, $route_name ) {
-		$route = new self( $task, $route_name );
-
-		add_action( 'rest_api_init', array( $route, 'register' ) );
-
-		return $route;
-	}
-
-	/**
-	 * @throws Exception if the input value is invalid.
-	 */
-	public function register() {
-		Assertions::starts_with( $this->route_name, '/', 'The route name must start with a slash.' );
-
-		register_rest_route(
-			self::VERSION_STRING,
-			$this->route_name,
-			array(
-				'methods'             => WP_REST_Server::CREATABLE,
-				'callback'            => function () {
-					return $this->background_task->start();
-				},
-				'permission_callback' => array( $this, 'permission_callback' ),
-			)
-		);
-
-		register_rest_route(
-			self::VERSION_STRING,
-			$this->route_name,
-			array(
-				'methods'             => WP_REST_Server::READABLE,
-				'callback'            => function () {
-					return $this->background_task->get_info();
-				},
-				'permission_callback' => array( $this, 'permission_callback' ),
-			)
-		);
-
-		register_rest_route(
-			self::VERSION_STRING,
-			$this->route_name,
-			array(
-				'methods'             => WP_REST_Server::DELETABLE,
-				'callback'            => function () {
-					return $this->background_task->stop();
-				},
-				'permission_callback' => array( $this, 'permission_callback' ),
-			)
-		);
-
-		register_rest_route(
-			self::VERSION_STRING,
-			$this->route_name,
-			array(
-				'methods'             => 'PUT',
-				'callback'            => function () {
-					return $this->background_task->resume();
-				},
-				'permission_callback' => array( $this, 'permission_callback' ),
-			)
-		);
-
-	}
-
-	public function permission_callback() {
-		$user = wp_get_current_user();
-
-		return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles, true );
-	}
-
-	public function get_rest_path() {
-		return self::VERSION_STRING . $this->route_name;
-	}
+    const VERSION_STRING = 'wordlift/v1';
+
+    /**
+     * @var Background_Route_Task
+     */
+    private $background_task;
+
+    /**
+     * @var string
+     */
+    private $route_name;
+
+    public function __construct( $background_task, $route_name ) {
+        $this->background_task = $background_task;
+        $this->route_name      = $route_name;
+    }
+
+    public static function create( $task, $route_name ) {
+        $route = new self( $task, $route_name );
+
+        add_action( 'rest_api_init', array( $route, 'register' ) );
+
+        return $route;
+    }
+
+    /**
+     * @throws Exception if the input value is invalid.
+     */
+    public function register() {
+        Assertions::starts_with( $this->route_name, '/', 'The route name must start with a slash.' );
+
+        register_rest_route(
+            self::VERSION_STRING,
+            $this->route_name,
+            array(
+                'methods'             => WP_REST_Server::CREATABLE,
+                'callback'            => function () {
+                    return $this->background_task->start();
+                },
+                'permission_callback' => array( $this, 'permission_callback' ),
+            )
+        );
+
+        register_rest_route(
+            self::VERSION_STRING,
+            $this->route_name,
+            array(
+                'methods'             => WP_REST_Server::READABLE,
+                'callback'            => function () {
+                    return $this->background_task->get_info();
+                },
+                'permission_callback' => array( $this, 'permission_callback' ),
+            )
+        );
+
+        register_rest_route(
+            self::VERSION_STRING,
+            $this->route_name,
+            array(
+                'methods'             => WP_REST_Server::DELETABLE,
+                'callback'            => function () {
+                    return $this->background_task->stop();
+                },
+                'permission_callback' => array( $this, 'permission_callback' ),
+            )
+        );
+
+        register_rest_route(
+            self::VERSION_STRING,
+            $this->route_name,
+            array(
+                'methods'             => 'PUT',
+                'callback'            => function () {
+                    return $this->background_task->resume();
+                },
+                'permission_callback' => array( $this, 'permission_callback' ),
+            )
+        );
+
+    }
+
+    public function permission_callback() {
+        $user = wp_get_current_user();
+
+        return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles, true );
+    }
+
+    public function get_rest_path() {
+        return self::VERSION_STRING . $this->route_name;
+    }
 
 }

src/wordlift/task/background/class-background-task.php

Indentation +114 added lines, -114 removed lines

@@ -7,119 +7,119 @@
 
 class Background_Task extends Wordlift_Plugin_WP_Background_Process implements Background_Route_Task {
 
-	const STATE_STARTED = 'started';
-	const STATE_STOPPED = 'stopped';
-
-	/**
-	 * The current state of the task, started or stopped.
-	 *
-	 * @var Background_Task_State $state
-	 */
-	private $state;
-
-	/**
-	 * The actual task.
-	 *
-	 * @var Task $task
-	 */
-	private $task;
-
-	/**
-	 * The prefix to store the state and other information in WP's options table, determined at instantiation.
-	 *
-	 * @var string $option_prefix
-	 */
-	private $option_prefix;
-
-	/**
-	 * @param Task $task
-	 */
-	public function __construct( $task ) {
-		$this->action        = $task->get_id();
-		$this->option_prefix = "_{$this->action}_";
-
-		parent::__construct();
-
-		// Set the current state.
-		if ( self::STATE_STARTED === $this->get_state() ) {
-			$this->state = new Background_Task_Started_State( $this, $task );
-		} else {
-			$this->state = new Background_Task_Stopped_State( $this );
-		}
-
-		$this->task = $task;
-	}
-
-	public static function create( $task ) {
-		return new self( $task );
-	}
-
-	public function get_option_prefix() {
-		return $this->option_prefix;
-	}
-
-	/**
-	 * This function is called:
-	 *  - To start a new Synchronization, by passing a {@link Sync_Start_Message} instance.
-	 *  - To synchronize a post, by passing a numeric ID.
-	 *
-	 * This function returns the parameter for the next call or NULL if there are no more posts to process.
-	 *
-	 * @param mixed $item Queue item to iterate over.
-	 *
-	 * @return int[]|false The next post IDs or false if there are no more.
-	 */
-	protected function task( $item ) {
-
-		return $this->state->task( $item );
-	}
-
-	/**
-	 * Transition to the started state.
-	 */
-	public function start() {
-		$this->state->leave();
-		$this->state = new Background_Task_Started_State( $this, $this->task );
-		$this->state->enter();
-	}
-
-	/**
-	 * Transition to the stopped state.
-	 */
-	public function stop() {
-		$this->state->leave();
-		$this->state = new Background_Task_Stopped_State( $this );
-		$this->state->enter();
-	}
-
-	public function resume() {
-		$this->state->resume();
-	}
-
-	/**
-	 * Get the current state.
-	 *
-	 * @return string Either self::STARTED_STATE or self::STOPPED_STATE (default).
-	 */
-	public function get_state() {
-		return get_option( $this->option_prefix . 'state', self::STATE_STOPPED );
-	}
-
-	/**
-	 * Persist the current state.
-	 *
-	 * @param string $value
-	 *
-	 * @return bool
-	 */
-	public function set_state( $value ) {
-		return null === $value
-			? delete_option( $this->option_prefix . 'state' )
-			: update_option( $this->option_prefix . 'state', $value, true );
-	}
-
-	public function get_info() {
-		return $this->state->get_info();
-	}
+    const STATE_STARTED = 'started';
+    const STATE_STOPPED = 'stopped';
+
+    /**
+     * The current state of the task, started or stopped.
+     *
+     * @var Background_Task_State $state
+     */
+    private $state;
+
+    /**
+     * The actual task.
+     *
+     * @var Task $task
+     */
+    private $task;
+
+    /**
+     * The prefix to store the state and other information in WP's options table, determined at instantiation.
+     *
+     * @var string $option_prefix
+     */
+    private $option_prefix;
+
+    /**
+     * @param Task $task
+     */
+    public function __construct( $task ) {
+        $this->action        = $task->get_id();
+        $this->option_prefix = "_{$this->action}_";
+
+        parent::__construct();
+
+        // Set the current state.
+        if ( self::STATE_STARTED === $this->get_state() ) {
+            $this->state = new Background_Task_Started_State( $this, $task );
+        } else {
+            $this->state = new Background_Task_Stopped_State( $this );
+        }
+
+        $this->task = $task;
+    }
+
+    public static function create( $task ) {
+        return new self( $task );
+    }
+
+    public function get_option_prefix() {
+        return $this->option_prefix;
+    }
+
+    /**
+     * This function is called:
+     *  - To start a new Synchronization, by passing a {@link Sync_Start_Message} instance.
+     *  - To synchronize a post, by passing a numeric ID.
+     *
+     * This function returns the parameter for the next call or NULL if there are no more posts to process.
+     *
+     * @param mixed $item Queue item to iterate over.
+     *
+     * @return int[]|false The next post IDs or false if there are no more.
+     */
+    protected function task( $item ) {
+
+        return $this->state->task( $item );
+    }
+
+    /**
+     * Transition to the started state.
+     */
+    public function start() {
+        $this->state->leave();
+        $this->state = new Background_Task_Started_State( $this, $this->task );
+        $this->state->enter();
+    }
+
+    /**
+     * Transition to the stopped state.
+     */
+    public function stop() {
+        $this->state->leave();
+        $this->state = new Background_Task_Stopped_State( $this );
+        $this->state->enter();
+    }
+
+    public function resume() {
+        $this->state->resume();
+    }
+
+    /**
+     * Get the current state.
+     *
+     * @return string Either self::STARTED_STATE or self::STOPPED_STATE (default).
+     */
+    public function get_state() {
+        return get_option( $this->option_prefix . 'state', self::STATE_STOPPED );
+    }
+
+    /**
+     * Persist the current state.
+     *
+     * @param string $value
+     *
+     * @return bool
+     */
+    public function set_state( $value ) {
+        return null === $value
+            ? delete_option( $this->option_prefix . 'state' )
+            : update_option( $this->option_prefix . 'state', $value, true );
+    }
+
+    public function get_info() {
+        return $this->state->get_info();
+    }
 
 }

src/wordlift/task/background/class-background-route-task.php

Indentation +10 added lines, -10 removed lines

@@ -3,18 +3,18 @@
 namespace Wordlift\Task\Background;
 
 interface Background_Route_Task {
-	/**
-	 * Transition to the started state.
-	 */
-	public function start();
+    /**
+     * Transition to the started state.
+     */
+    public function start();
 
-	/**
-	 * Transition to the stopped state.
-	 */
-	public function stop();
+    /**
+     * Transition to the stopped state.
+     */
+    public function stop();
 
-	public function resume();
+    public function resume();
 
-	public function get_info();
+    public function get_info();
 
 }

src/wordlift/task/background/class-background-task-factory.php

Indentation +51 added lines, -51 removed lines

@@ -14,58 +14,58 @@
  */
 class Background_Task_Factory {
 
-	/**
-	 * Create a {@link Background_Task} given the provided task and route.
-	 *
-	 * @param Task   $task The target task.
-	 * @param string $route The route name.
-	 * @param string $page_id The page id.
-	 * @param string $page_title The page title.
-	 *
-	 * @return void
-	 * @throws Exception in case of invalid arguments.
-	 */
-	public static function create( $task, $route, $page_id, $page_title ) {
-		self::assertions( $task, $route );
-		$background_task       = Background_Task::create( $task );
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
-	}
+    /**
+     * Create a {@link Background_Task} given the provided task and route.
+     *
+     * @param Task   $task The target task.
+     * @param string $route The route name.
+     * @param string $page_id The page id.
+     * @param string $page_title The page title.
+     *
+     * @return void
+     * @throws Exception in case of invalid arguments.
+     */
+    public static function create( $task, $route, $page_id, $page_title ) {
+        self::assertions( $task, $route );
+        $background_task       = Background_Task::create( $task );
+        $background_task_route = Background_Task_Route::create( $background_task, $route );
+        Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+    }
 
-	/**
-	 * Create a {@link Background_Task} given the provided task and route.
-	 *
-	 * @param Task   $task The target task.
-	 * @param string $route The route name.
-	 * @param string $page_id The page id.
-	 * @param string $page_title The page title.
-	 *
-	 * @return void
-	 * @throws Exception in case of invalid arguments.
-	 */
-	public static function create_action_scheduler_task( $hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5 ) {
-		self::assertions( $task, $route );
-		$background_task       = new \Wordlift\Task\Action_Scheduler\Background_Task(
-			$hook,
-			$group,
-			$task,
-			"_{$hook}_",
-			$batch_size
-		);
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
-	}
+    /**
+     * Create a {@link Background_Task} given the provided task and route.
+     *
+     * @param Task   $task The target task.
+     * @param string $route The route name.
+     * @param string $page_id The page id.
+     * @param string $page_title The page title.
+     *
+     * @return void
+     * @throws Exception in case of invalid arguments.
+     */
+    public static function create_action_scheduler_task( $hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5 ) {
+        self::assertions( $task, $route );
+        $background_task       = new \Wordlift\Task\Action_Scheduler\Background_Task(
+            $hook,
+            $group,
+            $task,
+            "_{$hook}_",
+            $batch_size
+        );
+        $background_task_route = Background_Task_Route::create( $background_task, $route );
+        Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+    }
 
-	/**
-	 * @param Task  $task
-	 * @param $route
-	 *
-	 * @return void
-	 * @throws Exception in case of invalid arguments.
-	 */
-	private static function assertions( Task $task, $route ) {
-		Assertions::is_a( $task, 'Wordlift\Task\Task' );
-		Assertions::starts_with( $route, '/', __( 'The route must start with a slash.', 'wordlift' ) );
-	}
+    /**
+     * @param Task  $task
+     * @param $route
+     *
+     * @return void
+     * @throws Exception in case of invalid arguments.
+     */
+    private static function assertions( Task $task, $route ) {
+        Assertions::is_a( $task, 'Wordlift\Task\Task' );
+        Assertions::starts_with( $route, '/', __( 'The route must start with a slash.', 'wordlift' ) );
+    }
 
 }

src/wordlift/task/action-scheduler/class-background-task.php

Indentation +97 added lines, -97 removed lines

@@ -8,101 +8,101 @@
 use Wordlift\Task\Task;
 
 class Background_Task extends Action_Scheduler_Background_Process implements Background_Route_Task {
-	/**
-	 * The option prefix to store state.
-	 *
-	 * @var string $option_prefix
-	 */
-	private $option_prefix;
-	/**
-	 * @var Task
-	 */
-	private $task;
-
-	const STATE_STARTED = 'started';
-	const STATE_STOPPED = 'stopped';
-	/**
-	 * @var int
-	 */
-	private $batch_size;
-
-	public function __construct( $hook, $group, $task, $option_prefix, $batch_size = 5 ) {
-		parent::__construct( $hook, $group );
-		$this->task          = $task;
-		$this->option_prefix = $option_prefix;
-		$this->batch_size    = $batch_size;
-	}
-
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function do_task( $args ) {
-		if ( self::STATE_STOPPED === $this->get_process_state() ) {
-			return State::complete();
-		}
-		$context = $this->get_context();
-		$this->task->tick( null, $context->get_data() + array( 'batch_size' => $this->batch_size ) );
-
-		if ( ( $context->get_count() - $context->get_offset() ) >= 0 ) {
-			$context->set_offset( $context->get_offset() + $this->batch_size )->set_updated( time() );
-			$this->set_info( $context );
-			return State::items_in_queue();
-		} else {
-			$this->set_process_state( self::STATE_STOPPED );
-			return State::complete();
-		}
-
-	}
-
-	public function start() {
-		$this->delete_info();
-		$this->set_process_state( self::STATE_STARTED );
-		$this->schedule();
-	}
-
-	public function stop() {
-		$this->set_process_state( self::STATE_STOPPED );
-		$this->unschedule();
-	}
-
-	public function resume() {
-		$this->set_process_state( self::STATE_STARTED );
-		$this->schedule();
-	}
-
-	public function get_info() {
-		return $this->get_context()->get_data() + array( 'state' => $this->get_process_state() );
-	}
-
-	public function get_context() {
-		$data = get_option(
-			"{$this->option_prefix}_state",
-			null
-		);
-
-		if ( null === $data ) {
-			return Context::from( (int) $this->task->starting() );
-		}
-
-		return Context::from_data( $data );
-	}
-
-	/**
-	 * @param $context Context
-	 *
-	 * @return void
-	 */
-	public function set_info( $context ) {
-		update_option( "{$this->option_prefix}_state", $context->get_data() );
-	}
-
-	private function delete_info() {
-		delete_option( "{$this->option_prefix}_state" );
-	}
-
-	private function get_process_state() {
-		return get_option( "{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED );
-	}
-
-	private function set_process_state( $state ) {
-		update_option( "{$this->option_prefix}_action_scheduler_state", $state );
-	}
+    /**
+     * The option prefix to store state.
+     *
+     * @var string $option_prefix
+     */
+    private $option_prefix;
+    /**
+     * @var Task
+     */
+    private $task;
+
+    const STATE_STARTED = 'started';
+    const STATE_STOPPED = 'stopped';
+    /**
+     * @var int
+     */
+    private $batch_size;
+
+    public function __construct( $hook, $group, $task, $option_prefix, $batch_size = 5 ) {
+        parent::__construct( $hook, $group );
+        $this->task          = $task;
+        $this->option_prefix = $option_prefix;
+        $this->batch_size    = $batch_size;
+    }
+
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function do_task( $args ) {
+        if ( self::STATE_STOPPED === $this->get_process_state() ) {
+            return State::complete();
+        }
+        $context = $this->get_context();
+        $this->task->tick( null, $context->get_data() + array( 'batch_size' => $this->batch_size ) );
+
+        if ( ( $context->get_count() - $context->get_offset() ) >= 0 ) {
+            $context->set_offset( $context->get_offset() + $this->batch_size )->set_updated( time() );
+            $this->set_info( $context );
+            return State::items_in_queue();
+        } else {
+            $this->set_process_state( self::STATE_STOPPED );
+            return State::complete();
+        }
+
+    }
+
+    public function start() {
+        $this->delete_info();
+        $this->set_process_state( self::STATE_STARTED );
+        $this->schedule();
+    }
+
+    public function stop() {
+        $this->set_process_state( self::STATE_STOPPED );
+        $this->unschedule();
+    }
+
+    public function resume() {
+        $this->set_process_state( self::STATE_STARTED );
+        $this->schedule();
+    }
+
+    public function get_info() {
+        return $this->get_context()->get_data() + array( 'state' => $this->get_process_state() );
+    }
+
+    public function get_context() {
+        $data = get_option(
+            "{$this->option_prefix}_state",
+            null
+        );
+
+        if ( null === $data ) {
+            return Context::from( (int) $this->task->starting() );
+        }
+
+        return Context::from_data( $data );
+    }
+
+    /**
+     * @param $context Context
+     *
+     * @return void
+     */
+    public function set_info( $context ) {
+        update_option( "{$this->option_prefix}_state", $context->get_data() );
+    }
+
+    private function delete_info() {
+        delete_option( "{$this->option_prefix}_state" );
+    }
+
+    private function get_process_state() {
+        return get_option( "{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED );
+    }
+
+    private function set_process_state( $state ) {
+        update_option( "{$this->option_prefix}_action_scheduler_state", $state );
+    }
 }