Release240 (#296)

* switch in FILTER_SANITIZE_FULL_SPECIAL_CHARS in place of FILTER_SANITIZE_STRING

* Clean up settings

Clean up autocomplete settings language

* language update

Updated Algolia required logo language. Fixes #281

* Add API link

First pass adding links to manage Algolia API keys #280

* Submenu ordering

Set submenu priority ordering

* plugin footer

Added a admin dashboard footer with relevant plugin links

* language clarity

Cleaned up options and provide more clarity on what they do

* More language updates

Clarification in settings and documentation

* convert to less strict filter that is still compatible

* bump php minimum version and confirm tested up to version

* catch some missed i18n spots

* Improve reindex and push settings help text

* Fix phpcs issues

* Prefix PHP vendor dependencies (#267)

* Add a vendor_prefixed dir for prefixing vendor libs

* Remove committed algoliasearch-client-php lib

* Add and configure brianhenryie/strauss

* Deprecate algolia_should_require_search_client filter with no replacement

* Require vendor_prefixed autoloader

* Extending WP_CLI_Command not necessary since WP-CLI 0.23.0 2016

* Add php-stubs/wordpress-stubs and php-stubs/wp-cli-stubs for dev

* Add class-algolia-cli.php to classmap.php

* Use prefixed Algolia PHP Client namespace

* Bump version to 2.3.2

* Add 2.3.2 to Changelog

---------

Co-authored-by: Michael Beckwith <tw2113@gmail.com>

* composer update run

* Feature/166 update readme content (#294)

* touch up the tags to remove a dash in "instantsearch" that should not be there

* touch up short and longer description to be a bit more accurate

* revise feature listing to be a bit more concise

* update links to reflect where support should go to vs feature requests/bugs

* apostrophe should not be there

* bump recommended version in prep for next release

* Fill in Laura's version for short description

* tag updates

* Fill in Laura's version for long description

* remove determined irrelevant keywords, add ecommerce and seo

* get faceted in the overall description and specifically feature section

* bump version number

* update changelog

* remove non-existant 2.3.2 release notes

* actually get our vendor prefixed files

* fix composer and package json versions

---------

Co-authored-by: Brad Williams <brad@webdevstudios.com>
Co-authored-by: Ashar Irfan <mrasharirfan@gmail.com>
Co-authored-by: Richard Aber <richaber@gmail.com>

README.txt

@@ -1,32 +1,33 @@
 === WP Search with Algolia ===
 Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113, richaber, mrasharirfan
-Tags: Search, Algolia, Autocomplete, instant-search, relevant search, search highlight, faceted search, find-as-you-type search, suggest, search by category, ajax search, better search, custom search
+Tags: search, algolia, autocomplete, instantsearch, relevance search, faceted search, find-as-you-type search, ecommerce, seo
 Requires at least: 5.0
-Tested up to: 6.1
-Requires PHP: 7.2
-Stable tag: 2.3.1
+Tested up to: 6.1.1
+Requires PHP: 7.4
+Stable tag: 2.4.0
 License: GNU General Public License v2.0, MIT License
 
-Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
+Use the power of Algolia to fall in love with your website's search. Enable Autocomplete and Instantsearch. Control the look, feel, and relevance.
 
 == Description ==
 
-Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
+"I hate my website's search!" We hear it all the time. Look no further than WP Search with Algolia to fall in love with your website's search capabilities.
+Forked, built, and supported by WebDevStudios, the website agency behind Custom Post Type UI, WP Search with Algolia immediately improves search on your site. Your users will be impressed.
+Autocomplete and Instantsearch are included and enabled. Plus, you receive full control over the look, feel, and relevance of your users' search experience.
 
 = Features =
-* Relevant search results in milliseconds
-* Native typo-tolerance
-* Is language-agnostic
-* Offers hooks and filters for easy customization
-* Built by developers, for developers
+* Relevant, faceted ready search results in milliseconds with native typo-tolerance from Algolia Search
+* Language-agnostic
+* WordPress hooks and filters available for easy customization of indexed content.
 
 This plugin requires API keys from [Algolia](https://www.algolia.com/). API keys are free for small personal projects and non-commercial use. Learn more about [commercial use pricing](https://www.algolia.com/pricing/).
 
 = Links =
 * [WebDevStudios](https://webdevstudios.com)
 * [Algolia](https://algolia.com)
 * [Documentation](https://github.com/WebDevStudios/wp-search-with-algolia/wiki)
-* [Support](https://github.com/WebDevStudios/wp-search-with-algolia/issues)
+* [Support](https://wordpress.org/support/plugin/wp-search-with-algolia/)
+* [Feature requests and bugs](https://github.com/WebDevStudios/wp-search-with-algolia/issues)
 
 *This plugin is a derivative work of the code from the [Search by Algolia – Instant & Relevant results](https://wordpress.org/plugins/search-by-algolia-instant-relevant-results/) plugin for WordPress, which is licensed under the GPLv2.*
 
@@ -50,7 +51,7 @@ Yes. The Algolia Team **[no longer supports their original plugin](https://commu
 
 = Should I switch to this plugin? =
 
-Yes. Because Algolia no longer supports their plugin, you will no longer receive updates. WebDevStudios uses Algolia on many of it's projects, and is committed to maintaining this plugin for years to come.
+Yes. Because Algolia no longer supports their plugin, you will no longer receive updates. WebDevStudios uses Algolia on many of its projects, and is committed to maintaining this plugin.
 
 = How do I switch from the "Search by Algolia – Instant & Relevant results" plugin? =
 
@@ -63,7 +64,7 @@ Yes. Because Algolia no longer supports their plugin, you will no longer receive
 = What are the minimum requirements? =
 
 * Requires WordPress 5.0+
-* PHP version 7.2 or greater (PHP 7.3 is recommended)
+* PHP version 7.4 or greater
 * MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
 * cURL PHP extension
 * mbstring PHP extension
@@ -106,6 +107,13 @@ WebDevStudios provides end-to-end WordPress opportunities from strategy and plan
 
 Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
 
+= 2.4.0 =
+* Increase minimum PHP version to PHP 7.4
+* Fixed PHP8 compatibility issues
+* Prefixed Algolia library to avoid potential conflicts with other code using the same libraries.
+* Revised copy and wording around the plugin for better clarity.
+* Deprecate the `algolia_should_require_search_client` filter in favor of prefixed Algolia PHP Client namespace
+
 = 2.3.1 =
 * Update autocomplete template to use addEventListener instead of onload function
 * Update Algolia InstantSearch.js to 4.49.1

algolia.php

@@ -3,9 +3,9 @@
  * Plugin Name:       WP Search with Algolia
  * Plugin URI:        https://github.com/WebDevStudios/wp-search-with-algolia
  * Description:       Integrate the powerful Algolia search service with WordPress
- * Version:           2.3.1
+ * Version:           2.4.0
  * Requires at least: 5.0
- * Requires PHP:      7.2
+ * Requires PHP:      7.4
  * Author:            WebDevStudios
  * Author URI:        https://webdevstudios.com
  * License:           GNU General Public License v2.0 / MIT License
@@ -26,10 +26,10 @@
 }
 
 // The Algolia Search plugin version.
-define( 'ALGOLIA_VERSION', '2.3.1' );
+define( 'ALGOLIA_VERSION', '2.4.0' );
 
 // The minmum required PHP version.
-define( 'ALGOLIA_MIN_PHP_VERSION', '7.2' );
+define( 'ALGOLIA_MIN_PHP_VERSION', '7.4' );
 
 // The minimum required WordPress version.
 define( 'ALGOLIA_MIN_WP_VERSION', '5.0' );
@@ -129,7 +129,6 @@ function algolia_load_textdomain() {
 	$algolia = Algolia_Plugin_Factory::create();
 
 	if ( defined( 'WP_CLI' ) && WP_CLI ) {
-		include ALGOLIA_PATH . 'includes/class-algolia-cli.php';
 		WP_CLI::add_command( 'algolia', new Algolia_CLI() );
 	}
 } else {

classmap.php

@@ -12,17 +12,32 @@
 	exit();
 }
 
-// The Algolia Search PHP API SearchClient.
-if ( apply_filters( 'algolia_should_require_search_client', true ) ) {
-	require_once ALGOLIA_PATH . 'includes/libraries/algoliasearch-client-php/autoload.php';
-}
+/**
+ * Filters whether to include the Algolia PHP API Client library.
+ *
+ * @since      1.0.0
+ * @deprecated 2.3.2 No longer necessary as the Algolia PHP API Client library is now prefixed.
+ *
+ * @param bool $true Include the Algolia PHP API Client library.
+ */
+apply_filters_deprecated(
+	'algolia_should_require_search_client',
+	[ true ],
+	'2.3.2',
+	'',
+	esc_html__( 'The "algolia_should_require_search_client" filter is deprecated and no longer has any effect.', 'wp-search-with-algolia' )
+);
+
+// Autoload vendor dependencies, that have been prefixed to prevent namespace collision.
+require_once ALGOLIA_PATH . 'vendor_prefixed/autoload.php';
 
 require_once ALGOLIA_PATH . 'includes/factories/class-algolia-http-client-interface-factory.php';
 require_once ALGOLIA_PATH . 'includes/factories/class-algolia-search-client-factory.php';
 require_once ALGOLIA_PATH . 'includes/factories/class-algolia-plugin-factory.php';
 
 require_once ALGOLIA_PATH . 'includes/class-algolia-api.php';
 require_once ALGOLIA_PATH . 'includes/class-algolia-autocomplete-config.php';
+require_once ALGOLIA_PATH . 'includes/class-algolia-cli.php';
 require_once ALGOLIA_PATH . 'includes/class-algolia-compatibility.php';
 require_once ALGOLIA_PATH . 'includes/class-algolia-plugin.php';
 require_once ALGOLIA_PATH . 'includes/class-algolia-search.php';
@@ -50,8 +65,8 @@
 
 if ( is_admin() ) {
 	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin.php';
+	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin-page-settings.php';
 	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin-page-autocomplete.php';
 	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin-page-native-search.php';
-	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin-page-settings.php';
 	require_once ALGOLIA_PATH . 'includes/admin/class-algolia-admin-template-notices.php';
 }

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "webdevstudios/wp-search-with-algolia",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Integrate the powerful Algolia search service with WordPress.",
   "authors": [
     {
@@ -22,32 +22,70 @@
   },
   "require-dev": {
     "algolia/algoliasearch-client-php": "^3.3",
-    "psr/http-message": "~1.0.1",
-    "psr/log": "~1.0.2",
-    "psr/simple-cache": "~1.0.1",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
     "phpcompatibility/phpcompatibility-wp": "^2.1.2",
     "wp-coding-standards/wpcs": "^2.3.0",
-    "slowprog/composer-copy-file": "^0.3.3"
+    "psr/http-message": "^1.0",
+    "psr/log": "^1.1",
+    "psr/simple-cache": "^1.0",
+    "brianhenryie/strauss": "^0.11.1",
+    "php-stubs/wp-cli-stubs": "^2.7",
+    "php-stubs/wordpress-stubs": "^6.1"
   },
   "extra": {
     "installer-name": "wp-search-with-algolia",
+    "strauss": {
+      "target_directory": "vendor_prefixed",
+      "namespace_prefix": "WebDevStudios\\WPSWA\\",
+      "classmap_prefix": "WDS_WPSWA_",
+      "constant_prefix": "WDS_WPSWA_",
+      "packages": [
+        "algolia/algoliasearch-client-php",
+        "psr/http-message",
+        "psr/log",
+        "psr/simple-cache"
+      ],
+      "override_autoload": {
+      },
+      "exclude_from_copy": {
+        "packages": [
+        ],
+        "namespaces": [
+        ],
+        "file_patterns": [
+        ]
+      },
+      "exclude_from_prefix": {
+        "packages": [
+        ],
+        "namespaces": [
+        ],
+        "file_patterns": [
+        ]
+      },
+      "namespace_replacement_patterns" : {
+      },
+      "delete_vendor_files": false
+    },
     "copy-file": {
-      "vendor/algolia": "includes/libraries"
     },
     "copy-file-dev": {
-      "vendor/algolia": "includes/libraries",
-      "vendor/psr": "includes/libraries/algoliasearch-client-php/vendor/psr"
     }
   },
   "scripts": {
     "lint": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs --standard=phpcs.xml --extensions=php .",
     "lint:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf --standard=phpcs.xml --extensions=php .",
     "post-install-cmd": [
-      "SlowProg\\CopyFile\\ScriptHandler::copy"
+      "@php ./vendor/bin/strauss"
     ],
     "post-update-cmd": [
-      "SlowProg\\CopyFile\\ScriptHandler::copy"
+      "@php ./vendor/bin/strauss"
     ]
+  },
+  "config": {
+    "allow-plugins": {
+      "composer/installers": true,
+      "dealerdirect/phpcodesniffer-composer-installer": true
+    }
   }
 }