insideout10 / wordlift-plugin

src/wordlift/dataset/background/class-abstract-sync-background-process-state.php

Indentation +28 added lines, -28 removed lines

@@ -4,33 +4,33 @@
 
 abstract class Abstract_Sync_Background_Process_State implements Sync_Background_Process_State {
 
-	private $state;
-
-	function __construct( $state ) {
-		$this->state = $state;
-	}
-
-	function get_info() {
-		$started     = get_option( '_wl_sync_background_process_started' );
-		$offset      = get_option( '_wl_sync_background_process_offset' );
-		$stage       = get_option( '_wl_sync_background_process_stage' );
-		$counts      = get_option( '_wl_sync_background_process_count', array( 0 ) );
-		$last_update = get_option( '_wl_sync_background_process_updated' );
-
-		// Calculate the overall index by adding the count of completed stages.
-		$index = $offset + 1;
-		for ( $i = 0; $i < $stage; $i ++ ) {
-			$index += $counts[ $i ];
-		}
-
-		// Get the total count.
-		$total_count = array_sum( $counts );
-
-		return new Sync_Background_Process_Info( $this->state, $started, $index, $total_count, $last_update );
-	}
-
-	function resume() {
-		// do nothing.
-	}
+    private $state;
+
+    function __construct( $state ) {
+        $this->state = $state;
+    }
+
+    function get_info() {
+        $started     = get_option( '_wl_sync_background_process_started' );
+        $offset      = get_option( '_wl_sync_background_process_offset' );
+        $stage       = get_option( '_wl_sync_background_process_stage' );
+        $counts      = get_option( '_wl_sync_background_process_count', array( 0 ) );
+        $last_update = get_option( '_wl_sync_background_process_updated' );
+
+        // Calculate the overall index by adding the count of completed stages.
+        $index = $offset + 1;
+        for ( $i = 0; $i < $stage; $i ++ ) {
+            $index += $counts[ $i ];
+        }
+
+        // Get the total count.
+        $total_count = array_sum( $counts );
+
+        return new Sync_Background_Process_Info( $this->state, $started, $index, $total_count, $last_update );
+    }
+
+    function resume() {
+        // do nothing.
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -6,27 +6,27 @@
 
 	private $state;
 
-	function __construct( $state ) {
+	function __construct($state) {
 		$this->state = $state;
 	}
 
 	function get_info() {
-		$started     = get_option( '_wl_sync_background_process_started' );
-		$offset      = get_option( '_wl_sync_background_process_offset' );
-		$stage       = get_option( '_wl_sync_background_process_stage' );
-		$counts      = get_option( '_wl_sync_background_process_count', array( 0 ) );
-		$last_update = get_option( '_wl_sync_background_process_updated' );
+		$started     = get_option('_wl_sync_background_process_started');
+		$offset      = get_option('_wl_sync_background_process_offset');
+		$stage       = get_option('_wl_sync_background_process_stage');
+		$counts      = get_option('_wl_sync_background_process_count', array(0));
+		$last_update = get_option('_wl_sync_background_process_updated');
 
 		// Calculate the overall index by adding the count of completed stages.
 		$index = $offset + 1;
-		for ( $i = 0; $i < $stage; $i ++ ) {
-			$index += $counts[ $i ];
+		for ($i = 0; $i < $stage; $i++) {
+			$index += $counts[$i];
 		}
 
 		// Get the total count.
-		$total_count = array_sum( $counts );
+		$total_count = array_sum($counts);
 
-		return new Sync_Background_Process_Info( $this->state, $started, $index, $total_count, $last_update );
+		return new Sync_Background_Process_Info($this->state, $started, $index, $total_count, $last_update);
 	}
 
 	function resume() {

src/wordlift/dataset/background/class-sync-background-process-wpjson-endpoint.php

Indentation +61 added lines, -61 removed lines

@@ -6,66 +6,66 @@
 
 class Sync_Background_Process_Wpjson_Endpoint {
 
-	/**
-	 * @var Sync_Background_Process
-	 */
-	private $sync_background_process;
-
-	/**
-	 * Sync_Background_Process_Wpjson_Endpoint constructor.
-	 *
-	 * @param Sync_Background_Process $sync_background_process
-	 */
-	function __construct( $sync_background_process ) {
-
-		add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
-
-		$this->sync_background_process = $sync_background_process;
-
-	}
-
-	function rest_api_init() {
-
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
-			'methods'             => WP_REST_Server::CREATABLE,
-			'callback'            => array( $this->sync_background_process, 'start' ),
-			'permission_callback' => function () {
-				$user = wp_get_current_user();
-
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
-			}
-		) );
-
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
-			'methods'             => WP_REST_Server::READABLE,
-			'callback'            => array( $this->sync_background_process, 'get_info' ),
-			'permission_callback' => function () {
-				$user = wp_get_current_user();
-
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
-			}
-		) );
-
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
-			'methods'             => WP_REST_Server::DELETABLE,
-			'callback'            => array( $this->sync_background_process, 'stop' ),
-			'permission_callback' => function () {
-				$user = wp_get_current_user();
-
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
-			}
-		) );
-
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
-			'methods'             => 'PUT',
-			'callback'            => array( $this->sync_background_process, 'resume' ),
-			'permission_callback' => function () {
-				$user = wp_get_current_user();
-
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
-			}
-		) );
-
-	}
+    /**
+     * @var Sync_Background_Process
+     */
+    private $sync_background_process;
+
+    /**
+     * Sync_Background_Process_Wpjson_Endpoint constructor.
+     *
+     * @param Sync_Background_Process $sync_background_process
+     */
+    function __construct( $sync_background_process ) {
+
+        add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
+
+        $this->sync_background_process = $sync_background_process;
+
+    }
+
+    function rest_api_init() {
+
+        register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+            'methods'             => WP_REST_Server::CREATABLE,
+            'callback'            => array( $this->sync_background_process, 'start' ),
+            'permission_callback' => function () {
+                $user = wp_get_current_user();
+
+                return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+            }
+        ) );
+
+        register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+            'methods'             => WP_REST_Server::READABLE,
+            'callback'            => array( $this->sync_background_process, 'get_info' ),
+            'permission_callback' => function () {
+                $user = wp_get_current_user();
+
+                return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+            }
+        ) );
+
+        register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+            'methods'             => WP_REST_Server::DELETABLE,
+            'callback'            => array( $this->sync_background_process, 'stop' ),
+            'permission_callback' => function () {
+                $user = wp_get_current_user();
+
+                return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+            }
+        ) );
+
+        register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+            'methods'             => 'PUT',
+            'callback'            => array( $this->sync_background_process, 'resume' ),
+            'permission_callback' => function () {
+                $user = wp_get_current_user();
+
+                return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+            }
+        ) );
+
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
 	 *
 	 * @param Sync_Background_Process $sync_background_process
 	 */
-	function __construct( $sync_background_process ) {
+	function __construct($sync_background_process) {
 
-		add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
+		add_action('rest_api_init', array($this, 'rest_api_init'));
 
 		$this->sync_background_process = $sync_background_process;
 
@@ -26,45 +26,45 @@ 
 
 	function rest_api_init() {
 
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+		register_rest_route('wordlift/v1', '/dataset/background/sync', array(
 			'methods'             => WP_REST_Server::CREATABLE,
-			'callback'            => array( $this->sync_background_process, 'start' ),
-			'permission_callback' => function () {
+			'callback'            => array($this->sync_background_process, 'start'),
+			'permission_callback' => function() {
 				$user = wp_get_current_user();
 
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+				return is_super_admin($user->ID) || in_array('administrator', (array) $user->roles);
 			}
-		) );
+		));
 
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+		register_rest_route('wordlift/v1', '/dataset/background/sync', array(
 			'methods'             => WP_REST_Server::READABLE,
-			'callback'            => array( $this->sync_background_process, 'get_info' ),
-			'permission_callback' => function () {
+			'callback'            => array($this->sync_background_process, 'get_info'),
+			'permission_callback' => function() {
 				$user = wp_get_current_user();
 
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+				return is_super_admin($user->ID) || in_array('administrator', (array) $user->roles);
 			}
-		) );
+		));
 
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+		register_rest_route('wordlift/v1', '/dataset/background/sync', array(
 			'methods'             => WP_REST_Server::DELETABLE,
-			'callback'            => array( $this->sync_background_process, 'stop' ),
-			'permission_callback' => function () {
+			'callback'            => array($this->sync_background_process, 'stop'),
+			'permission_callback' => function() {
 				$user = wp_get_current_user();
 
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+				return is_super_admin($user->ID) || in_array('administrator', (array) $user->roles);
 			}
-		) );
+		));
 
-		register_rest_route( 'wordlift/v1', '/dataset/background/sync', array(
+		register_rest_route('wordlift/v1', '/dataset/background/sync', array(
 			'methods'             => 'PUT',
-			'callback'            => array( $this->sync_background_process, 'resume' ),
-			'permission_callback' => function () {
+			'callback'            => array($this->sync_background_process, 'resume'),
+			'permission_callback' => function() {
 				$user = wp_get_current_user();
 
-				return is_super_admin( $user->ID ) || in_array( 'administrator', (array) $user->roles );
+				return is_super_admin($user->ID) || in_array('administrator', (array) $user->roles);
 			}
-		) );
+		));
 
 	}
 

src/wordlift/dataset/background/class-sync-background-process-started-state.php

Indentation +127 added lines, -127 removed lines

@@ -11,132 +11,132 @@
 
 class Sync_Background_Process_Started_State extends Abstract_Sync_Background_Process_State {
 
-	/**
-	 * @var Sync_Background_Process
-	 */
-	private $context;
-
-	/**
-	 * @var Sync_Service
-	 */
-	private $sync_service;
-
-	/**
-	 * @var Sync_Background_Process_Stage[]
-	 */
-	private $stages;
-
-	private $batch_size = 5;
-	/**
-	 * @var bool
-	 */
-	private $reset;
-
-	/**
-	 * Sync_Background_Process_Started_State constructor.
-	 *
-	 * @param Sync_Background_Process $context
-	 * @param Sync_Service $sync_service
-	 * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
-	 * @param bool $reset Whether to reset the counters
-	 */
-	function __construct( $context, $sync_service, $sync_object_adapter_factory, $reset = true ) {
-		parent::__construct( Sync_Background_Process::STATE_STARTED );
-
-		$this->context      = $context;
-		$this->sync_service = $sync_service;
-
-		$this->stages = array(
-			new Sync_Background_Process_Posts_Stage( $sync_object_adapter_factory ),
-			new Sync_Background_Process_Terms_Stage( $sync_object_adapter_factory ),
-			new Sync_Background_Process_Users_Stage( $sync_object_adapter_factory ),
-		);
-	}
-
-	function enter() {
-		// Delete the KG contents.
-		$this->sync_service->delete_all();
-
-		// Clear caches.
-		do_action( 'wl_ttl_cache_cleaner__flush' );
-
-		$counts = array_map( function ( $item ) {
-			return $item->count();
-		}, $this->stages );
-
-		update_option( '_wl_sync_background_process_count', $counts, true );
-		update_option( '_wl_sync_background_process_stage', 0, true );
-		update_option( '_wl_sync_background_process_offset', 0, true );
-		update_option( '_wl_sync_background_process_started', time(), true );
-		update_option( '_wl_sync_background_process_updated', time(), true );
-
-		$this->context->set_state( Sync_Background_Process::STATE_STARTED );
-
-		$this->resume();
-	}
-
-	function resume() {
-		$this->context->push_to_queue( true );
-		$this->context->save()->dispatch();
-	}
-
-	function leave() {
-		$this->context->set_state( null );
-	}
-
-	function task( $args ) {
-
-		$offset     = get_option( '_wl_sync_background_process_offset' );
-		$stage      = get_option( '_wl_sync_background_process_stage' );
-		$counts     = get_option( '_wl_sync_background_process_count' );
-		$batch_size = min( $counts[ $stage ] - $offset, $this->batch_size );
-
-		add_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
-		try {
-			$object_adapters = $this->stages[ $stage ]->get_sync_object_adapters( $offset, $batch_size );
-			$this->sync_service->sync_many( $object_adapters, true );
-		} catch ( \Exception $e ) {
-			// ignored.
-		}
-		remove_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
-
-		update_option( '_wl_sync_background_process_updated', time(), true );
-
-		// Increase the offset.
-		if ( ( $offset + $batch_size ) < $counts[ $stage ] ) {
-			update_option( '_wl_sync_background_process_offset', $offset + $batch_size, true );
-
-			return true;
-		}
-
-		// Increase the stage.
-		if ( ( $stage + 1 ) < count( $this->stages ) ) {
-			update_option( '_wl_sync_background_process_stage', $stage + 1, true );
-			update_option( '_wl_sync_background_process_offset', 0, true );
-
-			return true;
-		}
-
-		// Stop processing.
-		$this->context->stop();
-
-		return false;
-	}
-
-	/**
-	 * Hook to provide a request to update the status on the server.
-	 *
-	 * @param array $args
-	 *
-	 * @return mixed
-	 */
-	public function api_service__request( $args ) {
-
-		$state_header_value = str_replace( "\n", '', wp_json_encode( $this->context->get_info() ) );
-
-		$args['headers']['X-Wordlift-Dataset-Sync-State-V1'] = $state_header_value;
-
-		return $args;
-	}
+    /**
+     * @var Sync_Background_Process
+     */
+    private $context;
+
+    /**
+     * @var Sync_Service
+     */
+    private $sync_service;
+
+    /**
+     * @var Sync_Background_Process_Stage[]
+     */
+    private $stages;
+
+    private $batch_size = 5;
+    /**
+     * @var bool
+     */
+    private $reset;
+
+    /**
+     * Sync_Background_Process_Started_State constructor.
+     *
+     * @param Sync_Background_Process $context
+     * @param Sync_Service $sync_service
+     * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
+     * @param bool $reset Whether to reset the counters
+     */
+    function __construct( $context, $sync_service, $sync_object_adapter_factory, $reset = true ) {
+        parent::__construct( Sync_Background_Process::STATE_STARTED );
+
+        $this->context      = $context;
+        $this->sync_service = $sync_service;
+
+        $this->stages = array(
+            new Sync_Background_Process_Posts_Stage( $sync_object_adapter_factory ),
+            new Sync_Background_Process_Terms_Stage( $sync_object_adapter_factory ),
+            new Sync_Background_Process_Users_Stage( $sync_object_adapter_factory ),
+        );
+    }
+
+    function enter() {
+        // Delete the KG contents.
+        $this->sync_service->delete_all();
+
+        // Clear caches.
+        do_action( 'wl_ttl_cache_cleaner__flush' );
+
+        $counts = array_map( function ( $item ) {
+            return $item->count();
+        }, $this->stages );
+
+        update_option( '_wl_sync_background_process_count', $counts, true );
+        update_option( '_wl_sync_background_process_stage', 0, true );
+        update_option( '_wl_sync_background_process_offset', 0, true );
+        update_option( '_wl_sync_background_process_started', time(), true );
+        update_option( '_wl_sync_background_process_updated', time(), true );
+
+        $this->context->set_state( Sync_Background_Process::STATE_STARTED );
+
+        $this->resume();
+    }
+
+    function resume() {
+        $this->context->push_to_queue( true );
+        $this->context->save()->dispatch();
+    }
+
+    function leave() {
+        $this->context->set_state( null );
+    }
+
+    function task( $args ) {
+
+        $offset     = get_option( '_wl_sync_background_process_offset' );
+        $stage      = get_option( '_wl_sync_background_process_stage' );
+        $counts     = get_option( '_wl_sync_background_process_count' );
+        $batch_size = min( $counts[ $stage ] - $offset, $this->batch_size );
+
+        add_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
+        try {
+            $object_adapters = $this->stages[ $stage ]->get_sync_object_adapters( $offset, $batch_size );
+            $this->sync_service->sync_many( $object_adapters, true );
+        } catch ( \Exception $e ) {
+            // ignored.
+        }
+        remove_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
+
+        update_option( '_wl_sync_background_process_updated', time(), true );
+
+        // Increase the offset.
+        if ( ( $offset + $batch_size ) < $counts[ $stage ] ) {
+            update_option( '_wl_sync_background_process_offset', $offset + $batch_size, true );
+
+            return true;
+        }
+
+        // Increase the stage.
+        if ( ( $stage + 1 ) < count( $this->stages ) ) {
+            update_option( '_wl_sync_background_process_stage', $stage + 1, true );
+            update_option( '_wl_sync_background_process_offset', 0, true );
+
+            return true;
+        }
+
+        // Stop processing.
+        $this->context->stop();
+
+        return false;
+    }
+
+    /**
+     * Hook to provide a request to update the status on the server.
+     *
+     * @param array $args
+     *
+     * @return mixed
+     */
+    public function api_service__request( $args ) {
+
+        $state_header_value = str_replace( "\n", '', wp_json_encode( $this->context->get_info() ) );
+
+        $args['headers']['X-Wordlift-Dataset-Sync-State-V1'] = $state_header_value;
+
+        return $args;
+    }
 
 }

Spacing +34 added lines, -34 removed lines

@@ -40,16 +40,16 @@ 
 	 * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
 	 * @param bool $reset Whether to reset the counters
 	 */
-	function __construct( $context, $sync_service, $sync_object_adapter_factory, $reset = true ) {
-		parent::__construct( Sync_Background_Process::STATE_STARTED );
+	function __construct($context, $sync_service, $sync_object_adapter_factory, $reset = true) {
+		parent::__construct(Sync_Background_Process::STATE_STARTED);
 
 		$this->context      = $context;
 		$this->sync_service = $sync_service;
 
 		$this->stages = array(
-			new Sync_Background_Process_Posts_Stage( $sync_object_adapter_factory ),
-			new Sync_Background_Process_Terms_Stage( $sync_object_adapter_factory ),
-			new Sync_Background_Process_Users_Stage( $sync_object_adapter_factory ),
+			new Sync_Background_Process_Posts_Stage($sync_object_adapter_factory),
+			new Sync_Background_Process_Terms_Stage($sync_object_adapter_factory),
+			new Sync_Background_Process_Users_Stage($sync_object_adapter_factory),
 		);
 	}
 
@@ -58,61 +58,61 @@ 
 		$this->sync_service->delete_all();
 
 		// Clear caches.
-		do_action( 'wl_ttl_cache_cleaner__flush' );
+		do_action('wl_ttl_cache_cleaner__flush');
 
-		$counts = array_map( function ( $item ) {
+		$counts = array_map(function($item) {
 			return $item->count();
-		}, $this->stages );
+		}, $this->stages);
 
-		update_option( '_wl_sync_background_process_count', $counts, true );
-		update_option( '_wl_sync_background_process_stage', 0, true );
-		update_option( '_wl_sync_background_process_offset', 0, true );
-		update_option( '_wl_sync_background_process_started', time(), true );
-		update_option( '_wl_sync_background_process_updated', time(), true );
+		update_option('_wl_sync_background_process_count', $counts, true);
+		update_option('_wl_sync_background_process_stage', 0, true);
+		update_option('_wl_sync_background_process_offset', 0, true);
+		update_option('_wl_sync_background_process_started', time(), true);
+		update_option('_wl_sync_background_process_updated', time(), true);
 
-		$this->context->set_state( Sync_Background_Process::STATE_STARTED );
+		$this->context->set_state(Sync_Background_Process::STATE_STARTED);
 
 		$this->resume();
 	}
 
 	function resume() {
-		$this->context->push_to_queue( true );
+		$this->context->push_to_queue(true);
 		$this->context->save()->dispatch();
 	}
 
 	function leave() {
-		$this->context->set_state( null );
+		$this->context->set_state(null);
 	}
 
-	function task( $args ) {
+	function task($args) {
 
-		$offset     = get_option( '_wl_sync_background_process_offset' );
-		$stage      = get_option( '_wl_sync_background_process_stage' );
-		$counts     = get_option( '_wl_sync_background_process_count' );
-		$batch_size = min( $counts[ $stage ] - $offset, $this->batch_size );
+		$offset     = get_option('_wl_sync_background_process_offset');
+		$stage      = get_option('_wl_sync_background_process_stage');
+		$counts     = get_option('_wl_sync_background_process_count');
+		$batch_size = min($counts[$stage] - $offset, $this->batch_size);
 
-		add_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
+		add_filter('wl_api_service__request', array($this, 'api_service__request'));
 		try {
-			$object_adapters = $this->stages[ $stage ]->get_sync_object_adapters( $offset, $batch_size );
-			$this->sync_service->sync_many( $object_adapters, true );
-		} catch ( \Exception $e ) {
+			$object_adapters = $this->stages[$stage]->get_sync_object_adapters($offset, $batch_size);
+			$this->sync_service->sync_many($object_adapters, true);
+		} catch (\Exception $e) {
 			// ignored.
 		}
-		remove_filter( 'wl_api_service__request', array( $this, 'api_service__request' ) );
+		remove_filter('wl_api_service__request', array($this, 'api_service__request'));
 
-		update_option( '_wl_sync_background_process_updated', time(), true );
+		update_option('_wl_sync_background_process_updated', time(), true);
 
 		// Increase the offset.
-		if ( ( $offset + $batch_size ) < $counts[ $stage ] ) {
-			update_option( '_wl_sync_background_process_offset', $offset + $batch_size, true );
+		if (($offset + $batch_size) < $counts[$stage]) {
+			update_option('_wl_sync_background_process_offset', $offset + $batch_size, true);
 
 			return true;
 		}
 
 		// Increase the stage.
-		if ( ( $stage + 1 ) < count( $this->stages ) ) {
-			update_option( '_wl_sync_background_process_stage', $stage + 1, true );
-			update_option( '_wl_sync_background_process_offset', 0, true );
+		if (($stage + 1) < count($this->stages)) {
+			update_option('_wl_sync_background_process_stage', $stage + 1, true);
+			update_option('_wl_sync_background_process_offset', 0, true);
 
 			return true;
 		}
@@ -130,9 +130,9 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function api_service__request( $args ) {
+	public function api_service__request($args) {
 
-		$state_header_value = str_replace( "\n", '', wp_json_encode( $this->context->get_info() ) );
+		$state_header_value = str_replace("\n", '', wp_json_encode($this->context->get_info()));
 
 		$args['headers']['X-Wordlift-Dataset-Sync-State-V1'] = $state_header_value;
 

src/wordlift/admin/class-admin-user-option.php

Indentation +40 added lines, -40 removed lines

@@ -7,45 +7,45 @@
  */
 class Admin_User_Option {
 
-	const WORDLIFT_ADMIN = 'wl_is_wordlift_admin';
-
-	public static function is_wordlift_admin() {
-		return intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
-	}
-
-	public function connect_hook() {
-		add_action( 'wordlift_user_settings_page', array( $this, 'render_checkbox' ) );
-		add_action( 'edit_user_profile_update', array( $this, 'save_checkbox' ) );
-		add_action( 'personal_options_update', array( $this, 'save_checkbox' ) );
-	}
-
-	public function save_checkbox() {
-
-		if ( ! current_user_can( 'manage_options' ) ) {
-			return;
-		}
-
-		if ( ! isset( $_POST[ self::WORDLIFT_ADMIN ] ) ) {
-			delete_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN );
-
-			return;
-		}
-		update_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, 1 );
-	}
-
-	public function render_checkbox() {
-		if ( ! current_user_can( 'manage_options' ) ) {
-			return;
-		}
-		$is_checked = intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
-		echo $this->get_checkbox( $is_checked );
-	}
-
-	public static function get_checkbox( $is_checked ) {
-		$checked    = $is_checked ? "checked='checked'" : '';
-		$admin_text = __( 'Wordlift Admin', 'wordlift' );
-
-		return "<tr><th>$admin_text</th><td><input type='checkbox' name='wl_is_wordlift_admin' $checked></td></tr>";
-	}
+    const WORDLIFT_ADMIN = 'wl_is_wordlift_admin';
+
+    public static function is_wordlift_admin() {
+        return intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
+    }
+
+    public function connect_hook() {
+        add_action( 'wordlift_user_settings_page', array( $this, 'render_checkbox' ) );
+        add_action( 'edit_user_profile_update', array( $this, 'save_checkbox' ) );
+        add_action( 'personal_options_update', array( $this, 'save_checkbox' ) );
+    }
+
+    public function save_checkbox() {
+
+        if ( ! current_user_can( 'manage_options' ) ) {
+            return;
+        }
+
+        if ( ! isset( $_POST[ self::WORDLIFT_ADMIN ] ) ) {
+            delete_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN );
+
+            return;
+        }
+        update_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, 1 );
+    }
+
+    public function render_checkbox() {
+        if ( ! current_user_can( 'manage_options' ) ) {
+            return;
+        }
+        $is_checked = intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
+        echo $this->get_checkbox( $is_checked );
+    }
+
+    public static function get_checkbox( $is_checked ) {
+        $checked    = $is_checked ? "checked='checked'" : '';
+        $admin_text = __( 'Wordlift Admin', 'wordlift' );
+
+        return "<tr><th>$admin_text</th><td><input type='checkbox' name='wl_is_wordlift_admin' $checked></td></tr>";
+    }
 
 }
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

@@ -10,40 +10,40 @@
 	const WORDLIFT_ADMIN = 'wl_is_wordlift_admin';
 
 	public static function is_wordlift_admin() {
-		return intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
+		return intval(get_user_meta(get_current_user_id(), self::WORDLIFT_ADMIN, true)) === 1;
 	}
 
 	public function connect_hook() {
-		add_action( 'wordlift_user_settings_page', array( $this, 'render_checkbox' ) );
-		add_action( 'edit_user_profile_update', array( $this, 'save_checkbox' ) );
-		add_action( 'personal_options_update', array( $this, 'save_checkbox' ) );
+		add_action('wordlift_user_settings_page', array($this, 'render_checkbox'));
+		add_action('edit_user_profile_update', array($this, 'save_checkbox'));
+		add_action('personal_options_update', array($this, 'save_checkbox'));
 	}
 
 	public function save_checkbox() {
 
-		if ( ! current_user_can( 'manage_options' ) ) {
+		if ( ! current_user_can('manage_options')) {
 			return;
 		}
 
-		if ( ! isset( $_POST[ self::WORDLIFT_ADMIN ] ) ) {
-			delete_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN );
+		if ( ! isset($_POST[self::WORDLIFT_ADMIN])) {
+			delete_user_meta(get_current_user_id(), self::WORDLIFT_ADMIN);
 
 			return;
 		}
-		update_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, 1 );
+		update_user_meta(get_current_user_id(), self::WORDLIFT_ADMIN, 1);
 	}
 
 	public function render_checkbox() {
-		if ( ! current_user_can( 'manage_options' ) ) {
+		if ( ! current_user_can('manage_options')) {
 			return;
 		}
-		$is_checked = intval( get_user_meta( get_current_user_id(), self::WORDLIFT_ADMIN, true ) ) === 1;
-		echo $this->get_checkbox( $is_checked );
+		$is_checked = intval(get_user_meta(get_current_user_id(), self::WORDLIFT_ADMIN, true)) === 1;
+		echo $this->get_checkbox($is_checked);
 	}
 
-	public static function get_checkbox( $is_checked ) {
+	public static function get_checkbox($is_checked) {
 		$checked    = $is_checked ? "checked='checked'" : '';
-		$admin_text = __( 'Wordlift Admin', 'wordlift' );
+		$admin_text = __('Wordlift Admin', 'wordlift');
 
 		return "<tr><th>$admin_text</th><td><input type='checkbox' name='wl_is_wordlift_admin' $checked></td></tr>";
 	}

src/wordlift/features/class-feature.php

Indentation +24 added lines, -24 removed lines

@@ -4,32 +4,32 @@
 
 class Feature {
 
-	/**
-	 * @var string
-	 */
-	public $feature_slug;
+    /**
+     * @var string
+     */
+    public $feature_slug;
 
-	/**
-	 * @var bool
-	 */
-	public $default_value;
+    /**
+     * @var bool
+     */
+    public $default_value;
 
-	/**
-	 * @var Callable
-	 */
-	public $callback;
+    /**
+     * @var Callable
+     */
+    public $callback;
 
-	/**
-	 * Feature constructor.
-	 *
-	 * @param $feature_slug string Slug for feature without wl__feature__enable
-	 * @param $default_value bool Default value for the flag, true or false.
-	 * @param $callback Callable Callback for the feature.
-	 */
-	public function __construct( $feature_slug, $default_value, $callback ) {
-		$this->feature_slug  = $feature_slug;
-		$this->default_value = $default_value;
-		$this->callback      = $callback;
-	}
+    /**
+     * Feature constructor.
+     *
+     * @param $feature_slug string Slug for feature without wl__feature__enable
+     * @param $default_value bool Default value for the flag, true or false.
+     * @param $callback Callable Callback for the feature.
+     */
+    public function __construct( $feature_slug, $default_value, $callback ) {
+        $this->feature_slug  = $feature_slug;
+        $this->default_value = $default_value;
+        $this->callback      = $callback;
+    }
 
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	 * @param $default_value bool Default value for the flag, true or false.
 	 * @param $callback Callable Callback for the feature.
 	 */
-	public function __construct( $feature_slug, $default_value, $callback ) {
+	public function __construct($feature_slug, $default_value, $callback) {
 		$this->feature_slug  = $feature_slug;
 		$this->default_value = $default_value;
 		$this->callback      = $callback;

src/wordlift/vocabulary/dashboard/class-term-matches-widget.php

Indentation +26 added lines, -26 removed lines

@@ -10,35 +10,35 @@ 
  * @author Naveen Muthusamy <naveen@wordlift.io>
  */
 class Term_Matches_Widget {
-	/**
-	 * @var Term_Count
-	 */
-	private $term_count;
+    /**
+     * @var Term_Count
+     */
+    private $term_count;
 
-	/**
-	 * Term_Matches_Widget constructor.
-	 *
-	 * @param $term_count Term_Count
-	 */
-	public function __construct( $term_count ) {
-		$this->term_count = $term_count;
-	}
+    /**
+     * Term_Matches_Widget constructor.
+     *
+     * @param $term_count Term_Count
+     */
+    public function __construct( $term_count ) {
+        $this->term_count = $term_count;
+    }
 
-	public function connect_hook() {
-		add_action( 'wl_admin_dashboard_widgets', array( $this, 'render_widget' ) );
-	}
+    public function connect_hook() {
+        add_action( 'wl_admin_dashboard_widgets', array( $this, 'render_widget' ) );
+    }
 
-	public function render_widget() {
-		$term_count  = $this->term_count->get_term_count();
-		if ( $term_count <= 0 ) {
-			return;
-		}
+    public function render_widget() {
+        $term_count  = $this->term_count->get_term_count();
+        if ( $term_count <= 0 ) {
+            return;
+        }
 
-		$match_terms_url = menu_page_url('wl-vocabulary-match-terms', false);
-		$term_count_link = "<a href='$match_terms_url'>" . Badge_Generator::get_formatted_count_string( $term_count ) . " term(s)</a>";
-		$match_terms = __('Match terms', 'wordlift');
-		$additional_text = __(' waiting to be matched with entities.', 'wordlift');
-		echo <<<EOF
+        $match_terms_url = menu_page_url('wl-vocabulary-match-terms', false);
+        $term_count_link = "<a href='$match_terms_url'>" . Badge_Generator::get_formatted_count_string( $term_count ) . " term(s)</a>";
+        $match_terms = __('Match terms', 'wordlift');
+        $additional_text = __(' waiting to be matched with entities.', 'wordlift');
+        echo <<<EOF
         <div id="wl-match-terms" class="wl-dashboard__block wl-dashboard__block--match-terms">
             <header>
                 <h3>$match_terms</h3>
@@ -48,6 +48,6 @@ 
                 </p>
         </div>
 EOF;
-	}
+    }
 
 }
\ No newline at end of file

Spacing +5 added lines, -5 removed lines

@@ -20,22 +20,22 @@
 	 *
 	 * @param $term_count Term_Count
 	 */
-	public function __construct( $term_count ) {
+	public function __construct($term_count) {
 		$this->term_count = $term_count;
 	}
 
 	public function connect_hook() {
-		add_action( 'wl_admin_dashboard_widgets', array( $this, 'render_widget' ) );
+		add_action('wl_admin_dashboard_widgets', array($this, 'render_widget'));
 	}
 
 	public function render_widget() {
-		$term_count  = $this->term_count->get_term_count();
-		if ( $term_count <= 0 ) {
+		$term_count = $this->term_count->get_term_count();
+		if ($term_count <= 0) {
 			return;
 		}
 
 		$match_terms_url = menu_page_url('wl-vocabulary-match-terms', false);
-		$term_count_link = "<a href='$match_terms_url'>" . Badge_Generator::get_formatted_count_string( $term_count ) . " term(s)</a>";
+		$term_count_link = "<a href='$match_terms_url'>".Badge_Generator::get_formatted_count_string($term_count)." term(s)</a>";
 		$match_terms = __('Match terms', 'wordlift');
 		$additional_text = __(' waiting to be matched with entities.', 'wordlift');
 		echo <<<EOF

src/wordlift/vocabulary/menu/badge/class-badge-generator.php

Indentation +32 added lines, -32 removed lines

@@ -10,38 +10,38 @@
  */
 class Badge_Generator {
 
-	/**
-	 * Returns the term count which needs to be shown on ui.
-	 * @param $number
-	 *
-	 * @return int
-	 */
-	public static function get_ui_count( $number ) {
-
-		$number = (int) $number;
-
-		if ( $number < 100 ) {
-			return $number;
-		}
-
-		return 100;
-	}
-
-	public static function generate_html( $number ) {
-		$count_string = self::get_formatted_count_string( $number );
-		return "<span class=\"wl-admin-menu-badge\">$count_string</span>";
-	}
-
-	/**
-	 * @param $number
-	 *
-	 * @return string
-	 */
-	public static function get_formatted_count_string( $number ) {
-		$round        = self::get_ui_count( $number );
-
-		return $round < 100 ? "$round" : "$round+";
-	}
+    /**
+     * Returns the term count which needs to be shown on ui.
+     * @param $number
+     *
+     * @return int
+     */
+    public static function get_ui_count( $number ) {
+
+        $number = (int) $number;
+
+        if ( $number < 100 ) {
+            return $number;
+        }
+
+        return 100;
+    }
+
+    public static function generate_html( $number ) {
+        $count_string = self::get_formatted_count_string( $number );
+        return "<span class=\"wl-admin-menu-badge\">$count_string</span>";
+    }
+
+    /**
+     * @param $number
+     *
+     * @return string
+     */
+    public static function get_formatted_count_string( $number ) {
+        $round        = self::get_ui_count( $number );
+
+        return $round < 100 ? "$round" : "$round+";
+    }
 
 
 }
\ No newline at end of file

Spacing +6 added lines, -6 removed lines

@@ -16,19 +16,19 @@ 
 	 *
 	 * @return int
 	 */
-	public static function get_ui_count( $number ) {
+	public static function get_ui_count($number) {
 
 		$number = (int) $number;
 
-		if ( $number < 100 ) {
+		if ($number < 100) {
 			return $number;
 		}
 
 		return 100;
 	}
 
-	public static function generate_html( $number ) {
-		$count_string = self::get_formatted_count_string( $number );
+	public static function generate_html($number) {
+		$count_string = self::get_formatted_count_string($number);
 		return "<span class=\"wl-admin-menu-badge\">$count_string</span>";
 	}
 
@@ -37,8 +37,8 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_formatted_count_string( $number ) {
-		$round        = self::get_ui_count( $number );
+	public static function get_formatted_count_string($number) {
+		$round = self::get_ui_count($number);
 
 		return $round < 100 ? "$round" : "$round+";
 	}

src/wordlift/vocabulary/data/entity-list/class-legacy-entity-list.php

Indentation +45 added lines, -45 removed lines

@@ -12,49 +12,49 @@
  */
 class Legacy_Entity_List extends Entity_List {
 
-	/**
-	 * This function is called when default entity doesnt find any data.
-	 * @return array
-	 */
-	public function get_jsonld_data() {
-		$tag  = get_term( $this->term_id );
-		$type = get_term_meta( $tag->term_id, Entity_Rest_Endpoint::TYPE_META_KEY, true );
-		if ( $type === '' ) {
-			return array();
-		}
-
-		return array(
-			array(
-				'@id'           => get_term_link( $tag->term_id ) . '#id',
-				'@type'         => $type,
-				'name'          => $tag->name,
-				'description'   => ! empty( $tag->description ) ?: get_term_meta( $tag->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY, true ),
-				'sameAs'        => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY ),
-				'alternateName' => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY )
-			)
-		);
-	}
-
-	/**
-	 * This function is never used.
-	 *
-	 * @param \WP_REST_Request $request
-	 *
-	 * @return bool
-	 */
-	public function save_jsonld_data( $request ) {
-		return false;
-	}
-
-	public function clear_data() {
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::TYPE_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::EXTERNAL_ENTITY_META_KEY );
-	}
-
-	public function remove_entity_by_id( $entity_id ) {
-		$this->clear_data();
-	}
+    /**
+     * This function is called when default entity doesnt find any data.
+     * @return array
+     */
+    public function get_jsonld_data() {
+        $tag  = get_term( $this->term_id );
+        $type = get_term_meta( $tag->term_id, Entity_Rest_Endpoint::TYPE_META_KEY, true );
+        if ( $type === '' ) {
+            return array();
+        }
+
+        return array(
+            array(
+                '@id'           => get_term_link( $tag->term_id ) . '#id',
+                '@type'         => $type,
+                'name'          => $tag->name,
+                'description'   => ! empty( $tag->description ) ?: get_term_meta( $tag->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY, true ),
+                'sameAs'        => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY ),
+                'alternateName' => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY )
+            )
+        );
+    }
+
+    /**
+     * This function is never used.
+     *
+     * @param \WP_REST_Request $request
+     *
+     * @return bool
+     */
+    public function save_jsonld_data( $request ) {
+        return false;
+    }
+
+    public function clear_data() {
+        delete_term_meta( $this->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY );
+        delete_term_meta( $this->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY );
+        delete_term_meta( $this->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY );
+        delete_term_meta( $this->term_id, Entity_Rest_Endpoint::TYPE_META_KEY );
+        delete_term_meta( $this->term_id, Entity_Rest_Endpoint::EXTERNAL_ENTITY_META_KEY );
+    }
+
+    public function remove_entity_by_id( $entity_id ) {
+        $this->clear_data();
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -17,20 +17,20 @@ 
 	 * @return array
 	 */
 	public function get_jsonld_data() {
-		$tag  = get_term( $this->term_id );
-		$type = get_term_meta( $tag->term_id, Entity_Rest_Endpoint::TYPE_META_KEY, true );
-		if ( $type === '' ) {
+		$tag  = get_term($this->term_id);
+		$type = get_term_meta($tag->term_id, Entity_Rest_Endpoint::TYPE_META_KEY, true);
+		if ($type === '') {
 			return array();
 		}
 
 		return array(
 			array(
-				'@id'           => get_term_link( $tag->term_id ) . '#id',
+				'@id'           => get_term_link($tag->term_id).'#id',
 				'@type'         => $type,
 				'name'          => $tag->name,
-				'description'   => ! empty( $tag->description ) ?: get_term_meta( $tag->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY, true ),
-				'sameAs'        => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY ),
-				'alternateName' => get_term_meta( $tag->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY )
+				'description'   => ! empty($tag->description) ?: get_term_meta($tag->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY, true),
+				'sameAs'        => get_term_meta($tag->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY),
+				'alternateName' => get_term_meta($tag->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY)
 			)
 		);
 	}
@@ -42,19 +42,19 @@ 
 	 *
 	 * @return bool
 	 */
-	public function save_jsonld_data( $request ) {
+	public function save_jsonld_data($request) {
 		return false;
 	}
 
 	public function clear_data() {
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::TYPE_META_KEY );
-		delete_term_meta( $this->term_id, Entity_Rest_Endpoint::EXTERNAL_ENTITY_META_KEY );
+		delete_term_meta($this->term_id, Entity_Rest_Endpoint::SAME_AS_META_KEY);
+		delete_term_meta($this->term_id, Entity_Rest_Endpoint::ALTERNATIVE_LABEL_META_KEY);
+		delete_term_meta($this->term_id, Entity_Rest_Endpoint::DESCRIPTION_META_KEY);
+		delete_term_meta($this->term_id, Entity_Rest_Endpoint::TYPE_META_KEY);
+		delete_term_meta($this->term_id, Entity_Rest_Endpoint::EXTERNAL_ENTITY_META_KEY);
 	}
 
-	public function remove_entity_by_id( $entity_id ) {
+	public function remove_entity_by_id($entity_id) {
 		$this->clear_data();
 	}
 }

src/admin/class-wordlift-admin-page.php

Indentation +133 added lines, -133 removed lines

@@ -18,138 +18,138 @@
  */
 abstract class Wordlift_Admin_Page {
 
-	/**
-	 * Define the {@link Wordlift_Admin_Page} constructor.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-		add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
-	}
-
-	/**
-	 * Get the parent slug.
-	 *
-	 * @return string The parent slug (default 'wl_admin_menu').
-	 * @since 3.11.0
-	 *
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * Get the required capability.
-	 *
-	 * @return string The capability (default 'manage_options').
-	 * @since 3.11.0
-	 *
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * Get the page title. Will be translated.
-	 *
-	 * @return string The page title.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_page_title();
-
-	/**
-	 * Get the menu title. Will be translated.
-	 *
-	 * @return string The menu title.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_menu_title();
-
-	/**
-	 * Get the menu slug.
-	 *
-	 * @return string The menu slug.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_menu_slug();
-
-	/**
-	 * Get the page url.
-	 *
-	 * @return string The escaped url of the admin page
-	 * @since 3.14.0
-	 *
-	 */
-	function get_url() {
-
-		// ideally should have used menu_page_url, but it is loaded later than some usages.
-		$url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
-
-		return esc_url( $url );
-	}
-
-	/**
-	 * Get the partial file name, used in the {@link render} function.
-	 *
-	 * @return string The partial file name.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_partial_name();
-
-	/**
-	 * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
-	 * page to the admin menu.
-	 *
-	 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
-	 * @since 3.11.0
-	 *
-	 */
-	public function admin_menu() {
-		// Add the sub-menu page.
-		//
-		// See http://codex.wordpress.org/Function_Reference/add_submenu_page
-		$page = add_submenu_page(
-			$this->get_parent_slug(),
-			$this->get_page_title(),
-			$this->get_menu_title(),
-			$this->get_capability(),                   // The required capability, provided by the calling hook.
-			$this->get_menu_slug(),
-			array( $this, 'render' )
-		);
-
-		// Set a hook to enqueue scripts only when the settings page is displayed.
-		add_action( 'admin_print_scripts-' . $page, array(
-			$this,
-			'enqueue_scripts',
-		) );
-
-		// Finally return the page hook_suffix.
-		return $page;
-	}
-
-	/**
-	 * Enqueue scripts for the specific page. Subclasses can override this function
-	 * to provide their own styles/scripts.
-	 *
-	 * @since 3.11.0
-	 */
-	public function enqueue_scripts() {
-	}
-
-	/**
-	 * Render the page.
-	 */
-	public function render() {
-
-		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
-
-	}
+    /**
+     * Define the {@link Wordlift_Admin_Page} constructor.
+     *
+     * @since 3.20.0
+     */
+    public function __construct() {
+        add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
+    }
+
+    /**
+     * Get the parent slug.
+     *
+     * @return string The parent slug (default 'wl_admin_menu').
+     * @since 3.11.0
+     *
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * Get the required capability.
+     *
+     * @return string The capability (default 'manage_options').
+     * @since 3.11.0
+     *
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * Get the page title. Will be translated.
+     *
+     * @return string The page title.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_page_title();
+
+    /**
+     * Get the menu title. Will be translated.
+     *
+     * @return string The menu title.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_menu_title();
+
+    /**
+     * Get the menu slug.
+     *
+     * @return string The menu slug.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_menu_slug();
+
+    /**
+     * Get the page url.
+     *
+     * @return string The escaped url of the admin page
+     * @since 3.14.0
+     *
+     */
+    function get_url() {
+
+        // ideally should have used menu_page_url, but it is loaded later than some usages.
+        $url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
+
+        return esc_url( $url );
+    }
+
+    /**
+     * Get the partial file name, used in the {@link render} function.
+     *
+     * @return string The partial file name.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_partial_name();
+
+    /**
+     * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
+     * page to the admin menu.
+     *
+     * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
+     * @since 3.11.0
+     *
+     */
+    public function admin_menu() {
+        // Add the sub-menu page.
+        //
+        // See http://codex.wordpress.org/Function_Reference/add_submenu_page
+        $page = add_submenu_page(
+            $this->get_parent_slug(),
+            $this->get_page_title(),
+            $this->get_menu_title(),
+            $this->get_capability(),                   // The required capability, provided by the calling hook.
+            $this->get_menu_slug(),
+            array( $this, 'render' )
+        );
+
+        // Set a hook to enqueue scripts only when the settings page is displayed.
+        add_action( 'admin_print_scripts-' . $page, array(
+            $this,
+            'enqueue_scripts',
+        ) );
+
+        // Finally return the page hook_suffix.
+        return $page;
+    }
+
+    /**
+     * Enqueue scripts for the specific page. Subclasses can override this function
+     * to provide their own styles/scripts.
+     *
+     * @since 3.11.0
+     */
+    public function enqueue_scripts() {
+    }
+
+    /**
+     * Render the page.
+     */
+    public function render() {
+
+        // Include the partial.
+        include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
+
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -24,7 +24,7 @@ 
 	 * @since 3.20.0
 	 */
 	public function __construct() {
-		add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
+		add_action('admin_menu', array($this, 'admin_menu'), 10, 0);
 	}
 
 	/**
@@ -88,9 +88,9 @@ 
 	function get_url() {
 
 		// ideally should have used menu_page_url, but it is loaded later than some usages.
-		$url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
+		$url = admin_url('admin.php?page='.$this->get_menu_slug());
 
-		return esc_url( $url );
+		return esc_url($url);
 	}
 
 	/**
@@ -118,16 +118,16 @@ 
 			$this->get_parent_slug(),
 			$this->get_page_title(),
 			$this->get_menu_title(),
-			$this->get_capability(),                   // The required capability, provided by the calling hook.
+			$this->get_capability(), // The required capability, provided by the calling hook.
 			$this->get_menu_slug(),
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 
 		// Set a hook to enqueue scripts only when the settings page is displayed.
-		add_action( 'admin_print_scripts-' . $page, array(
+		add_action('admin_print_scripts-'.$page, array(
 			$this,
 			'enqueue_scripts',
-		) );
+		));
 
 		// Finally return the page hook_suffix.
 		return $page;
@@ -148,7 +148,7 @@ 
 	public function render() {
 
 		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
+		include(plugin_dir_path(__FILE__).'partials/'.$this->get_partial_name());
 
 	}