Merge pull request #21 from getshifter/feat/algolia/support-terms-and-users

feat: [Algolia integrations] Support wp_terms / wp_users to replace these links

Author: sawanoboly

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/php:7.3-cli
+      - image: circleci/php:7.4-cli
 
     working_directory: ~/shifter-wp-mu
 

admin/class-shifter-admin.php

@@ -115,7 +115,7 @@ public function shifter_heartbert_on_sitepreview_write_script() {
 		<script>
 		function shifter_heartbert_getajax() {
 			var xhr= new XMLHttpRequest();
-			xhr.open("GET","<?php echo esc_url(add_query_arg('action','nopriv_heartbeat',site_url('/wp-admin/admin-ajax.php')));?>");
+			xhr.open("GET","<?php echo esc_url( add_query_arg( 'action', 'nopriv_heartbeat', site_url( '/wp-admin/admin-ajax.php' ) ) ); ?>");
 			xhr.send();
 		}
 		var shifterHB = setInterval("shifter_heartbert_getajax()", 30000);
@@ -137,28 +137,62 @@ public function shifter_mail_from( $email_address ) {
 	}
 
 	/**
-	 * Integrations between Shifter and Algolia
+	 * Integrations between Shifter and Algolia Shared private function
 	 *
-	 * @param string $shared_attributes Shared attrs.
-	 * @param string $post Post.
+	 * @param string $url URL strings.
+	 * @return string Replaced URL from Shifter WP to Shifter CDN
 	 *
-	 * @since 1.0.0
+	 * @since 1.1.0
 	 */
-	public function shifter_replace_algolia_permalink( $shared_attributes, $post ) {
+	private function replace_url_to_public_domain( $url ) {
 		$replaced_domain = getenv( 'SHIFTER_DOMAIN' );
 		if ( ! $replaced_domain ) {
 			$replaced_domain = getenv( 'CF_DOMAIN' );
 		}
 		if ( $replaced_domain ) {
-			$url            = $shared_attributes['permalink'];
 			$parsed_url     = wp_parse_url( $url );
 			$replace_target = $parsed_url['host'];
 			if ( isset( $parsed_url['port'] ) && $parsed_url['port'] ) {
 				$replace_target .= ":{$parsed_url['port']}";
 			}
-			$shared_attributes['permalink'] = preg_replace( "#{$replace_target}#i", $replaced_domain, $url );
+			return preg_replace( "#{$replace_target}#i", $replaced_domain, $url );
 		}
-		return $shared_attributes;
+		return $url;
+	}
+
+	/**
+	 * Integrations between Shifter and Algolia for wp_posts items
+	 *
+	 * @param string $record Shared attrs.
+	 *
+	 * @since 1.0.0
+	 */
+	public function replace_algolia_posts_permalink( $record ) {
+		$record['permalink'] = $this->replace_url_to_public_domain( $record['permalink'] );
+		return $record;
+	}
+	/**
+	 * Integrations between Shifter and Algolia for wp_terms items
+	 *
+	 * @param string $record Shared attrs.
+	 *
+	 * @since 1.1.0
+	 */
+	public function replace_algolia_terms_permalink( $record ) {
+		$record['permalink'] = $this->replace_url_to_public_domain( $record['permalink'] );
+		return $record;
+	}
+
+	/**
+	 * Integrations between Shifter and Algolia for wp_users items
+	 *
+	 * @param string $record Shared attrs.
+	 *
+	 * @since 1.1.0
+	 */
+	public function replace_algolia_users_posts_url( $record ) {
+		$record['posts_url'] = $this->replace_url_to_public_domain( $record['posts_url'] );
+		return $record;
 	}
 
 	/**

api/class-shifter-api.php

@@ -154,7 +154,7 @@ private function refresh_token() {
 			'body'    => wp_json_encode( array( 'refreshToken' => $this->refresh_token ) ),
 		);
 		$response   = wp_remote_request( $this->refresh_url, $args );
-		$body       = $response[ 'body' ];
+		$body       = $response['body'];
 		$body_array = json_decode( $body );
 		// phpcs:disable
 		$this->access_token = $body_array->AccessToken;

composer.json

@@ -3,9 +3,9 @@
   "type": "wordpress-plugin",
   "description": "",
   "require": {
-    "wp-coding-standards/wpcs": "^2.0",
-    "squizlabs/php_codesniffer": "^3.4",
-    "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0"
+    "wp-coding-standards/wpcs": "*",
+    "squizlabs/php_codesniffer": "*",
+    "dealerdirect/phpcodesniffer-composer-installer": "*"
   },
   "scripts": {
     "post-install-cmd": [
@@ -15,10 +15,10 @@
       "\"vendor/bin/phpcs\" --config-set installed_paths vendor/wp-coding-standards/wpcs"
     ],
     "cs-fix": [
-      "phpcbf . -pwv --ignore=vendor,node_modules --extensions=php --standard=WordPress || git diff"
+      "phpcbf . -pwv --ignore=vendor,node_modules,volume --extensions=php --standard=WordPress || git diff"
     ],
     "cs-lint": [
-      "phpcs . -p --ignore=vendor,node_modules --extensions=php --standard=WordPress"
+      "phpcs . -p --ignore=vendor,node_modules,volume --extensions=php --standard=WordPress"
     ]
   },
   "authors": [

composer.lock

@@ -154,7 +154,7 @@ public function shifter_admin_bar_items() {
 		);
 
 		$wp_admin_bar->add_menu( $shifter_support_back_to_shifter_dashboard );
-		if (!getenv( 'SHIFTER_DISABLE_GENERATE' )) {
+		if ( ! getenv( 'SHIFTER_DISABLE_GENERATE' ) ) {
 			$wp_admin_bar->add_menu( $shifter_support_generate );
 		}
 		$wp_admin_bar->add_menu( $shifter_support_terminate );

global/class-shifter-global.php

@@ -182,8 +182,10 @@ private function define_admin_hooks() {
 		$this->loader->add_filter( 'wp_mail_from', $plugin_admin, 'shifter_mail_from' );
 
 		// Shifter Algolia Intergrations.
-		$this->loader->add_filter( 'algolia_post_shared_attributes', $plugin_admin, 'shifter_replace_algolia_permalink', 10, 2 );
-		$this->loader->add_filter( 'algolia_searchable_post_shared_attributes', $plugin_admin, 'shifter_replace_algolia_permalink', 10, 2 );
+		$this->loader->add_filter( 'algolia_post_shared_attributes', $plugin_admin, 'replace_algolia_posts_permalink', 10, 1 );
+		$this->loader->add_filter( 'algolia_searchable_post_shared_attributes', $plugin_admin, 'replace_algolia_posts_permalink', 10, 1 );
+		$this->loader->add_filter( 'algolia_term_record', $plugin_admin, 'replace_algolia_terms_permalink', 10, 1 );
+		$this->loader->add_filter( 'algolia_user_record', $plugin_admin, 'replace_algolia_users_posts_url', 10, 1 );
 
 		// Shifter Admin Page.
 		$this->loader->add_action( 'admin_menu', $plugin_admin, 'shifter_mu_admin_page' );

includes/class-shifter.php

@@ -8,7 +8,7 @@
  * that starts the plugin.
  *
  * @link    https://www.getshifter.io
- * @since   1.0.0
+ * @since   1.1.0
  * @package Shifter
  *
  * @wordpress-plugin