insideout10 / wordlift-plugin

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

Indentation +238 added lines, -238 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -28,126 +28,126 @@ 
  */
 class Wordlift_Admin_Setup {
 
-	/**
-	 * A {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
-	 */
-	private $key_validation_service;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.20.0
-	 * @access private
-	 * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 */
-	private $language_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since  3.20.0
-	 * @access private
-	 * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 */
-	private $country_select_element;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @param \Wordlift_Key_Validation_Service        $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
-	 * @param \Wordlift_Entity_Service                $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Country_Select_Element  $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since    3.9.0
-	 */
-	public function __construct( $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
-
-		// Set a reference to the key validation service.
-		$this->key_validation_service = $key_validation_service;
-
-		// Set a reference to the entity service.
-		$this->entity_service = $entity_service;
-
-		// Set a reference to the UI elements language and country.
-		$this->language_select_element = $language_select_element;
-		$this->country_select_element  = $country_select_element;
-
-		// Hook to some WP's events:
-		// When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
-		add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
-
-		// Hook to `admin_menu` in order to add our own setup wizard page.
-		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
-
-		// Triggered when the user accesses the admin area, we decide whether to show our own wizard.
-		add_action( 'admin_init', array( $this, 'show_page' ) );
-
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			// Hook to `admin_notices` to display our notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
-		}
-	}
-
-	/**
-	 * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
-	 *
-	 * @since 3.9.0
-	 */
-	public function admin_init() {
-
-		// If the `_wl_activation_redirect` is set, the redirect to the setup page.
-		if ( get_transient( '_wl_activation_redirect' ) ) {
-			delete_transient( '_wl_activation_redirect' );
-
-			// If the user asked to skip the wizard then comply.
-			if ( Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) {
-				return;
-			}
-
-			// If we're already on the page or the user doesn't have permissions, return.
-			if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-				return;
-			}
-
-			// Finally redirect to the setup page.
-			wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
-
-			exit;
-		}
-
-	}
-
-	/**
-	 * Generate an admin notice suggesting to start the wizard if there is no configuration.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_notices() {
-
-		// Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
-		if ( '' === Wordlift_Configuration_Service::get_instance()->get_key() && ! Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) { ?>
+    /**
+     * A {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
+     */
+    private $key_validation_service;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.20.0
+     * @access private
+     * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     */
+    private $language_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since  3.20.0
+     * @access private
+     * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     */
+    private $country_select_element;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @param \Wordlift_Key_Validation_Service        $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
+     * @param \Wordlift_Entity_Service                $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Country_Select_Element  $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since    3.9.0
+     */
+    public function __construct( $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
+
+        // Set a reference to the key validation service.
+        $this->key_validation_service = $key_validation_service;
+
+        // Set a reference to the entity service.
+        $this->entity_service = $entity_service;
+
+        // Set a reference to the UI elements language and country.
+        $this->language_select_element = $language_select_element;
+        $this->country_select_element  = $country_select_element;
+
+        // Hook to some WP's events:
+        // When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
+        add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
+
+        // Hook to `admin_menu` in order to add our own setup wizard page.
+        add_action( 'admin_menu', array( $this, 'admin_menu' ) );
+
+        // Triggered when the user accesses the admin area, we decide whether to show our own wizard.
+        add_action( 'admin_init', array( $this, 'show_page' ) );
+
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            // Hook to `admin_notices` to display our notices.
+            add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+        }
+    }
+
+    /**
+     * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
+     *
+     * @since 3.9.0
+     */
+    public function admin_init() {
+
+        // If the `_wl_activation_redirect` is set, the redirect to the setup page.
+        if ( get_transient( '_wl_activation_redirect' ) ) {
+            delete_transient( '_wl_activation_redirect' );
+
+            // If the user asked to skip the wizard then comply.
+            if ( Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) {
+                return;
+            }
+
+            // If we're already on the page or the user doesn't have permissions, return.
+            if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                return;
+            }
+
+            // Finally redirect to the setup page.
+            wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
+
+            exit;
+        }
+
+    }
+
+    /**
+     * Generate an admin notice suggesting to start the wizard if there is no configuration.
+     *
+     * @since    3.9.0
+     */
+    public function admin_notices() {
+
+        // Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
+        if ( '' === Wordlift_Configuration_Service::get_instance()->get_key() && ! Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) { ?>
 			<div id="wl-message" class="updated">
 				<p><?php esc_html_e( 'Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift' ); ?></p>
 				<p class="submit">
@@ -158,138 +158,138 @@ 
 				</p>
 			</div>
 			<?php
-		}
-
-	}
-
-	/**
-	 * Handle hiding the wizard notices by user request.
-	 *
-	 * @since    3.9.0
-	 */
-	public function hide_notices() {
-
-		// If it's not a `wl-hide-notice` or the nonce is not set, return.
-		if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
-			return;
-		}
-
-		// If the nonce is invalid, return an error.
-		if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_wl_notice_nonce'] ) ), 'wordlift_hide_notices_nonce' ) ) {
-			wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
-		}
-
-		// If the user doesn't have the right privileges, return an error.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die( esc_html__( 'Cheatin&#8217; huh?', 'wordlift' ) );
-		}
-
-		// Store a flag telling to skip the wizard.
-		Wordlift_Configuration_Service::get_instance()->set_skip_wizard( true );
-
-	}
-
-	/**
-	 * Register the wizard page to be able to access it.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_menu() {
-		/**
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/1209
-		 * @since 3.27.7
-		 */
-		// @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
-		add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
-	}
-
-	/**
-	 * Displays the wizard page.
-	 *
-	 * @since    3.9.0
-	 */
-	public function show_page() {
-
-		// First check if we are in the wizard page at all, if not do nothing.
-		if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
-			return;
-		}
-
-		// If it's a POST and the `wl-save-configuration` action is set, save the configuration.
-		if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
-
-			// Check the nonce and the user capabilities.
-			check_admin_referer( 'wl-save-configuration' );
-
-			// Check if the user has the right privileges.
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( esc_html__( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
-			}
-
-			// Save the configuration.
-			$this->save_configuration( $_POST );
-
-			// Redirect to the admin's page.
-			wp_safe_redirect( admin_url() );
-			exit();
-		}
+        }
+
+    }
+
+    /**
+     * Handle hiding the wizard notices by user request.
+     *
+     * @since    3.9.0
+     */
+    public function hide_notices() {
+
+        // If it's not a `wl-hide-notice` or the nonce is not set, return.
+        if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
+            return;
+        }
+
+        // If the nonce is invalid, return an error.
+        if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_wl_notice_nonce'] ) ), 'wordlift_hide_notices_nonce' ) ) {
+            wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
+        }
+
+        // If the user doesn't have the right privileges, return an error.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die( esc_html__( 'Cheatin&#8217; huh?', 'wordlift' ) );
+        }
+
+        // Store a flag telling to skip the wizard.
+        Wordlift_Configuration_Service::get_instance()->set_skip_wizard( true );
+
+    }
+
+    /**
+     * Register the wizard page to be able to access it.
+     *
+     * @since    3.9.0
+     */
+    public function admin_menu() {
+        /**
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/1209
+         * @since 3.27.7
+         */
+        // @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
+        add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
+    }
+
+    /**
+     * Displays the wizard page.
+     *
+     * @since    3.9.0
+     */
+    public function show_page() {
+
+        // First check if we are in the wizard page at all, if not do nothing.
+        if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
+            return;
+        }
+
+        // If it's a POST and the `wl-save-configuration` action is set, save the configuration.
+        if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
+
+            // Check the nonce and the user capabilities.
+            check_admin_referer( 'wl-save-configuration' );
+
+            // Check if the user has the right privileges.
+            if ( ! current_user_can( 'manage_options' ) ) {
+                wp_die( esc_html__( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
+            }
+
+            // Save the configuration.
+            $this->save_configuration( $_POST );
+
+            // Redirect to the admin's page.
+            wp_safe_redirect( admin_url() );
+            exit();
+        }
 
         // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$language_select = $this->language_select_element;
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$country_select = $this->country_select_element;
+        $language_select = $this->language_select_element;
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $country_select = $this->country_select_element;
 
-		include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-setup.php';
+        include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-setup.php';
 
-		exit;
-	}
+        exit;
+    }
 
-	/**
-	 * Save WordLift's configuration using the provided parameters.
-	 *
-	 * @param array $params An array of configuration parameters.
-	 *
-	 * @since 3.9.0
-	 */
-	public function save_configuration( $params ) {
+    /**
+     * Save WordLift's configuration using the provided parameters.
+     *
+     * @param array $params An array of configuration parameters.
+     *
+     * @since 3.9.0
+     */
+    public function save_configuration( $params ) {
 
-		// We have the following parameters:
-		// `key`, holding WL's key,
-		// `vocabulary`, holding the vocabulary path,
-		// `wl-country-code` with the country code (e.g. `us`),
-		// `share-diagnostic`, the user preferences about sharing data with us.
-		// `user_type`, the user type either `personal` or `company`,
-		// `name`, with the `personal` or `company`'s name,
-		// `logo`, the attachment id for the `personal` or `company` entity.
+        // We have the following parameters:
+        // `key`, holding WL's key,
+        // `vocabulary`, holding the vocabulary path,
+        // `wl-country-code` with the country code (e.g. `us`),
+        // `share-diagnostic`, the user preferences about sharing data with us.
+        // `user_type`, the user type either `personal` or `company`,
+        // `name`, with the `personal` or `company`'s name,
+        // `logo`, the attachment id for the `personal` or `company` entity.
 
-		// Store the key:
-		Wordlift_Configuration_Service::get_instance()->set_key( $params['key'] );
+        // Store the key:
+        Wordlift_Configuration_Service::get_instance()->set_key( $params['key'] );
 
-		// Store the vocabulary path:
-		Wordlift_Configuration_Service::get_instance()->set_entity_base_path( $params['vocabulary'] );
+        // Store the vocabulary path:
+        Wordlift_Configuration_Service::get_instance()->set_entity_base_path( $params['vocabulary'] );
 
-		// Store the site's country:
-		Wordlift_Configuration_Service::get_instance()->set_country_code( $params['wl-country-code'] );
+        // Store the site's country:
+        Wordlift_Configuration_Service::get_instance()->set_country_code( $params['wl-country-code'] );
 
-		// Store the preferences in variable, because if the checkbox is not checked
-		// the `share-diagnostic` will not exists in `$params` array.
-		$share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
+        // Store the preferences in variable, because if the checkbox is not checked
+        // the `share-diagnostic` will not exists in `$params` array.
+        $share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
 
-		// Store the diagnostic preferences:
-		Wordlift_Configuration_Service::get_instance()->set_diagnostic_preferences( $share_diagnostic_preferences );
+        // Store the diagnostic preferences:
+        Wordlift_Configuration_Service::get_instance()->set_diagnostic_preferences( $share_diagnostic_preferences );
 
-		// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-		$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
+        // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+        $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
 
-		// Create an entity for the publisher.
-		$publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
+        // Create an entity for the publisher.
+        $publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
 
-		// Store the publisher entity post id in the configuration.
-		Wordlift_Configuration_Service::get_instance()->set_publisher_id( $publisher_post_id );
+        // Store the publisher entity post id in the configuration.
+        Wordlift_Configuration_Service::get_instance()->set_publisher_id( $publisher_post_id );
 
-		flush_rewrite_rules(); // Needed because of possible change to the entity base path.
+        flush_rewrite_rules(); // Needed because of possible change to the entity base path.
 
-	}
+    }
 
 }

Spacing +41 added lines, -41 removed lines

@@ -12,7 +12,7 @@ 
  * @since      3.9.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -74,7 +74,7 @@ 
 	 *
 	 * @since    3.9.0
 	 */
-	public function __construct( $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
+	public function __construct($key_validation_service, $entity_service, $language_select_element, $country_select_element) {
 
 		// Set a reference to the key validation service.
 		$this->key_validation_service = $key_validation_service;
@@ -88,13 +88,13 @@ 
 
 		// Hook to some WP's events:
 		// When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
-		add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
+		add_action('wp_loaded', array($this, 'hide_notices'));
 
 		// Hook to `admin_menu` in order to add our own setup wizard page.
-		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
+		add_action('admin_menu', array($this, 'admin_menu'));
 
 		// Triggered when the user accesses the admin area, we decide whether to show our own wizard.
-		add_action( 'admin_init', array( $this, 'show_page' ) );
+		add_action('admin_init', array($this, 'show_page'));
 
 		/**
 		 * Filter: wl_feature__enable__notices.
@@ -104,9 +104,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+		if (apply_filters('wl_feature__enable__notices', true)) {
 			// Hook to `admin_notices` to display our notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+			add_action('admin_notices', array($this, 'admin_notices'));
 		}
 	}
 
@@ -118,21 +118,21 @@ 
 	public function admin_init() {
 
 		// If the `_wl_activation_redirect` is set, the redirect to the setup page.
-		if ( get_transient( '_wl_activation_redirect' ) ) {
-			delete_transient( '_wl_activation_redirect' );
+		if (get_transient('_wl_activation_redirect')) {
+			delete_transient('_wl_activation_redirect');
 
 			// If the user asked to skip the wizard then comply.
-			if ( Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) {
+			if (Wordlift_Configuration_Service::get_instance()->is_skip_wizard()) {
 				return;
 			}
 
 			// If we're already on the page or the user doesn't have permissions, return.
-			if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			if (( ! empty($_GET['page']) && 'wl-setup' === $_GET['page']) || is_network_admin() || isset($_GET['activate-multi']) || ! current_user_can('manage_options')) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 				return;
 			}
 
 			// Finally redirect to the setup page.
-			wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
+			wp_safe_redirect(admin_url('index.php?page=wl-setup'));
 
 			exit;
 		}
@@ -147,14 +147,14 @@ 
 	public function admin_notices() {
 
 		// Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
-		if ( '' === Wordlift_Configuration_Service::get_instance()->get_key() && ! Wordlift_Configuration_Service::get_instance()->is_skip_wizard() ) { ?>
+		if ('' === Wordlift_Configuration_Service::get_instance()->get_key() && ! Wordlift_Configuration_Service::get_instance()->is_skip_wizard()) { ?>
 			<div id="wl-message" class="updated">
-				<p><?php esc_html_e( 'Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift' ); ?></p>
+				<p><?php esc_html_e('Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift'); ?></p>
 				<p class="submit">
-					<a href="<?php echo esc_url( admin_url( 'admin.php?page=wl-setup' ) ); ?>"
-					   class="button-primary"><?php esc_html_e( 'Run the Setup Wizard', 'wordlift' ); ?></a>
+					<a href="<?php echo esc_url(admin_url('admin.php?page=wl-setup')); ?>"
+					   class="button-primary"><?php esc_html_e('Run the Setup Wizard', 'wordlift'); ?></a>
 					<a class="button-secondary skip"
-					   href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'wl-hide-notice', 'install' ), 'wordlift_hide_notices_nonce', '_wl_notice_nonce' ) ); ?>"><?php esc_html_e( 'Skip Setup', 'wordlift' ); ?></a>
+					   href="<?php echo esc_url(wp_nonce_url(add_query_arg('wl-hide-notice', 'install'), 'wordlift_hide_notices_nonce', '_wl_notice_nonce')); ?>"><?php esc_html_e('Skip Setup', 'wordlift'); ?></a>
 				</p>
 			</div>
 			<?php
@@ -170,22 +170,22 @@ 
 	public function hide_notices() {
 
 		// If it's not a `wl-hide-notice` or the nonce is not set, return.
-		if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
+		if ( ! isset($_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'])) {
 			return;
 		}
 
 		// If the nonce is invalid, return an error.
-		if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_wl_notice_nonce'] ) ), 'wordlift_hide_notices_nonce' ) ) {
-			wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
+		if ( ! wp_verify_nonce(sanitize_text_field(wp_unslash($_GET['_wl_notice_nonce'])), 'wordlift_hide_notices_nonce')) {
+			wp_die(esc_html__('Action failed. Please refresh the page and retry.', 'wordlift'));
 		}
 
 		// If the user doesn't have the right privileges, return an error.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die( esc_html__( 'Cheatin&#8217; huh?', 'wordlift' ) );
+		if ( ! current_user_can('manage_options')) {
+			wp_die(esc_html__('Cheatin&#8217; huh?', 'wordlift'));
 		}
 
 		// Store a flag telling to skip the wizard.
-		Wordlift_Configuration_Service::get_instance()->set_skip_wizard( true );
+		Wordlift_Configuration_Service::get_instance()->set_skip_wizard(true);
 
 	}
 
@@ -201,7 +201,7 @@ 
 		 * @since 3.27.7
 		 */
 		// @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
-		add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
+		add_dashboard_page('', '', 'manage_options', 'wl-setup', '');
 	}
 
 	/**
@@ -212,26 +212,26 @@ 
 	public function show_page() {
 
 		// First check if we are in the wizard page at all, if not do nothing.
-		if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
+		if (empty($_GET['page']) || 'wl-setup' !== $_GET['page']) {
 			return;
 		}
 
 		// If it's a POST and the `wl-save-configuration` action is set, save the configuration.
-		if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
+		if (isset($_POST['action']) && 'wl-save-configuration' === $_POST['action']) {
 
 			// Check the nonce and the user capabilities.
-			check_admin_referer( 'wl-save-configuration' );
+			check_admin_referer('wl-save-configuration');
 
 			// Check if the user has the right privileges.
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( esc_html__( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
+			if ( ! current_user_can('manage_options')) {
+				wp_die(esc_html__('Sorry, you do not have a permission to save the settings', 'wordlift'));
 			}
 
 			// Save the configuration.
-			$this->save_configuration( $_POST );
+			$this->save_configuration($_POST);
 
 			// Redirect to the admin's page.
-			wp_safe_redirect( admin_url() );
+			wp_safe_redirect(admin_url());
 			exit();
 		}
 
@@ -240,7 +240,7 @@ 
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		$country_select = $this->country_select_element;
 
-		include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-setup.php';
+		include plugin_dir_path(__DIR__).'admin/partials/wordlift-admin-setup.php';
 
 		exit;
 	}
@@ -252,7 +252,7 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function save_configuration( $params ) {
+	public function save_configuration($params) {
 
 		// We have the following parameters:
 		// `key`, holding WL's key,
@@ -264,29 +264,29 @@ 
 		// `logo`, the attachment id for the `personal` or `company` entity.
 
 		// Store the key:
-		Wordlift_Configuration_Service::get_instance()->set_key( $params['key'] );
+		Wordlift_Configuration_Service::get_instance()->set_key($params['key']);
 
 		// Store the vocabulary path:
-		Wordlift_Configuration_Service::get_instance()->set_entity_base_path( $params['vocabulary'] );
+		Wordlift_Configuration_Service::get_instance()->set_entity_base_path($params['vocabulary']);
 
 		// Store the site's country:
-		Wordlift_Configuration_Service::get_instance()->set_country_code( $params['wl-country-code'] );
+		Wordlift_Configuration_Service::get_instance()->set_country_code($params['wl-country-code']);
 
 		// Store the preferences in variable, because if the checkbox is not checked
 		// the `share-diagnostic` will not exists in `$params` array.
-		$share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
+		$share_diagnostic_preferences = empty($params['share-diagnostic']) ? 'no' : 'yes';
 
 		// Store the diagnostic preferences:
-		Wordlift_Configuration_Service::get_instance()->set_diagnostic_preferences( $share_diagnostic_preferences );
+		Wordlift_Configuration_Service::get_instance()->set_diagnostic_preferences($share_diagnostic_preferences);
 
 		// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-		$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
+		$type_uri = sprintf('http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person');
 
 		// Create an entity for the publisher.
-		$publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
+		$publisher_post_id = $this->entity_service->create($params['name'], $type_uri, $params['logo'], 'publish');
 
 		// Store the publisher entity post id in the configuration.
-		Wordlift_Configuration_Service::get_instance()->set_publisher_id( $publisher_post_id );
+		Wordlift_Configuration_Service::get_instance()->set_publisher_id($publisher_post_id);
 
 		flush_rewrite_rules(); // Needed because of possible change to the entity base path.
 

src/admin/class-wordlift-notice-service.php

Indentation +189 added lines, -189 removed lines

@@ -7,194 +7,194 @@
  */
 class Wordlift_Notice_Service {
 
-	/**
-	 * The template used to display notices. The <em>notice dismissible</em> style classes make this notice dismissible
-	 * on the WordPress UI (via a small X button on the right side of the notice).
-	 *
-	 * @since 3.2.0
-	 */
-	const TEMPLATE = '<div class="wl-notice notice is-dismissible %s"><p>%s</p></div>';
-
-	/**
-	 * The standard WordPress <em>update</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const UPDATE = 'update';
-
-	/**
-	 * The standard WordPress <em>update-nag</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const UPDATE_NAG = 'update-nag';
-
-	/**
-	 * The standard WordPress <em>error</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const ERROR = 'error';
-
-	/**
-	 * A custom WordLift css style class used for WordLift suggestions.
-	 *
-	 * @since 3.3.0
-	 */
-	const SUGGESTION = 'wl-suggestion';
-
-	/**
-	 * The array of notices.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var array $notices The array of notices.
-	 */
-	private $notices = array();
-
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create an instance of the Notice service.
-	 *
-	 * @since 3.2.0
-	 */
-	public function __construct() {
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			// Hook to be called when to display notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
-		}
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Notice_Service The singleton instance of the Notice service.
-	 * @since 3.2.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Add a notice.
-	 *
-	 * @param string $class The css class.
-	 * @param string $message The message.
-	 *
-	 * @since 3.2.0
-	 */
-	public function add( $class, $message ) {
-
-		$this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
-
-	}
-
-	/**
-	 * Add an update notice (message with a white background and a green left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 */
-	public function add_update( $message ) {
-
-		$this->add( self::UPDATE, $message );
-
-	}
-
-	/**
-	 * Add an update nag notice (message with a white background and a yellow left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 */
-	public function add_update_nag( $message ) {
-
-		$this->add( self::UPDATE_NAG, $message );
-
-	}
-
-	/**
-	 * Add an error notice (message with a white background and a red left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 */
-	public function add_error( $message ) {
-
-		$this->add( self::ERROR, $message );
-
-	}
-
-	/**
-	 * Add a suggestion notice (message with a white background and a WordLift brand colored left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.3.0
-	 */
-	public function add_suggestion( $message ) {
-
-		$this->add( self::SUGGESTION, $message );
-
-	}
-
-	/**
-	 * Print out the notices when the admin_notices action is called.
-	 *
-	 * @since 3.2.0
-	 */
-	public function admin_notices() {
-
-		foreach ( $this->notices as $notice ) {
-			echo wp_kses(
-				$notice,
-				array(
-					'div' => array( 'class' => array() ),
-					'p'   => array(),
-				)
-			);
-		}
-
-	}
-
-	/**
-	 * Transform message depending on message type. Return a string
-	 *
-	 * @param string $message The message.
-	 *
-	 * @since 3.3.0
-	 */
-	private function transform( $message ) {
-
-		switch ( gettype( $message ) ) {
-			case 'array':
-				return implode( '<br />', $message );
-			default:
-				return $message;
-		}
-
-	}
+    /**
+     * The template used to display notices. The <em>notice dismissible</em> style classes make this notice dismissible
+     * on the WordPress UI (via a small X button on the right side of the notice).
+     *
+     * @since 3.2.0
+     */
+    const TEMPLATE = '<div class="wl-notice notice is-dismissible %s"><p>%s</p></div>';
+
+    /**
+     * The standard WordPress <em>update</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const UPDATE = 'update';
+
+    /**
+     * The standard WordPress <em>update-nag</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const UPDATE_NAG = 'update-nag';
+
+    /**
+     * The standard WordPress <em>error</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const ERROR = 'error';
+
+    /**
+     * A custom WordLift css style class used for WordLift suggestions.
+     *
+     * @since 3.3.0
+     */
+    const SUGGESTION = 'wl-suggestion';
+
+    /**
+     * The array of notices.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var array $notices The array of notices.
+     */
+    private $notices = array();
+
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
+     */
+    private static $instance;
+
+    /**
+     * Create an instance of the Notice service.
+     *
+     * @since 3.2.0
+     */
+    public function __construct() {
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            // Hook to be called when to display notices.
+            add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+        }
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Notice_Service The singleton instance of the Notice service.
+     * @since 3.2.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Add a notice.
+     *
+     * @param string $class The css class.
+     * @param string $message The message.
+     *
+     * @since 3.2.0
+     */
+    public function add( $class, $message ) {
+
+        $this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
+
+    }
+
+    /**
+     * Add an update notice (message with a white background and a green left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     */
+    public function add_update( $message ) {
+
+        $this->add( self::UPDATE, $message );
+
+    }
+
+    /**
+     * Add an update nag notice (message with a white background and a yellow left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     */
+    public function add_update_nag( $message ) {
+
+        $this->add( self::UPDATE_NAG, $message );
+
+    }
+
+    /**
+     * Add an error notice (message with a white background and a red left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     */
+    public function add_error( $message ) {
+
+        $this->add( self::ERROR, $message );
+
+    }
+
+    /**
+     * Add a suggestion notice (message with a white background and a WordLift brand colored left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.3.0
+     */
+    public function add_suggestion( $message ) {
+
+        $this->add( self::SUGGESTION, $message );
+
+    }
+
+    /**
+     * Print out the notices when the admin_notices action is called.
+     *
+     * @since 3.2.0
+     */
+    public function admin_notices() {
+
+        foreach ( $this->notices as $notice ) {
+            echo wp_kses(
+                $notice,
+                array(
+                    'div' => array( 'class' => array() ),
+                    'p'   => array(),
+                )
+            );
+        }
+
+    }
+
+    /**
+     * Transform message depending on message type. Return a string
+     *
+     * @param string $message The message.
+     *
+     * @since 3.3.0
+     */
+    private function transform( $message ) {
+
+        switch ( gettype( $message ) ) {
+            case 'array':
+                return implode( '<br />', $message );
+            default:
+                return $message;
+        }
+
+    }
 
 }

Spacing +17 added lines, -17 removed lines

@@ -75,9 +75,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+		if (apply_filters('wl_feature__enable__notices', true)) {
 			// Hook to be called when to display notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+			add_action('admin_notices', array($this, 'admin_notices'));
 		}
 		self::$instance = $this;
 
@@ -102,9 +102,9 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function add( $class, $message ) {
+	public function add($class, $message) {
 
-		$this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
+		$this->notices[] = sprintf(self::TEMPLATE, $class, $this->transform($message));
 
 	}
 
@@ -115,9 +115,9 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function add_update( $message ) {
+	public function add_update($message) {
 
-		$this->add( self::UPDATE, $message );
+		$this->add(self::UPDATE, $message);
 
 	}
 
@@ -128,9 +128,9 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function add_update_nag( $message ) {
+	public function add_update_nag($message) {
 
-		$this->add( self::UPDATE_NAG, $message );
+		$this->add(self::UPDATE_NAG, $message);
 
 	}
 
@@ -141,9 +141,9 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function add_error( $message ) {
+	public function add_error($message) {
 
-		$this->add( self::ERROR, $message );
+		$this->add(self::ERROR, $message);
 
 	}
 
@@ -154,9 +154,9 @@ 
 	 *
 	 * @since 3.3.0
 	 */
-	public function add_suggestion( $message ) {
+	public function add_suggestion($message) {
 
-		$this->add( self::SUGGESTION, $message );
+		$this->add(self::SUGGESTION, $message);
 
 	}
 
@@ -167,11 +167,11 @@ 
 	 */
 	public function admin_notices() {
 
-		foreach ( $this->notices as $notice ) {
+		foreach ($this->notices as $notice) {
 			echo wp_kses(
 				$notice,
 				array(
-					'div' => array( 'class' => array() ),
+					'div' => array('class' => array()),
 					'p'   => array(),
 				)
 			);
@@ -186,11 +186,11 @@ 
 	 *
 	 * @since 3.3.0
 	 */
-	private function transform( $message ) {
+	private function transform($message) {
 
-		switch ( gettype( $message ) ) {
+		switch (gettype($message)) {
 			case 'array':
-				return implode( '<br />', $message );
+				return implode('<br />', $message);
 			default:
 				return $message;
 		}

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

Indentation +128 added lines, -128 removed lines

@@ -18,133 +18,133 @@
  */
 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 public function get_page_title();
-
-	/**
-	 * Get the menu title. Will be translated.
-	 *
-	 * @return string The menu title.
-	 * @since 3.11.0
-	 */
-	abstract public function get_menu_title();
-
-	/**
-	 * Get the menu slug.
-	 *
-	 * @return string The menu slug.
-	 * @since 3.11.0
-	 */
-	abstract public function get_menu_slug();
-
-	/**
-	 * Get the page url.
-	 *
-	 * @return string The escaped url of the admin page
-	 * @since 3.14.0
-	 */
-	public 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 public 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 public function get_page_title();
+
+    /**
+     * Get the menu title. Will be translated.
+     *
+     * @return string The menu title.
+     * @since 3.11.0
+     */
+    abstract public function get_menu_title();
+
+    /**
+     * Get the menu slug.
+     *
+     * @return string The menu slug.
+     * @since 3.11.0
+     */
+    abstract public function get_menu_slug();
+
+    /**
+     * Get the page url.
+     *
+     * @return string The escaped url of the admin page
+     * @since 3.14.0
+     */
+    public 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 public 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 +7 added lines, -7 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);
 	}
 
 	/**
@@ -82,9 +82,9 @@ 
 	public 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);
 	}
 
 	/**
@@ -110,14 +110,14 @@ 
 			$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,
+			'admin_print_scripts-'.$page,
 			array(
 				$this,
 				'enqueue_scripts',
@@ -143,7 +143,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();
 
 	}
 

src/admin/elements/class-wordlift-admin-author-element.php

Indentation +120 added lines, -120 removed lines

@@ -19,125 +19,125 @@
  */
 class Wordlift_Admin_Author_Element implements Wordlift_Admin_Element {
 
-	/**
-	 * The {@link Wordlift_Publisher_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
-	 */
-	private $publisher_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Select2_Element} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Admin_Select2_Element $select_element A {@link Wordlift_Admin_Select2_Element} instance.
-	 */
-	private $select_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Person_Element} instance.
-	 *
-	 * @param \Wordlift_Publisher_Service     $publisher_service The {@link Wordlift_Publisher_Service} instance.
-	 * @param \Wordlift_Admin_Select2_Element $select_element The {@link Wordlift_Admin_Select_Element} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct( $publisher_service, $select_element ) {
-
-		$this->publisher_service = $publisher_service;
-
-		// Child elements.
-		$this->select_element = $select_element;
-
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function render( $args ) {
-
-		// Parse the arguments and merge with default values.
-		$params = wp_parse_args(
-			$args,
-			array(
-				'id'             => uniqid( 'wl-input-' ),
-				'name'           => uniqid( 'wl-input-' ),
-				'current_entity' => 0,
-			)
-		);
-
-		$current_entity_id = $params['current_entity'];
-		$data              = $this->publisher_service->query();
-
-		// Set a default to show when no entity is associated and a way to unassign.
-		array_unshift(
-			$data,
-			array(
-				'id'            => '0',
-				'text'          => '<em>' . __( '(none)', 'wordlift' ) . '</em>',
-				'type'          => '',
-				'thumbnail_url' => plugin_dir_url( __DIR__ ) . 'images/pixel.png',
-			)
-		);
-
-		// Finally do the render, passing along also the current selected entity
-		// id and the options data.
-		return $this->do_render( $params, $current_entity_id, $data );
-	}
-
-	/**
-	 * Render the `select` using the provided parameters.
-	 *
-	 * @param array $params The array of parameters from the `render` function.
-	 * @param int   $current_post_id The currently selected {@link WP_Post} `id`.
-	 * @param array $data An array of Select2 options.
-	 *
-	 * @return \Wordlift_Admin_Author_Element $this Return this element.
-	 * @since 3.14.0
-	 */
-	protected function do_render( $params, $current_post_id, $data ) {
-
-		// Queue the script which will initialize the select and style it.
-		wp_enqueue_script( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.js', array( 'wordlift-select2' ), WORDLIFT_VERSION, false );
-		wp_enqueue_style( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.css', array(), WORDLIFT_VERSION );
-
-		// Prepare the URLs for entities which don't have logos.
-		$person_thumbnail_url       = plugin_dir_url( __DIR__ ) . '../images/person.png';
-		$organization_thumbnail_url = plugin_dir_url( __DIR__ ) . '../images/organization.png';
-
-		// Get the current post.
-		$current_post = $current_post_id ? get_post( $current_post_id ) : null;
-
-		// Finally render the Select.
-		$this->select_element->render(
-			array(
-				// Id.
-				'id'      => $params['id'],
-				// Name.
-				'name'    => $params['name'],
-				// Class names.
-				'class'   => 'wl-select2-element',
-				// The selected id.
-				'value'   => $current_post_id,
-				// The selected item (must be in the options for Select2 to display it).
-				'options' => $current_post ? array( $current_post->ID => $current_post->post_title ) : array(),
-				// Data attributes.
-				'data'    => array(
-					// The list of available options.
-					'wl-select2-data'               => wp_json_encode( $data ),
-					// The HTML template for each option.
-					'wl-select2-template-result'    => "<div class='wl-select2-result'><span class='wl-select2-thumbnail' style='background-image: url( <%- obj.thumbnail_url || ( 'Organization' === obj.type ? '$organization_thumbnail_url' : '$person_thumbnail_url' ) %> );'>&nbsp;</span><span class='wl-select2'><%- obj.text %></span><span class='wl-select2-type'><%- obj.type %></span></div>",
-					// The HTML template for the selected option.
-					'wl-select2-template-selection' => "<div class='wl-select2-selection'><span class='wl-select2-thumbnail' style='background-image: url( <%- obj.thumbnail_url || ( 'Organization' === obj.type ? '$organization_thumbnail_url' : '$person_thumbnail_url' ) %> );'>&nbsp;</span><span class='wl-select2'><%- obj.text %></span><span class='wl-select2-type'><%- obj.type %></span></div>",
-				),
-			)
-		);
-
-		// Finally return the element instance.
-		return $this;
-	}
+    /**
+     * The {@link Wordlift_Publisher_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
+     */
+    private $publisher_service;
+
+    /**
+     * A {@link Wordlift_Admin_Select2_Element} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Admin_Select2_Element $select_element A {@link Wordlift_Admin_Select2_Element} instance.
+     */
+    private $select_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Person_Element} instance.
+     *
+     * @param \Wordlift_Publisher_Service     $publisher_service The {@link Wordlift_Publisher_Service} instance.
+     * @param \Wordlift_Admin_Select2_Element $select_element The {@link Wordlift_Admin_Select_Element} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct( $publisher_service, $select_element ) {
+
+        $this->publisher_service = $publisher_service;
+
+        // Child elements.
+        $this->select_element = $select_element;
+
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function render( $args ) {
+
+        // Parse the arguments and merge with default values.
+        $params = wp_parse_args(
+            $args,
+            array(
+                'id'             => uniqid( 'wl-input-' ),
+                'name'           => uniqid( 'wl-input-' ),
+                'current_entity' => 0,
+            )
+        );
+
+        $current_entity_id = $params['current_entity'];
+        $data              = $this->publisher_service->query();
+
+        // Set a default to show when no entity is associated and a way to unassign.
+        array_unshift(
+            $data,
+            array(
+                'id'            => '0',
+                'text'          => '<em>' . __( '(none)', 'wordlift' ) . '</em>',
+                'type'          => '',
+                'thumbnail_url' => plugin_dir_url( __DIR__ ) . 'images/pixel.png',
+            )
+        );
+
+        // Finally do the render, passing along also the current selected entity
+        // id and the options data.
+        return $this->do_render( $params, $current_entity_id, $data );
+    }
+
+    /**
+     * Render the `select` using the provided parameters.
+     *
+     * @param array $params The array of parameters from the `render` function.
+     * @param int   $current_post_id The currently selected {@link WP_Post} `id`.
+     * @param array $data An array of Select2 options.
+     *
+     * @return \Wordlift_Admin_Author_Element $this Return this element.
+     * @since 3.14.0
+     */
+    protected function do_render( $params, $current_post_id, $data ) {
+
+        // Queue the script which will initialize the select and style it.
+        wp_enqueue_script( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.js', array( 'wordlift-select2' ), WORDLIFT_VERSION, false );
+        wp_enqueue_style( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.css', array(), WORDLIFT_VERSION );
+
+        // Prepare the URLs for entities which don't have logos.
+        $person_thumbnail_url       = plugin_dir_url( __DIR__ ) . '../images/person.png';
+        $organization_thumbnail_url = plugin_dir_url( __DIR__ ) . '../images/organization.png';
+
+        // Get the current post.
+        $current_post = $current_post_id ? get_post( $current_post_id ) : null;
+
+        // Finally render the Select.
+        $this->select_element->render(
+            array(
+                // Id.
+                'id'      => $params['id'],
+                // Name.
+                'name'    => $params['name'],
+                // Class names.
+                'class'   => 'wl-select2-element',
+                // The selected id.
+                'value'   => $current_post_id,
+                // The selected item (must be in the options for Select2 to display it).
+                'options' => $current_post ? array( $current_post->ID => $current_post->post_title ) : array(),
+                // Data attributes.
+                'data'    => array(
+                    // The list of available options.
+                    'wl-select2-data'               => wp_json_encode( $data ),
+                    // The HTML template for each option.
+                    'wl-select2-template-result'    => "<div class='wl-select2-result'><span class='wl-select2-thumbnail' style='background-image: url( <%- obj.thumbnail_url || ( 'Organization' === obj.type ? '$organization_thumbnail_url' : '$person_thumbnail_url' ) %> );'>&nbsp;</span><span class='wl-select2'><%- obj.text %></span><span class='wl-select2-type'><%- obj.type %></span></div>",
+                    // The HTML template for the selected option.
+                    'wl-select2-template-selection' => "<div class='wl-select2-selection'><span class='wl-select2-thumbnail' style='background-image: url( <%- obj.thumbnail_url || ( 'Organization' === obj.type ? '$organization_thumbnail_url' : '$person_thumbnail_url' ) %> );'>&nbsp;</span><span class='wl-select2'><%- obj.text %></span><span class='wl-select2-type'><%- obj.type %></span></div>",
+                ),
+            )
+        );
+
+        // Finally return the element instance.
+        return $this;
+    }
 
 }

Spacing +15 added lines, -15 removed lines

@@ -45,7 +45,7 @@ 
 	 *
 	 * @since 3.14.0
 	 */
-	public function __construct( $publisher_service, $select_element ) {
+	public function __construct($publisher_service, $select_element) {
 
 		$this->publisher_service = $publisher_service;
 
@@ -57,14 +57,14 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function render( $args ) {
+	public function render($args) {
 
 		// Parse the arguments and merge with default values.
 		$params = wp_parse_args(
 			$args,
 			array(
-				'id'             => uniqid( 'wl-input-' ),
-				'name'           => uniqid( 'wl-input-' ),
+				'id'             => uniqid('wl-input-'),
+				'name'           => uniqid('wl-input-'),
 				'current_entity' => 0,
 			)
 		);
@@ -77,15 +77,15 @@ 
 			$data,
 			array(
 				'id'            => '0',
-				'text'          => '<em>' . __( '(none)', 'wordlift' ) . '</em>',
+				'text'          => '<em>'.__('(none)', 'wordlift').'</em>',
 				'type'          => '',
-				'thumbnail_url' => plugin_dir_url( __DIR__ ) . 'images/pixel.png',
+				'thumbnail_url' => plugin_dir_url(__DIR__).'images/pixel.png',
 			)
 		);
 
 		// Finally do the render, passing along also the current selected entity
 		// id and the options data.
-		return $this->do_render( $params, $current_entity_id, $data );
+		return $this->do_render($params, $current_entity_id, $data);
 	}
 
 	/**
@@ -98,18 +98,18 @@ 
 	 * @return \Wordlift_Admin_Author_Element $this Return this element.
 	 * @since 3.14.0
 	 */
-	protected function do_render( $params, $current_post_id, $data ) {
+	protected function do_render($params, $current_post_id, $data) {
 
 		// Queue the script which will initialize the select and style it.
-		wp_enqueue_script( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.js', array( 'wordlift-select2' ), WORDLIFT_VERSION, false );
-		wp_enqueue_style( 'wl-author-element', plugin_dir_url( __DIR__ ) . 'js/1/author.css', array(), WORDLIFT_VERSION );
+		wp_enqueue_script('wl-author-element', plugin_dir_url(__DIR__).'js/1/author.js', array('wordlift-select2'), WORDLIFT_VERSION, false);
+		wp_enqueue_style('wl-author-element', plugin_dir_url(__DIR__).'js/1/author.css', array(), WORDLIFT_VERSION);
 
 		// Prepare the URLs for entities which don't have logos.
-		$person_thumbnail_url       = plugin_dir_url( __DIR__ ) . '../images/person.png';
-		$organization_thumbnail_url = plugin_dir_url( __DIR__ ) . '../images/organization.png';
+		$person_thumbnail_url       = plugin_dir_url(__DIR__).'../images/person.png';
+		$organization_thumbnail_url = plugin_dir_url(__DIR__).'../images/organization.png';
 
 		// Get the current post.
-		$current_post = $current_post_id ? get_post( $current_post_id ) : null;
+		$current_post = $current_post_id ? get_post($current_post_id) : null;
 
 		// Finally render the Select.
 		$this->select_element->render(
@@ -123,11 +123,11 @@ 
 				// The selected id.
 				'value'   => $current_post_id,
 				// The selected item (must be in the options for Select2 to display it).
-				'options' => $current_post ? array( $current_post->ID => $current_post->post_title ) : array(),
+				'options' => $current_post ? array($current_post->ID => $current_post->post_title) : array(),
 				// Data attributes.
 				'data'    => array(
 					// The list of available options.
-					'wl-select2-data'               => wp_json_encode( $data ),
+					'wl-select2-data'               => wp_json_encode($data),
 					// The HTML template for each option.
 					'wl-select2-template-result'    => "<div class='wl-select2-result'><span class='wl-select2-thumbnail' style='background-image: url( <%- obj.thumbnail_url || ( 'Organization' === obj.type ? '$organization_thumbnail_url' : '$person_thumbnail_url' ) %> );'>&nbsp;</span><span class='wl-select2'><%- obj.text %></span><span class='wl-select2-type'><%- obj.type %></span></div>",
 					// The HTML template for the selected option.

src/admin/elements/class-wordlift-admin-radio-input-element.php

Indentation +42 added lines, -42 removed lines

@@ -18,54 +18,54 @@ 
  */
 class Wordlift_Admin_Radio_Input_Element implements Wordlift_Admin_Element {
 
-	/**
-	 * Output the HTML for an input box type settings_page.
-	 *
-	 * @param array $args {
-	 *                           An array of arguments.
-	 *
-	 * @type string $name The name attribute of the input element. Mandatory.
-	 * @type string $id The id attribute of the input element. Optional,
-	 *                           randomly generated one is used if not supplied.
-	 * @type string $value The value of the input element. Optional, defaults
-	 *                           to empty string.
-	 * @type string $css_class The class attribute for the input element. If empty
-	 *                           string no class attribute will be added. Optional,
-	 *                           defaults to empty string.
-	 * @type string $description The description text to be displayed below the element.
-	 *                           Can include some HTML element. If empty string no
-	 *                           description will be displayed. Optional, defaults to
-	 *                           empty string.
-	 * }
-	 * @return $this|Wordlift_Admin_Element
-	 * @since      3.13.0
-	 */
-	public function render( $args ) {
-		/*
+    /**
+     * Output the HTML for an input box type settings_page.
+     *
+     * @param array $args {
+     *                           An array of arguments.
+     *
+     * @type string $name The name attribute of the input element. Mandatory.
+     * @type string $id The id attribute of the input element. Optional,
+     *                           randomly generated one is used if not supplied.
+     * @type string $value The value of the input element. Optional, defaults
+     *                           to empty string.
+     * @type string $css_class The class attribute for the input element. If empty
+     *                           string no class attribute will be added. Optional,
+     *                           defaults to empty string.
+     * @type string $description The description text to be displayed below the element.
+     *                           Can include some HTML element. If empty string no
+     *                           description will be displayed. Optional, defaults to
+     *                           empty string.
+     * }
+     * @return $this|Wordlift_Admin_Element
+     * @since      3.13.0
+     */
+    public function render( $args ) {
+        /*
 		 * Parse the arguments and merge with default values.
 		 * Name intentionally do not have a default as it has to be in SyncEvent
 		 * with form handling code
 		 */
-		$params = wp_parse_args(
-			$args,
-			array(
-				'id'          => uniqid( 'wl-input-' ),
-				'value'       => '',
-				'css_class'   => '',
-				'description' => '',
-			)
-		);
+        $params = wp_parse_args(
+            $args,
+            array(
+                'id'          => uniqid( 'wl-input-' ),
+                'value'       => '',
+                'css_class'   => '',
+                'description' => '',
+            )
+        );
 
-		// Set the readonly and class attributes and the description.
-		$value = $params['value'];
-		?>
+        // Set the readonly and class attributes and the description.
+        $value = $params['value'];
+        ?>
 
 		<input type="radio" id="<?php echo esc_attr( $params['id'] ); ?>"
 			   name="<?php echo esc_attr( $params['name'] ); ?>"
 			   value="yes" 
 			   <?php
-				if ( ! empty( $params['css_class'] ) ) {
-					?>
+                if ( ! empty( $params['css_class'] ) ) {
+                    ?>
 					 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
 			<?php checked( $value, 'yes' ); ?>
 		/> Yes
@@ -73,8 +73,8 @@ 
 			   name="<?php echo esc_attr( $params['name'] ); ?>"
 			   value="no" 
 			   <?php
-				if ( ! empty( $params['css_class'] ) ) {
-					?>
+                if ( ! empty( $params['css_class'] ) ) {
+                    ?>
 					 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
 			<?php checked( $value, 'no' ); ?>
 		/> No
@@ -82,7 +82,7 @@ 
 			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
 		<?php
 
-		return $this;
-	}
+        return $this;
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -40,7 +40,7 @@ 
 	 * @return $this|Wordlift_Admin_Element
 	 * @since      3.13.0
 	 */
-	public function render( $args ) {
+	public function render($args) {
 		/*
 		 * Parse the arguments and merge with default values.
 		 * Name intentionally do not have a default as it has to be in SyncEvent
@@ -49,7 +49,7 @@ 
 		$params = wp_parse_args(
 			$args,
 			array(
-				'id'          => uniqid( 'wl-input-' ),
+				'id'          => uniqid('wl-input-'),
 				'value'       => '',
 				'css_class'   => '',
 				'description' => '',
@@ -60,26 +60,26 @@ 
 		$value = $params['value'];
 		?>
 
-		<input type="radio" id="<?php echo esc_attr( $params['id'] ); ?>"
-			   name="<?php echo esc_attr( $params['name'] ); ?>"
+		<input type="radio" id="<?php echo esc_attr($params['id']); ?>"
+			   name="<?php echo esc_attr($params['name']); ?>"
 			   value="yes" 
 			   <?php
-				if ( ! empty( $params['css_class'] ) ) {
+				if ( ! empty($params['css_class'])) {
 					?>
-					 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
-			<?php checked( $value, 'yes' ); ?>
+					 class="<?php echo esc_attr($params['css_class']); ?>" <?php } ?>
+			<?php checked($value, 'yes'); ?>
 		/> Yes
-		<input type="radio" id="<?php echo esc_attr( $params['id'] ); ?>"
-			   name="<?php echo esc_attr( $params['name'] ); ?>"
+		<input type="radio" id="<?php echo esc_attr($params['id']); ?>"
+			   name="<?php echo esc_attr($params['name']); ?>"
 			   value="no" 
 			   <?php
-				if ( ! empty( $params['css_class'] ) ) {
+				if ( ! empty($params['css_class'])) {
 					?>
-					 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
-			<?php checked( $value, 'no' ); ?>
+					 class="<?php echo esc_attr($params['css_class']); ?>" <?php } ?>
+			<?php checked($value, 'no'); ?>
 		/> No
-		<?php if ( ! empty( $params['description'] ) ) { ?>
-			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
+		<?php if ( ! empty($params['description'])) { ?>
+			<p><?php echo wp_kses($params['description'], array('a' => array('href' => array()))); ?></p><?php } ?>
 		<?php
 
 		return $this;

src/admin/elements/class-wordlift-admin-country-select-element.php

Indentation +64 added lines, -64 removed lines

@@ -18,37 +18,37 @@ 
  */
 class Wordlift_Admin_Country_Select_Element extends Wordlift_Admin_Select_Element {
 
-	/**
-	 * Adds a filter that will add data `country-codes` attrbiute to the country select
-	 * to allow front-end validation.
-	 *
-	 * @since 3.18.0
-	 */
-	public function __construct() {
-		// Adds the country codes as data attribute to allow front-end validation.
-		add_filter( 'wl_admin_select_element_data_attributes', array( $this, 'add_country_codes_data' ), 10, 1 );
-	}
+    /**
+     * Adds a filter that will add data `country-codes` attrbiute to the country select
+     * to allow front-end validation.
+     *
+     * @since 3.18.0
+     */
+    public function __construct() {
+        // Adds the country codes as data attribute to allow front-end validation.
+        add_filter( 'wl_admin_select_element_data_attributes', array( $this, 'add_country_codes_data' ), 10, 1 );
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	public function render_options( $params ) {
-		// Print all the supported countries, preselecting the one configured
-		// in WP (or United Kingdom if not supported). We now use the `Wordlift_Countries`
-		// class which provides the list of countries supported by WordLift.
-		//
-		// https://github.com/insideout10/wordlift-plugin/issues/713
+    /**
+     * @inheritdoc
+     */
+    public function render_options( $params ) {
+        // Print all the supported countries, preselecting the one configured
+        // in WP (or United Kingdom if not supported). We now use the `Wordlift_Countries`
+        // class which provides the list of countries supported by WordLift.
+        //
+        // https://github.com/insideout10/wordlift-plugin/issues/713
 
-		$lang = ( isset( $params['lang'] ) ) ? $params['lang'] : false;
+        $lang = ( isset( $params['lang'] ) ) ? $params['lang'] : false;
 
-		// Get WordLift's supported countries.
-		$countries = Wordlift_Countries::get_countries( $lang );
+        // Get WordLift's supported countries.
+        $countries = Wordlift_Countries::get_countries( $lang );
 
-		// If we support WP's configured language, then use that, otherwise use English by default.
-		$language = isset( $countries[ $params['value'] ] ) ? $params['value'] : 'uk';
+        // If we support WP's configured language, then use that, otherwise use English by default.
+        $language = isset( $countries[ $params['value'] ] ) ? $params['value'] : 'uk';
 
-		foreach ( $countries as $code => $label ) :
-			?>
+        foreach ( $countries as $code => $label ) :
+            ?>
 			<option
 					value="<?php echo esc_attr( $code ); ?>"
 				<?php echo selected( $code, $language, false ); ?>
@@ -56,50 +56,50 @@ 
 				<?php echo esc_html( $label ); ?>
 			</option>
 			<?php
-		endforeach;
-	}
+        endforeach;
+    }
 
-	/**
-	 * Returns select options html.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @return void Echoes select options or empty string if required params are not set.
-	 */
-	public function get_options_html() {
-		$html = '';
+    /**
+     * Returns select options html.
+     *
+     * @since 3.18.0
+     *
+     * @return void Echoes select options or empty string if required params are not set.
+     */
+    public function get_options_html() {
+        $html = '';
 
-		// Check whether the required params are set.
+        // Check whether the required params are set.
         // phpcs:ignore Standard.Category.SniffName.ErrorCode
-		if ( ! empty( $_POST['lang'] ) && ! empty( $_POST['value'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			ob_start();
-			// Get the new options.
-			// phpcs:ignore Standard.Category.SniffName.ErrorCode
-			$this->render_options( $_POST ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+        if ( ! empty( $_POST['lang'] ) && ! empty( $_POST['value'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            ob_start();
+            // Get the new options.
+            // phpcs:ignore Standard.Category.SniffName.ErrorCode
+            $this->render_options( $_POST ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
-			$html = ob_get_clean();
-		}
+            $html = ob_get_clean();
+        }
 
-		// Return the html.
-		wp_send_json_success( $html );
-	}
+        // Return the html.
+        wp_send_json_success( $html );
+    }
 
-	/**
-	 * Modify the field data attributes by adding`country-code`
-	 * to existing attributes.
-	 *
-	 * @param array $attributes Current data attributes.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @return array $attributes Modified attributes.
-	 */
-	public function add_country_codes_data( $attributes ) {
-		// Add the country codes.
-		$attributes['country-codes'] = wp_json_encode( Wordlift_Countries::get_codes() );
+    /**
+     * Modify the field data attributes by adding`country-code`
+     * to existing attributes.
+     *
+     * @param array $attributes Current data attributes.
+     *
+     * @since 3.18.0
+     *
+     * @return array $attributes Modified attributes.
+     */
+    public function add_country_codes_data( $attributes ) {
+        // Add the country codes.
+        $attributes['country-codes'] = wp_json_encode( Wordlift_Countries::get_codes() );
 
-		// Return the attributes.
-		return $attributes;
-	}
+        // Return the attributes.
+        return $attributes;
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -26,34 +26,34 @@ 
 	 */
 	public function __construct() {
 		// Adds the country codes as data attribute to allow front-end validation.
-		add_filter( 'wl_admin_select_element_data_attributes', array( $this, 'add_country_codes_data' ), 10, 1 );
+		add_filter('wl_admin_select_element_data_attributes', array($this, 'add_country_codes_data'), 10, 1);
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	public function render_options( $params ) {
+	public function render_options($params) {
 		// Print all the supported countries, preselecting the one configured
 		// in WP (or United Kingdom if not supported). We now use the `Wordlift_Countries`
 		// class which provides the list of countries supported by WordLift.
 		//
 		// https://github.com/insideout10/wordlift-plugin/issues/713
 
-		$lang = ( isset( $params['lang'] ) ) ? $params['lang'] : false;
+		$lang = (isset($params['lang'])) ? $params['lang'] : false;
 
 		// Get WordLift's supported countries.
-		$countries = Wordlift_Countries::get_countries( $lang );
+		$countries = Wordlift_Countries::get_countries($lang);
 
 		// If we support WP's configured language, then use that, otherwise use English by default.
-		$language = isset( $countries[ $params['value'] ] ) ? $params['value'] : 'uk';
+		$language = isset($countries[$params['value']]) ? $params['value'] : 'uk';
 
-		foreach ( $countries as $code => $label ) :
+		foreach ($countries as $code => $label) :
 			?>
 			<option
-					value="<?php echo esc_attr( $code ); ?>"
-				<?php echo selected( $code, $language, false ); ?>
+					value="<?php echo esc_attr($code); ?>"
+				<?php echo selected($code, $language, false); ?>
 			>
-				<?php echo esc_html( $label ); ?>
+				<?php echo esc_html($label); ?>
 			</option>
 			<?php
 		endforeach;
@@ -71,17 +71,17 @@ 
 
 		// Check whether the required params are set.
         // phpcs:ignore Standard.Category.SniffName.ErrorCode
-		if ( ! empty( $_POST['lang'] ) && ! empty( $_POST['value'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		if ( ! empty($_POST['lang']) && ! empty($_POST['value'])) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
 			ob_start();
 			// Get the new options.
 			// phpcs:ignore Standard.Category.SniffName.ErrorCode
-			$this->render_options( $_POST ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$this->render_options($_POST); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
 			$html = ob_get_clean();
 		}
 
 		// Return the html.
-		wp_send_json_success( $html );
+		wp_send_json_success($html);
 	}
 
 	/**
@@ -94,9 +94,9 @@ 
 	 *
 	 * @return array $attributes Modified attributes.
 	 */
-	public function add_country_codes_data( $attributes ) {
+	public function add_country_codes_data($attributes) {
 		// Add the country codes.
-		$attributes['country-codes'] = wp_json_encode( Wordlift_Countries::get_codes() );
+		$attributes['country-codes'] = wp_json_encode(Wordlift_Countries::get_codes());
 
 		// Return the attributes.
 		return $attributes;

src/admin/elements/class-wordlift-admin-input-element.php

Indentation +50 added lines, -50 removed lines

@@ -18,75 +18,75 @@
  */
 class Wordlift_Admin_Input_Element implements Wordlift_Admin_Element {
 
-	/**
-	 * Output the HTML for an input box type settings_page
-	 *
-	 * @param array $args An array with the following keys:
-	 *                    Parameters controlling the result.
-	 *
-	 * @type string name The name attribute of the input element. Mandatory.
-	 *
-	 * @type string id    The id attribute of the input element. Optional.
-	 * @type string id    The id attribute of the input element.
-	 *                            Optional, randomly generated one is used if not supplied.
-	 * @type string value    The value of the input element.
-	 *                            Optional, defaults to empty string.
-	 * @type bool readonly    Indicates whether the input is read only.
-	 *                            Optional, defaults to read-write
-	 * @type string css_class    The class attribute for the input element.
-	 *                            If empty string no class attribute will be added.
-	 *                            Optional, defaults to empty string.
-	 * @type string description    The descriptio text to be displayed below the element.
-	 *                            Can include some HTML element.
-	 *                            If empty string no description will be displayed.
-	 *                            Optional, defaults to empty string.
-	 * @since 3.21.0 added the ability to use a $type arg.
-	 *
-	 * @return $this|Wordlift_Admin_Element
-	 */
-	public function render( $args ) {
+    /**
+     * Output the HTML for an input box type settings_page
+     *
+     * @param array $args An array with the following keys:
+     *                    Parameters controlling the result.
+     *
+     * @type string name The name attribute of the input element. Mandatory.
+     *
+     * @type string id    The id attribute of the input element. Optional.
+     * @type string id    The id attribute of the input element.
+     *                            Optional, randomly generated one is used if not supplied.
+     * @type string value    The value of the input element.
+     *                            Optional, defaults to empty string.
+     * @type bool readonly    Indicates whether the input is read only.
+     *                            Optional, defaults to read-write
+     * @type string css_class    The class attribute for the input element.
+     *                            If empty string no class attribute will be added.
+     *                            Optional, defaults to empty string.
+     * @type string description    The descriptio text to be displayed below the element.
+     *                            Can include some HTML element.
+     *                            If empty string no description will be displayed.
+     *                            Optional, defaults to empty string.
+     * @since 3.21.0 added the ability to use a $type arg.
+     *
+     * @return $this|Wordlift_Admin_Element
+     */
+    public function render( $args ) {
 
-		/*
+        /*
 		 * Parse the arguments and merge with default values.
 		 * Name intentionally do not have a default as it has to be in SyncEvent
 		 * with form handling code
 		 */
-		$pre_params = wp_parse_args(
-			$args,
-			array(
-				'id'          => uniqid( 'wl-input-' ),
-				'value'       => '',
-				'readonly'    => false,
-				'css_class'   => '',
-				'description' => '',
-			)
-		);
-		$params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
-		// allow different types of input - default to 'text'.
-		$input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
-		?>
+        $pre_params = wp_parse_args(
+            $args,
+            array(
+                'id'          => uniqid( 'wl-input-' ),
+                'value'       => '',
+                'readonly'    => false,
+                'css_class'   => '',
+                'description' => '',
+            )
+        );
+        $params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
+        // allow different types of input - default to 'text'.
+        $input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
+        ?>
 
 		<input type="<?php echo esc_attr( $input_type ); ?>"
 			   id="<?php echo esc_attr( $params['id'] ); ?>"
 			   name="<?php echo esc_attr( $params['name'] ); ?>"
 			   value="<?php echo esc_attr( $params['value'] ); ?>"
 			<?php
-			if ( ! empty( $params['readonly'] ) ) {
-				?>
+            if ( ! empty( $params['readonly'] ) ) {
+                ?>
 				 readonly="readonly" <?php } ?>
 			<?php
-			if ( ! empty( $params['css_class'] ) ) {
-				?>
+            if ( ! empty( $params['css_class'] ) ) {
+                ?>
 				 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
 		/>
 		<?php
-		if ( ! empty( $params['description'] ) ) {
-			?>
+        if ( ! empty( $params['description'] ) ) {
+            ?>
 			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
 
 		<?php
 
-		return $this;
-	}
+        return $this;
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -44,7 +44,7 @@ 
 	 *
 	 * @return $this|Wordlift_Admin_Element
 	 */
-	public function render( $args ) {
+	public function render($args) {
 
 		/*
 		 * Parse the arguments and merge with default values.
@@ -54,35 +54,35 @@ 
 		$pre_params = wp_parse_args(
 			$args,
 			array(
-				'id'          => uniqid( 'wl-input-' ),
+				'id'          => uniqid('wl-input-'),
 				'value'       => '',
 				'readonly'    => false,
 				'css_class'   => '',
 				'description' => '',
 			)
 		);
-		$params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
+		$params     = apply_filters('wl_admin_input_element_params', $pre_params);
 		// allow different types of input - default to 'text'.
-		$input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
+		$input_type = ! empty($params['type']) ? $params['type'] : 'text';
 		?>
 
-		<input type="<?php echo esc_attr( $input_type ); ?>"
-			   id="<?php echo esc_attr( $params['id'] ); ?>"
-			   name="<?php echo esc_attr( $params['name'] ); ?>"
-			   value="<?php echo esc_attr( $params['value'] ); ?>"
+		<input type="<?php echo esc_attr($input_type); ?>"
+			   id="<?php echo esc_attr($params['id']); ?>"
+			   name="<?php echo esc_attr($params['name']); ?>"
+			   value="<?php echo esc_attr($params['value']); ?>"
 			<?php
-			if ( ! empty( $params['readonly'] ) ) {
+			if ( ! empty($params['readonly'])) {
 				?>
 				 readonly="readonly" <?php } ?>
 			<?php
-			if ( ! empty( $params['css_class'] ) ) {
+			if ( ! empty($params['css_class'])) {
 				?>
-				 class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
+				 class="<?php echo esc_attr($params['css_class']); ?>" <?php } ?>
 		/>
 		<?php
-		if ( ! empty( $params['description'] ) ) {
+		if ( ! empty($params['description'])) {
 			?>
-			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
+			<p><?php echo wp_kses($params['description'], array('a' => array('href' => array()))); ?></p><?php } ?>
 
 		<?php
 

src/admin/elements/class-wordlift-admin-tabs-element.php

Indentation +41 added lines, -41 removed lines

@@ -18,48 +18,48 @@ 
  */
 class Wordlift_Admin_Tabs_Element implements Wordlift_Admin_Element {
 
-	/**
-	 * Render the element.
-	 *
-	 * @param array $args {
-	 *      Parameters controlling the html being output.
-	 *
-	 * @type integer $active The index of the active panel on first render
-	 *                              a zero based number of the tab actual placement
-	 *
-	 * @type array $tabs {
-	 *          The array of tabs to be rendered.
-	 *          The index of the elements is expected to be an ascending integers
-	 *          tabs with lower index values will be render first (on the left)
-	 *
-	 * @type string $label The label used for the tab.
-	 * @type callable $callback The callback to call to render the
-	 *                                      Tab "panel".
-	 * @type array $args The arguments array passed to the callback.
-	 *          }
-	 *      }
-	 *
-	 * @return \Wordlift_Admin_Element The element instance.
-	 * @since 3.11.0
-	 */
-	public function render( $args ) {
+    /**
+     * Render the element.
+     *
+     * @param array $args {
+     *      Parameters controlling the html being output.
+     *
+     * @type integer $active The index of the active panel on first render
+     *                              a zero based number of the tab actual placement
+     *
+     * @type array $tabs {
+     *          The array of tabs to be rendered.
+     *          The index of the elements is expected to be an ascending integers
+     *          tabs with lower index values will be render first (on the left)
+     *
+     * @type string $label The label used for the tab.
+     * @type callable $callback The callback to call to render the
+     *                                      Tab "panel".
+     * @type array $args The arguments array passed to the callback.
+     *          }
+     *      }
+     *
+     * @return \Wordlift_Admin_Element The element instance.
+     * @since 3.11.0
+     */
+    public function render( $args ) {
 
-		// Enqueue the jQuery UI Tabs script.
-		wp_enqueue_script( 'jquery-ui-tabs' );
+        // Enqueue the jQuery UI Tabs script.
+        wp_enqueue_script( 'jquery-ui-tabs' );
 
-		// Parse the arguments and merge with default values.
-		$params = wp_parse_args(
-			$args,
-			array(
-				'tabs'   => array(),
-				'active' => 0,
-			)
-		);
+        // Parse the arguments and merge with default values.
+        $params = wp_parse_args(
+            $args,
+            array(
+                'tabs'   => array(),
+                'active' => 0,
+            )
+        );
 
-		// Following is the HTML code:
-		// - the labels are printed, using the tab's `label`,
-		// - the panels are printed, using the tab's `callback`.
-		?>
+        // Following is the HTML code:
+        // - the labels are printed, using the tab's `label`,
+        // - the panels are printed, using the tab's `callback`.
+        ?>
 		<div
 				class="wl-tabs-element"
 				data-active="<?php echo esc_attr( $params['active'] ); ?>"
@@ -82,7 +82,7 @@ 
 
 		<?php
 
-		return $this;
-	}
+        return $this;
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -42,10 +42,10 @@ 
 	 * @return \Wordlift_Admin_Element The element instance.
 	 * @since 3.11.0
 	 */
-	public function render( $args ) {
+	public function render($args) {
 
 		// Enqueue the jQuery UI Tabs script.
-		wp_enqueue_script( 'jquery-ui-tabs' );
+		wp_enqueue_script('jquery-ui-tabs');
 
 		// Parse the arguments and merge with default values.
 		$params = wp_parse_args(
@@ -62,20 +62,20 @@ 
 		?>
 		<div
 				class="wl-tabs-element"
-				data-active="<?php echo esc_attr( $params['active'] ); ?>"
+				data-active="<?php echo esc_attr($params['active']); ?>"
 		>
 			<ul class="nav-tab-wrapper">
-				<?php foreach ( $params['tabs'] as $index => $tab ) : ?>
+				<?php foreach ($params['tabs'] as $index => $tab) : ?>
 					<li class="nav-tab">
-						<a href="#tabs-<?php echo esc_html( $index + 1 ); ?>">
-							<?php echo esc_html( $tab['label'] ); ?>
+						<a href="#tabs-<?php echo esc_html($index + 1); ?>">
+							<?php echo esc_html($tab['label']); ?>
 						</a>
 					</li>
 				<?php endforeach; ?>
 			</ul>
-			<?php foreach ( $params['tabs'] as $index => $tab ) : ?>
-				<div id="tabs-<?php echo esc_html( $index + 1 ); ?>">
-					<?php call_user_func( $tab['callback'], $tab['args'] ); ?>
+			<?php foreach ($params['tabs'] as $index => $tab) : ?>
+				<div id="tabs-<?php echo esc_html($index + 1); ?>">
+					<?php call_user_func($tab['callback'], $tab['args']); ?>
 				</div>
 			<?php endforeach; ?>
 		</div>

src/admin/elements/class-wordlift-admin-select2-element.php

Indentation +27 added lines, -27 removed lines

@@ -18,13 +18,13 @@ 
  */
 class Wordlift_Admin_Select2_Element extends Wordlift_Admin_Select_Element {
 
-	/**
-	 * @inheritdoc
-	 */
-	public function render_options( $params ) {
-		// Loop through all params and add the options.
-		foreach ( $params['options'] as $value => $label ) :
-			?>
+    /**
+     * @inheritdoc
+     */
+    public function render_options( $params ) {
+        // Loop through all params and add the options.
+        foreach ( $params['options'] as $value => $label ) :
+            ?>
 			<option
 					value="<?php echo esc_attr( $value ); ?>"
 				<?php selected( $params['value'], $value ); ?>
@@ -32,26 +32,26 @@ 
 				<?php echo esc_html( $label ); ?>
 			</option>
 			<?php
-		endforeach;
-	}
+        endforeach;
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	protected function enqueue_resources() {
-		// Enqueue select2 library js and css.
-		// Underscore is needed for Select2's `templateResult` and `templateSelection` templates.
-		wp_enqueue_script(
-			'wordlift-select2',
-			plugin_dir_url( __DIR__ ) . 'js/select2/js/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
-			array(
-				'jquery',
-				'underscore',
-			),
-			'4.0.3',
-			false
-		);
-		wp_enqueue_style( 'wordlift-select2', plugin_dir_url( __DIR__ ) . 'js/select2/css/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.css', array(), '4.0.3' );
-	}
+    /**
+     * @inheritdoc
+     */
+    protected function enqueue_resources() {
+        // Enqueue select2 library js and css.
+        // Underscore is needed for Select2's `templateResult` and `templateSelection` templates.
+        wp_enqueue_script(
+            'wordlift-select2',
+            plugin_dir_url( __DIR__ ) . 'js/select2/js/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+            array(
+                'jquery',
+                'underscore',
+            ),
+            '4.0.3',
+            false
+        );
+        wp_enqueue_style( 'wordlift-select2', plugin_dir_url( __DIR__ ) . 'js/select2/css/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.css', array(), '4.0.3' );
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -21,15 +21,15 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function render_options( $params ) {
+	public function render_options($params) {
 		// Loop through all params and add the options.
-		foreach ( $params['options'] as $value => $label ) :
+		foreach ($params['options'] as $value => $label) :
 			?>
 			<option
-					value="<?php echo esc_attr( $value ); ?>"
-				<?php selected( $params['value'], $value ); ?>
+					value="<?php echo esc_attr($value); ?>"
+				<?php selected($params['value'], $value); ?>
 			>
-				<?php echo esc_html( $label ); ?>
+				<?php echo esc_html($label); ?>
 			</option>
 			<?php
 		endforeach;
@@ -43,7 +43,7 @@ 
 		// Underscore is needed for Select2's `templateResult` and `templateSelection` templates.
 		wp_enqueue_script(
 			'wordlift-select2',
-			plugin_dir_url( __DIR__ ) . 'js/select2/js/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+			plugin_dir_url(__DIR__).'js/select2/js/select2'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '.min' : '').'.js',
 			array(
 				'jquery',
 				'underscore',
@@ -51,7 +51,7 @@ 
 			'4.0.3',
 			false
 		);
-		wp_enqueue_style( 'wordlift-select2', plugin_dir_url( __DIR__ ) . 'js/select2/css/select2' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.css', array(), '4.0.3' );
+		wp_enqueue_style('wordlift-select2', plugin_dir_url(__DIR__).'js/select2/css/select2'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '.min' : '').'.css', array(), '4.0.3');
 	}
 
 }