w3bdesign / algolia-woo-indexer

classes/class-algolia-woo-indexer.php

Indentation +464 added lines, -464 removed lines

@@ -23,418 +23,418 @@ 
  * Include plugin file if function is_plugin_active does not exist
  */
 if (! function_exists('is_plugin_active')) {
-    require_once(ABSPATH . '/wp-admin/includes/plugin.php');
+	require_once(ABSPATH . '/wp-admin/includes/plugin.php');
 }
 
 if (! class_exists('Algolia_Woo_Indexer')) {
-    /**
-     * Algolia WooIndexer main class
-     */
-    class Algolia_Woo_Indexer
-    {
-        const PLUGIN_NAME      = 'Algolia Woo Indexer';
-        const PLUGIN_TRANSIENT = 'algowoo-plugin-notice';
-
-        /**
-         * Class instance
-         *
-         * @var object
-         */
-        private static $instance;
-
-        /**
-         * The plugin URL
-         *
-         * @var string
-         */
-        private static $plugin_url = '';
-
-        /**
-         * Class constructor
-         *
-         * @return void
-         */
-        public function __construct()
-        {
-            $this->init();
-        }
-
-        /**
-         * Setup sections and fields to store and retrieve values from Settings API
-         *
-         * @return void
-         */
-        public static function setup_settings_sections()
-        {
-            /**
-            * Setup arguments for settings sections and fields
-            *
-            * @see https://developer.wordpress.org/reference/functions/register_setting/
-            */
-            if (is_admin()) {
-                $arguments = array(
-                    'type'              => 'string',
-                    'sanitize_callback' => 'settings_fields_validate_options',
-                    'default'           => null,
-                );
-                register_setting('algolia_woo_options', 'algolia_woo_options', $arguments);
-
-                /**
-                 * Make sure we reference the instance of the current class by using self::get_instance()
-                 * This way we can setup the correct callback function for add_settings_section and add_settings_field
-                 */
-                $algowooindexer = self::get_instance();
-
-                /**
-                 * Add our necessary settings sections and fields
-                 */
-                add_settings_section(
-                    'algolia_woo_indexer_main',
-                    esc_html__('Algolia Woo Plugin Settings', 'algolia-woo-indexer'),
-                    array( $algowooindexer, 'algolia_woo_indexer_section_text' ),
-                    'algolia_woo_indexer'
-                );
-                add_settings_field(
-                    'algolia_woo_indexer_application_id',
-                    esc_html__('Application ID', 'algolia-woo-indexer'),
-                    array( $algowooindexer, 'algolia_woo_indexer_application_id_output' ),
-                    'algolia_woo_indexer',
-                    'algolia_woo_indexer_main'
-                );
-                add_settings_field(
-                    'algolia_woo_indexer_admin_api_key',
-                    esc_html__('Admin API Key', 'algolia-woo-indexer'),
-                    array( $algowooindexer, 'algolia_woo_indexer_admin_api_key_output' ),
-                    'algolia_woo_indexer',
-                    'algolia_woo_indexer_main'
-                );
-                add_settings_field(
-                    'algolia_woo_indexer_index_name',
-                    esc_html__('Index name (will be created if not existing)', 'algolia-woo-indexer'),
-                    array( $algowooindexer, 'algolia_woo_indexer_index_name_output' ),
-                    'algolia_woo_indexer',
-                    'algolia_woo_indexer_main'
-                );
-                add_settings_field(
-                    'algolia_woo_indexer_automatically_send_new_products',
-                    esc_html__('Automatically index new products', 'algolia-woo-indexer'),
-                    array( $algowooindexer, 'algolia_woo_indexer_automatically_send_new_products_output' ),
-                    'algolia_woo_indexer',
-                    'algolia_woo_indexer_main'
-                );
-            }
-        }
-
-        /**
-         * Output for admin API key field
-         *
-         * @see https://developer.wordpress.org/reference/functions/wp_nonce_field/
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_admin_api_key_output()
-        {
-            $api_key = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
-            $api_key = is_string($api_key) ? $api_key : CHANGE_ME;
-
-            wp_nonce_field('algolia_woo_indexer_admin_api_nonce_action', 'algolia_woo_indexer_admin_api_nonce_name');
-
-            echo "<input id='algolia_woo_indexer_admin_api_key' name='algolia_woo_indexer_admin_api_key[key]'
+	/**
+	 * Algolia WooIndexer main class
+	 */
+	class Algolia_Woo_Indexer
+	{
+		const PLUGIN_NAME      = 'Algolia Woo Indexer';
+		const PLUGIN_TRANSIENT = 'algowoo-plugin-notice';
+
+		/**
+		 * Class instance
+		 *
+		 * @var object
+		 */
+		private static $instance;
+
+		/**
+		 * The plugin URL
+		 *
+		 * @var string
+		 */
+		private static $plugin_url = '';
+
+		/**
+		 * Class constructor
+		 *
+		 * @return void
+		 */
+		public function __construct()
+		{
+			$this->init();
+		}
+
+		/**
+		 * Setup sections and fields to store and retrieve values from Settings API
+		 *
+		 * @return void
+		 */
+		public static function setup_settings_sections()
+		{
+			/**
+			 * Setup arguments for settings sections and fields
+			 *
+			 * @see https://developer.wordpress.org/reference/functions/register_setting/
+			 */
+			if (is_admin()) {
+				$arguments = array(
+					'type'              => 'string',
+					'sanitize_callback' => 'settings_fields_validate_options',
+					'default'           => null,
+				);
+				register_setting('algolia_woo_options', 'algolia_woo_options', $arguments);
+
+				/**
+				 * Make sure we reference the instance of the current class by using self::get_instance()
+				 * This way we can setup the correct callback function for add_settings_section and add_settings_field
+				 */
+				$algowooindexer = self::get_instance();
+
+				/**
+				 * Add our necessary settings sections and fields
+				 */
+				add_settings_section(
+					'algolia_woo_indexer_main',
+					esc_html__('Algolia Woo Plugin Settings', 'algolia-woo-indexer'),
+					array( $algowooindexer, 'algolia_woo_indexer_section_text' ),
+					'algolia_woo_indexer'
+				);
+				add_settings_field(
+					'algolia_woo_indexer_application_id',
+					esc_html__('Application ID', 'algolia-woo-indexer'),
+					array( $algowooindexer, 'algolia_woo_indexer_application_id_output' ),
+					'algolia_woo_indexer',
+					'algolia_woo_indexer_main'
+				);
+				add_settings_field(
+					'algolia_woo_indexer_admin_api_key',
+					esc_html__('Admin API Key', 'algolia-woo-indexer'),
+					array( $algowooindexer, 'algolia_woo_indexer_admin_api_key_output' ),
+					'algolia_woo_indexer',
+					'algolia_woo_indexer_main'
+				);
+				add_settings_field(
+					'algolia_woo_indexer_index_name',
+					esc_html__('Index name (will be created if not existing)', 'algolia-woo-indexer'),
+					array( $algowooindexer, 'algolia_woo_indexer_index_name_output' ),
+					'algolia_woo_indexer',
+					'algolia_woo_indexer_main'
+				);
+				add_settings_field(
+					'algolia_woo_indexer_automatically_send_new_products',
+					esc_html__('Automatically index new products', 'algolia-woo-indexer'),
+					array( $algowooindexer, 'algolia_woo_indexer_automatically_send_new_products_output' ),
+					'algolia_woo_indexer',
+					'algolia_woo_indexer_main'
+				);
+			}
+		}
+
+		/**
+		 * Output for admin API key field
+		 *
+		 * @see https://developer.wordpress.org/reference/functions/wp_nonce_field/
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_admin_api_key_output()
+		{
+			$api_key = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
+			$api_key = is_string($api_key) ? $api_key : CHANGE_ME;
+
+			wp_nonce_field('algolia_woo_indexer_admin_api_nonce_action', 'algolia_woo_indexer_admin_api_nonce_name');
+
+			echo "<input id='algolia_woo_indexer_admin_api_key' name='algolia_woo_indexer_admin_api_key[key]'
 				type='text' value='" . esc_attr($api_key) . "' />";
-        }
-
-        /**
-         * Output for application ID field
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_application_id_output()
-        {
-            $application_id = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
-            $application_id = is_string($application_id) ? $application_id : CHANGE_ME;
-
-            echo "<input id='algolia_woo_indexer_application_id' name='algolia_woo_indexer_application_id[id]'
+		}
+
+		/**
+		 * Output for application ID field
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_application_id_output()
+		{
+			$application_id = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
+			$application_id = is_string($application_id) ? $application_id : CHANGE_ME;
+
+			echo "<input id='algolia_woo_indexer_application_id' name='algolia_woo_indexer_application_id[id]'
 				type='text' value='" . esc_attr($application_id) . "' />";
-        }
-
-        /**
-         * Output for index name field
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_index_name_output()
-        {
-            $index_name = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
-            $index_name = is_string($index_name) ? $index_name : CHANGE_ME;
-
-            echo "<input id='algolia_woo_indexer_index_name' name='algolia_woo_indexer_index_name[name]'
+		}
+
+		/**
+		 * Output for index name field
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_index_name_output()
+		{
+			$index_name = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
+			$index_name = is_string($index_name) ? $index_name : CHANGE_ME;
+
+			echo "<input id='algolia_woo_indexer_index_name' name='algolia_woo_indexer_index_name[name]'
 				type='text' value='" . esc_attr($index_name) . "' />";
-        }
+		}
         
-        /**
-         * Output for checkbox to check if we automatically send new products to Algolia
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_automatically_send_new_products_output()
-        {
-            /**
-             * Sanitization is not really needed as the variable is not directly echoed
-             * But I have still done it to be 100% safe
-             */
-            $automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
-            $automatically_send_new_products = (! empty($automatically_send_new_products)) ? 1 : 0; ?>
+		/**
+		 * Output for checkbox to check if we automatically send new products to Algolia
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_automatically_send_new_products_output()
+		{
+			/**
+			 * Sanitization is not really needed as the variable is not directly echoed
+			 * But I have still done it to be 100% safe
+			 */
+			$automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
+			$automatically_send_new_products = (! empty($automatically_send_new_products)) ? 1 : 0; ?>
 			<input id="algolia_woo_indexer_automatically_send_new_products" name="algolia_woo_indexer_automatically_send_new_products[checked]"
 			type="checkbox" <?php checked(1, $automatically_send_new_products); ?> />
 			<?php
-        }
-
-        /**
-         * Section text for plugin settings section text
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_section_text()
-        {
-            echo esc_html__('Enter your settings here', 'algolia-woo-indexer');
-        }
-
-        /**
-         * Check if we are going to send products by verifying send products nonce
-         *
-         * @return void
-         */
-        public static function maybe_send_products()
-        {
-            if (true === Algolia_Verify_Nonces::verify_send_products_nonce()) {
-                Algolia_Send_Products::send_products_to_algolia();
-            }
-        }
-
-        /**
-         * Initialize class, setup settings sections and fields
-         *
-         * @return void
-         */
-        public static function init()
-        {
-
-            /**
-             * Fetch the option to see if we are going to automatically send new products
-             */
-            $automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
-
-            /**
-             * Check that we have the minimum versions required and all of the required PHP extensions
-             */
-            Algolia_Check_Requirements::check_unmet_requirements();
-
-            if (! Algolia_Check_Requirements::algolia_wp_version_check() || ! Algolia_Check_Requirements::algolia_php_version_check()) {
-                add_action(
-                    'admin_notices',
-                    function () {
-                        echo '<div class="error notice">
+		}
+
+		/**
+		 * Section text for plugin settings section text
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_section_text()
+		{
+			echo esc_html__('Enter your settings here', 'algolia-woo-indexer');
+		}
+
+		/**
+		 * Check if we are going to send products by verifying send products nonce
+		 *
+		 * @return void
+		 */
+		public static function maybe_send_products()
+		{
+			if (true === Algolia_Verify_Nonces::verify_send_products_nonce()) {
+				Algolia_Send_Products::send_products_to_algolia();
+			}
+		}
+
+		/**
+		 * Initialize class, setup settings sections and fields
+		 *
+		 * @return void
+		 */
+		public static function init()
+		{
+
+			/**
+			 * Fetch the option to see if we are going to automatically send new products
+			 */
+			$automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
+
+			/**
+			 * Check that we have the minimum versions required and all of the required PHP extensions
+			 */
+			Algolia_Check_Requirements::check_unmet_requirements();
+
+			if (! Algolia_Check_Requirements::algolia_wp_version_check() || ! Algolia_Check_Requirements::algolia_php_version_check()) {
+				add_action(
+					'admin_notices',
+					function () {
+						echo '<div class="error notice">
                                   <p>' . esc_html__('Please check the server requirements for Algolia Woo Indexer. <br/> It requires minimum PHP version 7.2 and WordPress version 5.0', 'algolia-woo-indexer') . '</p>
                                 </div>';
-                    }
-                );
-            }
-
-            $ob_class = get_called_class();
-
-            /**
-             * Setup translations
-             */
-            add_action('plugins_loaded', array( $ob_class, 'load_textdomain' ));
-
-            /**
-             * Add actions to setup admin menu
-             */
-            if (is_admin()) {
-                add_action('admin_menu', array( $ob_class, 'admin_menu' ));
-                add_action('admin_init', array( $ob_class, 'setup_settings_sections' ));
-                add_action('admin_init', array( $ob_class, 'update_settings_options' ));
-                add_action('admin_init', array( $ob_class, 'maybe_send_products' ));
-
-                /**
-                 * Register hook to automatically send new products if the option is set
-                 */
-
-                if ('1' === $automatically_send_new_products) {
-                    add_action('save_post', array( $ob_class, 'send_new_product_to_algolia' ), 10, 3);
-                }
-
-                self::$plugin_url = admin_url('options-general.php?page=algolia-woo-indexer-settings');
-
-                if (! is_plugin_active('woocommerce/woocommerce.php')) {
-                    add_action(
-                        'admin_notices',
-                        function () {
-                            echo '<div class="error notice">
+					}
+				);
+			}
+
+			$ob_class = get_called_class();
+
+			/**
+			 * Setup translations
+			 */
+			add_action('plugins_loaded', array( $ob_class, 'load_textdomain' ));
+
+			/**
+			 * Add actions to setup admin menu
+			 */
+			if (is_admin()) {
+				add_action('admin_menu', array( $ob_class, 'admin_menu' ));
+				add_action('admin_init', array( $ob_class, 'setup_settings_sections' ));
+				add_action('admin_init', array( $ob_class, 'update_settings_options' ));
+				add_action('admin_init', array( $ob_class, 'maybe_send_products' ));
+
+				/**
+				 * Register hook to automatically send new products if the option is set
+				 */
+
+				if ('1' === $automatically_send_new_products) {
+					add_action('save_post', array( $ob_class, 'send_new_product_to_algolia' ), 10, 3);
+				}
+
+				self::$plugin_url = admin_url('options-general.php?page=algolia-woo-indexer-settings');
+
+				if (! is_plugin_active('woocommerce/woocommerce.php')) {
+					add_action(
+						'admin_notices',
+						function () {
+							echo '<div class="error notice">
 								  <p>' . esc_html__('WooCommerce plugin must be enabled for Algolia Woo Indexer to work.', 'algolia-woo-indexer') . '</p>
 								</div>';
-                        }
-                    );
-                }
-            }
-        }
-
-        /**
-         * Send a single product to Algolia once a new product has been published
-         *
-         * @param int   $post_id ID of the product.
-         * @param array $post Post array.
-         *
-         * @return void
-         */
-        public static function send_new_product_to_algolia($post_id, $post)
-        {
-            if ('publish' !== $post->post_status || 'product' !== $post->post_type) {
-                return;
-            }
-            Algolia_Send_Products::send_products_to_algolia($post_id);
-        }
-
-        /**
-         * Verify nonces before we update options and settings
-         * Also retrieve the value from the send_products_to_algolia hidden field to check if we are sending products to Algolia
-         *
-         * @return void
-         */
-        public static function update_settings_options()
-        {
-            Algolia_Verify_Nonces::verify_settings_nonce();
-
-            /**
-             * Do not proceed if we are going to send products
-             */
-            if (true === Algolia_Verify_Nonces::verify_send_products_nonce()) {
-                return;
-            }
-
-            /**
-             * Filter the application id, api key, index name and verify that the input is an array
-             *
-             * @see https://www.php.net/manual/en/function.filter-input.php
-             */
-            $post_application_id             = filter_input(INPUT_POST, 'algolia_woo_indexer_application_id', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
-            $post_api_key                    = filter_input(INPUT_POST, 'algolia_woo_indexer_admin_api_key', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
-            $post_index_name                 = filter_input(INPUT_POST, 'algolia_woo_indexer_index_name', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
-            $automatically_send_new_products = filter_input(INPUT_POST, 'algolia_woo_indexer_automatically_send_new_products', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
-
-            /**
-             * Properly sanitize text fields before updating data
-             *
-             * @see https://developer.wordpress.org/reference/functions/sanitize_text_field/
-             */
-            $filtered_application_id = sanitize_text_field($post_application_id['id']);
-            $filtered_api_key        = sanitize_text_field($post_api_key['key']);
-            $filtered_index_name     = sanitize_text_field($post_index_name['name']);
-
-            /**
-             * Sanitizing by setting the value to either 1 or 0
-             */
-            $filtered_automatically_send_new_products = (! empty($automatically_send_new_products)) ? 1 : 0;
-
-            /**
-             * Values have been filtered and sanitized
-             * Check if set and not empty and update the database
-             *
-             * @see https://developer.wordpress.org/reference/functions/update_option/
-             */
-            if (isset($filtered_application_id) && (! empty($filtered_application_id))) {
-                update_option(
-                    ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID,
-                    $filtered_application_id
-                );
-            }
-
-            if (isset($filtered_api_key) && (! empty($filtered_api_key))) {
-                update_option(
-                    ALGOWOO_DB_OPTION . ALGOLIA_API_KEY,
-                    $filtered_api_key
-                );
-            }
-
-            if (isset($filtered_index_name) && (! empty($filtered_index_name))) {
-                update_option(
-                    ALGOWOO_DB_OPTION . INDEX_NAME,
-                    $filtered_index_name
-                );
-            }
-
-            if (isset($filtered_automatically_send_new_products) && (! empty($filtered_automatically_send_new_products))) {
-                update_option(
-                    ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS,
-                    $filtered_automatically_send_new_products
-                );
-            }
-        }
-
-        /**
-         * Sanitize input in settings fields and filter through regex to accept only a-z and A-Z
-         *
-         * @param string $input Settings text data
-         * @return array
-         */
-        public static function settings_fields_validate_options($input)
-        {
-            $valid         = array();
-            $valid['name'] = preg_replace(
-                '/[^a-zA-Z\s]/',
-                '',
-                $input['name']
-            );
-            return $valid;
-        }
-
-        /**
-         * Load text domain for translations
-         *
-         * @return void
-         */
-        public static function load_textdomain()
-        {
-            load_plugin_textdomain('algolia-woo-indexer', false, basename(dirname(__FILE__)) . '/languages/');
-        }
-
-        /**
-         * Add the new menu to settings section so that we can configure the plugin
-         *
-         * @return void
-         */
-        public static function admin_menu()
-        {
-            add_submenu_page(
-                'options-general.php',
-                esc_html__('Algolia Woo Indexer Settings', 'algolia-woo-indexer'),
-                esc_html__('Algolia Woo Indexer Settings', 'algolia-woo-indexer'),
-                'manage_options',
-                'algolia-woo-indexer-settings',
-                array( get_called_class(), 'algolia_woo_indexer_settings' )
-            );
-        }
-
-        /**
-         * Display settings and allow user to modify them
-         *
-         * @return void
-         */
-        public static function algolia_woo_indexer_settings()
-        {
-            /**
-            * Verify that the user can access the settings page
-            */
-            if (! current_user_can('manage_options')) {
-                wp_die(esc_html__('Action not allowed.', 'algolia_woo_indexer_settings'));
-            } ?>
+						}
+					);
+				}
+			}
+		}
+
+		/**
+		 * Send a single product to Algolia once a new product has been published
+		 *
+		 * @param int   $post_id ID of the product.
+		 * @param array $post Post array.
+		 *
+		 * @return void
+		 */
+		public static function send_new_product_to_algolia($post_id, $post)
+		{
+			if ('publish' !== $post->post_status || 'product' !== $post->post_type) {
+				return;
+			}
+			Algolia_Send_Products::send_products_to_algolia($post_id);
+		}
+
+		/**
+		 * Verify nonces before we update options and settings
+		 * Also retrieve the value from the send_products_to_algolia hidden field to check if we are sending products to Algolia
+		 *
+		 * @return void
+		 */
+		public static function update_settings_options()
+		{
+			Algolia_Verify_Nonces::verify_settings_nonce();
+
+			/**
+			 * Do not proceed if we are going to send products
+			 */
+			if (true === Algolia_Verify_Nonces::verify_send_products_nonce()) {
+				return;
+			}
+
+			/**
+			 * Filter the application id, api key, index name and verify that the input is an array
+			 *
+			 * @see https://www.php.net/manual/en/function.filter-input.php
+			 */
+			$post_application_id             = filter_input(INPUT_POST, 'algolia_woo_indexer_application_id', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
+			$post_api_key                    = filter_input(INPUT_POST, 'algolia_woo_indexer_admin_api_key', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
+			$post_index_name                 = filter_input(INPUT_POST, 'algolia_woo_indexer_index_name', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
+			$automatically_send_new_products = filter_input(INPUT_POST, 'algolia_woo_indexer_automatically_send_new_products', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
+
+			/**
+			 * Properly sanitize text fields before updating data
+			 *
+			 * @see https://developer.wordpress.org/reference/functions/sanitize_text_field/
+			 */
+			$filtered_application_id = sanitize_text_field($post_application_id['id']);
+			$filtered_api_key        = sanitize_text_field($post_api_key['key']);
+			$filtered_index_name     = sanitize_text_field($post_index_name['name']);
+
+			/**
+			 * Sanitizing by setting the value to either 1 or 0
+			 */
+			$filtered_automatically_send_new_products = (! empty($automatically_send_new_products)) ? 1 : 0;
+
+			/**
+			 * Values have been filtered and sanitized
+			 * Check if set and not empty and update the database
+			 *
+			 * @see https://developer.wordpress.org/reference/functions/update_option/
+			 */
+			if (isset($filtered_application_id) && (! empty($filtered_application_id))) {
+				update_option(
+					ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID,
+					$filtered_application_id
+				);
+			}
+
+			if (isset($filtered_api_key) && (! empty($filtered_api_key))) {
+				update_option(
+					ALGOWOO_DB_OPTION . ALGOLIA_API_KEY,
+					$filtered_api_key
+				);
+			}
+
+			if (isset($filtered_index_name) && (! empty($filtered_index_name))) {
+				update_option(
+					ALGOWOO_DB_OPTION . INDEX_NAME,
+					$filtered_index_name
+				);
+			}
+
+			if (isset($filtered_automatically_send_new_products) && (! empty($filtered_automatically_send_new_products))) {
+				update_option(
+					ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS,
+					$filtered_automatically_send_new_products
+				);
+			}
+		}
+
+		/**
+		 * Sanitize input in settings fields and filter through regex to accept only a-z and A-Z
+		 *
+		 * @param string $input Settings text data
+		 * @return array
+		 */
+		public static function settings_fields_validate_options($input)
+		{
+			$valid         = array();
+			$valid['name'] = preg_replace(
+				'/[^a-zA-Z\s]/',
+				'',
+				$input['name']
+			);
+			return $valid;
+		}
+
+		/**
+		 * Load text domain for translations
+		 *
+		 * @return void
+		 */
+		public static function load_textdomain()
+		{
+			load_plugin_textdomain('algolia-woo-indexer', false, basename(dirname(__FILE__)) . '/languages/');
+		}
+
+		/**
+		 * Add the new menu to settings section so that we can configure the plugin
+		 *
+		 * @return void
+		 */
+		public static function admin_menu()
+		{
+			add_submenu_page(
+				'options-general.php',
+				esc_html__('Algolia Woo Indexer Settings', 'algolia-woo-indexer'),
+				esc_html__('Algolia Woo Indexer Settings', 'algolia-woo-indexer'),
+				'manage_options',
+				'algolia-woo-indexer-settings',
+				array( get_called_class(), 'algolia_woo_indexer_settings' )
+			);
+		}
+
+		/**
+		 * Display settings and allow user to modify them
+		 *
+		 * @return void
+		 */
+		public static function algolia_woo_indexer_settings()
+		{
+			/**
+			 * Verify that the user can access the settings page
+			 */
+			if (! current_user_can('manage_options')) {
+				wp_die(esc_html__('Action not allowed.', 'algolia_woo_indexer_settings'));
+			} ?>
 			<div class="wrap">
 				<h1><?php esc_html__('Algolia Woo Indexer Settings', 'algolia-woo-indexer'); ?></h1>
 				<form action="<?php echo esc_url(self::$plugin_url); ?>" method="POST">
 			<?php
-            settings_fields('algolia_woo_options');
-            do_settings_sections('algolia_woo_indexer');
-            submit_button('', 'primary wide'); ?>
+			settings_fields('algolia_woo_options');
+			do_settings_sections('algolia_woo_indexer');
+			submit_button('', 'primary wide'); ?>
 				</form>
 				<form action="<?php echo esc_url(self::$plugin_url); ?>" method="POST">
 					<?php wp_nonce_field('send_products_to_algolia_nonce_action', 'send_products_to_algolia_nonce_name'); ?>
@@ -443,75 +443,75 @@ 
 				</form>
 			</div>
 			<?php
-        }
-
-        /**
-         * Get active object instance
-         *
-         * @return object
-         */
-        public static function get_instance()
-        {
-            if (! self::$instance) {
-                self::$instance = new Algolia_Woo_Indexer();
-            }
-            return self::$instance;
-        }
-
-        /**
-         * The actions to execute when the plugin is activated.
-         *
-         * @return void
-         */
-        public static function activate_plugin()
-        {
-
-            /**
-             * Set default values for options if not already set
-             */
-            $automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
-            $algolia_application_id          = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
-            $algolia_api_key                 = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
-            $algolia_index_name              = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
+		}
+
+		/**
+		 * Get active object instance
+		 *
+		 * @return object
+		 */
+		public static function get_instance()
+		{
+			if (! self::$instance) {
+				self::$instance = new Algolia_Woo_Indexer();
+			}
+			return self::$instance;
+		}
+
+		/**
+		 * The actions to execute when the plugin is activated.
+		 *
+		 * @return void
+		 */
+		public static function activate_plugin()
+		{
+
+			/**
+			 * Set default values for options if not already set
+			 */
+			$automatically_send_new_products = get_option(ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS);
+			$algolia_application_id          = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
+			$algolia_api_key                 = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
+			$algolia_index_name              = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
             
-            if (empty($automatically_send_new_products)) {
-                add_option(
-                    ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS,
-                    '0'
-                );
-            }
-
-            if (empty($algolia_application_id)) {
-                add_option(
-                    ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID,
-                    'Change me'
-                );
-            }
-
-            if (empty($algolia_api_key)) {
-                add_option(
-                    ALGOWOO_DB_OPTION . ALGOLIA_API_KEY,
-                    'Change me'
-                );
-            }
-
-            if (empty($algolia_index_name)) {
-                add_option(
-                    ALGOWOO_DB_OPTION . INDEX_NAME,
-                    'Change me'
-                );
-            }
-            set_transient(self::PLUGIN_TRANSIENT, true);
-        }
-
-        /**
-         * The actions to execute when the plugin is deactivated.
-         *
-         * @return void
-         */
-        public static function deactivate_plugin()
-        {
-            delete_transient(self::PLUGIN_TRANSIENT);
-        }
-    }
+			if (empty($automatically_send_new_products)) {
+				add_option(
+					ALGOWOO_DB_OPTION . AUTOMATICALLY_SEND_NEW_PRODUCTS,
+					'0'
+				);
+			}
+
+			if (empty($algolia_application_id)) {
+				add_option(
+					ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID,
+					'Change me'
+				);
+			}
+
+			if (empty($algolia_api_key)) {
+				add_option(
+					ALGOWOO_DB_OPTION . ALGOLIA_API_KEY,
+					'Change me'
+				);
+			}
+
+			if (empty($algolia_index_name)) {
+				add_option(
+					ALGOWOO_DB_OPTION . INDEX_NAME,
+					'Change me'
+				);
+			}
+			set_transient(self::PLUGIN_TRANSIENT, true);
+		}
+
+		/**
+		 * The actions to execute when the plugin is deactivated.
+		 *
+		 * @return void
+		 */
+		public static function deactivate_plugin()
+		{
+			delete_transient(self::PLUGIN_TRANSIENT);
+		}
+	}
 }
\ No newline at end of file

classes/class-check-requirements.php

Indentation +55 added lines, -55 removed lines

@@ -18,28 +18,28 @@ 
  * Abort if this file is called directly
  */
 if (! defined('ABSPATH')) {
-    exit;
+	exit;
 }
 
 if (! class_exists('Algolia_Check_Requirements')) {
-    /**
-     * Check requirements for Algolia plugin
-     */
-    class Algolia_Check_Requirements
-    {
+	/**
+	 * Check requirements for Algolia plugin
+	 */
+	class Algolia_Check_Requirements
+	{
 
-        /**
-         * Check for required PHP version.
-         *
-         * @return bool
-         */
-        public static function algolia_php_version_check()
-        {
-            if (version_compare(PHP_VERSION, ALGOLIA_MIN_PHP_VERSION, '<')) {
-                return false;
-            }
-            return true;
-        }
+		/**
+		 * Check for required PHP version.
+		 *
+		 * @return bool
+		 */
+		public static function algolia_php_version_check()
+		{
+			if (version_compare(PHP_VERSION, ALGOLIA_MIN_PHP_VERSION, '<')) {
+				return false;
+			}
+			return true;
+		}
 
 		/**
 		 * Check if values are empty and display error notice if not all values have been set
@@ -52,52 +52,52 @@ 
 		public static function check_algolia_input_values($algolia_application_id, $algolia_api_key, $algolia_index_name )
 		{	
 			if (empty($algolia_application_id) || empty($algolia_api_key || empty($algolia_index_name))) {
-                add_action(
-                    'admin_notices',
-                    function () {
-                        echo '<div class="error notice">
+				add_action(
+					'admin_notices',
+					function () {
+						echo '<div class="error notice">
 							  <p>' . esc_html__('All settings need to be set for the plugin to work.', 'algolia-woo-indexer') . '</p>
 							</div>';
-                    }
-                );    
-            }
-        }
+					}
+				);    
+			}
+		}
 
-        /**
-         * Check for required WordPress version.
-         *
-         * @return bool
-         */
-        public static function algolia_wp_version_check()
-        {
-            if (version_compare($GLOBALS['wp_version'], ALGOLIA_MIN_WP_VERSION, '<')) {
-                return false;
-            }
-            return true;
-        }
+		/**
+		 * Check for required WordPress version.
+		 *
+		 * @return bool
+		 */
+		public static function algolia_wp_version_check()
+		{
+			if (version_compare($GLOBALS['wp_version'], ALGOLIA_MIN_WP_VERSION, '<')) {
+				return false;
+			}
+			return true;
+		}
 
-        /**
-         * Check that we have all of the required PHP extensions installed
-         *
-         * @return void
-         */
-        public static function check_unmet_requirements()
-        {
-            if (! extension_loaded('mbstring')) {
-                echo '<div class="error notice">
+		/**
+		 * Check that we have all of the required PHP extensions installed
+		 *
+		 * @return void
+		 */
+		public static function check_unmet_requirements()
+		{
+			if (! extension_loaded('mbstring')) {
+				echo '<div class="error notice">
 					  <p>' . esc_html__('Algolia Woo Indexer requires the "mbstring" PHP extension to be enabled. Please contact your hosting provider.', 'algolia-woo-indexer') . '</p>
 				  </div>';
-            } elseif (! function_exists('mb_ereg_replace')) {
-                echo '<div class="error notice">
+			} elseif (! function_exists('mb_ereg_replace')) {
+				echo '<div class="error notice">
 					  <p>' . esc_html__('Algolia Woo Indexer needs "mbregex" NOT to be disabled. Please contact your hosting provider.', 'algolia-woo-indexer') . '</p>
 				  </div>';
-            }
-            if (! extension_loaded('curl')) {
-                echo '<div class="error notice">
+			}
+			if (! extension_loaded('curl')) {
+				echo '<div class="error notice">
 					  <p>' . esc_html__('Algolia Woo Indexer requires the "cURL" PHP extension to be enabled. Please contact your hosting provider.', 'algolia-woo-indexer') . '</p>
 				  </div>';
-                return;
-            }
-        }
+				return;
+			}
+		}
 	}
 }

classes/class-send-products.php

Indentation +168 added lines, -168 removed lines

@@ -15,14 +15,14 @@ 
  * Abort if this file is called directly
  */
 if (!defined('ABSPATH')) {
-    exit;
+	exit;
 }
 
 /**
  * Include plugin file if function is_plugin_active does not exist
  */
 if (!function_exists('is_plugin_active')) {
-    require_once(ABSPATH . '/wp-admin/includes/plugin.php');
+	require_once(ABSPATH . '/wp-admin/includes/plugin.php');
 }
 
 /**
@@ -45,174 +45,174 @@ 
 define('ALGOLIA_API_KEY', '_admin_api_key');
 
 if (!class_exists('Algolia_Send_Products')) {
-    /**
-     * Algolia WooIndexer main class
-     */
-    class Algolia_Send_Products
-    {
-        const PLUGIN_NAME      = 'Algolia Woo Indexer';
-        const PLUGIN_TRANSIENT = 'algowoo-plugin-notice';
-
-        /**
-         * The Algolia instance
-         *
-         * @var \Algolia\AlgoliaSearch\SearchClient
-         */
-        private static $algolia = null;
-
-        /**
-         * Check if we can connect to Algolia, if not, handle the exception, display an error and then return
-         */
-        public static function can_connect_to_algolia()
-        {
-            try {
-                self::$algolia->listApiKeys();
-            } catch (\Algolia\AlgoliaSearch\Exceptions\UnreachableException $error) {
-                add_action(
-                    'admin_notices',
-                    function () {
-                        echo '<div class="error notice">
+	/**
+	 * Algolia WooIndexer main class
+	 */
+	class Algolia_Send_Products
+	{
+		const PLUGIN_NAME      = 'Algolia Woo Indexer';
+		const PLUGIN_TRANSIENT = 'algowoo-plugin-notice';
+
+		/**
+		 * The Algolia instance
+		 *
+		 * @var \Algolia\AlgoliaSearch\SearchClient
+		 */
+		private static $algolia = null;
+
+		/**
+		 * Check if we can connect to Algolia, if not, handle the exception, display an error and then return
+		 */
+		public static function can_connect_to_algolia()
+		{
+			try {
+				self::$algolia->listApiKeys();
+			} catch (\Algolia\AlgoliaSearch\Exceptions\UnreachableException $error) {
+				add_action(
+					'admin_notices',
+					function () {
+						echo '<div class="error notice">
 							  <p>' . esc_html__('An error has been encountered. Please check your application ID and API key. ', 'algolia-woo-indexer') . '</p>
 							</div>';
-                    }
-                );
-                return;
-            }
-        }
-
-        /**
-         * Send WooCommerce products to Algolia
-         *
-         * @param Int $id Product to send to Algolia if we send only a single product
-         * @return void
-         */
-        public static function send_products_to_algolia($id = '')
-        {
-            /**
-             * Remove classes from plugin URL and autoload Algolia with Composer
-             */
-
-            $base_plugin_directory = str_replace('classes', '', dirname(__FILE__));
-            require_once $base_plugin_directory . '/vendor/autoload.php';
-
-            /**
-             * Fetch the required variables from the Settings API
-             */
-
-            $algolia_application_id = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
-            $algolia_application_id = is_string($algolia_application_id) ? $algolia_application_id : CHANGE_ME;
-
-            $algolia_api_key        = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
-            $algolia_api_key        = is_string($algolia_api_key) ? $algolia_api_key : CHANGE_ME;
-
-            $algolia_index_name     = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
-            $algolia_index_name        = is_string($algolia_index_name) ? $algolia_index_name : CHANGE_ME;
-
-            /**
-             * Display admin notice and return if not all values have been set
-             */
-
-            Algolia_Check_Requirements::check_algolia_input_values($algolia_application_id, $algolia_api_key, $algolia_index_name);
-
-            /**
-             * Initiate the Algolia client
-             */
-            self::$algolia = \Algolia\AlgoliaSearch\SearchClient::create($algolia_application_id, $algolia_api_key);
-
-            /**
-             * Check if we can connect, if not, handle the exception, display an error and then return
-             */
-            self::can_connect_to_algolia();
-
-            /**
-             * Initialize the search index and set the name to the option from the database
-             */
-            $index = self::$algolia->initIndex($algolia_index_name);
-
-            /**
-             * Setup arguments for sending all products to Algolia
-             *
-             * Limit => -1 means we send all products
-             */
-            $arguments = array(
-                'status'   => 'publish',
-                'limit'    => -1,
-                'paginate' => false,
-            );
-
-            /**
-             * Setup arguments for sending only a single product
-             */
-            if (isset($id) && '' !== $id) {
-                $arguments = array(
-                    'status'   => 'publish',
-                    'include'  => array($id),
-                    'paginate' => false,
-                );
-            }
-
-            /**
-             * Fetch all products from WooCommerce
-             *
-             * @see https://docs.woocommerce.com/wc-apidocs/function-wc_get_products.html
-             */
-            $products =
-                /** @scrutinizer ignore-call */
-                wc_get_products($arguments);
-
-            if (empty($products)) {
-                return;
-            }
-            $records = array();
-            $record  = array();
-
-            foreach ($products as $product) {
-                /**
-                 * Set sale price or regular price based on product type
-                 */
-                if ($product->is_type('simple')) {
-                    $sale_price     =  $product->get_sale_price();
-                    $regular_price  =  $product->get_regular_price();
-                } elseif ($product->is_type('variable')) {
-                    $sale_price     =  $product->get_variation_sale_price('min', true);
-                    $regular_price  =  $product->get_variation_regular_price('max', true);
-                }
-
-                /**
-                 * Extract image from $product->get_image()
-                 */
-                preg_match('/<img(.*)src(.*)=(.*)"(.*)"/U', $product->get_image(), $result);
-                $product_image = array_pop($result);
-                /**
-                 * Build the record array using the information from the WooCommerce product
-                 */
-                $record['objectID']                      = $product->get_id();
-                $record['product_name']                  = $product->get_name();
-                $record['product_image']                 = $product_image;
-                $record['short_description']             = $product->get_short_description();
-                $record['regular_price']                 = $regular_price;
-                $record['sale_price']                    = $sale_price;
-                $record['on_sale']                       = $product->is_on_sale();
-                $records[] = $record;
-            }
-            wp_reset_postdata();
-
-            /**
-             * Send the information to Algolia and save the result
-             * If result is NullResponse, print an error message
-             */
-            $result = $index->saveObjects($records);
-
-            if ('Algolia\AlgoliaSearch\Response\NullResponse' === get_class($result)) {
-                wp_die(esc_html__('No response from the server. Please check your settings and try again', 'algolia_woo_indexer_settings'));
-            }
-
-            /**
-             * Display success message
-             */
-            echo '<div class="notice notice-success is-dismissible">
+					}
+				);
+				return;
+			}
+		}
+
+		/**
+		 * Send WooCommerce products to Algolia
+		 *
+		 * @param Int $id Product to send to Algolia if we send only a single product
+		 * @return void
+		 */
+		public static function send_products_to_algolia($id = '')
+		{
+			/**
+			 * Remove classes from plugin URL and autoload Algolia with Composer
+			 */
+
+			$base_plugin_directory = str_replace('classes', '', dirname(__FILE__));
+			require_once $base_plugin_directory . '/vendor/autoload.php';
+
+			/**
+			 * Fetch the required variables from the Settings API
+			 */
+
+			$algolia_application_id = get_option(ALGOWOO_DB_OPTION . ALGOLIA_APPLICATION_ID);
+			$algolia_application_id = is_string($algolia_application_id) ? $algolia_application_id : CHANGE_ME;
+
+			$algolia_api_key        = get_option(ALGOWOO_DB_OPTION . ALGOLIA_API_KEY);
+			$algolia_api_key        = is_string($algolia_api_key) ? $algolia_api_key : CHANGE_ME;
+
+			$algolia_index_name     = get_option(ALGOWOO_DB_OPTION . INDEX_NAME);
+			$algolia_index_name        = is_string($algolia_index_name) ? $algolia_index_name : CHANGE_ME;
+
+			/**
+			 * Display admin notice and return if not all values have been set
+			 */
+
+			Algolia_Check_Requirements::check_algolia_input_values($algolia_application_id, $algolia_api_key, $algolia_index_name);
+
+			/**
+			 * Initiate the Algolia client
+			 */
+			self::$algolia = \Algolia\AlgoliaSearch\SearchClient::create($algolia_application_id, $algolia_api_key);
+
+			/**
+			 * Check if we can connect, if not, handle the exception, display an error and then return
+			 */
+			self::can_connect_to_algolia();
+
+			/**
+			 * Initialize the search index and set the name to the option from the database
+			 */
+			$index = self::$algolia->initIndex($algolia_index_name);
+
+			/**
+			 * Setup arguments for sending all products to Algolia
+			 *
+			 * Limit => -1 means we send all products
+			 */
+			$arguments = array(
+				'status'   => 'publish',
+				'limit'    => -1,
+				'paginate' => false,
+			);
+
+			/**
+			 * Setup arguments for sending only a single product
+			 */
+			if (isset($id) && '' !== $id) {
+				$arguments = array(
+					'status'   => 'publish',
+					'include'  => array($id),
+					'paginate' => false,
+				);
+			}
+
+			/**
+			 * Fetch all products from WooCommerce
+			 *
+			 * @see https://docs.woocommerce.com/wc-apidocs/function-wc_get_products.html
+			 */
+			$products =
+				/** @scrutinizer ignore-call */
+				wc_get_products($arguments);
+
+			if (empty($products)) {
+				return;
+			}
+			$records = array();
+			$record  = array();
+
+			foreach ($products as $product) {
+				/**
+				 * Set sale price or regular price based on product type
+				 */
+				if ($product->is_type('simple')) {
+					$sale_price     =  $product->get_sale_price();
+					$regular_price  =  $product->get_regular_price();
+				} elseif ($product->is_type('variable')) {
+					$sale_price     =  $product->get_variation_sale_price('min', true);
+					$regular_price  =  $product->get_variation_regular_price('max', true);
+				}
+
+				/**
+				 * Extract image from $product->get_image()
+				 */
+				preg_match('/<img(.*)src(.*)=(.*)"(.*)"/U', $product->get_image(), $result);
+				$product_image = array_pop($result);
+				/**
+				 * Build the record array using the information from the WooCommerce product
+				 */
+				$record['objectID']                      = $product->get_id();
+				$record['product_name']                  = $product->get_name();
+				$record['product_image']                 = $product_image;
+				$record['short_description']             = $product->get_short_description();
+				$record['regular_price']                 = $regular_price;
+				$record['sale_price']                    = $sale_price;
+				$record['on_sale']                       = $product->is_on_sale();
+				$records[] = $record;
+			}
+			wp_reset_postdata();
+
+			/**
+			 * Send the information to Algolia and save the result
+			 * If result is NullResponse, print an error message
+			 */
+			$result = $index->saveObjects($records);
+
+			if ('Algolia\AlgoliaSearch\Response\NullResponse' === get_class($result)) {
+				wp_die(esc_html__('No response from the server. Please check your settings and try again', 'algolia_woo_indexer_settings'));
+			}
+
+			/**
+			 * Display success message
+			 */
+			echo '<div class="notice notice-success is-dismissible">
 					 	<p>' . esc_html__('Product(s) sent to Algolia.', 'algolia-woo-indexer') . '</p>
 				  		</div>';
-        }
-    }
+		}
+	}
 }