insideout10 / wordlift-plugin

src/ext/dependencies/deliciousbrains/wp-background-processing/classes/wp-background-process.php

Indentation +487 added lines, -487 removed lines

@@ -13,492 +13,492 @@
  */
 abstract class Wordlift_Plugin_WP_Background_Process extends Wordlift_Plugin_WP_Async_Request {
 
-	/**
-	 * Action
-	 *
-	 * (default value: 'background_process')
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $action = 'background_process';
-
-	/**
-	 * Start time of current process.
-	 *
-	 * (default value: 0)
-	 *
-	 * @var int
-	 * @access protected
-	 */
-	protected $start_time = 0;
-
-	/**
-	 * Cron_hook_identifier
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $cron_hook_identifier;
-
-	/**
-	 * Cron_interval_identifier
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $cron_interval_identifier;
-
-	/**
-	 * Initiate new background process
-	 */
-	public function __construct() {
-		parent::__construct();
-
-		$this->cron_hook_identifier     = $this->identifier . '_cron';
-		$this->cron_interval_identifier = $this->identifier . '_cron_interval';
-
-		add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
-		add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
-	}
-
-	/**
-	 * Dispatch
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function dispatch() {
-		// Schedule the cron healthcheck.
-		$this->schedule_event();
-
-		// Perform remote post.
-		return parent::dispatch();
-	}
-
-	/**
-	 * Push to queue
-	 *
-	 * @param mixed $data Data.
-	 *
-	 * @return $this
-	 */
-	public function push_to_queue( $data ) {
-		$this->data[] = $data;
-
-		return $this;
-	}
-
-	/**
-	 * Save queue
-	 *
-	 * @return $this
-	 */
-	public function save() {
-		$key = $this->generate_key();
-
-		if ( ! empty( $this->data ) ) {
-			update_site_option( $key, $this->data );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Update queue
-	 *
-	 * @param string $key  Key.
-	 * @param array  $data Data.
-	 *
-	 * @return $this
-	 */
-	public function update( $key, $data ) {
-		if ( ! empty( $data ) ) {
-			update_site_option( $key, $data );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Delete queue
-	 *
-	 * @param string $key Key.
-	 *
-	 * @return $this
-	 */
-	public function delete( $key ) {
-		delete_site_option( $key );
-
-		return $this;
-	}
-
-	/**
-	 * Generate key
-	 *
-	 * Generates a unique key based on microtime. Queue items are
-	 * given a unique key so that they can be merged upon save.
-	 *
-	 * @param int $length Length.
-	 *
-	 * @return string
-	 */
-	protected function generate_key( $length = 64 ) {
-		$unique  = md5( microtime() . rand() );
-		$prepend = $this->identifier . '_batch_';
-
-		return substr( $prepend . $unique, 0, $length );
-	}
-
-	/**
-	 * Maybe process queue
-	 *
-	 * Checks whether data exists within the queue and that
-	 * the process is not already running.
-	 */
-	public function maybe_handle() {
-		// Don't lock up other requests while processing
-		session_write_close();
-
-		if ( $this->is_process_running() ) {
-			// Background process already running.
-			wp_die();
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			wp_die();
-		}
-
-		check_ajax_referer( $this->identifier, 'nonce' );
-
-		$this->handle();
-
-		wp_die();
-	}
-
-	/**
-	 * Is queue empty
-	 *
-	 * @return bool
-	 */
-	protected function is_queue_empty() {
-		global $wpdb;
-
-		$table  = $wpdb->options;
-		$column = 'option_name';
-
-		if ( is_multisite() ) {
-			$table  = $wpdb->sitemeta;
-			$column = 'meta_key';
-		}
-
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
-
-		$count = $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM {$table} WHERE {$column} LIKE %s", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-				$key
-			)
-		);
-
-		return ( $count > 0 ) ? false : true;
-	}
-
-	/**
-	 * Is process running
-	 *
-	 * Check whether the current process is already running
-	 * in a background process.
-	 */
-	protected function is_process_running() {
-		if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
-			// Process already running.
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Lock process
-	 *
-	 * Lock the process so that multiple instances can't run simultaneously.
-	 * Override if applicable, but the duration should be greater than that
-	 * defined in the time_exceeded() method.
-	 */
-	protected function lock_process() {
-		$this->start_time = time(); // Set start time of current process.
-
-		$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
-		$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
-
-		set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
-	}
-
-	/**
-	 * Unlock process
-	 *
-	 * Unlock the process so that other instances can spawn.
-	 *
-	 * @return $this
-	 */
-	protected function unlock_process() {
-		delete_site_transient( $this->identifier . '_process_lock' );
-
-		return $this;
-	}
-
-	/**
-	 * Get batch
-	 *
-	 * @return stdClass Return the first batch from the queue
-	 */
-	protected function get_batch() {
-		global $wpdb;
-
-		$table        = $wpdb->options;
-		$column       = 'option_name';
-		$key_column   = 'option_id';
-		$value_column = 'option_value';
-
-		if ( is_multisite() ) {
-			$table        = $wpdb->sitemeta;
-			$column       = 'meta_key';
-			$key_column   = 'meta_id';
-			$value_column = 'meta_value';
-		}
-
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
-
-		$query = $wpdb->get_row(
-			$wpdb->prepare(
-				"SELECT * FROM {$table} WHERE {$column} LIKE %s ORDER BY {$key_column} ASC LIMIT 1", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-				$key
-			)
-		);
-
-		$batch       = new stdClass();
-		$batch->key  = $query->$column;
-		$batch->data = maybe_unserialize( $query->$value_column );
-
-		return $batch;
-	}
-
-	/**
-	 * Handle
-	 *
-	 * Pass each queue item to the task handler, while remaining
-	 * within server memory and time limit constraints.
-	 */
-	protected function handle() {
-		$this->lock_process();
-
-		do {
-			$batch = $this->get_batch();
-
-			foreach ( $batch->data as $key => $value ) {
-				$task = $this->task( $value );
-
-				if ( false !== $task ) {
-					$batch->data[ $key ] = $task;
-				} else {
-					unset( $batch->data[ $key ] );
-				}
-
-				if ( $this->time_exceeded() || $this->memory_exceeded() ) {
-					// Batch limits reached.
-					break;
-				}
-			}
-
-			// Update or delete current batch.
-			if ( ! empty( $batch->data ) ) {
-				$this->update( $batch->key, $batch->data );
-			} else {
-				$this->delete( $batch->key );
-			}
-		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
-
-		$this->unlock_process();
-
-		// Start next batch or complete process.
-		if ( ! $this->is_queue_empty() ) {
-			$this->dispatch();
-		} else {
-			$this->complete();
-		}
-
-		wp_die();
-	}
-
-	/**
-	 * Memory exceeded
-	 *
-	 * Ensures the batch process never exceeds 90%
-	 * of the maximum WordPress memory.
-	 *
-	 * @return bool
-	 */
-	protected function memory_exceeded() {
-		$memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
-		$current_memory = memory_get_usage( true );
-		$return         = false;
-
-		if ( $current_memory >= $memory_limit ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_memory_exceeded', $return );
-	}
-
-	/**
-	 * Get memory limit
-	 *
-	 * @return int
-	 */
-	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
-		} else {
-			// Sensible default.
-			$memory_limit = '128M';
-		}
-
-		if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
-			// Unlimited, set to 32GB.
-			$memory_limit = '32000M';
-		}
-
-		return wp_convert_hr_to_bytes( $memory_limit );
-	}
-
-	/**
-	 * Time exceeded.
-	 *
-	 * Ensures the batch never exceeds a sensible time limit.
-	 * A timeout limit of 30s is common on shared hosting.
-	 *
-	 * @return bool
-	 */
-	protected function time_exceeded() {
-		$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
-		$return = false;
-
-		if ( time() >= $finish ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_time_exceeded', $return );
-	}
-
-	/**
-	 * Complete.
-	 *
-	 * Override if applicable, but ensure that the below actions are
-	 * performed, or, call parent::complete().
-	 */
-	protected function complete() {
-		// Unschedule the cron healthcheck.
-		$this->clear_scheduled_event();
-	}
-
-	/**
-	 * Schedule cron healthcheck
-	 *
-	 * @access public
-	 *
-	 * @param mixed $schedules Schedules.
-	 *
-	 * @return mixed
-	 */
-	public function schedule_cron_healthcheck( $schedules ) {
-		$interval = apply_filters( $this->identifier . '_cron_interval', 5 );
-
-		if ( property_exists( $this, 'cron_interval' ) ) {
-			$interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
-		}
-
-		// Adds every 5 minutes to the existing schedules.
-		$schedules[ $this->identifier . '_cron_interval' ] = array(
-			'interval' => MINUTE_IN_SECONDS * $interval,
-			'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
-		);
-
-		return $schedules;
-	}
-
-	/**
-	 * Handle cron healthcheck
-	 *
-	 * Restart the background process if not already running
-	 * and data exists in the queue.
-	 */
-	public function handle_cron_healthcheck() {
-		if ( $this->is_process_running() ) {
-			// Background process already running.
-			exit;
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			$this->clear_scheduled_event();
-			exit;
-		}
-
-		$this->handle();
-
-		exit;
-	}
-
-	/**
-	 * Schedule event
-	 */
-	protected function schedule_event() {
-		if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
-			wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Clear scheduled event
-	 */
-	protected function clear_scheduled_event() {
-		$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
-
-		if ( $timestamp ) {
-			wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Cancel Process
-	 *
-	 * Stop processing queue items, clear cronjob and delete batch.
-	 */
-	public function cancel_process() {
-		if ( ! $this->is_queue_empty() ) {
-			$batch = $this->get_batch();
-
-			$this->delete( $batch->key );
-
-			wp_clear_scheduled_hook( $this->cron_hook_identifier );
-		}
-
-	}
-
-	/**
-	 * Task
-	 *
-	 * Override this method to perform any actions required on each
-	 * queue item. Return the modified item for further processing
-	 * in the next pass through. Or, return false to remove the
-	 * item from the queue.
-	 *
-	 * @param mixed $item Queue item to iterate over.
-	 *
-	 * @return mixed
-	 */
-	abstract protected function task( $item );
+    /**
+     * Action
+     *
+     * (default value: 'background_process')
+     *
+     * @var string
+     * @access protected
+     */
+    protected $action = 'background_process';
+
+    /**
+     * Start time of current process.
+     *
+     * (default value: 0)
+     *
+     * @var int
+     * @access protected
+     */
+    protected $start_time = 0;
+
+    /**
+     * Cron_hook_identifier
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $cron_hook_identifier;
+
+    /**
+     * Cron_interval_identifier
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $cron_interval_identifier;
+
+    /**
+     * Initiate new background process
+     */
+    public function __construct() {
+        parent::__construct();
+
+        $this->cron_hook_identifier     = $this->identifier . '_cron';
+        $this->cron_interval_identifier = $this->identifier . '_cron_interval';
+
+        add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
+        add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
+    }
+
+    /**
+     * Dispatch
+     *
+     * @access public
+     * @return void
+     */
+    public function dispatch() {
+        // Schedule the cron healthcheck.
+        $this->schedule_event();
+
+        // Perform remote post.
+        return parent::dispatch();
+    }
+
+    /**
+     * Push to queue
+     *
+     * @param mixed $data Data.
+     *
+     * @return $this
+     */
+    public function push_to_queue( $data ) {
+        $this->data[] = $data;
+
+        return $this;
+    }
+
+    /**
+     * Save queue
+     *
+     * @return $this
+     */
+    public function save() {
+        $key = $this->generate_key();
+
+        if ( ! empty( $this->data ) ) {
+            update_site_option( $key, $this->data );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Update queue
+     *
+     * @param string $key  Key.
+     * @param array  $data Data.
+     *
+     * @return $this
+     */
+    public function update( $key, $data ) {
+        if ( ! empty( $data ) ) {
+            update_site_option( $key, $data );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Delete queue
+     *
+     * @param string $key Key.
+     *
+     * @return $this
+     */
+    public function delete( $key ) {
+        delete_site_option( $key );
+
+        return $this;
+    }
+
+    /**
+     * Generate key
+     *
+     * Generates a unique key based on microtime. Queue items are
+     * given a unique key so that they can be merged upon save.
+     *
+     * @param int $length Length.
+     *
+     * @return string
+     */
+    protected function generate_key( $length = 64 ) {
+        $unique  = md5( microtime() . rand() );
+        $prepend = $this->identifier . '_batch_';
+
+        return substr( $prepend . $unique, 0, $length );
+    }
+
+    /**
+     * Maybe process queue
+     *
+     * Checks whether data exists within the queue and that
+     * the process is not already running.
+     */
+    public function maybe_handle() {
+        // Don't lock up other requests while processing
+        session_write_close();
+
+        if ( $this->is_process_running() ) {
+            // Background process already running.
+            wp_die();
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            wp_die();
+        }
+
+        check_ajax_referer( $this->identifier, 'nonce' );
+
+        $this->handle();
+
+        wp_die();
+    }
+
+    /**
+     * Is queue empty
+     *
+     * @return bool
+     */
+    protected function is_queue_empty() {
+        global $wpdb;
+
+        $table  = $wpdb->options;
+        $column = 'option_name';
+
+        if ( is_multisite() ) {
+            $table  = $wpdb->sitemeta;
+            $column = 'meta_key';
+        }
+
+        $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+
+        $count = $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM {$table} WHERE {$column} LIKE %s", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+                $key
+            )
+        );
+
+        return ( $count > 0 ) ? false : true;
+    }
+
+    /**
+     * Is process running
+     *
+     * Check whether the current process is already running
+     * in a background process.
+     */
+    protected function is_process_running() {
+        if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
+            // Process already running.
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Lock process
+     *
+     * Lock the process so that multiple instances can't run simultaneously.
+     * Override if applicable, but the duration should be greater than that
+     * defined in the time_exceeded() method.
+     */
+    protected function lock_process() {
+        $this->start_time = time(); // Set start time of current process.
+
+        $lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
+        $lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
+
+        set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
+    }
+
+    /**
+     * Unlock process
+     *
+     * Unlock the process so that other instances can spawn.
+     *
+     * @return $this
+     */
+    protected function unlock_process() {
+        delete_site_transient( $this->identifier . '_process_lock' );
+
+        return $this;
+    }
+
+    /**
+     * Get batch
+     *
+     * @return stdClass Return the first batch from the queue
+     */
+    protected function get_batch() {
+        global $wpdb;
+
+        $table        = $wpdb->options;
+        $column       = 'option_name';
+        $key_column   = 'option_id';
+        $value_column = 'option_value';
+
+        if ( is_multisite() ) {
+            $table        = $wpdb->sitemeta;
+            $column       = 'meta_key';
+            $key_column   = 'meta_id';
+            $value_column = 'meta_value';
+        }
+
+        $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+
+        $query = $wpdb->get_row(
+            $wpdb->prepare(
+                "SELECT * FROM {$table} WHERE {$column} LIKE %s ORDER BY {$key_column} ASC LIMIT 1", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+                $key
+            )
+        );
+
+        $batch       = new stdClass();
+        $batch->key  = $query->$column;
+        $batch->data = maybe_unserialize( $query->$value_column );
+
+        return $batch;
+    }
+
+    /**
+     * Handle
+     *
+     * Pass each queue item to the task handler, while remaining
+     * within server memory and time limit constraints.
+     */
+    protected function handle() {
+        $this->lock_process();
+
+        do {
+            $batch = $this->get_batch();
+
+            foreach ( $batch->data as $key => $value ) {
+                $task = $this->task( $value );
+
+                if ( false !== $task ) {
+                    $batch->data[ $key ] = $task;
+                } else {
+                    unset( $batch->data[ $key ] );
+                }
+
+                if ( $this->time_exceeded() || $this->memory_exceeded() ) {
+                    // Batch limits reached.
+                    break;
+                }
+            }
+
+            // Update or delete current batch.
+            if ( ! empty( $batch->data ) ) {
+                $this->update( $batch->key, $batch->data );
+            } else {
+                $this->delete( $batch->key );
+            }
+        } while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
+
+        $this->unlock_process();
+
+        // Start next batch or complete process.
+        if ( ! $this->is_queue_empty() ) {
+            $this->dispatch();
+        } else {
+            $this->complete();
+        }
+
+        wp_die();
+    }
+
+    /**
+     * Memory exceeded
+     *
+     * Ensures the batch process never exceeds 90%
+     * of the maximum WordPress memory.
+     *
+     * @return bool
+     */
+    protected function memory_exceeded() {
+        $memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
+        $current_memory = memory_get_usage( true );
+        $return         = false;
+
+        if ( $current_memory >= $memory_limit ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_memory_exceeded', $return );
+    }
+
+    /**
+     * Get memory limit
+     *
+     * @return int
+     */
+    protected function get_memory_limit() {
+        if ( function_exists( 'ini_get' ) ) {
+            $memory_limit = ini_get( 'memory_limit' );
+        } else {
+            // Sensible default.
+            $memory_limit = '128M';
+        }
+
+        if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
+            // Unlimited, set to 32GB.
+            $memory_limit = '32000M';
+        }
+
+        return wp_convert_hr_to_bytes( $memory_limit );
+    }
+
+    /**
+     * Time exceeded.
+     *
+     * Ensures the batch never exceeds a sensible time limit.
+     * A timeout limit of 30s is common on shared hosting.
+     *
+     * @return bool
+     */
+    protected function time_exceeded() {
+        $finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
+        $return = false;
+
+        if ( time() >= $finish ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_time_exceeded', $return );
+    }
+
+    /**
+     * Complete.
+     *
+     * Override if applicable, but ensure that the below actions are
+     * performed, or, call parent::complete().
+     */
+    protected function complete() {
+        // Unschedule the cron healthcheck.
+        $this->clear_scheduled_event();
+    }
+
+    /**
+     * Schedule cron healthcheck
+     *
+     * @access public
+     *
+     * @param mixed $schedules Schedules.
+     *
+     * @return mixed
+     */
+    public function schedule_cron_healthcheck( $schedules ) {
+        $interval = apply_filters( $this->identifier . '_cron_interval', 5 );
+
+        if ( property_exists( $this, 'cron_interval' ) ) {
+            $interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
+        }
+
+        // Adds every 5 minutes to the existing schedules.
+        $schedules[ $this->identifier . '_cron_interval' ] = array(
+            'interval' => MINUTE_IN_SECONDS * $interval,
+            'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
+        );
+
+        return $schedules;
+    }
+
+    /**
+     * Handle cron healthcheck
+     *
+     * Restart the background process if not already running
+     * and data exists in the queue.
+     */
+    public function handle_cron_healthcheck() {
+        if ( $this->is_process_running() ) {
+            // Background process already running.
+            exit;
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            $this->clear_scheduled_event();
+            exit;
+        }
+
+        $this->handle();
+
+        exit;
+    }
+
+    /**
+     * Schedule event
+     */
+    protected function schedule_event() {
+        if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
+            wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Clear scheduled event
+     */
+    protected function clear_scheduled_event() {
+        $timestamp = wp_next_scheduled( $this->cron_hook_identifier );
+
+        if ( $timestamp ) {
+            wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Cancel Process
+     *
+     * Stop processing queue items, clear cronjob and delete batch.
+     */
+    public function cancel_process() {
+        if ( ! $this->is_queue_empty() ) {
+            $batch = $this->get_batch();
+
+            $this->delete( $batch->key );
+
+            wp_clear_scheduled_hook( $this->cron_hook_identifier );
+        }
+
+    }
+
+    /**
+     * Task
+     *
+     * Override this method to perform any actions required on each
+     * queue item. Return the modified item for further processing
+     * in the next pass through. Or, return false to remove the
+     * item from the queue.
+     *
+     * @param mixed $item Queue item to iterate over.
+     *
+     * @return mixed
+     */
+    abstract protected function task( $item );
 
 }

Spacing +68 added lines, -68 removed lines

@@ -55,11 +55,11 @@ 
 	public function __construct() {
 		parent::__construct();
 
-		$this->cron_hook_identifier     = $this->identifier . '_cron';
-		$this->cron_interval_identifier = $this->identifier . '_cron_interval';
+		$this->cron_hook_identifier     = $this->identifier.'_cron';
+		$this->cron_interval_identifier = $this->identifier.'_cron_interval';
 
-		add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
-		add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
+		add_action($this->cron_hook_identifier, array($this, 'handle_cron_healthcheck'));
+		add_filter('cron_schedules', array($this, 'schedule_cron_healthcheck'));
 	}
 
 	/**
@@ -83,7 +83,7 @@ 
 	 *
 	 * @return $this
 	 */
-	public function push_to_queue( $data ) {
+	public function push_to_queue($data) {
 		$this->data[] = $data;
 
 		return $this;
@@ -97,8 +97,8 @@ 
 	public function save() {
 		$key = $this->generate_key();
 
-		if ( ! empty( $this->data ) ) {
-			update_site_option( $key, $this->data );
+		if ( ! empty($this->data)) {
+			update_site_option($key, $this->data);
 		}
 
 		return $this;
@@ -112,9 +112,9 @@ 
 	 *
 	 * @return $this
 	 */
-	public function update( $key, $data ) {
-		if ( ! empty( $data ) ) {
-			update_site_option( $key, $data );
+	public function update($key, $data) {
+		if ( ! empty($data)) {
+			update_site_option($key, $data);
 		}
 
 		return $this;
@@ -127,8 +127,8 @@ 
 	 *
 	 * @return $this
 	 */
-	public function delete( $key ) {
-		delete_site_option( $key );
+	public function delete($key) {
+		delete_site_option($key);
 
 		return $this;
 	}
@@ -143,11 +143,11 @@ 
 	 *
 	 * @return string
 	 */
-	protected function generate_key( $length = 64 ) {
-		$unique  = md5( microtime() . rand() );
-		$prepend = $this->identifier . '_batch_';
+	protected function generate_key($length = 64) {
+		$unique  = md5(microtime().rand());
+		$prepend = $this->identifier.'_batch_';
 
-		return substr( $prepend . $unique, 0, $length );
+		return substr($prepend.$unique, 0, $length);
 	}
 
 	/**
@@ -160,17 +160,17 @@ 
 		// Don't lock up other requests while processing
 		session_write_close();
 
-		if ( $this->is_process_running() ) {
+		if ($this->is_process_running()) {
 			// Background process already running.
 			wp_die();
 		}
 
-		if ( $this->is_queue_empty() ) {
+		if ($this->is_queue_empty()) {
 			// No data to process.
 			wp_die();
 		}
 
-		check_ajax_referer( $this->identifier, 'nonce' );
+		check_ajax_referer($this->identifier, 'nonce');
 
 		$this->handle();
 
@@ -188,12 +188,12 @@ 
 		$table  = $wpdb->options;
 		$column = 'option_name';
 
-		if ( is_multisite() ) {
+		if (is_multisite()) {
 			$table  = $wpdb->sitemeta;
 			$column = 'meta_key';
 		}
 
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+		$key = $wpdb->esc_like($this->identifier.'_batch_').'%';
 
 		$count = $wpdb->get_var(
 			$wpdb->prepare(
@@ -202,7 +202,7 @@ 
 			)
 		);
 
-		return ( $count > 0 ) ? false : true;
+		return ($count > 0) ? false : true;
 	}
 
 	/**
@@ -212,7 +212,7 @@ 
 	 * in a background process.
 	 */
 	protected function is_process_running() {
-		if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
+		if (get_site_transient($this->identifier.'_process_lock')) {
 			// Process already running.
 			return true;
 		}
@@ -230,10 +230,10 @@ 
 	protected function lock_process() {
 		$this->start_time = time(); // Set start time of current process.
 
-		$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
-		$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
+		$lock_duration = (property_exists($this, 'queue_lock_time')) ? $this->queue_lock_time : 60; // 1 minute
+		$lock_duration = apply_filters($this->identifier.'_queue_lock_time', $lock_duration);
 
-		set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
+		set_site_transient($this->identifier.'_process_lock', microtime(), $lock_duration);
 	}
 
 	/**
@@ -244,7 +244,7 @@ 
 	 * @return $this
 	 */
 	protected function unlock_process() {
-		delete_site_transient( $this->identifier . '_process_lock' );
+		delete_site_transient($this->identifier.'_process_lock');
 
 		return $this;
 	}
@@ -262,14 +262,14 @@ 
 		$key_column   = 'option_id';
 		$value_column = 'option_value';
 
-		if ( is_multisite() ) {
+		if (is_multisite()) {
 			$table        = $wpdb->sitemeta;
 			$column       = 'meta_key';
 			$key_column   = 'meta_id';
 			$value_column = 'meta_value';
 		}
 
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+		$key = $wpdb->esc_like($this->identifier.'_batch_').'%';
 
 		$query = $wpdb->get_row(
 			$wpdb->prepare(
@@ -280,7 +280,7 @@ 
 
 		$batch       = new stdClass();
 		$batch->key  = $query->$column;
-		$batch->data = maybe_unserialize( $query->$value_column );
+		$batch->data = maybe_unserialize($query->$value_column);
 
 		return $batch;
 	}
@@ -297,33 +297,33 @@ 
 		do {
 			$batch = $this->get_batch();
 
-			foreach ( $batch->data as $key => $value ) {
-				$task = $this->task( $value );
+			foreach ($batch->data as $key => $value) {
+				$task = $this->task($value);
 
-				if ( false !== $task ) {
-					$batch->data[ $key ] = $task;
+				if (false !== $task) {
+					$batch->data[$key] = $task;
 				} else {
-					unset( $batch->data[ $key ] );
+					unset($batch->data[$key]);
 				}
 
-				if ( $this->time_exceeded() || $this->memory_exceeded() ) {
+				if ($this->time_exceeded() || $this->memory_exceeded()) {
 					// Batch limits reached.
 					break;
 				}
 			}
 
 			// Update or delete current batch.
-			if ( ! empty( $batch->data ) ) {
-				$this->update( $batch->key, $batch->data );
+			if ( ! empty($batch->data)) {
+				$this->update($batch->key, $batch->data);
 			} else {
-				$this->delete( $batch->key );
+				$this->delete($batch->key);
 			}
-		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
+		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty());
 
 		$this->unlock_process();
 
 		// Start next batch or complete process.
-		if ( ! $this->is_queue_empty() ) {
+		if ( ! $this->is_queue_empty()) {
 			$this->dispatch();
 		} else {
 			$this->complete();
@@ -342,14 +342,14 @@ 
 	 */
 	protected function memory_exceeded() {
 		$memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
-		$current_memory = memory_get_usage( true );
+		$current_memory = memory_get_usage(true);
 		$return         = false;
 
-		if ( $current_memory >= $memory_limit ) {
+		if ($current_memory >= $memory_limit) {
 			$return = true;
 		}
 
-		return apply_filters( $this->identifier . '_memory_exceeded', $return );
+		return apply_filters($this->identifier.'_memory_exceeded', $return);
 	}
 
 	/**
@@ -358,19 +358,19 @@ 
 	 * @return int
 	 */
 	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
+		if (function_exists('ini_get')) {
+			$memory_limit = ini_get('memory_limit');
 		} else {
 			// Sensible default.
 			$memory_limit = '128M';
 		}
 
-		if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
+		if ( ! $memory_limit || - 1 === intval($memory_limit)) {
 			// Unlimited, set to 32GB.
 			$memory_limit = '32000M';
 		}
 
-		return wp_convert_hr_to_bytes( $memory_limit );
+		return wp_convert_hr_to_bytes($memory_limit);
 	}
 
 	/**
@@ -382,14 +382,14 @@ 
 	 * @return bool
 	 */
 	protected function time_exceeded() {
-		$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
+		$finish = $this->start_time + apply_filters($this->identifier.'_default_time_limit', 20); // 20 seconds
 		$return = false;
 
-		if ( time() >= $finish ) {
+		if (time() >= $finish) {
 			$return = true;
 		}
 
-		return apply_filters( $this->identifier . '_time_exceeded', $return );
+		return apply_filters($this->identifier.'_time_exceeded', $return);
 	}
 
 	/**
@@ -412,17 +412,17 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function schedule_cron_healthcheck( $schedules ) {
-		$interval = apply_filters( $this->identifier . '_cron_interval', 5 );
+	public function schedule_cron_healthcheck($schedules) {
+		$interval = apply_filters($this->identifier.'_cron_interval', 5);
 
-		if ( property_exists( $this, 'cron_interval' ) ) {
-			$interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
+		if (property_exists($this, 'cron_interval')) {
+			$interval = apply_filters($this->identifier.'_cron_interval', $this->cron_interval);
 		}
 
 		// Adds every 5 minutes to the existing schedules.
-		$schedules[ $this->identifier . '_cron_interval' ] = array(
+		$schedules[$this->identifier.'_cron_interval'] = array(
 			'interval' => MINUTE_IN_SECONDS * $interval,
-			'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
+			'display'  => sprintf(__('Every %d Minutes'), $interval),
 		);
 
 		return $schedules;
@@ -435,12 +435,12 @@ 
 	 * and data exists in the queue.
 	 */
 	public function handle_cron_healthcheck() {
-		if ( $this->is_process_running() ) {
+		if ($this->is_process_running()) {
 			// Background process already running.
 			exit;
 		}
 
-		if ( $this->is_queue_empty() ) {
+		if ($this->is_queue_empty()) {
 			// No data to process.
 			$this->clear_scheduled_event();
 			exit;
@@ -455,8 +455,8 @@ 
 	 * Schedule event
 	 */
 	protected function schedule_event() {
-		if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
-			wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
+		if ( ! wp_next_scheduled($this->cron_hook_identifier)) {
+			wp_schedule_event(time(), $this->cron_interval_identifier, $this->cron_hook_identifier);
 		}
 	}
 
@@ -464,10 +464,10 @@ 
 	 * Clear scheduled event
 	 */
 	protected function clear_scheduled_event() {
-		$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
+		$timestamp = wp_next_scheduled($this->cron_hook_identifier);
 
-		if ( $timestamp ) {
-			wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
+		if ($timestamp) {
+			wp_unschedule_event($timestamp, $this->cron_hook_identifier);
 		}
 	}
 
@@ -477,12 +477,12 @@ 
 	 * Stop processing queue items, clear cronjob and delete batch.
 	 */
 	public function cancel_process() {
-		if ( ! $this->is_queue_empty() ) {
+		if ( ! $this->is_queue_empty()) {
 			$batch = $this->get_batch();
 
-			$this->delete( $batch->key );
+			$this->delete($batch->key);
 
-			wp_clear_scheduled_hook( $this->cron_hook_identifier );
+			wp_clear_scheduled_hook($this->cron_hook_identifier);
 		}
 
 	}
@@ -499,6 +499,6 @@ 
 	 *
 	 * @return mixed
 	 */
-	abstract protected function task( $item );
+	abstract protected function task($item);
 
 }

src/widgets/class-wordlift-timeline-widget.php

Indentation +42 added lines, -42 removed lines

@@ -2,53 +2,53 @@
 
 class Wordlift_Timeline_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes
-		parent::__construct(
-			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ) ) // Args
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes
+        parent::__construct(
+            'wl_timeline_widget', // Base ID
+            __( 'WordLift Timeline Widget', 'wordlift' ), // Name
+            array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ) ) // Args
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args
-	 * @param array $instance
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget
-		echo do_shortcode( '[wl_timeline global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget
+        echo do_shortcode( '[wl_timeline global=true]' );
+    }
 
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
-		// outputs the options form on admin
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function form( $instance ) {
+        // outputs the options form on admin
+    }
 
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options
-	 * @param array $old_instance The previous options
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved
+    }
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+    register_widget( 'WordLift_Timeline_Widget' );
 }

Spacing +7 added lines, -7 removed lines

@@ -9,8 +9,8 @@ 
 		// widget actual processes
 		parent::__construct(
 			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ) ) // Args
+			__('WordLift Timeline Widget', 'wordlift'), // Name
+			array('description' => __('Displays entities of type event using an interactive timeline.', 'wordlift')) // Args
 		);
 	}
 
@@ -21,9 +21,9 @@ 
 	 * @param array $instance
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget
-		echo do_shortcode( '[wl_timeline global=true]' );
+		echo do_shortcode('[wl_timeline global=true]');
 	}
 
 	/**
@@ -32,7 +32,7 @@ 
 	 * @param array $instance The widget options
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin
 	}
 
@@ -43,12 +43,12 @@ 
 	 * @param array $old_instance The previous options
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved
 	}
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+	register_widget('WordLift_Timeline_Widget');
 }

src/widgets/class-wordlift-chord-widget.php

Indentation +48 added lines, -48 removed lines

@@ -10,56 +10,56 @@ 
  */
 class Wordlift_Chord_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes.
-		parent::__construct(
-			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
-			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
-			) // Args.
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes.
+        parent::__construct(
+            'wl_chord_widget', // Base ID.
+            __( 'Chord Widget', 'wordlift' ), // Name.
+            array(
+                'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+            ) // Args.
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args widget args.
-	 * @param array $instance widget instance.
-	 */
-	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args widget args.
+     * @param array $instance widget instance.
+     */
+    // @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget.
+        echo do_shortcode( '[wl_chord global=true]' );
+    }
 
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options.
-	 *
-	 * @return string|void
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
-		// outputs the options form on admin.
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options.
+     *
+     * @return string|void
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function form( $instance ) {
+        // outputs the options form on admin.
+    }
 
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options.
-	 * @param array $old_instance The previous options.
-	 *
-	 * @return array|void
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved.
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options.
+     * @param array $old_instance The previous options.
+     *
+     * @return array|void
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved.
+    }
 }
 
 /**
@@ -69,5 +69,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+    register_widget( 'WordLift_Chord_Widget' );
 }

Spacing +7 added lines, -7 removed lines

@@ -17,9 +17,9 @@ 
 		// widget actual processes.
 		parent::__construct(
 			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
+			__('Chord Widget', 'wordlift'), // Name.
 			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+				'description' => __('The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift'),
 			) // Args.
 		);
 	}
@@ -31,9 +31,9 @@ 
 	 * @param array $instance widget instance.
 	 */
 	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
+		echo do_shortcode('[wl_chord global=true]');
 	}
 
 	/**
@@ -44,7 +44,7 @@ 
 	 * @return string|void
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin.
 	}
 
@@ -57,7 +57,7 @@ 
 	 * @return array|void
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved.
 	}
 }
@@ -69,5 +69,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+	register_widget('WordLift_Chord_Widget');
 }

src/wordlift-constants.php

Indentation +10 added lines, -10 removed lines

@@ -13,7 +13,7 @@ 
 
 // Use the WordLift API URL set on the command line.
 if ( ! defined( 'WORDLIFT_API_URL' ) && false !== getenv( 'WORDLIFT_API_URL' ) ) {
-	define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
+    define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
 }
 
 // 3.13.0, we use by default WLS 1.11 which provides us with the new, faster
@@ -52,15 +52,15 @@ 
  * @since 3.16.0
  */
 function wl_temp_dir() {
-	$tempdir         = get_temp_dir();
-	$unique          = md5( site_url() . get_current_blog_id() );
-	$unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
+    $tempdir         = get_temp_dir();
+    $unique          = md5( site_url() . get_current_blog_id() );
+    $unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
 
-	// If directory do not exist, create it.
-	if ( ! file_exists( $unique_temp_dir ) ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@mkdir( $unique_temp_dir );
-	}
+    // If directory do not exist, create it.
+    if ( ! file_exists( $unique_temp_dir ) ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @mkdir( $unique_temp_dir );
+    }
 
-	return $unique_temp_dir . '/';
+    return $unique_temp_dir . '/';
 }

Spacing +15 added lines, -15 removed lines

@@ -6,43 +6,43 @@ 
  */
 
 // Set the temporary files folder.
-defined( 'WL_TEMP_DIR' ) || define( 'WL_TEMP_DIR', wl_temp_dir() );
+defined('WL_TEMP_DIR') || define('WL_TEMP_DIR', wl_temp_dir());
 
 // Define the meta name used to store the entity URL.
-define( 'WL_ENTITY_URL_META_NAME', 'entity_url' );
+define('WL_ENTITY_URL_META_NAME', 'entity_url');
 
 // WordLift Directory URL.
-defined( 'WL_DIR_URL' ) || define( 'WL_DIR_URL', plugin_dir_url( __FILE__ ) );
+defined('WL_DIR_URL') || define('WL_DIR_URL', plugin_dir_url(__FILE__));
 
 // Use the WordLift API URL set on the command line.
-if ( ! defined( 'WORDLIFT_API_URL' ) && false !== getenv( 'WORDLIFT_API_URL' ) ) {
-	define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
+if ( ! defined('WORDLIFT_API_URL') && false !== getenv('WORDLIFT_API_URL')) {
+	define('WORDLIFT_API_URL', getenv('WORDLIFT_API_URL'));
 }
 
 // 3.13.0, we use by default WLS 1.11 which provides us with the new, faster
 // chunked analysis.
-define( 'WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE', defined( 'WORDLIFT_API_URL' ) ? WORDLIFT_API_URL . '/' : 'https://api.wordlift.io/' );
+define('WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE', defined('WORDLIFT_API_URL') ? WORDLIFT_API_URL . '/' : 'https://api.wordlift.io/');
 
 // @since 3.29.0 we do not use https://developers.google.com/structured-data/testing-tool/?url=
-define( 'WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL', 'https://search.google.com/test/rich-results?url=' );
+define('WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL', 'https://search.google.com/test/rich-results?url=');
 
 // If is set to true, there will be additional button in 'Download Your Data' page
 // that will allow users to download their data in JSON-LD format.
-defined( 'WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA' ) || define( 'WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA', false );
+defined('WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA') || define('WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA', false);
 
 /*
  * Define the default scope for autocomplete requests.
  *
  * @see https://github.com/insideout10/wordlift-plugin/issues/839
  */
-defined( 'WL_AUTOCOMPLETE_SCOPE' ) || define( 'WL_AUTOCOMPLETE_SCOPE', 'cloud' );
+defined('WL_AUTOCOMPLETE_SCOPE') || define('WL_AUTOCOMPLETE_SCOPE', 'cloud');
 
 /*
  * Enable/disable the `all entity types` feature. Initially we keep the feature disabled to enture proper Q/A.
  *
  * @see https://github.com/insideout10/wordlift-plugin/issues/835
  */
-defined( 'WL_ALL_ENTITY_TYPES' ) || define( 'WL_ALL_ENTITY_TYPES', false );
+defined('WL_ALL_ENTITY_TYPES') || define('WL_ALL_ENTITY_TYPES', false);
 
 /**
  * Get a site unique directory under the system or WordPress temporary directory.
@@ -56,14 +56,14 @@ 
  */
 function wl_temp_dir() {
 	$tempdir         = get_temp_dir();
-	$unique          = md5( site_url() . get_current_blog_id() );
-	$unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
+	$unique          = md5(site_url().get_current_blog_id());
+	$unique_temp_dir = $tempdir.'wl_'.$unique; // $tempdir should have a trailing slash.
 
 	// If directory do not exist, create it.
-	if ( ! file_exists( $unique_temp_dir ) ) {
+	if ( ! file_exists($unique_temp_dir)) {
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@mkdir( $unique_temp_dir );
+		@mkdir($unique_temp_dir);
 	}
 
-	return $unique_temp_dir . '/';
+	return $unique_temp_dir.'/';
 }

src/deprecations.php

Indentation +96 added lines, -96 removed lines

@@ -17,7 +17,7 @@ 
  */
 function wl_write_log( $log ) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+    Wordlift_Log_Service::get_instance()->debug( $log );
 
 }
 
@@ -26,21 +26,21 @@ 
  * see http://vip.wordpress.com/documentation/register-additional-html-attributes-for-tinymce-and-wp-kses/
  */
 function wordlift_allowed_post_tags() {
-	global $allowedposttags;
-
-	$tags           = array( 'span' );
-	$new_attributes = array(
-		'itemscope' => array(),
-		'itemtype'  => array(),
-		'itemprop'  => array(),
-		'itemid'    => array(),
-	);
-
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
-		}
-	}
+    global $allowedposttags;
+
+    $tags           = array( 'span' );
+    $new_attributes = array(
+        'itemscope' => array(),
+        'itemtype'  => array(),
+        'itemprop'  => array(),
+        'itemid'    => array(),
+    );
+
+    foreach ( $tags as $tag ) {
+        if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
+            $allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+        }
+    }
 }
 
 // add allowed post tags.
@@ -51,18 +51,18 @@ 
  */
 function wordlift_admin_enqueue_scripts() {
 
-	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+    // Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
+    wp_enqueue_script( 'wpdialogs' );
+    wp_enqueue_style( 'wp-jquery-ui-dialog' );
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
+    wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+    wp_enqueue_script( 'jquery-ui-autocomplete' );
 
-	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
-	}
+    // Disable auto-save for custom entity posts only
+    if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
+        wp_dequeue_script( 'autosave' );
+    }
 
 }
 
@@ -78,21 +78,21 @@ 
  */
 function wordlift_allowed_html( $allowedtags, $context ) {
 
-	if ( 'post' !== $context ) {
-		return $allowedtags;
-	}
-
-	return array_merge_recursive(
-		$allowedtags,
-		array(
-			'span' => array(
-				'itemscope' => true,
-				'itemtype'  => true,
-				'itemid'    => true,
-				'itemprop'  => true,
-			),
-		)
-	);
+    if ( 'post' !== $context ) {
+        return $allowedtags;
+    }
+
+    return array_merge_recursive(
+        $allowedtags,
+        array(
+            'span' => array(
+                'itemscope' => true,
+                'itemtype'  => true,
+                'itemid'    => true,
+                'itemprop'  => true,
+            ),
+        )
+    );
 }
 
 add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
@@ -107,9 +107,9 @@ 
  */
 function wl_get_image_urls( $post_id ) {
 
-	return Wordlift_Storage_Factory::get_instance()
-								   ->post_images()
-								   ->get( $post_id );
+    return Wordlift_Storage_Factory::get_instance()
+                                    ->post_images()
+                                    ->get( $post_id );
 
 }
 
@@ -123,26 +123,26 @@ 
  */
 function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
 
-	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
-
-	$posts = get_posts(
-		array(
-			'post_type'      => 'attachment',
-			'posts_per_page' => 1,
-			'post_status'    => 'any',
-			'post_parent'    => $parent_post_id,
-			'meta_key'       => 'wl_source_url',
-			'meta_value'     => $source_url,
-		)
-	);
-
-	// Return the found post.
-	if ( 1 === count( $posts ) ) {
-		return $posts[0];
-	}
-
-	// Return null.
-	return null;
+    // wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
+
+    $posts = get_posts(
+        array(
+            'post_type'      => 'attachment',
+            'posts_per_page' => 1,
+            'post_status'    => 'any',
+            'post_parent'    => $parent_post_id,
+            'meta_key'       => 'wl_source_url',
+            'meta_value'     => $source_url,
+        )
+    );
+
+    // Return the found post.
+    if ( 1 === count( $posts ) ) {
+        return $posts[0];
+    }
+
+    // Return null.
+    return null;
 }
 
 /**
@@ -153,8 +153,8 @@ 
  */
 function wl_set_source_url( $post_id, $source_url ) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+    delete_post_meta( $post_id, 'wl_source_url' );
+    add_post_meta( $post_id, 'wl_source_url', $source_url );
 }
 
 /**
@@ -170,7 +170,7 @@ 
  */
 function wl_sanitize_uri_path( $path, $char = '_' ) {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+    return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
 }
 
 /**
@@ -182,47 +182,47 @@ 
  */
 function wl_replace_item_id_with_uri( $content ) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+    $log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
+    $log->trace( 'Replacing item IDs with URIs...' );
 
-	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+    // Strip slashes, see https://core.trac.wordpress.org/ticket/21767
+    $content = stripslashes( $content );
 
-	// If any match are found.
-	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+    // If any match are found.
+    $matches = array();
+    if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
 
-		foreach ( $matches as $match ) {
+        foreach ( $matches as $match ) {
 
-			// Get the item ID.
-			$item_id = $match[1];
+            // Get the item ID.
+            $item_id = $match[1];
 
-			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
-			$post = Wordlift_Entity_Service::get_instance()
-										   ->get_entity_post_by_uri( $item_id );
+            // Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
+            $post = Wordlift_Entity_Service::get_instance()
+                                            ->get_entity_post_by_uri( $item_id );
 
-			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
-				continue;
-			}
+            // If no entity is found, continue to the next one.
+            if ( null === $post ) {
+                continue;
+            }
 
-			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+            // Get the URI for that post.
+            $uri = wl_get_entity_uri( $post->ID );
 
-			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
+            // wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
-			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( ! empty( $uri ) && $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
-			}
-		}
-	}
+            // If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
+            if ( ! empty( $uri ) && $item_id !== $uri ) {
+                $uri_e   = esc_html( $uri );
+                $content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+            }
+        }
+    }
 
-	// Reapply slashes.
-	$content = addslashes( $content );
+    // Reapply slashes.
+    $content = addslashes( $content );
 
-	return $content;
+    return $content;
 }
 
 add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );

Spacing +40 added lines, -40 removed lines

@@ -15,9 +15,9 @@ 
  *
  * @deprecated use Wordlift_Log_Service::get_instance()->info( $log );
  */
-function wl_write_log( $log ) {
+function wl_write_log($log) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+	Wordlift_Log_Service::get_instance()->debug($log);
 
 }
 
@@ -28,7 +28,7 @@ 
 function wordlift_allowed_post_tags() {
 	global $allowedposttags;
 
-	$tags           = array( 'span' );
+	$tags           = array('span');
 	$new_attributes = array(
 		'itemscope' => array(),
 		'itemtype'  => array(),
@@ -36,15 +36,15 @@ 
 		'itemid'    => array(),
 	);
 
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+	foreach ($tags as $tag) {
+		if (isset($allowedposttags[$tag]) && is_array($allowedposttags[$tag])) {
+			$allowedposttags[$tag] = array_merge($allowedposttags[$tag], $new_attributes); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
 		}
 	}
 }
 
 // add allowed post tags.
-add_action( 'init', 'wordlift_allowed_post_tags' );
+add_action('init', 'wordlift_allowed_post_tags');
 
 /**
  * Register additional scripts for the admin UI.
@@ -52,21 +52,21 @@ 
 function wordlift_admin_enqueue_scripts() {
 
 	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+	wp_enqueue_script('wpdialogs');
+	wp_enqueue_style('wp-jquery-ui-dialog');
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
+	wp_enqueue_style('wordlift-reloaded', plugin_dir_url(__FILE__).'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION);
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+	wp_enqueue_script('jquery-ui-autocomplete');
 
 	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
+	if (Wordlift_Entity_Service::TYPE_NAME === get_post_type()) {
+		wp_dequeue_script('autosave');
 	}
 
 }
 
-add_action( 'admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts' );
+add_action('admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts');
 
 /**
  * Hooked to *wp_kses_allowed_html* filter, adds microdata attributes.
@@ -76,9 +76,9 @@ 
  *
  * @return array An array which contains allowed microdata attributes.
  */
-function wordlift_allowed_html( $allowedtags, $context ) {
+function wordlift_allowed_html($allowedtags, $context) {
 
-	if ( 'post' !== $context ) {
+	if ('post' !== $context) {
 		return $allowedtags;
 	}
 
@@ -95,7 +95,7 @@ 
 	);
 }
 
-add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
+add_filter('wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2);
 
 /**
  * Get all the images bound to a post.
@@ -105,11 +105,11 @@ 
  * @return array An array of image URLs.
  * @deprecated use Wordlift_Storage_Factory::get_instance()->post_images()->get( $post_id )
  */
-function wl_get_image_urls( $post_id ) {
+function wl_get_image_urls($post_id) {
 
 	return Wordlift_Storage_Factory::get_instance()
 								   ->post_images()
-								   ->get( $post_id );
+								   ->get($post_id);
 
 }
 
@@ -121,7 +121,7 @@ 
  *
  * @return WP_Post|null A post instance or null if not found.
  */
-function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
+function wl_get_attachment_for_source_url($parent_post_id, $source_url) {
 
 	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
@@ -137,7 +137,7 @@ 
 	);
 
 	// Return the found post.
-	if ( 1 === count( $posts ) ) {
+	if (1 === count($posts)) {
 		return $posts[0];
 	}
 
@@ -151,10 +151,10 @@ 
  * @param int    $post_id The post ID.
  * @param string $source_url The source URL.
  */
-function wl_set_source_url( $post_id, $source_url ) {
+function wl_set_source_url($post_id, $source_url) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+	delete_post_meta($post_id, 'wl_source_url');
+	add_post_meta($post_id, 'wl_source_url', $source_url);
 }
 
 /**
@@ -168,9 +168,9 @@ 
  * @deprecated use Wordlift_Uri_Service::get_instance()->sanitize_path();
  * @see        https://codex.wordpress.org/Function_Reference/sanitize_title
  */
-function wl_sanitize_uri_path( $path, $char = '_' ) {
+function wl_sanitize_uri_path($path, $char = '_') {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+	return Wordlift_Uri_Service::get_instance()->sanitize_path($path, $char);
 }
 
 /**
@@ -180,52 +180,52 @@ 
  *
  * @return string The updated post content.
  */
-function wl_replace_item_id_with_uri( $content ) {
+function wl_replace_item_id_with_uri($content) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+	$log = Wordlift_Log_Service::get_logger('wl_replace_item_id_with_uri');
+	$log->trace('Replacing item IDs with URIs...');
 
 	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+	$content = stripslashes($content);
 
 	// If any match are found.
 	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+	if (0 < preg_match_all('/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER)) {
 
-		foreach ( $matches as $match ) {
+		foreach ($matches as $match) {
 
 			// Get the item ID.
 			$item_id = $match[1];
 
 			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
 			$post = Wordlift_Entity_Service::get_instance()
-										   ->get_entity_post_by_uri( $item_id );
+										   ->get_entity_post_by_uri($item_id);
 
 			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
+			if (null === $post) {
 				continue;
 			}
 
 			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+			$uri = wl_get_entity_uri($post->ID);
 
 			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
 			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( ! empty( $uri ) && $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+			if ( ! empty($uri) && $item_id !== $uri) {
+				$uri_e   = esc_html($uri);
+				$content = str_replace(" itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content);
 			}
 		}
 	}
 
 	// Reapply slashes.
-	$content = addslashes( $content );
+	$content = addslashes($content);
 
 	return $content;
 }
 
-add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
+add_filter('content_save_pre', 'wl_replace_item_id_with_uri', 1, 1);
 
 require_once 'wordlift-entity-functions.php';
 

src/js/dist/gutenberg-faq-plugin.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
-	'version'      => '18770cde607d785a81b65ef98e409669',
+    'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
+    'version'      => '18770cde607d785a81b65ef98e409669',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
+	'dependencies' => array('wp-polyfill', 'wp-rich-text'),
 	'version'      => '18770cde607d785a81b65ef98e409669',
 );

src/admin/class-wordlift-entity-types-taxonomy-walker.php

Indentation +109 added lines, -109 removed lines

@@ -10,7 +10,7 @@ 
  * @subpackage Wordlift/includes
  */
 if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+    require_once ABSPATH . 'wp-admin/includes/template.php';
 }
 
 /**
@@ -24,113 +24,113 @@ 
 // phpcs:ignore Generic.Classes.DuplicateClassName.Found
 class Wordlift_Entity_Types_Taxonomy_Walker extends Walker_Category_Checklist {
 
-	/**
-	 * Entity taxonomy metabox must show exclusive options, no checkboxes.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param       $args     {
-	 *                        An array of arguments.
-	 *
-	 * @type string $taxonomy The taxonomy name.
-	 *              }
-	 *
-	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
-	 */
-	public function terms_checklist_args( $args ) {
-
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			return $args;
-		}
-
-		// We override the way WP prints the taxonomy metabox HTML.
-		$args['walker']        = $this;
-		$args['checked_ontop'] = false;
-
-		return $args;
-
-	}
-
-	/**
-	 * Change checkboxes to radios.
-	 *
-	 * $max_depth = -1 means flatly display every element.
-	 * $max_depth = 0 means display all levels.
-	 * $max_depth > 0 specifies the number of display levels.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param array $elements  An array of elements.
-	 * @param int   $max_depth The maximum hierarchical depth.
-	 *
-	 * @param array $args      Additional arguments.
-	 *
-	 * @return string The hierarchical item output.
-	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
-
-		// `max_depth` force to -1 to display a flat taxonomy.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
-
-		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
-			$output
-		);
-
-		return $output;
-	}
-
-	/**
-	 * Start the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 * @param int    $id       ID of the current term.
-	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
-		}
-	}
-
-	/**
-	 * End the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
-		}
-
-	}
+    /**
+     * Entity taxonomy metabox must show exclusive options, no checkboxes.
+     *
+     * @since 3.1.0
+     *
+     * @param       $args     {
+     *                        An array of arguments.
+     *
+     * @type string $taxonomy The taxonomy name.
+     *              }
+     *
+     * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
+     */
+    public function terms_checklist_args( $args ) {
+
+        if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            return $args;
+        }
+
+        // We override the way WP prints the taxonomy metabox HTML.
+        $args['walker']        = $this;
+        $args['checked_ontop'] = false;
+
+        return $args;
+
+    }
+
+    /**
+     * Change checkboxes to radios.
+     *
+     * $max_depth = -1 means flatly display every element.
+     * $max_depth = 0 means display all levels.
+     * $max_depth > 0 specifies the number of display levels.
+     *
+     * @since 3.1.0
+     *
+     * @param array $elements  An array of elements.
+     * @param int   $max_depth The maximum hierarchical depth.
+     *
+     * @param array $args      Additional arguments.
+     *
+     * @return string The hierarchical item output.
+     */
+    public function walk( $elements, $max_depth, $args = array() ) {
+
+        // `max_depth` force to -1 to display a flat taxonomy.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/305
+        $output = parent::walk( $elements, - 1, $args );
+
+        $output = str_replace(
+            array( 'type="checkbox"', "type='checkbox'" ),
+            array( 'type="radio"', "type='radio'" ),
+            $output
+        );
+
+        return $output;
+    }
+
+    /**
+     * Start the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     * @param int    $id       ID of the current term.
+     */
+    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::start_el( $output, $category, $depth, $args, $id );
+        }
+    }
+
+    /**
+     * End the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     */
+    public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::end_el( $output, $category, $depth, $args );
+        }
+
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -9,8 +9,8 @@ 
  * @package    Wordlift
  * @subpackage Wordlift/includes
  */
-if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+if ( ! class_exists('Walker_Category_Checklist')) {
+	require_once ABSPATH.'wp-admin/includes/template.php';
 }
 
 /**
@@ -37,9 +37,9 @@ 
 	 *
 	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
 	 */
-	public function terms_checklist_args( $args ) {
+	public function terms_checklist_args($args) {
 
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+		if ( ! isset($args['taxonomy']) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
 			return $args;
 		}
 
@@ -67,16 +67,16 @@ 
 	 *
 	 * @return string The hierarchical item output.
 	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
+	public function walk($elements, $max_depth, $args = array()) {
 
 		// `max_depth` force to -1 to display a flat taxonomy.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
+		$output = parent::walk($elements, - 1, $args);
 
 		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
+			array('type="checkbox"', "type='checkbox'"),
+			array('type="radio"', "type='radio'"),
 			$output
 		);
 
@@ -94,17 +94,17 @@ 
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 * @param int    $id       ID of the current term.
 	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+	public function start_el(&$output, $category, $depth = 0, $args = array(), $id = 0) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::start_el($output, $category, $depth, $args, $id);
 		}
 	}
 
@@ -118,17 +118,17 @@ 
 	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+	public function end_el(&$output, $category, $depth = 0, $args = array()) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::end_el($output, $category, $depth, $args);
 		}
 
 	}

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

Indentation +290 added lines, -290 removed lines

@@ -20,131 +20,131 @@ 
  */
 class Wordlift_Admin_Post_Edit_Page {
 
-	/**
-	 * Constants to be used instead of text inside FAQ
-	 * helper methods.
-	 */
-	const GUTENBERG       = 'gutenberg';
-	const TINY_MCE        = 'tiny_mce';
-	const FAQ_LIST_BOX_ID = 'wl-faq-meta-list-box';
-
-	/** Constant to be used for translation domain */
-	const WORDLIFT_TEXT_DOMAIN = 'wordlift';
-
-	/**
-	 * The {@link Wordlift} plugin instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	private $plugin;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.4
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
-	 *
-	 * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 *
-	 * @since 3.11.0
-	 */
-	public function __construct( $plugin ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
-
-		// Bail out if we're in the UX Builder editor.
-		if ( $this->is_ux_builder_editor() ) {
-			$this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
-
-			return;
-		}
-
-		// Define the callbacks.
-		$callback = array( $this, 'enqueue_scripts' );
-		// Set a hook to enqueue scripts only when the edit page is displayed.
-		add_action( 'admin_print_scripts-post.php', $callback );
-		add_action( 'admin_print_scripts-post-new.php', $callback );
-
-		$this->plugin = $plugin;
-	}
-
-	/**
-	 * Check whether the current post opens with G'berg or not.
-	 *
-	 * @return bool True if G'berg is used otherwise false.
-	 * @since 3.22.3
-	 */
-	public function is_gutenberg_page() {
-		if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
-			// The Gutenberg plugin is on.
-			return true;
-		}
-
-		$current_screen = get_current_screen();
-		if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
-			// Gutenberg page on 5+.
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if we're in UX builder.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/691
-	 *
-	 * @since 3.15.4
-	 *
-	 * @return bool True if we're in UX builder, otherwise false.
-	 */
-	private function is_ux_builder_editor() {
-
-		return function_exists( 'ux_builder_is_editor' )
-			   && ux_builder_is_editor();
-	}
-
-	/**
-	 * Enqueue scripts and styles for the edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	public function enqueue_scripts() {
-
-		// Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/832
-		wp_dequeue_script( 'ontrapagesAngular' );
-		wp_dequeue_script( 'ontrapagesApp' );
-		wp_dequeue_script( 'ontrapagesController' );
-
-		// Bail out if this is G'berg.
-		if ( $this->is_gutenberg_page() ) {
-			return;
-		}
-
-		// If Gutenberg is enabled for the post, do not load the legacy edit.js.
-		if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
-			return;
-		}
-
-		// Bail out if classification sidebar is not enabled via hook
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
-			return;
-		}
-
-		/*
+    /**
+     * Constants to be used instead of text inside FAQ
+     * helper methods.
+     */
+    const GUTENBERG       = 'gutenberg';
+    const TINY_MCE        = 'tiny_mce';
+    const FAQ_LIST_BOX_ID = 'wl-faq-meta-list-box';
+
+    /** Constant to be used for translation domain */
+    const WORDLIFT_TEXT_DOMAIN = 'wordlift';
+
+    /**
+     * The {@link Wordlift} plugin instance.
+     *
+     * @since 3.11.0
+     *
+     * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    private $plugin;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.4
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
+     *
+     * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
+     *
+     * @since 3.11.0
+     */
+    public function __construct( $plugin ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
+
+        // Bail out if we're in the UX Builder editor.
+        if ( $this->is_ux_builder_editor() ) {
+            $this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
+
+            return;
+        }
+
+        // Define the callbacks.
+        $callback = array( $this, 'enqueue_scripts' );
+        // Set a hook to enqueue scripts only when the edit page is displayed.
+        add_action( 'admin_print_scripts-post.php', $callback );
+        add_action( 'admin_print_scripts-post-new.php', $callback );
+
+        $this->plugin = $plugin;
+    }
+
+    /**
+     * Check whether the current post opens with G'berg or not.
+     *
+     * @return bool True if G'berg is used otherwise false.
+     * @since 3.22.3
+     */
+    public function is_gutenberg_page() {
+        if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
+            // The Gutenberg plugin is on.
+            return true;
+        }
+
+        $current_screen = get_current_screen();
+        if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
+            // Gutenberg page on 5+.
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if we're in UX builder.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/691
+     *
+     * @since 3.15.4
+     *
+     * @return bool True if we're in UX builder, otherwise false.
+     */
+    private function is_ux_builder_editor() {
+
+        return function_exists( 'ux_builder_is_editor' )
+               && ux_builder_is_editor();
+    }
+
+    /**
+     * Enqueue scripts and styles for the edit page.
+     *
+     * @since 3.11.0
+     */
+    public function enqueue_scripts() {
+
+        // Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/832
+        wp_dequeue_script( 'ontrapagesAngular' );
+        wp_dequeue_script( 'ontrapagesApp' );
+        wp_dequeue_script( 'ontrapagesController' );
+
+        // Bail out if this is G'berg.
+        if ( $this->is_gutenberg_page() ) {
+            return;
+        }
+
+        // If Gutenberg is enabled for the post, do not load the legacy edit.js.
+        if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
+            return;
+        }
+
+        // Bail out if classification sidebar is not enabled via hook
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+            return;
+        }
+
+        /*
 		 * Enqueue the edit screen JavaScript. The `wordlift-admin.bundle.js` file
 		 * is scheduled to replace the older `wordlift-admin.min.js` once client-side
 		 * code is properly refactored.
@@ -153,178 +153,178 @@ 
 		 *
 		 * @since 3.20.0 edit.js has been migrated to the new webpack configuration.
 		 */
-		$script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
-
-		/**
-		 * Scripts_Helper introduced.
-		 *
-		 * @since 3.25.0 Scripts are loaded using script helper to ensure WP 4.4 compatibiility.
-		 * @since 3.25.1 The handle is used to hook the wp_localize_script for the _wlEntityTypes global object.
-		 */
-		Scripts_Helper::enqueue_based_on_wordpress_version(
-			'wl-classic-editor',
-			$script_name,
-			array(
-				$this->plugin->get_plugin_name(),
-				'jquery',
-				// Require wp.ajax.
-				'wp-util',
-				// @@todo: provide the following dependencies when we're in WP < 5.0 (i.e. when these dependencies aren't already defined).
-				'react',
-				'react-dom',
-				'wp-element',
-				'wp-polyfill',
-				/*
+        $script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
+
+        /**
+         * Scripts_Helper introduced.
+         *
+         * @since 3.25.0 Scripts are loaded using script helper to ensure WP 4.4 compatibiility.
+         * @since 3.25.1 The handle is used to hook the wp_localize_script for the _wlEntityTypes global object.
+         */
+        Scripts_Helper::enqueue_based_on_wordpress_version(
+            'wl-classic-editor',
+            $script_name,
+            array(
+                $this->plugin->get_plugin_name(),
+                'jquery',
+                // Require wp.ajax.
+                'wp-util',
+                // @@todo: provide the following dependencies when we're in WP < 5.0 (i.e. when these dependencies aren't already defined).
+                'react',
+                'react-dom',
+                'wp-element',
+                'wp-polyfill',
+                /*
 				* Angular isn't loaded anymore remotely, but it is loaded within wordlift-reloaded.js.
 				*
 				* See https://github.com/insideout10/wordlift-plugin/issues/865.
 				*
 				* @since 3.19.6
 				*/
-				// Require Angular.
-				// 'wl-angular',
-				// 'wl-angular-geolocation',
-				// 'wl-angular-touch',
-				// 'wl-angular-animate',
-				/**
-				 * We need the `wp.hooks` global to allow the edit.js script to send actions.
-				 *
-				 * @since 3.23.0
-				 */
-				'wp-hooks',
-			)
-		);
-
-		wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
-		// Disable Faq Editor.
-		// $this->load_faq_scripts_and_styles();
-		// $this->load_faq_settings( self::TINY_MCE );
-	}
-
-	/**
-	 * Enqueue the scripts and styles needed for FAQ
-	 */
-	private function load_faq_scripts_and_styles() {
-		wp_enqueue_style(
-			'wl-faq-metabox-style',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
-			array(),
-			WORDLIFT_VERSION
-		);
-		Scripts_Helper::enqueue_based_on_wordpress_version(
-			'wl-faq-metabox-script',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq',
-			array( 'wp-polyfill' ),
-			true
-		);
-	}
-
-	/**
-	 * Get FAQ settings array
-	 *
-	 * @return array
-	 */
-	public function get_faq_settings() {
-		return array(
-			'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
-			'listBoxId'               => self::FAQ_LIST_BOX_ID,
-			'nonce'                   => wp_create_nonce( 'wp_rest' ),
-			'postId'                  => get_the_ID(),
-			// Translation for warning, error message.
-			/* translators: %s: The invalid tag. */
-			'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
-			/* translators: %s: The word count limit warning. */
-			'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
-			'questionText'            => __( 'Question', 'wordlift' ),
-			'answerText'              => __( 'Answer', 'wordlift' ),
-			'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
-			'addQuestionText'         => __( 'Add Question', 'wordlift' ),
-			'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
-			'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
-			'updatingText'            => __( 'Updating...', 'wordlift' ),
-		);
-	}
-
-	/**
-	 * Load FAQ settings to the add/edit post page
-	 *
-	 * @param $editor string specifying which text editor needed to be used.
-	 */
-	private function load_faq_settings( $editor ) {
-		// This script also provides translations to gutenberg.
-		wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
-
-		// Enqueue the FAQ style
-		if ( self::GUTENBERG === $editor ) {
-			Scripts_Helper::enqueue_based_on_wordpress_version(
-				'wl-faq-gutenberg-plugin',
-				plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
-				array( 'wp-polyfill' ),
-				true
-			);
-		}
-	}
-
-	/**
-	 * Enqueue scripts and styles for the gutenberg edit page.
-	 *
-	 * @since 3.21.0
-	 */
-	public function enqueue_scripts_gutenberg() {
-		// Load FAQ settings. - Disabled for now
-		// $this->load_faq_scripts_and_styles();
-		// $this->load_faq_settings( self::GUTENBERG );
-
-		wp_register_script(
-			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
-			array(
-				'react',
-				'wordlift',
-				'wp-hooks',
-				'wp-data',
-				'wp-rich-text',
-				'wp-blocks',
-				'wp-plugins',
-				'wp-edit-post',
-			),
-			$this->plugin->get_version(),
-			false
-		);
-		wp_localize_script(
-			'wl-block-editor',
-			'_wlBlockEditorSettings',
-			array(
-				'root'  => esc_url_raw( rest_url() ),
-				'nonce' => wp_create_nonce( 'wp_rest' ),
-			)
-		);
-
-		/*
+                // Require Angular.
+                // 'wl-angular',
+                // 'wl-angular-geolocation',
+                // 'wl-angular-touch',
+                // 'wl-angular-animate',
+                /**
+                 * We need the `wp.hooks` global to allow the edit.js script to send actions.
+                 *
+                 * @since 3.23.0
+                 */
+                'wp-hooks',
+            )
+        );
+
+        wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
+        // Disable Faq Editor.
+        // $this->load_faq_scripts_and_styles();
+        // $this->load_faq_settings( self::TINY_MCE );
+    }
+
+    /**
+     * Enqueue the scripts and styles needed for FAQ
+     */
+    private function load_faq_scripts_and_styles() {
+        wp_enqueue_style(
+            'wl-faq-metabox-style',
+            plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
+            array(),
+            WORDLIFT_VERSION
+        );
+        Scripts_Helper::enqueue_based_on_wordpress_version(
+            'wl-faq-metabox-script',
+            plugin_dir_url( __DIR__ ) . 'js/dist/faq',
+            array( 'wp-polyfill' ),
+            true
+        );
+    }
+
+    /**
+     * Get FAQ settings array
+     *
+     * @return array
+     */
+    public function get_faq_settings() {
+        return array(
+            'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
+            'listBoxId'               => self::FAQ_LIST_BOX_ID,
+            'nonce'                   => wp_create_nonce( 'wp_rest' ),
+            'postId'                  => get_the_ID(),
+            // Translation for warning, error message.
+            /* translators: %s: The invalid tag. */
+            'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
+            /* translators: %s: The word count limit warning. */
+            'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
+            'questionText'            => __( 'Question', 'wordlift' ),
+            'answerText'              => __( 'Answer', 'wordlift' ),
+            'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
+            'addQuestionText'         => __( 'Add Question', 'wordlift' ),
+            'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
+            'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
+            'updatingText'            => __( 'Updating...', 'wordlift' ),
+        );
+    }
+
+    /**
+     * Load FAQ settings to the add/edit post page
+     *
+     * @param $editor string specifying which text editor needed to be used.
+     */
+    private function load_faq_settings( $editor ) {
+        // This script also provides translations to gutenberg.
+        wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
+
+        // Enqueue the FAQ style
+        if ( self::GUTENBERG === $editor ) {
+            Scripts_Helper::enqueue_based_on_wordpress_version(
+                'wl-faq-gutenberg-plugin',
+                plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
+                array( 'wp-polyfill' ),
+                true
+            );
+        }
+    }
+
+    /**
+     * Enqueue scripts and styles for the gutenberg edit page.
+     *
+     * @since 3.21.0
+     */
+    public function enqueue_scripts_gutenberg() {
+        // Load FAQ settings. - Disabled for now
+        // $this->load_faq_scripts_and_styles();
+        // $this->load_faq_settings( self::GUTENBERG );
+
+        wp_register_script(
+            'wl-block-editor',
+            plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
+            array(
+                'react',
+                'wordlift',
+                'wp-hooks',
+                'wp-data',
+                'wp-rich-text',
+                'wp-blocks',
+                'wp-plugins',
+                'wp-edit-post',
+            ),
+            $this->plugin->get_version(),
+            false
+        );
+        wp_localize_script(
+            'wl-block-editor',
+            '_wlBlockEditorSettings',
+            array(
+                'root'  => esc_url_raw( rest_url() ),
+                'nonce' => wp_create_nonce( 'wp_rest' ),
+            )
+        );
+
+        /*
 		 * @since 3.25.1 The hook is used by the wp_localize_script to register the _wlEntityTypes global object.
 		 */
-		wp_enqueue_style(
-			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
-			array(),
-			$this->plugin->get_version()
-		);
-
-		wp_enqueue_script(
-			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
-			array(),
-			$this->plugin->get_version(),
-			true
-		);
-
-		wp_enqueue_style(
-			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
-			array(),
-			$this->plugin->get_version()
-		);
-
-	}
+        wp_enqueue_style(
+            'wl-block-editor',
+            plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
+            array(),
+            $this->plugin->get_version()
+        );
+
+        wp_enqueue_script(
+            'wl-autocomplete-select',
+            plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
+            array(),
+            $this->plugin->get_version(),
+            true
+        );
+
+        wp_enqueue_style(
+            'wl-autocomplete-select',
+            plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
+            array(),
+            $this->plugin->get_version()
+        );
+
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -56,24 +56,24 @@ 
 	 *
 	 * @since 3.11.0
 	 */
-	public function __construct( $plugin ) {
+	public function __construct($plugin) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
+		add_action('enqueue_block_editor_assets', array($this, 'enqueue_scripts_gutenberg'));
 
 		// Bail out if we're in the UX Builder editor.
-		if ( $this->is_ux_builder_editor() ) {
-			$this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
+		if ($this->is_ux_builder_editor()) {
+			$this->log->info('WordLift will not show, since we are in UX Builder editor.');
 
 			return;
 		}
 
 		// Define the callbacks.
-		$callback = array( $this, 'enqueue_scripts' );
+		$callback = array($this, 'enqueue_scripts');
 		// Set a hook to enqueue scripts only when the edit page is displayed.
-		add_action( 'admin_print_scripts-post.php', $callback );
-		add_action( 'admin_print_scripts-post-new.php', $callback );
+		add_action('admin_print_scripts-post.php', $callback);
+		add_action('admin_print_scripts-post-new.php', $callback);
 
 		$this->plugin = $plugin;
 	}
@@ -85,13 +85,13 @@ 
 	 * @since 3.22.3
 	 */
 	public function is_gutenberg_page() {
-		if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
+		if (function_exists('is_gutenberg_page') && is_gutenberg_page()) {
 			// The Gutenberg plugin is on.
 			return true;
 		}
 
 		$current_screen = get_current_screen();
-		if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
+		if (method_exists($current_screen, 'is_block_editor') && $current_screen->is_block_editor()) {
 			// Gutenberg page on 5+.
 			return true;
 		}
@@ -110,7 +110,7 @@ 
 	 */
 	private function is_ux_builder_editor() {
 
-		return function_exists( 'ux_builder_is_editor' )
+		return function_exists('ux_builder_is_editor')
 			   && ux_builder_is_editor();
 	}
 
@@ -124,23 +124,23 @@ 
 		// Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
 		//
 		// @see https://github.com/insideout10/wordlift-plugin/issues/832
-		wp_dequeue_script( 'ontrapagesAngular' );
-		wp_dequeue_script( 'ontrapagesApp' );
-		wp_dequeue_script( 'ontrapagesController' );
+		wp_dequeue_script('ontrapagesAngular');
+		wp_dequeue_script('ontrapagesApp');
+		wp_dequeue_script('ontrapagesController');
 
 		// Bail out if this is G'berg.
-		if ( $this->is_gutenberg_page() ) {
+		if ($this->is_gutenberg_page()) {
 			return;
 		}
 
 		// If Gutenberg is enabled for the post, do not load the legacy edit.js.
-		if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
+		if (function_exists('use_block_editor_for_post') && use_block_editor_for_post(get_post())) {
 			return;
 		}
 
 		// Bail out if classification sidebar is not enabled via hook
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__classification-sidebar', true)) {
 			return;
 		}
 
@@ -153,7 +153,7 @@ 
 		 *
 		 * @since 3.20.0 edit.js has been migrated to the new webpack configuration.
 		 */
-		$script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
+		$script_name = plugin_dir_url(__DIR__).'js/dist/edit';
 
 		/**
 		 * Scripts_Helper introduced.
@@ -195,7 +195,7 @@ 
 			)
 		);
 
-		wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
+		wp_enqueue_style('wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version());
 		// Disable Faq Editor.
 		// $this->load_faq_scripts_and_styles();
 		// $this->load_faq_settings( self::TINY_MCE );
@@ -207,14 +207,14 @@ 
 	private function load_faq_scripts_and_styles() {
 		wp_enqueue_style(
 			'wl-faq-metabox-style',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
+			plugin_dir_url(__DIR__).'js/dist/faq.css',
 			array(),
 			WORDLIFT_VERSION
 		);
 		Scripts_Helper::enqueue_based_on_wordpress_version(
 			'wl-faq-metabox-script',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq',
-			array( 'wp-polyfill' ),
+			plugin_dir_url(__DIR__).'js/dist/faq',
+			array('wp-polyfill'),
 			true
 		);
 	}
@@ -226,22 +226,22 @@ 
 	 */
 	public function get_faq_settings() {
 		return array(
-			'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
+			'restUrl'                 => get_rest_url(null, WL_REST_ROUTE_DEFAULT_NAMESPACE.'/faq'),
 			'listBoxId'               => self::FAQ_LIST_BOX_ID,
-			'nonce'                   => wp_create_nonce( 'wp_rest' ),
+			'nonce'                   => wp_create_nonce('wp_rest'),
 			'postId'                  => get_the_ID(),
 			// Translation for warning, error message.
 			/* translators: %s: The invalid tag. */
-			'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
+			'invalidTagMessage'       => sprintf(__('Invalid tags %s is present in answer', 'wordlift'), '{INVALID_TAGS}'),
 			/* translators: %s: The word count limit warning. */
-			'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
-			'questionText'            => __( 'Question', 'wordlift' ),
-			'answerText'              => __( 'Answer', 'wordlift' ),
-			'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
-			'addQuestionText'         => __( 'Add Question', 'wordlift' ),
-			'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
-			'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
-			'updatingText'            => __( 'Updating...', 'wordlift' ),
+			'invalidWordCountMessage' => sprintf(__('Answer word count must not exceed %s words', 'wordlift'), '{ANSWER_WORD_COUNT_WARNING_LIMIT}'),
+			'questionText'            => __('Question', 'wordlift'),
+			'answerText'              => __('Answer', 'wordlift'),
+			'addQuestionOrAnswerText' => __('Add Question / Answer', 'wordlift'),
+			'addQuestionText'         => __('Add Question', 'wordlift'),
+			'addAnswerText'           => __('Add Answer', 'wordlift'),
+			'noFaqItemsText'          => __('Highlight a question in content, then click Add Question.', 'wordlift'),
+			'updatingText'            => __('Updating...', 'wordlift'),
 		);
 	}
 
@@ -250,16 +250,16 @@ 
 	 *
 	 * @param $editor string specifying which text editor needed to be used.
 	 */
-	private function load_faq_settings( $editor ) {
+	private function load_faq_settings($editor) {
 		// This script also provides translations to gutenberg.
-		wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
+		wp_localize_script('wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings());
 
 		// Enqueue the FAQ style
-		if ( self::GUTENBERG === $editor ) {
+		if (self::GUTENBERG === $editor) {
 			Scripts_Helper::enqueue_based_on_wordpress_version(
 				'wl-faq-gutenberg-plugin',
-				plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
-				array( 'wp-polyfill' ),
+				plugin_dir_url(__DIR__).'js/dist/block-editor-faq-plugin',
+				array('wp-polyfill'),
 				true
 			);
 		}
@@ -277,7 +277,7 @@ 
 
 		wp_register_script(
 			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
+			plugin_dir_url(__DIR__).'js/dist/block-editor.js',
 			array(
 				'react',
 				'wordlift',
@@ -295,8 +295,8 @@ 
 			'wl-block-editor',
 			'_wlBlockEditorSettings',
 			array(
-				'root'  => esc_url_raw( rest_url() ),
-				'nonce' => wp_create_nonce( 'wp_rest' ),
+				'root'  => esc_url_raw(rest_url()),
+				'nonce' => wp_create_nonce('wp_rest'),
 			)
 		);
 
@@ -305,14 +305,14 @@ 
 		 */
 		wp_enqueue_style(
 			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
+			plugin_dir_url(__DIR__).'js/dist/block-editor.css',
 			array(),
 			$this->plugin->get_version()
 		);
 
 		wp_enqueue_script(
 			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
+			plugin_dir_url(__DIR__).'js/dist/autocomplete-select.js',
 			array(),
 			$this->plugin->get_version(),
 			true
@@ -320,7 +320,7 @@ 
 
 		wp_enqueue_style(
 			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
+			plugin_dir_url(__DIR__).'js/dist/autocomplete-select.css',
 			array(),
 			$this->plugin->get_version()
 		);

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

Indentation +303 added lines, -303 removed lines

@@ -18,308 +18,308 @@
  */
 class Wordlift_Admin_Settings_Analytics_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.21.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.21.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;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
-	 * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
-	 *
-	 * @since 3.21.0
-	 */
-	public function __construct( $input_element, $radio_input_element ) {
-
-		// Set a reference to the UI elements.
-		$this->input_element       = $input_element;
-		$this->radio_input_element = $radio_input_element;
-
-		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.21.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_page_title() {
-
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_title() {
-
-		return __( 'Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_slug() {
-
-		return 'wl_configuration_admin_analytics_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_partial_name() {
-
-		return 'wordlift-admin-settings-analytics-page.php';
-	}
-
-	/**
-	 * Returns the string to use for the tab slug on main admin settings page.
-	 *
-	 * @method get_admin_page_tab_slug
-	 * @return string
-	 * @since  3.21.0
-	 */
-	public function get_admin_page_tab_slug() {
-		return 'analytics';
-	}
-
-	/**
-	 * Adds pages to the tabs menu on the main admin settings page.
-	 *
-	 * @method add_admin_page_tab
-	 * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
-	 *
-	 * @since  3.21.0
-	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
-			$tabs[] = array(
-				'title' => $this->get_menu_title(),
-				'slug'  => $this->get_admin_page_tab_slug(),
-			);
-		}
-
-		return $tabs;
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.21.0
-	 */
-	public function admin_init() {
-
-		// Register WordLift's analytics settings with our in class sanitizer.
-		register_setting(
-			'wl_analytics_settings',
-			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the analytics settings setction.
-		add_settings_section(
-			'wl_analytics_settings_section',
-			'',
-			'',
-			'wl_analytics_settings'
-		);
-
-		// Add a toggle to determine if analytics functions are enabled or not.
-		// NOTE: this uses yes/no rather than true/false.
-		add_settings_field(
-			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the uri.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the type.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Validates an entity uri based on an integer passed.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_uri
-	 * @param string $uri a sting representing an entity ID that can be converted to a uri.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function validate_entity_uri( $uri ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
-			// if we are out of range then pass the default value.
-			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
-		}
-
-		return absint( $uri );
-	}
-
-	/**
-	 * Validates an entity type.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_type
-	 * @param string $type This is an entity type ID in string form - really a number.
-	 *
-	 * @return int
-	 * @since  3.21.0
-	 */
-	public function validate_entity_type( $type ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
-			// if we are out of range then pass the default value.
-			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
-		}
-
-		return absint( $type );
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 * @since 3.21.0
-	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
-			// Any failing nonce checks already die().
-			return;
-		}
-
-		/**
-		 * Validate and sanitize the $inputs and store them in $output saved.
-		 */
-		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
-		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
-		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
-			// This dimension cannot be the same as the one set above. If it is
-			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
-				$input['analytics_entity_type_dimension'] = 0;
-			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
-		}
-
-		// return items added to the output for saving.
-		return $output;
-	}
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.21.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.21.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;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
+     * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
+     *
+     * @since 3.21.0
+     */
+    public function __construct( $input_element, $radio_input_element ) {
+
+        // Set a reference to the UI elements.
+        $this->input_element       = $input_element;
+        $this->radio_input_element = $radio_input_element;
+
+        // Adds this page to the main admin settings tabbed menu.
+        add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.21.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_page_title() {
+
+        return __( 'WorldLift Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_title() {
+
+        return __( 'Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_slug() {
+
+        return 'wl_configuration_admin_analytics_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_partial_name() {
+
+        return 'wordlift-admin-settings-analytics-page.php';
+    }
+
+    /**
+     * Returns the string to use for the tab slug on main admin settings page.
+     *
+     * @method get_admin_page_tab_slug
+     * @return string
+     * @since  3.21.0
+     */
+    public function get_admin_page_tab_slug() {
+        return 'analytics';
+    }
+
+    /**
+     * Adds pages to the tabs menu on the main admin settings page.
+     *
+     * @method add_admin_page_tab
+     * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
+     *
+     * @since  3.21.0
+     */
+    public function add_admin_page_tab( $tabs ) {
+        if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+            $tabs[] = array(
+                'title' => $this->get_menu_title(),
+                'slug'  => $this->get_admin_page_tab_slug(),
+            );
+        }
+
+        return $tabs;
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.21.0
+     */
+    public function admin_init() {
+
+        // Register WordLift's analytics settings with our in class sanitizer.
+        register_setting(
+            'wl_analytics_settings',
+            'wl_analytics_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the analytics settings setction.
+        add_settings_section(
+            'wl_analytics_settings_section',
+            '',
+            '',
+            'wl_analytics_settings'
+        );
+
+        // Add a toggle to determine if analytics functions are enabled or not.
+        // NOTE: this uses yes/no rather than true/false.
+        add_settings_field(
+            'wl-analytics-enabled',
+            __( 'Enable Analytics', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-enable',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
+                'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the uri.
+         */
+        add_settings_field(
+            'wl-analytics-entity-uri-dimension',
+            __( 'Entity URI dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-uri-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
+                'description' => __( 'Entity URI dimesion', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the type.
+         */
+        add_settings_field(
+            'wl-analytics-entity-type-dimension',
+            __( 'Entity Type dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-type-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
+                'description' => __( 'Entity Type dimension', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Validates an entity uri based on an integer passed.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_uri
+     * @param string $uri a sting representing an entity ID that can be converted to a uri.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function validate_entity_uri( $uri ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $uri < 1 || (int) $uri > 20 ) {
+            // if we are out of range then pass the default value.
+            $uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
+        }
+
+        return absint( $uri );
+    }
+
+    /**
+     * Validates an entity type.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_type
+     * @param string $type This is an entity type ID in string form - really a number.
+     *
+     * @return int
+     * @since  3.21.0
+     */
+    public function validate_entity_type( $type ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $type < 1 || (int) $type > 20 ) {
+            // if we are out of range then pass the default value.
+            $type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
+        }
+
+        return absint( $type );
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     * @since 3.21.0
+     */
+    public function sanitize_callback( $input ) {
+        if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+            // Any failing nonce checks already die().
+            return;
+        }
+
+        /**
+         * Validate and sanitize the $inputs and store them in $output saved.
+         */
+        $output = array();
+        if ( isset( $input['analytics_enable'] ) ) {
+            $output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+        }
+        if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
+            $output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+        }
+        if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+            // This dimension cannot be the same as the one set above. If it is
+            // then zero it out and it will fail validation.
+            if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+                $input['analytics_entity_type_dimension'] = 0;
+            }
+            $output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+        }
+
+        // return items added to the output for saving.
+        return $output;
+    }
 
 }

Spacing +34 added lines, -34 removed lines

@@ -53,14 +53,14 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	public function __construct( $input_element, $radio_input_element ) {
+	public function __construct($input_element, $radio_input_element) {
 
 		// Set a reference to the UI elements.
 		$this->input_element       = $input_element;
 		$this->radio_input_element = $radio_input_element;
 
 		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+		add_filter('wl_admin_page_tabs', array($this, 'add_admin_page_tab'));
 
 		self::$instance = $this;
 	}
@@ -97,7 +97,7 @@ 
 	 */
 	public function get_page_title() {
 
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
+		return __('WorldLift Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -105,7 +105,7 @@ 
 	 */
 	public function get_menu_title() {
 
-		return __( 'Analytics Settings', 'wordlift' );
+		return __('Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -143,8 +143,8 @@ 
 	 *
 	 * @since  3.21.0
 	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+	public function add_admin_page_tab($tabs) {
+		if (apply_filters('wl_feature__enable__analytics', true)) {
 			$tabs[] = array(
 				'title' => $this->get_menu_title(),
 				'slug'  => $this->get_admin_page_tab_slug(),
@@ -167,7 +167,7 @@ 
 		register_setting(
 			'wl_analytics_settings',
 			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the analytics settings setction.
@@ -182,15 +182,15 @@ 
 		// NOTE: this uses yes/no rather than true/false.
 		add_settings_field(
 			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Enable Analytics', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENABLE.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+				'description' => __('Toggle on/off the default values.', 'wordlift'),
 			)
 		);
 
@@ -201,16 +201,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity URI dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
+				'description' => __('Entity URI dimesion', 'wordlift'),
 			)
 		);
 
@@ -221,16 +221,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity Type dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
+				'description' => __('Entity Type dimension', 'wordlift'),
 			)
 		);
 
@@ -247,16 +247,16 @@ 
 	 * @return int
 	 * @since 3.21.0
 	 */
-	public function validate_entity_uri( $uri ) {
+	public function validate_entity_uri($uri) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
+		if ((int) $uri < 1 || (int) $uri > 20) {
 			// if we are out of range then pass the default value.
 			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
 		}
 
-		return absint( $uri );
+		return absint($uri);
 	}
 
 	/**
@@ -270,16 +270,16 @@ 
 	 * @return int
 	 * @since  3.21.0
 	 */
-	public function validate_entity_type( $type ) {
+	public function validate_entity_type($type) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
+		if ((int) $type < 1 || (int) $type > 20) {
 			// if we are out of range then pass the default value.
 			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
 		}
 
-		return absint( $type );
+		return absint($type);
 	}
 
 	/**
@@ -293,8 +293,8 @@ 
 	 * @return array The sanitized input array.
 	 * @since 3.21.0
 	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+	public function sanitize_callback($input) {
+		if ( ! check_admin_referer('wl_analytics_settings-options')) {
 			// Any failing nonce checks already die().
 			return;
 		}
@@ -303,19 +303,19 @@ 
 		 * Validate and sanitize the $inputs and store them in $output saved.
 		 */
 		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+		if (isset($input['analytics_enable'])) {
+			$output['analytics_enable'] = ('yes' === $input['analytics_enable']) ? 'yes' : 'no';
 		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+		if (isset($input['analytics_entity_uri_dimension'])) {
+			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri($input['analytics_entity_uri_dimension']);
 		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+		if (isset($input['analytics_entity_type_dimension'])) {
 			// This dimension cannot be the same as the one set above. If it is
 			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+			if (isset($output['analytics_entity_uri_dimension']) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension']) {
 				$input['analytics_entity_type_dimension'] = 0;
 			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type($input['analytics_entity_type_dimension']);
 		}
 
 		// return items added to the output for saving.