insideout10 / wordlift-plugin

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

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
 	 * Get the singleton instance of the Notice service.
 	 *
 	 * @since 3.14.0
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+	 * @return Wordlift_Notice_Service The singleton instance of the settings page service.
 	 */
 	public static function get_instance() {
 

Indentation +316 added lines, -316 removed lines

@@ -18,321 +18,321 @@
  */
 class Wordlift_Admin_Settings_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * 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;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.11.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.13.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;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 */
-	private $language_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 */
-	private $publisher_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift_Configuration_Service         $configuration_service
-	 * @param \Wordlift_Entity_Service                $entity_service
-	 * @param \Wordlift_Admin_Input_Element           $input_element
-	 * @param \Wordlift_Admin_Language_Select_Element $language_select_element
-	 * @param \Wordlift_Admin_Publisher_Element       $publisher_element
-	 * @param \Wordlift_Admin_Radio_Input_Element     $radio_input_element
-	 */
-	function __construct( $configuration_service, $entity_service, $input_element, $language_select_element, $publisher_element, $radio_input_element ) {
-
-		$this->configuration_service = $configuration_service;
-		$this->entity_service        = $entity_service;
-
-		// Set a reference to the UI elements.
-		$this->input_element           = $input_element;
-		$this->radio_input_element     = $radio_input_element;
-		$this->language_select_element = $language_select_element;
-		$this->publisher_element       = $publisher_element;
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @since 3.14.0
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_page_title() {
-
-		return 'WorldLift Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_title() {
-
-		return 'Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_slug() {
-
-		return 'wl_configuration_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_partial_name() {
-
-		return 'wordlift-admin-settings-page.php';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function enqueue_scripts() {
-
-		// Enqueue the media scripts to be used for the publisher's logo selection.
-		wp_enqueue_media();
-
-		// JavaScript required for the settings page.
-		// @todo: try to move to the `wordlift-admin.bundle.js`.
-		wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/wordlift-admin-settings-page.bundle.js', array( 'wp-util' ) );
-
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.11.0
-	 */
-	function admin_init() {
-
-		// Register WordLift's general settings, providing our own sanitize callback
-		// which will also check whether the user filled the WL Publisher form.
-		register_setting(
-			'wl_general_settings',
-			'wl_general_settings',
-			array( $this, 'sanitize_callback', )
-		);
-
-		// Add the general settings section.
-		add_settings_section(
-			'wl_general_settings_section', // ID used to identify this section and with which to register options.
-			'',                            // Section header.
-			'',                            // Callback used to render the description of the section.
-			'wl_general_settings'          // Page on which to add this section of options.
-		);
-
-		$key_args = array(
-			'id'          => 'wl-key',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
-			'value'       => $this->configuration_service->get_key(),
-			'description' => _x( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' ),
-		);
-
-		// Set the class for the key field based on the validity of the key.
-		// Class should be "untouched" for an empty (virgin) value, "valid"
-		// if the key is valid, or "invalid" otherwise.
-		$validation_service = new Wordlift_Key_Validation_Service();
-
-		if ( empty( $key_args['value'] ) ) {
-			$key_args['css_class'] = 'untouched';
-		} elseif ( $validation_service->is_valid( $key_args['value'] ) ) {
-			$key_args['css_class'] = 'valid';
-		} else {
-			$key_args['css_class'] = 'invalid';
-		}
-
-		// Add the `key` field.
-		add_settings_field(
-			'wl-key',                                       // Element id used to identify the field throughout the theme.
-			_x( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
-			// The name of the function responsible for rendering the option interface.
-			array( $this->input_element, 'render', ),
-			'wl_general_settings',                          // The page on which this option will be displayed.
-			'wl_general_settings_section',                  // The name of the section to which this field belongs.
-			$key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
-		);
-
-		// Entity Base Path input.
-		$entity_base_path_args = array(
-			// The array of arguments to pass to the callback. In this case, just a description.
-			'id'          => 'wl-entity-base-path',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
-			'value'       => $this->configuration_service->get_entity_base_path(),
-			'description' => sprintf( _x( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
-		);
-
-		$entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
-
-		// Add the `wl_entity_base_path` field.
-		add_settings_field(
-			'wl-entity-base-path',                                // ID used to identify the field throughout the theme
-			_x( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
-			// The name of the function responsible for rendering the option interface
-			array( $this->input_element, 'render', ),
-			'wl_general_settings',                                // The page on which this option will be displayed
-			'wl_general_settings_section',                        // The name of the section to which this field belongs
-			$entity_base_path_args
-		);
-
-		// Add the `language_name` field.
-		add_settings_field(
-			'wl-site-language',
-			_x( 'Site Language', 'wordlift' ),
-			array( $this->language_select_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				// The array of arguments to pass to the callback. In this case, just a description.
-				'id'          => 'wl-site-language',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LANGUAGE . ']',
-				'value'       => $this->configuration_service->get_language_code(),
-				'description' => __( 'Each WordLift Key can be used only in one language. Pick yours.', 'wordlift' ),
-			)
-		);
-
-		// Add the `publisher` field.
-		add_settings_field(
-			'wl-publisher-id',
-			_x( 'Publisher', 'wordlift' ),
-			array( $this->publisher_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'   => 'wl-publisher-id',
-				'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
-			)
-		);
-
-		// Add the `link by default` field.
-		add_settings_field(
-			'wl-link-by-default',
-			_x( 'Link by Default', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-link-by-default',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
-				'value'       => $this->configuration_service->is_link_by_default() ? 'yes' : 'no',
-				'description' => _x( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 */
-	function sanitize_callback( $input ) {
-
-		// Check whether a publisher name has been set.
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) {
-			$name         = $_POST['wl_publisher']['name'];
-			$type         = $_POST['wl_publisher']['type'];
-			$thumbnail_id = $_POST['wl_publisher']['thumbnail_id'] ?: null;
-
-			// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-			$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
-
-			// Create an entity for the publisher and assign it to the input
-			// parameter which WordPress automatically saves into the settings.
-			$input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
-		}
-
-		return $input;
-	}
+    /**
+     * 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;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.11.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.13.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;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     */
+    private $language_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     */
+    private $publisher_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift_Configuration_Service         $configuration_service
+     * @param \Wordlift_Entity_Service                $entity_service
+     * @param \Wordlift_Admin_Input_Element           $input_element
+     * @param \Wordlift_Admin_Language_Select_Element $language_select_element
+     * @param \Wordlift_Admin_Publisher_Element       $publisher_element
+     * @param \Wordlift_Admin_Radio_Input_Element     $radio_input_element
+     */
+    function __construct( $configuration_service, $entity_service, $input_element, $language_select_element, $publisher_element, $radio_input_element ) {
+
+        $this->configuration_service = $configuration_service;
+        $this->entity_service        = $entity_service;
+
+        // Set a reference to the UI elements.
+        $this->input_element           = $input_element;
+        $this->radio_input_element     = $radio_input_element;
+        $this->language_select_element = $language_select_element;
+        $this->publisher_element       = $publisher_element;
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @since 3.14.0
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_page_title() {
+
+        return 'WorldLift Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_title() {
+
+        return 'Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_slug() {
+
+        return 'wl_configuration_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_partial_name() {
+
+        return 'wordlift-admin-settings-page.php';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function enqueue_scripts() {
+
+        // Enqueue the media scripts to be used for the publisher's logo selection.
+        wp_enqueue_media();
+
+        // JavaScript required for the settings page.
+        // @todo: try to move to the `wordlift-admin.bundle.js`.
+        wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/wordlift-admin-settings-page.bundle.js', array( 'wp-util' ) );
+
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.11.0
+     */
+    function admin_init() {
+
+        // Register WordLift's general settings, providing our own sanitize callback
+        // which will also check whether the user filled the WL Publisher form.
+        register_setting(
+            'wl_general_settings',
+            'wl_general_settings',
+            array( $this, 'sanitize_callback', )
+        );
+
+        // Add the general settings section.
+        add_settings_section(
+            'wl_general_settings_section', // ID used to identify this section and with which to register options.
+            '',                            // Section header.
+            '',                            // Callback used to render the description of the section.
+            'wl_general_settings'          // Page on which to add this section of options.
+        );
+
+        $key_args = array(
+            'id'          => 'wl-key',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
+            'value'       => $this->configuration_service->get_key(),
+            'description' => _x( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' ),
+        );
+
+        // Set the class for the key field based on the validity of the key.
+        // Class should be "untouched" for an empty (virgin) value, "valid"
+        // if the key is valid, or "invalid" otherwise.
+        $validation_service = new Wordlift_Key_Validation_Service();
+
+        if ( empty( $key_args['value'] ) ) {
+            $key_args['css_class'] = 'untouched';
+        } elseif ( $validation_service->is_valid( $key_args['value'] ) ) {
+            $key_args['css_class'] = 'valid';
+        } else {
+            $key_args['css_class'] = 'invalid';
+        }
+
+        // Add the `key` field.
+        add_settings_field(
+            'wl-key',                                       // Element id used to identify the field throughout the theme.
+            _x( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
+            // The name of the function responsible for rendering the option interface.
+            array( $this->input_element, 'render', ),
+            'wl_general_settings',                          // The page on which this option will be displayed.
+            'wl_general_settings_section',                  // The name of the section to which this field belongs.
+            $key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
+        );
+
+        // Entity Base Path input.
+        $entity_base_path_args = array(
+            // The array of arguments to pass to the callback. In this case, just a description.
+            'id'          => 'wl-entity-base-path',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
+            'value'       => $this->configuration_service->get_entity_base_path(),
+            'description' => sprintf( _x( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
+        );
+
+        $entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
+
+        // Add the `wl_entity_base_path` field.
+        add_settings_field(
+            'wl-entity-base-path',                                // ID used to identify the field throughout the theme
+            _x( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
+            // The name of the function responsible for rendering the option interface
+            array( $this->input_element, 'render', ),
+            'wl_general_settings',                                // The page on which this option will be displayed
+            'wl_general_settings_section',                        // The name of the section to which this field belongs
+            $entity_base_path_args
+        );
+
+        // Add the `language_name` field.
+        add_settings_field(
+            'wl-site-language',
+            _x( 'Site Language', 'wordlift' ),
+            array( $this->language_select_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                // The array of arguments to pass to the callback. In this case, just a description.
+                'id'          => 'wl-site-language',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LANGUAGE . ']',
+                'value'       => $this->configuration_service->get_language_code(),
+                'description' => __( 'Each WordLift Key can be used only in one language. Pick yours.', 'wordlift' ),
+            )
+        );
+
+        // Add the `publisher` field.
+        add_settings_field(
+            'wl-publisher-id',
+            _x( 'Publisher', 'wordlift' ),
+            array( $this->publisher_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'   => 'wl-publisher-id',
+                'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
+            )
+        );
+
+        // Add the `link by default` field.
+        add_settings_field(
+            'wl-link-by-default',
+            _x( 'Link by Default', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-link-by-default',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
+                'value'       => $this->configuration_service->is_link_by_default() ? 'yes' : 'no',
+                'description' => _x( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @since 3.11.0
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     */
+    function sanitize_callback( $input ) {
+
+        // Check whether a publisher name has been set.
+        if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) {
+            $name         = $_POST['wl_publisher']['name'];
+            $type         = $_POST['wl_publisher']['type'];
+            $thumbnail_id = $_POST['wl_publisher']['thumbnail_id'] ?: null;
+
+            // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+            $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
+
+            // Create an entity for the publisher and assign it to the input
+            // parameter which WordPress automatically saves into the settings.
+            $input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
+        }
+
+        return $input;
+    }
 
 }

src/admin/class-wordlift-admin.php

Indentation +132 added lines, -132 removed lines

@@ -22,137 +22,137 @@
  */
 class Wordlift_Admin {
 
-	/**
-	 * The ID of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $plugin_name The ID of this plugin.
-	 */
-	private $plugin_name;
-
-	/**
-	 * The version of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $version The current version of this plugin.
-	 */
-	private $version;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @since    1.0.0
-	 *
-	 * @param   string                           $plugin_name           The name of this plugin.
-	 * @param   string                           $version               The version of this plugin.
-	 * @param    \Wordlift_Configuration_Service $configuration_service The configuration service.
-	 * @param    \Wordlift_Notice_Service        $notice_service        The notice service.
-	 */
-	public function __construct( $plugin_name, $version, $configuration_service, $notice_service ) {
-
-		$this->plugin_name = $plugin_name;
-		$this->version     = $version;
-
-		$dataset_uri = $configuration_service->get_dataset_uri();
-		$key         = $configuration_service->get_key();
-
-		if ( empty( $dataset_uri ) ) {
-			$settings_page = Wordlift_Admin_Settings_Page::get_instance();
-			if ( empty( $key ) ) {
-				$error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
-			} else {
-				$error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
-			}
-			$notice_service->add_error( $error );
-		}
-
-	}
-
-	/**
-	 * Register the stylesheets for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_styles() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
-
-	}
-
-	/**
-	 * Register the JavaScript for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_scripts() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		$configuration_service = Wordlift_Configuration_Service::get_instance();
-
-		// Enqueue the admin scripts.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
-			'jquery',
-			'underscore',
-			'backbone',
-		), $this->version, false );
-
-		// Set the basic params.
-		$params = array(
-			// @todo scripts in admin should use wp.post.
-			'ajax_url'        => admin_url( 'admin-ajax.php' ),
-			// @todo remove specific actions from settings.
-			'action'          => 'entity_by_title',
-			'datasetUri'      => $configuration_service->get_dataset_uri(),
-			'language'        => $configuration_service->get_language_code(),
-			'link_by_default' => $configuration_service->is_link_by_default(),
-			'l10n'            => array(
-				'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
-				'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
-				'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
-			),
-		);
-
-		// Set post-related values if there's a current post.
-		if ( null !== $post = $entity_being_edited = get_post() ) {
-
-			$params['post_id']           = $entity_being_edited->ID;
-			$params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
-			// We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
-			// from the results, since we don't want the current entity to be discovered by the analysis.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/345
-			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
-
-		}
-
-		// Finally output the params as `wlSettings` for JavaScript code.
-		wp_localize_script( $this->plugin_name, 'wlSettings', $params );
-
-	}
+    /**
+     * The ID of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $plugin_name The ID of this plugin.
+     */
+    private $plugin_name;
+
+    /**
+     * The version of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $version The current version of this plugin.
+     */
+    private $version;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @since    1.0.0
+     *
+     * @param   string                           $plugin_name           The name of this plugin.
+     * @param   string                           $version               The version of this plugin.
+     * @param    \Wordlift_Configuration_Service $configuration_service The configuration service.
+     * @param    \Wordlift_Notice_Service        $notice_service        The notice service.
+     */
+    public function __construct( $plugin_name, $version, $configuration_service, $notice_service ) {
+
+        $this->plugin_name = $plugin_name;
+        $this->version     = $version;
+
+        $dataset_uri = $configuration_service->get_dataset_uri();
+        $key         = $configuration_service->get_key();
+
+        if ( empty( $dataset_uri ) ) {
+            $settings_page = Wordlift_Admin_Settings_Page::get_instance();
+            if ( empty( $key ) ) {
+                $error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+            } else {
+                $error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+            }
+            $notice_service->add_error( $error );
+        }
+
+    }
+
+    /**
+     * Register the stylesheets for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_styles() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
+
+    }
+
+    /**
+     * Register the JavaScript for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_scripts() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        $configuration_service = Wordlift_Configuration_Service::get_instance();
+
+        // Enqueue the admin scripts.
+        wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
+            'jquery',
+            'underscore',
+            'backbone',
+        ), $this->version, false );
+
+        // Set the basic params.
+        $params = array(
+            // @todo scripts in admin should use wp.post.
+            'ajax_url'        => admin_url( 'admin-ajax.php' ),
+            // @todo remove specific actions from settings.
+            'action'          => 'entity_by_title',
+            'datasetUri'      => $configuration_service->get_dataset_uri(),
+            'language'        => $configuration_service->get_language_code(),
+            'link_by_default' => $configuration_service->is_link_by_default(),
+            'l10n'            => array(
+                'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
+                'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
+                'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
+            ),
+        );
+
+        // Set post-related values if there's a current post.
+        if ( null !== $post = $entity_being_edited = get_post() ) {
+
+            $params['post_id']           = $entity_being_edited->ID;
+            $params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
+            // We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
+            // from the results, since we don't want the current entity to be discovered by the analysis.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/345
+            $params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
+
+        }
+
+        // Finally output the params as `wlSettings` for JavaScript code.
+        wp_localize_script( $this->plugin_name, 'wlSettings', $params );
+
+    }
 
 }

Spacing +17 added lines, -17 removed lines

@@ -50,7 +50,7 @@ 
 	 * @param    \Wordlift_Configuration_Service $configuration_service The configuration service.
 	 * @param    \Wordlift_Notice_Service        $notice_service        The notice service.
 	 */
-	public function __construct( $plugin_name, $version, $configuration_service, $notice_service ) {
+	public function __construct($plugin_name, $version, $configuration_service, $notice_service) {
 
 		$this->plugin_name = $plugin_name;
 		$this->version     = $version;
@@ -58,14 +58,14 @@ 
 		$dataset_uri = $configuration_service->get_dataset_uri();
 		$key         = $configuration_service->get_key();
 
-		if ( empty( $dataset_uri ) ) {
+		if (empty($dataset_uri)) {
 			$settings_page = Wordlift_Admin_Settings_Page::get_instance();
-			if ( empty( $key ) ) {
-				$error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+			if (empty($key)) {
+				$error = sprintf(esc_html__("WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift'), '<a href="'.$settings_page->get_url().'">'.esc_html__('settings page', 'wordlift').'</a>');
 			} else {
-				$error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+				$error = sprintf(esc_html__("WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift'), '<a href="'.$settings_page->get_url().'">'.esc_html__('settings page', 'wordlift').'</a>');
 			}
-			$notice_service->add_error( $error );
+			$notice_service->add_error($error);
 		}
 
 	}
@@ -89,7 +89,7 @@ 
 		 * class.
 		 */
 
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
+		wp_enqueue_style($this->plugin_name, plugin_dir_url(__FILE__).'css/wordlift-admin.css', array(), $this->version, 'all');
 
 	}
 
@@ -115,43 +115,43 @@ 
 		$configuration_service = Wordlift_Configuration_Service::get_instance();
 
 		// Enqueue the admin scripts.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
+		wp_enqueue_script($this->plugin_name, plugin_dir_url(__FILE__).'js/wordlift-admin.bundle.js', array(
 			'jquery',
 			'underscore',
 			'backbone',
-		), $this->version, false );
+		), $this->version, false);
 
 		// Set the basic params.
 		$params = array(
 			// @todo scripts in admin should use wp.post.
-			'ajax_url'        => admin_url( 'admin-ajax.php' ),
+			'ajax_url'        => admin_url('admin-ajax.php'),
 			// @todo remove specific actions from settings.
 			'action'          => 'entity_by_title',
 			'datasetUri'      => $configuration_service->get_dataset_uri(),
 			'language'        => $configuration_service->get_language_code(),
 			'link_by_default' => $configuration_service->is_link_by_default(),
 			'l10n'            => array(
-				'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
-				'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
-				'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
+				'You already published an entity with the same name' => __('You already published an entity with the same name: ', 'wordlift'),
+				'logo_selection_title'                               => __('WordLift Choose Logo', 'wordlift'),
+				'logo_selection_button'                              => array('text' => __('Choose Logo', 'wordlift')),
 			),
 		);
 
 		// Set post-related values if there's a current post.
-		if ( null !== $post = $entity_being_edited = get_post() ) {
+		if (null !== $post = $entity_being_edited = get_post()) {
 
 			$params['post_id']           = $entity_being_edited->ID;
-			$params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
+			$params['entityBeingEdited'] = isset($entity_being_edited->post_type) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric(get_the_ID());
 			// We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
 			// from the results, since we don't want the current entity to be discovered by the analysis.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/345
-			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
+			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri($entity_being_edited->ID);
 
 		}
 
 		// Finally output the params as `wlSettings` for JavaScript code.
-		wp_localize_script( $this->plugin_name, 'wlSettings', $params );
+		wp_localize_script($this->plugin_name, 'wlSettings', $params);
 
 	}
 

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

Indentation +125 added lines, -125 removed lines

@@ -18,130 +18,130 @@
  */
 abstract class Wordlift_Admin_Page {
 
-	/**
-	 * Get the parent slug.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The parent slug (default 'wl_admin_menu').
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * Get the required capability.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The capability (default 'manage_options').
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * Get the page title. Will be translated.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The page title.
-	 */
-	abstract function get_page_title();
-
-	/**
-	 * Get the menu title. Will be translated.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The menu title.
-	 */
-	abstract function get_menu_title();
-
-	/**
-	 * Get the menu slug.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The menu slug.
-	 */
-	abstract function get_menu_slug();
-
-	/**
-	 * Get the page url.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @return string The escaped url of the admin page
-	 */
-	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.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return string The partial file name.
-	 */
-	abstract function get_partial_name();
-
-	/**
-	 * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
-	 * page to the admin menu.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
-	 */
-	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() );
-
-	}
+    /**
+     * Get the parent slug.
+     *
+     * @since 3.11.0
+     *
+     * @return string The parent slug (default 'wl_admin_menu').
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * Get the required capability.
+     *
+     * @since 3.11.0
+     *
+     * @return string The capability (default 'manage_options').
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * Get the page title. Will be translated.
+     *
+     * @since 3.11.0
+     *
+     * @return string The page title.
+     */
+    abstract function get_page_title();
+
+    /**
+     * Get the menu title. Will be translated.
+     *
+     * @since 3.11.0
+     *
+     * @return string The menu title.
+     */
+    abstract function get_menu_title();
+
+    /**
+     * Get the menu slug.
+     *
+     * @since 3.11.0
+     *
+     * @return string The menu slug.
+     */
+    abstract function get_menu_slug();
+
+    /**
+     * Get the page url.
+     *
+     * @since 3.14.0
+     *
+     * @return string The escaped url of the admin page
+     */
+    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.
+     *
+     * @since 3.11.0
+     *
+     * @return string The partial file name.
+     */
+    abstract function get_partial_name();
+
+    /**
+     * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
+     * page to the admin menu.
+     *
+     * @since 3.11.0
+     *
+     * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
+     */
+    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

@@ -79,9 +79,9 @@ 
 	function get_url() {
 
 		// ideally should have used menu_page_url, but it is loaded later than some usages.
-		$url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
+		$url = admin_url('admin.php?page='.$this->get_menu_slug());
 
-		return esc_url( $url );
+		return esc_url($url);
 	}
 
 	/**
@@ -110,16 +110,16 @@ 
 			$this->get_parent_slug(),
 			$this->get_page_title(),
 			$this->get_menu_title(),
-			$this->get_capability(),                   // The required capability, provided by the calling hook.
+			$this->get_capability(), // The required capability, provided by the calling hook.
 			$this->get_menu_slug(),
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 
 		// Set a hook to enqueue scripts only when the settings page is displayed.
-		add_action( 'admin_print_scripts-' . $page, array(
+		add_action('admin_print_scripts-'.$page, array(
 			$this,
 			'enqueue_scripts',
-		) );
+		));
 
 		// Finally return the page hook_suffix.
 		return $page;
@@ -140,7 +140,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());
 
 	}