refactor: property, method renamings and comments

Author: Mustafa Şükrü Kapusuz

includes/indices/class-algolia-index.php

@@ -18,7 +18,12 @@
  * @since 1.0.0
  */
 abstract class Algolia_Index {
-	protected $settings = [];
+	/**
+	 * Default index settings
+	 *
+	 * @var array
+	 */
+	protected array $default_settings = [];
 
 	/**
 	 * The SearchClient instance.
@@ -686,8 +691,8 @@ protected function get_re_index_batch_size() {
 	 *
 	 * @return array
 	 */
-	public function get_settings() {
-		$settings = (array) apply_filters( 'algolia_' . $this->get_id() . '_index_settings', $this->settings );
+	public function get_default_settings() {
+		$settings = (array) apply_filters( 'algolia_' . $this->get_id() . '_index_settings', $this->default_settings );
 
 		/**
 		 * Replacing `attributesToIndex` with `searchableAttributes` as

includes/indices/class-algolia-posts-index.php

@@ -14,7 +14,7 @@
  * @since 1.0.0
  */
 final class Algolia_Posts_Index extends Algolia_Index {
-	protected $settings = [
+	protected $default_settings = [
 		'searchableAttributes'  => array(
 			'unordered(post_title)',
 			'unordered(taxonomies)',
@@ -288,15 +288,16 @@ private function get_post_shared_attributes( WP_Post $post ) {
 
 	/**
 	 * Get settings.
+	 * Overridden to able to have "algolia_posts_index_settings" filter.
 	 *
 	 * @author WebDevStudios <contact@webdevstudios.com>
 	 * @since  1.0.0
 	 *
 	 * @return array
 	 */
-	public function get_settings() {
-		$this->settings = (array) apply_filters( 'algolia_posts_index_settings', $this->settings, $this->post_type );
-		return parent::get_settings();
+	public function get_default_settings() {
+		$this->default_settings = (array) apply_filters( 'algolia_posts_index_settings', $this->default_settings, $this->post_type );
+		return parent::get_default_settings();
 	}
 
 	/**

includes/indices/class-algolia-searchable-posts-index.php

@@ -249,14 +249,15 @@ private function get_post_shared_attributes( WP_Post $post ) {
 	/**
 	 * Get settings.
 	 *
+	 * Overridden to able to have "excerpt_length" WP filter hook for the attributesToSnippet.content
+	 *
 	 * @author WebDevStudios <contact@webdevstudios.com>
 	 * @since  1.0.0
 	 *
 	 * @return array
 	 */
-	public function get_settings() {
-		// override settings prop to inject the WP Filter Hook.
-		$this->settings = [
+	public function get_default_settings() {
+		$this->default_settings = [
 			'searchableAttributes'  => array(
 				'unordered(post_title)',
 				'unordered(taxonomies)',
@@ -282,7 +283,7 @@ public function get_settings() {
 			'snippetEllipsisText'   => '…',
 		];
 
-		return parent::get_settings();
+		return parent::get_default_settings();
 	}
 
 	/**

includes/indices/class-algolia-terms-index.php

@@ -14,7 +14,7 @@
  * @since 1.0.0
  */
 final class Algolia_Terms_Index extends Algolia_Index {
-	protected $settings = [
+	protected $default_settings = [
 		'searchableAttributes' => array(
 			'unordered(name)',
 			'unordered(description)',
@@ -138,10 +138,10 @@ protected function get_re_index_items_count() {
 	 *
 	 * @return array
 	 */
-	public function get_settings() {
+	public function get_default_settings() {
 		// override settings prop to have a custom WP filter hook for terms only
-		$this->settings = apply_filters( 'algolia_terms_index_settings', $this->settings, $this->taxonomy );
-		return parent::get_settings();
+		$this->default_settings = apply_filters( 'algolia_terms_index_settings', $this->default_settings, $this->taxonomy );
+		return parent::get_default_settings();
 	}
 
 	/**

includes/indices/class-algolia-users-index.php

@@ -14,7 +14,7 @@
  * @since 1.0.0
  */
 final class Algolia_Users_Index extends Algolia_Index {
-	protected $settings = [
+	protected $default_settings = [
 		'searchableAttributes' => array(
 			'unordered(display_name)',
 		),

includes/indices/settings/class-algolia-primary-index-settings.php

@@ -24,7 +24,7 @@ public function set_algolia_index(): void {
 	}
 
 	public function get_local_settings(): array {
-		return $this->get_index()->get_settings();
+		return $this->get_index()->get_default_settings();
 	}
 
 	public function get_remote_settings(): array {