insideout10 / wordlift-plugin

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

Indentation +303 added lines, -303 removed lines

@@ -18,308 +18,308 @@
  */
 class Wordlift_Admin_Settings_Analytics_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
-	 */
-	private $input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since  3.21.0
-	 * @access protected
-	 * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 */
-	private $radio_input_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
-	 * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
-	 *
-	 * @since 3.21.0
-	 */
-	public function __construct( $input_element, $radio_input_element ) {
-
-		// Set a reference to the UI elements.
-		$this->input_element       = $input_element;
-		$this->radio_input_element = $radio_input_element;
-
-		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.21.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_page_title() {
-
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_title() {
-
-		return __( 'Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_slug() {
-
-		return 'wl_configuration_admin_analytics_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_partial_name() {
-
-		return 'wordlift-admin-settings-analytics-page.php';
-	}
-
-	/**
-	 * Returns the string to use for the tab slug on main admin settings page.
-	 *
-	 * @method get_admin_page_tab_slug
-	 * @return string
-	 * @since  3.21.0
-	 */
-	public function get_admin_page_tab_slug() {
-		return 'analytics';
-	}
-
-	/**
-	 * Adds pages to the tabs menu on the main admin settings page.
-	 *
-	 * @method add_admin_page_tab
-	 * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
-	 *
-	 * @since  3.21.0
-	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
-			$tabs[] = array(
-				'title' => $this->get_menu_title(),
-				'slug'  => $this->get_admin_page_tab_slug(),
-			);
-		}
-
-		return $tabs;
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.21.0
-	 */
-	public function admin_init() {
-
-		// Register WordLift's analytics settings with our in class sanitizer.
-		register_setting(
-			'wl_analytics_settings',
-			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the analytics settings setction.
-		add_settings_section(
-			'wl_analytics_settings_section',
-			'',
-			'',
-			'wl_analytics_settings'
-		);
-
-		// Add a toggle to determine if analytics functions are enabled or not.
-		// NOTE: this uses yes/no rather than true/false.
-		add_settings_field(
-			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the uri.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the type.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Validates an entity uri based on an integer passed.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_uri
-	 * @param string $uri a sting representing an entity ID that can be converted to a uri.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function validate_entity_uri( $uri ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
-			// if we are out of range then pass the default value.
-			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
-		}
-
-		return absint( $uri );
-	}
-
-	/**
-	 * Validates an entity type.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_type
-	 * @param string $type This is an entity type ID in string form - really a number.
-	 *
-	 * @return int
-	 * @since  3.21.0
-	 */
-	public function validate_entity_type( $type ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
-			// if we are out of range then pass the default value.
-			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
-		}
-
-		return absint( $type );
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 * @since 3.21.0
-	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
-			// Any failing nonce checks already die().
-			return;
-		}
-
-		/**
-		 * Validate and sanitize the $inputs and store them in $output saved.
-		 */
-		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
-		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
-		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
-			// This dimension cannot be the same as the one set above. If it is
-			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
-				$input['analytics_entity_type_dimension'] = 0;
-			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
-		}
-
-		// return items added to the output for saving.
-		return $output;
-	}
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
+     */
+    private $input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since  3.21.0
+     * @access protected
+     * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     */
+    private $radio_input_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
+     * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
+     *
+     * @since 3.21.0
+     */
+    public function __construct( $input_element, $radio_input_element ) {
+
+        // Set a reference to the UI elements.
+        $this->input_element       = $input_element;
+        $this->radio_input_element = $radio_input_element;
+
+        // Adds this page to the main admin settings tabbed menu.
+        add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.21.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_page_title() {
+
+        return __( 'WorldLift Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_title() {
+
+        return __( 'Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_slug() {
+
+        return 'wl_configuration_admin_analytics_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_partial_name() {
+
+        return 'wordlift-admin-settings-analytics-page.php';
+    }
+
+    /**
+     * Returns the string to use for the tab slug on main admin settings page.
+     *
+     * @method get_admin_page_tab_slug
+     * @return string
+     * @since  3.21.0
+     */
+    public function get_admin_page_tab_slug() {
+        return 'analytics';
+    }
+
+    /**
+     * Adds pages to the tabs menu on the main admin settings page.
+     *
+     * @method add_admin_page_tab
+     * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
+     *
+     * @since  3.21.0
+     */
+    public function add_admin_page_tab( $tabs ) {
+        if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+            $tabs[] = array(
+                'title' => $this->get_menu_title(),
+                'slug'  => $this->get_admin_page_tab_slug(),
+            );
+        }
+
+        return $tabs;
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.21.0
+     */
+    public function admin_init() {
+
+        // Register WordLift's analytics settings with our in class sanitizer.
+        register_setting(
+            'wl_analytics_settings',
+            'wl_analytics_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the analytics settings setction.
+        add_settings_section(
+            'wl_analytics_settings_section',
+            '',
+            '',
+            'wl_analytics_settings'
+        );
+
+        // Add a toggle to determine if analytics functions are enabled or not.
+        // NOTE: this uses yes/no rather than true/false.
+        add_settings_field(
+            'wl-analytics-enabled',
+            __( 'Enable Analytics', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-enable',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
+                'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the uri.
+         */
+        add_settings_field(
+            'wl-analytics-entity-uri-dimension',
+            __( 'Entity URI dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-uri-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
+                'description' => __( 'Entity URI dimesion', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the type.
+         */
+        add_settings_field(
+            'wl-analytics-entity-type-dimension',
+            __( 'Entity Type dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-type-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
+                'description' => __( 'Entity Type dimension', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Validates an entity uri based on an integer passed.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_uri
+     * @param string $uri a sting representing an entity ID that can be converted to a uri.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function validate_entity_uri( $uri ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $uri < 1 || (int) $uri > 20 ) {
+            // if we are out of range then pass the default value.
+            $uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
+        }
+
+        return absint( $uri );
+    }
+
+    /**
+     * Validates an entity type.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_type
+     * @param string $type This is an entity type ID in string form - really a number.
+     *
+     * @return int
+     * @since  3.21.0
+     */
+    public function validate_entity_type( $type ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $type < 1 || (int) $type > 20 ) {
+            // if we are out of range then pass the default value.
+            $type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
+        }
+
+        return absint( $type );
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     * @since 3.21.0
+     */
+    public function sanitize_callback( $input ) {
+        if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+            // Any failing nonce checks already die().
+            return;
+        }
+
+        /**
+         * Validate and sanitize the $inputs and store them in $output saved.
+         */
+        $output = array();
+        if ( isset( $input['analytics_enable'] ) ) {
+            $output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+        }
+        if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
+            $output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+        }
+        if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+            // This dimension cannot be the same as the one set above. If it is
+            // then zero it out and it will fail validation.
+            if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+                $input['analytics_entity_type_dimension'] = 0;
+            }
+            $output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+        }
+
+        // return items added to the output for saving.
+        return $output;
+    }
 
 }

Spacing +34 added lines, -34 removed lines

@@ -53,14 +53,14 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	public function __construct( $input_element, $radio_input_element ) {
+	public function __construct($input_element, $radio_input_element) {
 
 		// Set a reference to the UI elements.
 		$this->input_element       = $input_element;
 		$this->radio_input_element = $radio_input_element;
 
 		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+		add_filter('wl_admin_page_tabs', array($this, 'add_admin_page_tab'));
 
 		self::$instance = $this;
 	}
@@ -97,7 +97,7 @@ 
 	 */
 	public function get_page_title() {
 
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
+		return __('WorldLift Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -105,7 +105,7 @@ 
 	 */
 	public function get_menu_title() {
 
-		return __( 'Analytics Settings', 'wordlift' );
+		return __('Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -143,8 +143,8 @@ 
 	 *
 	 * @since  3.21.0
 	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+	public function add_admin_page_tab($tabs) {
+		if (apply_filters('wl_feature__enable__analytics', true)) {
 			$tabs[] = array(
 				'title' => $this->get_menu_title(),
 				'slug'  => $this->get_admin_page_tab_slug(),
@@ -167,7 +167,7 @@ 
 		register_setting(
 			'wl_analytics_settings',
 			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the analytics settings setction.
@@ -182,15 +182,15 @@ 
 		// NOTE: this uses yes/no rather than true/false.
 		add_settings_field(
 			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Enable Analytics', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENABLE.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+				'description' => __('Toggle on/off the default values.', 'wordlift'),
 			)
 		);
 
@@ -201,16 +201,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity URI dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
+				'description' => __('Entity URI dimesion', 'wordlift'),
 			)
 		);
 
@@ -221,16 +221,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity Type dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
+				'description' => __('Entity Type dimension', 'wordlift'),
 			)
 		);
 
@@ -247,16 +247,16 @@ 
 	 * @return int
 	 * @since 3.21.0
 	 */
-	public function validate_entity_uri( $uri ) {
+	public function validate_entity_uri($uri) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
+		if ((int) $uri < 1 || (int) $uri > 20) {
 			// if we are out of range then pass the default value.
 			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
 		}
 
-		return absint( $uri );
+		return absint($uri);
 	}
 
 	/**
@@ -270,16 +270,16 @@ 
 	 * @return int
 	 * @since  3.21.0
 	 */
-	public function validate_entity_type( $type ) {
+	public function validate_entity_type($type) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
+		if ((int) $type < 1 || (int) $type > 20) {
 			// if we are out of range then pass the default value.
 			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
 		}
 
-		return absint( $type );
+		return absint($type);
 	}
 
 	/**
@@ -293,8 +293,8 @@ 
 	 * @return array The sanitized input array.
 	 * @since 3.21.0
 	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+	public function sanitize_callback($input) {
+		if ( ! check_admin_referer('wl_analytics_settings-options')) {
 			// Any failing nonce checks already die().
 			return;
 		}
@@ -303,19 +303,19 @@ 
 		 * Validate and sanitize the $inputs and store them in $output saved.
 		 */
 		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+		if (isset($input['analytics_enable'])) {
+			$output['analytics_enable'] = ('yes' === $input['analytics_enable']) ? 'yes' : 'no';
 		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+		if (isset($input['analytics_entity_uri_dimension'])) {
+			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri($input['analytics_entity_uri_dimension']);
 		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+		if (isset($input['analytics_entity_type_dimension'])) {
 			// This dimension cannot be the same as the one set above. If it is
 			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+			if (isset($output['analytics_entity_uri_dimension']) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension']) {
 				$input['analytics_entity_type_dimension'] = 0;
 			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type($input['analytics_entity_type_dimension']);
 		}
 
 		// return items added to the output for saving.

src/admin/wordlift-admin-meta-box-entities.php

Indentation +168 added lines, -168 removed lines

@@ -14,13 +14,13 @@ 
  */
 function wl_register_metaboxes() {
 
-	new Wl_Metabox();     // Everything is done inside here with the correct timing.
+    new Wl_Metabox();     // Everything is done inside here with the correct timing.
 
 }
 
 if ( is_admin() ) {
-	add_action( 'load-post.php', 'wl_register_metaboxes' );
-	add_action( 'load-post-new.php', 'wl_register_metaboxes' );
+    add_action( 'load-post.php', 'wl_register_metaboxes' );
+    add_action( 'load-post-new.php', 'wl_register_metaboxes' );
 }
 
 /**
@@ -31,41 +31,41 @@ 
  */
 function wl_admin_add_entities_meta_box( $post_type, $post ) {
 
-	/*
+    /*
 	 * Call the `wl_can_see_classification_box` filter to determine whether we can display the classification box.
 	 *
 	 * @since 3.20.3
 	 *
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/914
 	 */
-	if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
-		return;
-	}
-
-	// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-	if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
-		return;
-	}
-
-	// Bail out if the post type doesn't support a TinyMCE editor.
-	if ( ! wl_post_type_supports_editor( $post_type ) ) {
-		return;
-	}
-
-	// If the editor is not gutenberg and not any other custom editor then we use the sidebar.
-	if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
-		$post->ID
-	) ) {
-		// Add main meta box for related entities and 4W only if not Gutenberg
-		add_meta_box(
-			'wordlift_entities_box',
-			__( 'WordLift', 'wordlift' ),
-			'wl_entities_box_content',
-			$post_type,
-			'side',
-			'high'
-		);
-	}
+    if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
+        return;
+    }
+
+    // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+    if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+        return;
+    }
+
+    // Bail out if the post type doesn't support a TinyMCE editor.
+    if ( ! wl_post_type_supports_editor( $post_type ) ) {
+        return;
+    }
+
+    // If the editor is not gutenberg and not any other custom editor then we use the sidebar.
+    if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
+        $post->ID
+    ) ) {
+        // Add main meta box for related entities and 4W only if not Gutenberg
+        add_meta_box(
+            'wordlift_entities_box',
+            __( 'WordLift', 'wordlift' ),
+            'wl_entities_box_content',
+            $post_type,
+            'side',
+            'high'
+        );
+    }
 
 }
 
@@ -82,18 +82,18 @@ 
  */
 function wl_post_type_supports_editor( $post_type ) {
 
-	$default = post_type_supports( $post_type, 'editor' );
-
-	/**
-	 * Allow 3rd parties to force the classification to load.
-	 *
-	 * @param bool $default The preset value as gathered by the `post_type_supports` call.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/847.
-	 *
-	 * @since 3.19.4
-	 */
-	return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
+    $default = post_type_supports( $post_type, 'editor' );
+
+    /**
+     * Allow 3rd parties to force the classification to load.
+     *
+     * @param bool $default The preset value as gathered by the `post_type_supports` call.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/847.
+     *
+     * @since 3.19.4
+     */
+    return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
 }
 
 /**
@@ -103,141 +103,141 @@ 
  */
 function wl_entities_box_content( $post, $wrapper = true ) {
 
-	// Angularjs edit-post widget wrapper.
-	if ( $wrapper ) {
-		echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
-	}
+    // Angularjs edit-post widget wrapper.
+    if ( $wrapper ) {
+        echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
+    }
 }
 
 function wl_entities_box_content_scripts() {
-	$post = get_post();
+    $post = get_post();
 
-	// Angularjs edit-post widget classification boxes configuration.
-	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+    // Angularjs edit-post widget classification boxes configuration.
+    // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+    $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
 
-	// Array to store all related entities ids.
-	$all_referenced_entities_ids = array();
+    // Array to store all related entities ids.
+    $all_referenced_entities_ids = array();
 
-	// Add selected entities to classification_boxes.
-	foreach ( $classification_boxes as $i => $box ) {
+    // Add selected entities to classification_boxes.
+    foreach ( $classification_boxes as $i => $box ) {
 
-		// Get the entity referenced from the post content.
-		/*
+        // Get the entity referenced from the post content.
+        /*
 		 * Allow 3rd parties to provide another post content.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
-
-		// Enhance current box selected entities.
-		$classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
-
-		// Maps the URIs to entity posts.
-		$entity_service = Wordlift_Entity_Service::get_instance();
-
-		// Replace all entity URI's with post ID's if found or null if there is no related post.
-		$entity_ids = array_map(
-			function ( $item ) use ( $entity_service ) {
-				// Return entity post by the entity URI or null.
-				$post = $entity_service->get_entity_post_by_uri( $item );
-
-				// Check that the post object is not null.
-				if ( ! empty( $post ) ) {
-					  return $post->ID;
-				}
-			},
-			$entity_uris
-		);
-		// Store the entity ids for all the 4W.
-		$all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
-
-	}
-
-	// Json encoding for classification boxes structure.
-	$classification_boxes = wp_json_encode( $classification_boxes );
-
-	// Ensure there are no repetitions of the referenced entities.
-	$all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
-
-	// Remove all null, false and empty strings.
-	// NULL is being returned in some cases, when there is not related post, so we need to remove it.
-	$all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
-
-	// Build the entity storage object.
-	$referenced_entities_obj = array();
-	foreach ( $all_referenced_entities_ids as $referenced_entity ) {
-		$entity = wl_serialize_entity( $referenced_entity );
-		// Set a default confidence of `PHP_INT_MAX` for already annotated entities.
-		$referenced_entities_obj[ $entity['id'] ] = $entity
-													+ array( 'confidence' => PHP_INT_MAX );
-	}
-
-	$referenced_entities_obj = empty( $referenced_entities_obj ) ?
-		'{}' : wp_json_encode( $referenced_entities_obj );
-
-	$published_place_id  = get_post_meta(
-		$post->ID,
-		Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
-		true
-	);
-	$published_place_obj = ( $published_place_id ) ?
-		wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
-		null;
-
-	$topic_id  = get_post_meta(
-		$post->ID,
-		Wordlift_Schema_Service::FIELD_TOPIC,
-		true
-	);
-	$topic_obj = ( $topic_id ) ?
-		wp_json_encode( wl_serialize_entity( $topic_id ) ) :
-		null;
-
-	$configuration_service = Wordlift_Configuration_Service::get_instance();
-
-	$default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
-	$default_path           = WL_DEFAULT_PATH;
-	$dataset_uri            = $configuration_service->get_dataset_uri();
-	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
-
-	// Retrieve the current post author.
-	$post_author = get_userdata( $post->post_author )->display_name;
-	// Retrive the published date.
-	$published_date = get_the_time( 'Y-m-d', $post->ID );
-	// Current language.
-	$current_language            = $configuration_service->get_language_code();
-	$wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
-	$timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
-	$addslashes_post_author      = addslashes( $post_author );
-
-	$metabox_settings = array(
-		'classificationBoxes'      => json_decode( $classification_boxes ),
-		'entities'                 => json_decode( $referenced_entities_obj ),
-		'currentPostId'            => intval( $post->ID ),
-		'currentPostUri'           => $current_post_uri,
-		'currentPostType'          => $post->post_type,
-		'isEntity'                 => ! empty( $is_entity ),
-		'defaultThumbnailPath'     => $default_thumbnail_path,
-		'defaultWordLiftPath'      => $default_path,
-		'datasetUri'               => $dataset_uri,
-		'currentUser'              => $addslashes_post_author,
-		'publishedDate'            => $published_date,
-		'publishedPlace'           => $published_place_obj,
-		'topic'                    => json_decode( $topic_obj ),
-		'currentLanguage'          => $current_language,
-		'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
-		'ajax_url'                 => admin_url( 'admin-ajax.php' ),
-	);
-
-	// Allow Classic and Block Editor scripts to register first.
-	// Hook to the Block Editor script.
-	wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
-
-	// Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
-	wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        $entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
+
+        // Enhance current box selected entities.
+        $classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
+
+        // Maps the URIs to entity posts.
+        $entity_service = Wordlift_Entity_Service::get_instance();
+
+        // Replace all entity URI's with post ID's if found or null if there is no related post.
+        $entity_ids = array_map(
+            function ( $item ) use ( $entity_service ) {
+                // Return entity post by the entity URI or null.
+                $post = $entity_service->get_entity_post_by_uri( $item );
+
+                // Check that the post object is not null.
+                if ( ! empty( $post ) ) {
+                        return $post->ID;
+                }
+            },
+            $entity_uris
+        );
+        // Store the entity ids for all the 4W.
+        $all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
+
+    }
+
+    // Json encoding for classification boxes structure.
+    $classification_boxes = wp_json_encode( $classification_boxes );
+
+    // Ensure there are no repetitions of the referenced entities.
+    $all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
+
+    // Remove all null, false and empty strings.
+    // NULL is being returned in some cases, when there is not related post, so we need to remove it.
+    $all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
+
+    // Build the entity storage object.
+    $referenced_entities_obj = array();
+    foreach ( $all_referenced_entities_ids as $referenced_entity ) {
+        $entity = wl_serialize_entity( $referenced_entity );
+        // Set a default confidence of `PHP_INT_MAX` for already annotated entities.
+        $referenced_entities_obj[ $entity['id'] ] = $entity
+                                                    + array( 'confidence' => PHP_INT_MAX );
+    }
+
+    $referenced_entities_obj = empty( $referenced_entities_obj ) ?
+        '{}' : wp_json_encode( $referenced_entities_obj );
+
+    $published_place_id  = get_post_meta(
+        $post->ID,
+        Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
+        true
+    );
+    $published_place_obj = ( $published_place_id ) ?
+        wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
+        null;
+
+    $topic_id  = get_post_meta(
+        $post->ID,
+        Wordlift_Schema_Service::FIELD_TOPIC,
+        true
+    );
+    $topic_obj = ( $topic_id ) ?
+        wp_json_encode( wl_serialize_entity( $topic_id ) ) :
+        null;
+
+    $configuration_service = Wordlift_Configuration_Service::get_instance();
+
+    $default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
+    $default_path           = WL_DEFAULT_PATH;
+    $dataset_uri            = $configuration_service->get_dataset_uri();
+    $current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
+    $is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
+
+    // Retrieve the current post author.
+    $post_author = get_userdata( $post->post_author )->display_name;
+    // Retrive the published date.
+    $published_date = get_the_time( 'Y-m-d', $post->ID );
+    // Current language.
+    $current_language            = $configuration_service->get_language_code();
+    $wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
+    $timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
+    $addslashes_post_author      = addslashes( $post_author );
+
+    $metabox_settings = array(
+        'classificationBoxes'      => json_decode( $classification_boxes ),
+        'entities'                 => json_decode( $referenced_entities_obj ),
+        'currentPostId'            => intval( $post->ID ),
+        'currentPostUri'           => $current_post_uri,
+        'currentPostType'          => $post->post_type,
+        'isEntity'                 => ! empty( $is_entity ),
+        'defaultThumbnailPath'     => $default_thumbnail_path,
+        'defaultWordLiftPath'      => $default_path,
+        'datasetUri'               => $dataset_uri,
+        'currentUser'              => $addslashes_post_author,
+        'publishedDate'            => $published_date,
+        'publishedPlace'           => $published_place_obj,
+        'topic'                    => json_decode( $topic_obj ),
+        'currentLanguage'          => $current_language,
+        'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
+        'ajax_url'                 => admin_url( 'admin-ajax.php' ),
+    );
+
+    // Allow Classic and Block Editor scripts to register first.
+    // Hook to the Block Editor script.
+    wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+
+    // Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
+    wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
 
 }
 

Spacing +57 added lines, -59 removed lines

@@ -14,13 +14,13 @@ 
  */
 function wl_register_metaboxes() {
 
-	new Wl_Metabox();     // Everything is done inside here with the correct timing.
+	new Wl_Metabox(); // Everything is done inside here with the correct timing.
 
 }
 
-if ( is_admin() ) {
-	add_action( 'load-post.php', 'wl_register_metaboxes' );
-	add_action( 'load-post-new.php', 'wl_register_metaboxes' );
+if (is_admin()) {
+	add_action('load-post.php', 'wl_register_metaboxes');
+	add_action('load-post-new.php', 'wl_register_metaboxes');
 }
 
 /**
@@ -29,7 +29,7 @@ 
  * @param string  $post_type The type of the current open post.
  * @param WP_Post $post WordPress post.
  */
-function wl_admin_add_entities_meta_box( $post_type, $post ) {
+function wl_admin_add_entities_meta_box($post_type, $post) {
 
 	/*
 	 * Call the `wl_can_see_classification_box` filter to determine whether we can display the classification box.
@@ -38,28 +38,28 @@ 
 	 *
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/914
 	 */
-	if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
+	if ( ! apply_filters('wl_can_see_classification_box', true)) {
 		return;
 	}
 
 	// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-	if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+	if ( ! apply_filters('wl_feature__enable__classification-sidebar', true)) {
 		return;
 	}
 
 	// Bail out if the post type doesn't support a TinyMCE editor.
-	if ( ! wl_post_type_supports_editor( $post_type ) ) {
+	if ( ! wl_post_type_supports_editor($post_type)) {
 		return;
 	}
 
 	// If the editor is not gutenberg and not any other custom editor then we use the sidebar.
 	if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
 		$post->ID
-	) ) {
+	)) {
 		// Add main meta box for related entities and 4W only if not Gutenberg
 		add_meta_box(
 			'wordlift_entities_box',
-			__( 'WordLift', 'wordlift' ),
+			__('WordLift', 'wordlift'),
 			'wl_entities_box_content',
 			$post_type,
 			'side',
@@ -69,7 +69,7 @@ 
 
 }
 
-add_action( 'add_meta_boxes', 'wl_admin_add_entities_meta_box', 10, 2 );
+add_action('add_meta_boxes', 'wl_admin_add_entities_meta_box', 10, 2);
 
 /**
  * Whether the post type supports the editor UI.
@@ -80,9 +80,9 @@ 
  *
  * @return bool True if the editor UI is supported otherwise false.
  */
-function wl_post_type_supports_editor( $post_type ) {
+function wl_post_type_supports_editor($post_type) {
 
-	$default = post_type_supports( $post_type, 'editor' );
+	$default = post_type_supports($post_type, 'editor');
 
 	/**
 	 * Allow 3rd parties to force the classification to load.
@@ -93,7 +93,7 @@ 
 	 *
 	 * @since 3.19.4
 	 */
-	return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
+	return apply_filters('wl_post_type_supports_editor', $default, $post_type);
 }
 
 /**
@@ -101,10 +101,10 @@ 
  *
  * @param WP_Post $post The current post.
  */
-function wl_entities_box_content( $post, $wrapper = true ) {
+function wl_entities_box_content($post, $wrapper = true) {
 
 	// Angularjs edit-post widget wrapper.
-	if ( $wrapper ) {
+	if ($wrapper) {
 		echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
 	}
 }
@@ -114,13 +114,13 @@ 
 
 	// Angularjs edit-post widget classification boxes configuration.
 	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+	$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
 
 	// Array to store all related entities ids.
 	$all_referenced_entities_ids = array();
 
 	// Add selected entities to classification_boxes.
-	foreach ( $classification_boxes as $i => $box ) {
+	foreach ($classification_boxes as $i => $box) {
 
 		// Get the entity referenced from the post content.
 		/*
@@ -128,118 +128,116 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris($post_content);
 
 		// Enhance current box selected entities.
-		$classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
+		$classification_boxes[$i]['selectedEntities'] = $entity_uris;
 
 		// Maps the URIs to entity posts.
 		$entity_service = Wordlift_Entity_Service::get_instance();
 
 		// Replace all entity URI's with post ID's if found or null if there is no related post.
 		$entity_ids = array_map(
-			function ( $item ) use ( $entity_service ) {
+			function($item) use ($entity_service) {
 				// Return entity post by the entity URI or null.
-				$post = $entity_service->get_entity_post_by_uri( $item );
+				$post = $entity_service->get_entity_post_by_uri($item);
 
 				// Check that the post object is not null.
-				if ( ! empty( $post ) ) {
+				if ( ! empty($post)) {
 					  return $post->ID;
 				}
 			},
 			$entity_uris
 		);
 		// Store the entity ids for all the 4W.
-		$all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
+		$all_referenced_entities_ids = array_merge($all_referenced_entities_ids, $entity_ids);
 
 	}
 
 	// Json encoding for classification boxes structure.
-	$classification_boxes = wp_json_encode( $classification_boxes );
+	$classification_boxes = wp_json_encode($classification_boxes);
 
 	// Ensure there are no repetitions of the referenced entities.
-	$all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
+	$all_referenced_entities_ids = array_unique($all_referenced_entities_ids);
 
 	// Remove all null, false and empty strings.
 	// NULL is being returned in some cases, when there is not related post, so we need to remove it.
-	$all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
+	$all_referenced_entities_ids = array_filter($all_referenced_entities_ids);
 
 	// Build the entity storage object.
 	$referenced_entities_obj = array();
-	foreach ( $all_referenced_entities_ids as $referenced_entity ) {
-		$entity = wl_serialize_entity( $referenced_entity );
+	foreach ($all_referenced_entities_ids as $referenced_entity) {
+		$entity = wl_serialize_entity($referenced_entity);
 		// Set a default confidence of `PHP_INT_MAX` for already annotated entities.
-		$referenced_entities_obj[ $entity['id'] ] = $entity
-													+ array( 'confidence' => PHP_INT_MAX );
+		$referenced_entities_obj[$entity['id']] = $entity
+													+ array('confidence' => PHP_INT_MAX);
 	}
 
-	$referenced_entities_obj = empty( $referenced_entities_obj ) ?
-		'{}' : wp_json_encode( $referenced_entities_obj );
+	$referenced_entities_obj = empty($referenced_entities_obj) ?
+		'{}' : wp_json_encode($referenced_entities_obj);
 
-	$published_place_id  = get_post_meta(
+	$published_place_id = get_post_meta(
 		$post->ID,
 		Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
 		true
 	);
-	$published_place_obj = ( $published_place_id ) ?
-		wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
-		null;
+	$published_place_obj = ($published_place_id) ?
+		wp_json_encode(wl_serialize_entity($published_place_id)) : null;
 
-	$topic_id  = get_post_meta(
+	$topic_id = get_post_meta(
 		$post->ID,
 		Wordlift_Schema_Service::FIELD_TOPIC,
 		true
 	);
-	$topic_obj = ( $topic_id ) ?
-		wp_json_encode( wl_serialize_entity( $topic_id ) ) :
-		null;
+	$topic_obj = ($topic_id) ?
+		wp_json_encode(wl_serialize_entity($topic_id)) : null;
 
 	$configuration_service = Wordlift_Configuration_Service::get_instance();
 
 	$default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
 	$default_path           = WL_DEFAULT_PATH;
 	$dataset_uri            = $configuration_service->get_dataset_uri();
-	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
+	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri($post->ID);
+	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity($post->ID);
 
 	// Retrieve the current post author.
-	$post_author = get_userdata( $post->post_author )->display_name;
+	$post_author = get_userdata($post->post_author)->display_name;
 	// Retrive the published date.
-	$published_date = get_the_time( 'Y-m-d', $post->ID );
+	$published_date = get_the_time('Y-m-d', $post->ID);
 	// Current language.
 	$current_language            = $configuration_service->get_language_code();
 	$wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
-	$timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
-	$addslashes_post_author      = addslashes( $post_author );
+	$timelinejs_default_options  = wp_json_encode($wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT);
+	$addslashes_post_author      = addslashes($post_author);
 
 	$metabox_settings = array(
-		'classificationBoxes'      => json_decode( $classification_boxes ),
-		'entities'                 => json_decode( $referenced_entities_obj ),
-		'currentPostId'            => intval( $post->ID ),
+		'classificationBoxes'      => json_decode($classification_boxes),
+		'entities'                 => json_decode($referenced_entities_obj),
+		'currentPostId'            => intval($post->ID),
 		'currentPostUri'           => $current_post_uri,
 		'currentPostType'          => $post->post_type,
-		'isEntity'                 => ! empty( $is_entity ),
+		'isEntity'                 => ! empty($is_entity),
 		'defaultThumbnailPath'     => $default_thumbnail_path,
 		'defaultWordLiftPath'      => $default_path,
 		'datasetUri'               => $dataset_uri,
 		'currentUser'              => $addslashes_post_author,
 		'publishedDate'            => $published_date,
 		'publishedPlace'           => $published_place_obj,
-		'topic'                    => json_decode( $topic_obj ),
+		'topic'                    => json_decode($topic_obj),
 		'currentLanguage'          => $current_language,
-		'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
-		'ajax_url'                 => admin_url( 'admin-ajax.php' ),
+		'timelinejsDefaultOptions' => json_decode($timelinejs_default_options),
+		'ajax_url'                 => admin_url('admin-ajax.php'),
 	);
 
 	// Allow Classic and Block Editor scripts to register first.
 	// Hook to the Block Editor script.
-	wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+	wp_localize_script('wl-block-editor', '_wlMetaBoxSettings', array('settings' => $metabox_settings));
 
 	// Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
-	wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+	wp_localize_script('wl-classic-editor', '_wlMetaBoxSettings', array('settings' => $metabox_settings));
 
 }
 
-add_action( 'admin_print_scripts-post.php', 'wl_entities_box_content_scripts', 11 );
-add_action( 'admin_print_scripts-post-new.php', 'wl_entities_box_content_scripts', 11 );
+add_action('admin_print_scripts-post.php', 'wl_entities_box_content_scripts', 11);
+add_action('admin_print_scripts-post-new.php', 'wl_entities_box_content_scripts', 11);

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-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');
 	}
 
 }