eventespresso / event-espresso-core

core/services/locators/FileLocator.php

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function setFileMask($file_mask)
     {
-        if (! is_string($file_mask)) {
+        if ( ! is_string($file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
         }
         $this->file_mask = $file_mask;
@@ -72,12 +72,12 @@ 
      */
     public function locate($directory_paths)
     {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
+        if ( ! (is_string($directory_paths) || is_array($directory_paths))) {
             throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
         }
         foreach ((array) $directory_paths as $directory_path) {
             foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+                $this->filepaths[$key] = \EEH_File::standardise_directory_separators($file);
             }
         }
         return $this->filepaths;
@@ -94,7 +94,7 @@ 
     protected function findFilesByPath($directory_path = '')
     {
         $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+            \EEH_File::end_with_directory_separator($directory_path).$this->file_mask
         );
         foreach ($this->flags as $flag) {
             $iterator->setFlags($flag);

Indentation +73 added lines, -73 removed lines

@@ -16,88 +16,88 @@
  */
 class FileLocator extends Locator
 {
-    /**
-     * @var string $file_mask
-     */
-    protected $file_mask = '*.php';
+	/**
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '*.php';
 
-    /**
-     * @var array $filepaths
-     */
-    protected $filepaths = array();
+	/**
+	 * @var array $filepaths
+	 */
+	protected $filepaths = array();
 
 
-    /**
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setFileMask($file_mask)
-    {
-        if (! is_string($file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
-        }
-        $this->file_mask = $file_mask;
-    }
+	/**
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setFileMask($file_mask)
+	{
+		if (! is_string($file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
+		}
+		$this->file_mask = $file_mask;
+	}
 
 
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFilePaths()
-    {
-        return $this->filepaths;
-    }
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFilePaths()
+	{
+		return $this->filepaths;
+	}
 
 
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->filepaths);
-    }
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->filepaths);
+	}
 
 
-    /**
-     * given a path to a valid directory, or an array of valid paths,
-     * will find all files that match the provided mask
-     *
-     * @access public
-     * @param array|string $directory_paths
-     * @return \FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($directory_paths)
-    {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
-            throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
-        }
-        foreach ((array) $directory_paths as $directory_path) {
-            foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
-            }
-        }
-        return $this->filepaths;
-    }
+	/**
+	 * given a path to a valid directory, or an array of valid paths,
+	 * will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param array|string $directory_paths
+	 * @return \FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($directory_paths)
+	{
+		if (! (is_string($directory_paths) || is_array($directory_paths))) {
+			throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
+		}
+		foreach ((array) $directory_paths as $directory_path) {
+			foreach ($this->findFilesByPath($directory_path) as $key => $file) {
+				$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+			}
+		}
+		return $this->filepaths;
+	}
 
 
-    /**
-     * given a path to a valid directory, will find all files that match the provided mask
-     *
-     * @access protected
-     * @param string $directory_path
-     * @return \FilesystemIterator
-     */
-    protected function findFilesByPath($directory_path = '')
-    {
-        $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        return $iterator;
-    }
+	/**
+	 * given a path to a valid directory, will find all files that match the provided mask
+	 *
+	 * @access protected
+	 * @param string $directory_path
+	 * @return \FilesystemIterator
+	 */
+	protected function findFilesByPath($directory_path = '')
+	{
+		$iterator = new GlobIterator(
+			\EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		return $iterator;
+	}
 }

core/services/database/TableManager.php

Spacing +8 added lines, -8 removed lines

@@ -65,7 +65,7 @@ 
         global $wpdb;
         $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
+        if ( ! in_array($column_name, $columns)) {
             $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
             return $wpdb->query($alter_query);
         }
@@ -86,7 +86,7 @@ 
         global $wpdb;
         $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $field_array = array();
-        if (! empty($table_name)) {
+        if ( ! empty($table_name)) {
             $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
             if ($columns !== false) {
                 foreach ($columns as $column) {
@@ -132,14 +132,14 @@ 
         foreach ($table_names as $table_name) {
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
+                $tables_to_delete[$table_name] = $table_name;
             }
         }
-        if (! empty($tables_to_delete)) {
+        if ( ! empty($tables_to_delete)) {
             global $wpdb;
             // make sure we only have a unique strings in the array.
             $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         }
         return $tables_to_delete;
     }
@@ -189,7 +189,7 @@ 
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             /** @var \wpdb $wpdb */
             global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate();
 
             // get $wpdb to echo errors, but buffer them. This way at least WE know an error
             // happened. And then we can choose to tell the end user
@@ -201,7 +201,7 @@ 
             ob_end_clean();
             $wpdb->show_errors($old_show_errors_policy);
             $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
+            if ( ! empty($output)) {
                 throw new \EE_Error($output);
             }
         } else {
@@ -242,7 +242,7 @@ 
         if ($column_name === null) {
             $column_name = $index_name;
         }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
+        if ( ! $this->getTableAnalysis()->tableExists($table_name)) {
             return false;
         }
         $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);

Indentation +234 added lines, -234 removed lines

@@ -12,257 +12,257 @@
  */
 class TableManager extends \EE_Base
 {
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return array
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return array
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return int
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return int
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @param string $index_name
-     * @return int the number of indexes dropped. False if there was a datbase error
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int the number of indexes dropped. False if there was a datbase error
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name // using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var \wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var \wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
 
-            // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            // happened. And then we can choose to tell the end user
-            $old_show_errors_policy = $wpdb->show_errors(true);
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
-                throw new \EE_Error($output);
-            }
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+			// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			// happened. And then we can choose to tell the end user
+			$old_show_errors_policy = $wpdb->show_errors(true);
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if (! empty($output)) {
+				throw new \EE_Error($output);
+			}
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string     $column_name        if none is provided, we assume the column name matches the index (often
-     *                                       true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws /EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        $table_name,
-        $index_name,
-        $column_name = null,
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === null) {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if (
-                $column_name === $index_entry->Column_name
-                && (string) $desired_index_size !== $index_entry->Sub_part
-            ) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string     $column_name        if none is provided, we assume the column name matches the index (often
+	 *                                       true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws /EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		$table_name,
+		$index_name,
+		$column_name = null,
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === null) {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if (
+				$column_name === $index_entry->Column_name
+				&& (string) $desired_index_size !== $index_entry->Sub_part
+			) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }

core/services/commands/CommandHandlerManager.php

Spacing +4 added lines, -4 removed lines

@@ -74,7 +74,7 @@ 
         if (empty($command)) {
             throw new InvalidCommandHandlerException($command);
         }
-        $this->command_handlers[ $command ] = $command_handler;
+        $this->command_handlers[$command] = $command_handler;
     }
 
 
@@ -96,14 +96,14 @@ 
         $handler = null;
         // has a command handler already been set for this class ?
         // if not, can we find one via the FQCN ?
-        if (isset($this->command_handlers[ $command_name ])) {
-            $handler = $this->command_handlers[ $command_name ];
+        if (isset($this->command_handlers[$command_name])) {
+            $handler = $this->command_handlers[$command_name];
         } elseif (class_exists($command_handler)) {
             $handler = $this->loader->getShared($command_handler);
         }
         // if Handler requires an instance of the CommandBus, but that has not yet been set
         if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
+            if ( ! $command_bus instanceof CommandBusInterface) {
                 throw new DomainException(
                     esc_html__(
                         'CompositeCommandHandler classes require an instance of the CommandBus.',

Indentation +100 added lines, -100 removed lines

@@ -17,83 +17,83 @@ 
  */
 class CommandHandlerManager implements CommandHandlerManagerInterface
 {
-    /**
-     * @var CommandHandlerInterface[] $command_handlers
-     */
-    protected $command_handlers;
+	/**
+	 * @var CommandHandlerInterface[] $command_handlers
+	 */
+	protected $command_handlers;
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
 
 
-    /**
-     * CommandHandlerManager constructor
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * CommandHandlerManager constructor
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * By default, Commands and CommandHandlers would normally
-     * reside in the same folder under the same namespace,
-     * and the names of the two classes would only differ in that
-     * one ends in "Command" and the other ends in "CommandHandler".
-     * However, if you wanted to utilize a CommandHandler from somewhere else,
-     * then this method allows you to add that CommandHandler and specify the FQCN
-     * (Fully Qualified ClassName) for the Command class that it should be used for.
-     * For example:
-     *      by default the "Vendor\some\namespace\DoSomethingCommand"
-     *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
-     *      but if you wanted to instead process that commend using:
-     *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
-     *      then the following code:
-     *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
-     *      $CommandHandlerManager->addCommandHandler(
-     *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
-     *          'Vendor\some\namespace\DoSomethingCommand'
-     *      );
-     *      would result in the alternate CommandHandler being used to process that Command
-     *
-     * !!! IMPORTANT !!!
-     * If overriding the default CommandHandler for a Command,
-     * be sure to also override CommandHandler::verify(),
-     * or else an Exception will be thrown when the CommandBus
-     * attempts to verify that the incoming Command matches the Handler
-     *
-     * @param CommandHandlerInterface $command_handler
-     * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
-     * @return void
-     * @throws InvalidCommandHandlerException
-     */
-    public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
-    {
-        $command = ! empty($fqcn_for_command)
-            ? $fqcn_for_command
-            : str_replace('CommandHandler', 'Command', get_class($command_handler));
-        if (empty($command)) {
-            throw new InvalidCommandHandlerException($command);
-        }
-        $this->command_handlers[ $command ] = $command_handler;
-    }
+	/**
+	 * By default, Commands and CommandHandlers would normally
+	 * reside in the same folder under the same namespace,
+	 * and the names of the two classes would only differ in that
+	 * one ends in "Command" and the other ends in "CommandHandler".
+	 * However, if you wanted to utilize a CommandHandler from somewhere else,
+	 * then this method allows you to add that CommandHandler and specify the FQCN
+	 * (Fully Qualified ClassName) for the Command class that it should be used for.
+	 * For example:
+	 *      by default the "Vendor\some\namespace\DoSomethingCommand"
+	 *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
+	 *      but if you wanted to instead process that commend using:
+	 *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
+	 *      then the following code:
+	 *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
+	 *      $CommandHandlerManager->addCommandHandler(
+	 *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
+	 *          'Vendor\some\namespace\DoSomethingCommand'
+	 *      );
+	 *      would result in the alternate CommandHandler being used to process that Command
+	 *
+	 * !!! IMPORTANT !!!
+	 * If overriding the default CommandHandler for a Command,
+	 * be sure to also override CommandHandler::verify(),
+	 * or else an Exception will be thrown when the CommandBus
+	 * attempts to verify that the incoming Command matches the Handler
+	 *
+	 * @param CommandHandlerInterface $command_handler
+	 * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
+	 * @return void
+	 * @throws InvalidCommandHandlerException
+	 */
+	public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
+	{
+		$command = ! empty($fqcn_for_command)
+			? $fqcn_for_command
+			: str_replace('CommandHandler', 'Command', get_class($command_handler));
+		if (empty($command)) {
+			throw new InvalidCommandHandlerException($command);
+		}
+		$this->command_handlers[ $command ] = $command_handler;
+	}
 
 
-    /**
-     * @param CommandInterface    $command
-     * @param CommandBusInterface $command_bus
-     * @return mixed
-     * @throws DomainException
-     * @throws CommandHandlerNotFoundException
-     */
-    public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
-    {
-        $command_name = get_class($command);
-        /*
+	/**
+	 * @param CommandInterface    $command
+	 * @param CommandBusInterface $command_bus
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws CommandHandlerNotFoundException
+	 */
+	public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
+	{
+		$command_name = get_class($command);
+		/*
          * Filters the Fully Qualified Class Name for the Command Handler
          * that will be used to handle the incoming Command
          *
@@ -106,34 +106,34 @@ 
          * @param string "CommandHandler::class" Fully Qualified Class Name for the Command Handler
          * @param CommandInterface $command the actual Command instance
          */
-        $command_handler = apply_filters(
-            'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
-            str_replace('Command', 'CommandHandler', $command_name),
-            $command
-        );
-        $handler = null;
-        // has a command handler already been set for this class ?
-        // if not, can we find one via the FQCN ?
-        if (isset($this->command_handlers[ $command_name ])) {
-            $handler = $this->command_handlers[ $command_name ];
-        } elseif (class_exists($command_handler)) {
-            $handler = $this->loader->getShared($command_handler);
-        }
-        // if Handler requires an instance of the CommandBus, but that has not yet been set
-        if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
-                throw new DomainException(
-                    esc_html__(
-                        'CompositeCommandHandler classes require an instance of the CommandBus.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $handler->setCommandBus($command_bus);
-        }
-        if ($handler instanceof CommandHandlerInterface) {
-            return $handler;
-        }
-        throw new CommandHandlerNotFoundException($command_handler);
-    }
+		$command_handler = apply_filters(
+			'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
+			str_replace('Command', 'CommandHandler', $command_name),
+			$command
+		);
+		$handler = null;
+		// has a command handler already been set for this class ?
+		// if not, can we find one via the FQCN ?
+		if (isset($this->command_handlers[ $command_name ])) {
+			$handler = $this->command_handlers[ $command_name ];
+		} elseif (class_exists($command_handler)) {
+			$handler = $this->loader->getShared($command_handler);
+		}
+		// if Handler requires an instance of the CommandBus, but that has not yet been set
+		if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
+			if (! $command_bus instanceof CommandBusInterface) {
+				throw new DomainException(
+					esc_html__(
+						'CompositeCommandHandler classes require an instance of the CommandBus.',
+						'event_espresso'
+					)
+				);
+			}
+			$handler->setCommandBus($command_bus);
+		}
+		if ($handler instanceof CommandHandlerInterface) {
+			return $handler;
+		}
+		throw new CommandHandlerNotFoundException($command_handler);
+	}
 }

core/services/notices/Notice.php

Spacing +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
      */
     private function setType($type)
     {
-        if (! in_array($type, $this->types(), true)) {
+        if ( ! in_array($type, $this->types(), true)) {
             throw new InvalidDataTypeException(
                 '$type',
                 $type,

Indentation +249 added lines, -249 removed lines

@@ -13,253 +13,253 @@
  */
 class Notice implements NoticeInterface
 {
-    const ERROR = 'error';
-
-    const SUCCESS = 'success';
-
-    const ATTENTION = 'attention'; // alias for warning
-
-    const INFORMATION = 'information';
-
-    /**
-     * @var string $type
-     */
-    private $type;
-
-
-    /**
-     * @var string $message
-     */
-    private $message;
-
-
-    /**
-     * @var string $file
-     */
-    private $file;
-
-
-    /**
-     * @var string $func
-     */
-    private $func;
-
-
-    /**
-     * @var string $line
-     */
-    private $line;
-
-
-    /**
-     * @var boolean $dismissible
-     */
-    private $dismissible;
-
-
-    /**
-     * Notice constructor.
-     *
-     * @param string $type
-     * @param string $message
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '')
-    {
-        $this->setType($type);
-        $this->setMessage($message);
-        $this->setDismissible($dismissible);
-        $this->setFile($file);
-        $this->setFunc($func);
-        $this->setLine($line);
-    }
-
-
-    /**
-     * @return array
-     */
-    private function types()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_services_notices_Notice__types',
-            array(
-                Notice::ERROR,
-                Notice::SUCCESS,
-                Notice::ATTENTION,
-                Notice::INFORMATION,
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function message()
-    {
-        return $this->message;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file()
-    {
-        return $this->file;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function func()
-    {
-        return $this->func;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function line()
-    {
-        return $this->line;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isDismissible()
-    {
-        return $this->dismissible;
-    }
-
-
-    /**
-     * @param string $type
-     * @throws InvalidDataTypeException
-     */
-    private function setType($type)
-    {
-        if (! in_array($type, $this->types(), true)) {
-            throw new InvalidDataTypeException(
-                '$type',
-                $type,
-                $this->invalidTypeMessage()
-            );
-        }
-        $this->type = $type;
-    }
-
-
-    /**
-     * gets the $invalid_type_message string
-     */
-    private function invalidTypeMessage()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage',
-            sprintf(
-                esc_html__(
-                    ' one of the following notice types was expected: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                var_export($this->types(), true)
-            )
-        );
-    }
-
-
-    /**
-     * @param string $message
-     * @throws InvalidDataTypeException
-     */
-    private function setMessage($message)
-    {
-        if (empty($message) || ! is_string($message)) {
-            throw new InvalidDataTypeException(
-                '$message',
-                $message,
-                esc_html__('non empty string', 'event_espresso')
-            );
-        }
-        $this->message = sanitize_text_field($message);
-    }
-
-
-    /**
-     * @param string $file
-     * @throws InvalidDataTypeException
-     */
-    private function setFile($file)
-    {
-        if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) {
-            throw new InvalidDataTypeException(
-                '$file',
-                $file,
-                esc_html__('non empty string', 'event_espresso')
-            );
-        }
-        $this->file = sanitize_text_field($file);
-    }
-
-
-    /**
-     * @param string $func
-     * @throws InvalidDataTypeException
-     */
-    private function setFunc($func)
-    {
-        if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) {
-            throw new InvalidDataTypeException(
-                '$func',
-                $func,
-                esc_html__('non empty string', 'event_espresso')
-            );
-        }
-        $this->func = sanitize_text_field($func);
-    }
-
-
-    /**
-     * @param int $line
-     * @throws InvalidDataTypeException
-     */
-    private function setLine($line)
-    {
-        $line = absint($line);
-        if ($this->type === Notice::ERROR && $line === 0) {
-            throw new InvalidDataTypeException(
-                '$line',
-                $line,
-                esc_html__('integer', 'event_espresso')
-            );
-        }
-        $this->line = sanitize_text_field($line);
-    }
-
-
-    /**
-     * @param boolean $dismissible
-     */
-    private function setDismissible($dismissible = true)
-    {
-        $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN);
-    }
+	const ERROR = 'error';
+
+	const SUCCESS = 'success';
+
+	const ATTENTION = 'attention'; // alias for warning
+
+	const INFORMATION = 'information';
+
+	/**
+	 * @var string $type
+	 */
+	private $type;
+
+
+	/**
+	 * @var string $message
+	 */
+	private $message;
+
+
+	/**
+	 * @var string $file
+	 */
+	private $file;
+
+
+	/**
+	 * @var string $func
+	 */
+	private $func;
+
+
+	/**
+	 * @var string $line
+	 */
+	private $line;
+
+
+	/**
+	 * @var boolean $dismissible
+	 */
+	private $dismissible;
+
+
+	/**
+	 * Notice constructor.
+	 *
+	 * @param string $type
+	 * @param string $message
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '')
+	{
+		$this->setType($type);
+		$this->setMessage($message);
+		$this->setDismissible($dismissible);
+		$this->setFile($file);
+		$this->setFunc($func);
+		$this->setLine($line);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	private function types()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_services_notices_Notice__types',
+			array(
+				Notice::ERROR,
+				Notice::SUCCESS,
+				Notice::ATTENTION,
+				Notice::INFORMATION,
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function message()
+	{
+		return $this->message;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file()
+	{
+		return $this->file;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function func()
+	{
+		return $this->func;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function line()
+	{
+		return $this->line;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isDismissible()
+	{
+		return $this->dismissible;
+	}
+
+
+	/**
+	 * @param string $type
+	 * @throws InvalidDataTypeException
+	 */
+	private function setType($type)
+	{
+		if (! in_array($type, $this->types(), true)) {
+			throw new InvalidDataTypeException(
+				'$type',
+				$type,
+				$this->invalidTypeMessage()
+			);
+		}
+		$this->type = $type;
+	}
+
+
+	/**
+	 * gets the $invalid_type_message string
+	 */
+	private function invalidTypeMessage()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage',
+			sprintf(
+				esc_html__(
+					' one of the following notice types was expected: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				var_export($this->types(), true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $message
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMessage($message)
+	{
+		if (empty($message) || ! is_string($message)) {
+			throw new InvalidDataTypeException(
+				'$message',
+				$message,
+				esc_html__('non empty string', 'event_espresso')
+			);
+		}
+		$this->message = sanitize_text_field($message);
+	}
+
+
+	/**
+	 * @param string $file
+	 * @throws InvalidDataTypeException
+	 */
+	private function setFile($file)
+	{
+		if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) {
+			throw new InvalidDataTypeException(
+				'$file',
+				$file,
+				esc_html__('non empty string', 'event_espresso')
+			);
+		}
+		$this->file = sanitize_text_field($file);
+	}
+
+
+	/**
+	 * @param string $func
+	 * @throws InvalidDataTypeException
+	 */
+	private function setFunc($func)
+	{
+		if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) {
+			throw new InvalidDataTypeException(
+				'$func',
+				$func,
+				esc_html__('non empty string', 'event_espresso')
+			);
+		}
+		$this->func = sanitize_text_field($func);
+	}
+
+
+	/**
+	 * @param int $line
+	 * @throws InvalidDataTypeException
+	 */
+	private function setLine($line)
+	{
+		$line = absint($line);
+		if ($this->type === Notice::ERROR && $line === 0) {
+			throw new InvalidDataTypeException(
+				'$line',
+				$line,
+				esc_html__('integer', 'event_espresso')
+			);
+		}
+		$this->line = sanitize_text_field($line);
+	}
+
+
+	/**
+	 * @param boolean $dismissible
+	 */
+	private function setDismissible($dismissible = true)
+	{
+		$this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/libraries/rest_api/changes/ChangesIn40836.php

Spacing +4 added lines, -4 removed lines

@@ -119,9 +119,9 @@ 
                 $headers,
                 array_flip(
                     array(
-                        Base::HEADER_PREFIX_FOR_WP . 'Total',
-                        Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
-                        Base::HEADER_PREFIX_FOR_WP . 'PageSize',
+                        Base::HEADER_PREFIX_FOR_WP.'Total',
+                        Base::HEADER_PREFIX_FOR_WP.'TotalPages',
+                        Base::HEADER_PREFIX_FOR_WP.'PageSize',
                     )
                 )
             );
@@ -151,7 +151,7 @@ 
             && $model instanceof \EEM_CPT_Base
         ) {
             $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
+                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
                 'full'
             );
             $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;

Indentation +162 added lines, -162 removed lines

@@ -16,176 +16,176 @@
 class ChangesIn40836 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the "calculate" query param
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array($this, 'removeCalculateQueryParam'),
-            10,
-            3
-        );
-        // don't add the _calculated_fields either
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            array($this, 'removeCalculatedFieldsFromResponse'),
-            10,
-            5
-        );
-        // and also don't add the count headers
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeHeadersNewInThisVersion'),
-            10,
-            3
-        );
-        // remove the old featured_image part of the response...
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            array($this, 'addOldFeaturedImagePartOfCptEntities'),
-            10,
-            5
-        );
-        // assuming ticket 9425's change gets pushed with 9406, we don't need to
-        // remove it from the calculated fields on older requests (because this will
-        // be the first version with calculated fields)
-        // before this, infinity was -1, now it's null
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            array($this, 'useNegativeOneForInfinityBeforeThisVersion'),
-            10,
-            4
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the "calculate" query param
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array($this, 'removeCalculateQueryParam'),
+			10,
+			3
+		);
+		// don't add the _calculated_fields either
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			array($this, 'removeCalculatedFieldsFromResponse'),
+			10,
+			5
+		);
+		// and also don't add the count headers
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeHeadersNewInThisVersion'),
+			10,
+			3
+		);
+		// remove the old featured_image part of the response...
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			array($this, 'addOldFeaturedImagePartOfCptEntities'),
+			10,
+			5
+		);
+		// assuming ticket 9425's change gets pushed with 9406, we don't need to
+		// remove it from the calculated fields on older requests (because this will
+		// be the first version with calculated fields)
+		// before this, infinity was -1, now it's null
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			array($this, 'useNegativeOneForInfinityBeforeThisVersion'),
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Don't show "calculate" as an query param option in the index
-     *
-     * @param array    $query_params
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    public function removeCalculateQueryParam($query_params, EEM_Base $model, $version)
-    {
-        if ($this->appliesToVersion($version)) {
-            unset($query_params['calculate']);
-        }
-        return $query_params;
-    }
+	/**
+	 * Don't show "calculate" as an query param option in the index
+	 *
+	 * @param array    $query_params
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	public function removeCalculateQueryParam($query_params, EEM_Base $model, $version)
+	{
+		if ($this->appliesToVersion($version)) {
+			unset($query_params['calculate']);
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * Removes the "_calculate_fields" part of entity responses before 4.8.36
-     *
-     * @param array           $entity_response_array
-     * @param EEM_Base        $model
-     * @param string          $request_context
-     * @param WP_REST_Request $request
-     * @param Read            $controller
-     * @return array
-     */
-    public function removeCalculatedFieldsFromResponse(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
-            unset($entity_response_array['_calculated_fields']);
-        }
-        return $entity_response_array;
-    }
+	/**
+	 * Removes the "_calculate_fields" part of entity responses before 4.8.36
+	 *
+	 * @param array           $entity_response_array
+	 * @param EEM_Base        $model
+	 * @param string          $request_context
+	 * @param WP_REST_Request $request
+	 * @param Read            $controller
+	 * @return array
+	 */
+	public function removeCalculatedFieldsFromResponse(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
+			unset($entity_response_array['_calculated_fields']);
+		}
+		return $entity_response_array;
+	}
 
 
-    /**
-     * Removes the new headers for requests before 4.8.36
-     *
-     * @param array           $headers
-     * @param Controller_Base $controller
-     * @param string          $version
-     * @return array
-     */
-    public function removeHeadersNewInThisVersion(
-        $headers,
-        Controller_Base $controller,
-        $version
-    ) {
-        if ($this->appliesToVersion($version)) {
-            $headers = array_diff_key(
-                $headers,
-                array_flip(
-                    array(
-                        Base::HEADER_PREFIX_FOR_WP . 'Total',
-                        Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
-                        Base::HEADER_PREFIX_FOR_WP . 'PageSize',
-                    )
-                )
-            );
-        }
-        return $headers;
-    }
+	/**
+	 * Removes the new headers for requests before 4.8.36
+	 *
+	 * @param array           $headers
+	 * @param Controller_Base $controller
+	 * @param string          $version
+	 * @return array
+	 */
+	public function removeHeadersNewInThisVersion(
+		$headers,
+		Controller_Base $controller,
+		$version
+	) {
+		if ($this->appliesToVersion($version)) {
+			$headers = array_diff_key(
+				$headers,
+				array_flip(
+					array(
+						Base::HEADER_PREFIX_FOR_WP . 'Total',
+						Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
+						Base::HEADER_PREFIX_FOR_WP . 'PageSize',
+					)
+				)
+			);
+		}
+		return $headers;
+	}
 
 
-    /**
-     * Puts the 'featured_image_url' back in for responses before 4.8.36.
-     *
-     * @param array           $entity_response_array
-     * @param EEM_Base        $model
-     * @param string          $request_context
-     * @param WP_REST_Request $request
-     * @param Read            $controller
-     * @return array
-     */
-    public function addOldFeaturedImagePartOfCptEntities(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if (
-            $this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
-            && $model instanceof \EEM_CPT_Base
-        ) {
-            $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
-                'full'
-            );
-            $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
-        }
-        return $entity_response_array;
-    }
+	/**
+	 * Puts the 'featured_image_url' back in for responses before 4.8.36.
+	 *
+	 * @param array           $entity_response_array
+	 * @param EEM_Base        $model
+	 * @param string          $request_context
+	 * @param WP_REST_Request $request
+	 * @param Read            $controller
+	 * @return array
+	 */
+	public function addOldFeaturedImagePartOfCptEntities(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if (
+			$this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
+			&& $model instanceof \EEM_CPT_Base
+		) {
+			$attachment = wp_get_attachment_image_src(
+				get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
+				'full'
+			);
+			$entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
+		}
+		return $entity_response_array;
+	}
 
 
-    /**
-     * If the value was infinity, we now use null in our JSON responses,
-     * but before this version we used -1.
-     *
-     * @param mixed                $new_value
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_value
-     * @return mixed
-     */
-    public function useNegativeOneForInfinityBeforeThisVersion(
-        $new_value,
-        $field_obj,
-        $original_value,
-        $requested_value
-    ) {
-        if (
-            $this->appliesToVersion($requested_value)
-            && $original_value === EE_INF
-        ) {
-            // return the old representation of infinity in the JSON
-            return -1;
-        }
-        return $new_value;
-    }
+	/**
+	 * If the value was infinity, we now use null in our JSON responses,
+	 * but before this version we used -1.
+	 *
+	 * @param mixed                $new_value
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_value
+	 * @return mixed
+	 */
+	public function useNegativeOneForInfinityBeforeThisVersion(
+		$new_value,
+		$field_obj,
+		$original_value,
+		$requested_value
+	) {
+		if (
+			$this->appliesToVersion($requested_value)
+			&& $original_value === EE_INF
+		) {
+			// return the old representation of infinity in the JSON
+			return -1;
+		}
+		return $new_value;
+	}
 }

core/domain/entities/RegUrlLink.php

Spacing +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
         $base_code = '',
         $reg_url_link = ''
     ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
+        if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
             $this->reg_url_link = apply_filters(
                 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
                 $reg_url_link,
@@ -94,7 +94,7 @@ 
         }
         $this->reg_url_link = (string) apply_filters(
             'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
+            $reg_count.'-'.md5($base_code.microtime()),
             $reg_count,
             $base_code,
             $reg_url_link

Indentation +83 added lines, -83 removed lines

@@ -17,97 +17,97 @@
  */
 class RegUrlLink
 {
-    /*
+	/*
      * @var string $reg_url_link
      */
-    private $reg_url_link;
+	private $reg_url_link;
 
 
-    /**
-     * @param string $reg_url_link
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegUrlLinkString($reg_url_link)
-    {
-        if (empty($reg_url_link) || ! is_string($reg_url_link)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You must supply a valid non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        return new RegUrlLink(1, '', $reg_url_link);
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegUrlLinkString($reg_url_link)
+	{
+		if (empty($reg_url_link) || ! is_string($reg_url_link)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You must supply a valid non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		return new RegUrlLink(1, '', $reg_url_link);
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return RegUrlLink
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegistration(EE_Registration $registration)
-    {
-        return new RegUrlLink(
-            $registration->count(),
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return RegUrlLink
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegistration(EE_Registration $registration)
+	{
+		return new RegUrlLink(
+			$registration->count(),
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * CreateRegUrlLinkCommand constructor.
-     *
-     * @param int    $reg_count
-     * @param mixed  $base_code
-     * @param string $reg_url_link
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $reg_count = 1,
-        $base_code = '',
-        $reg_url_link = ''
-    ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
-            $this->reg_url_link = apply_filters(
-                'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-                $reg_url_link,
-                $reg_count,
-                $base_code,
-                $reg_url_link
-            );
-            return;
-        }
-        $reg_count = max(1, absint($reg_count));
-        $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
-        if (empty($base_code) || ! is_string($base_code)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->reg_url_link = (string) apply_filters(
-            'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
-            $reg_count,
-            $base_code,
-            $reg_url_link
-        );
-    }
+	/**
+	 * CreateRegUrlLinkCommand constructor.
+	 *
+	 * @param int    $reg_count
+	 * @param mixed  $base_code
+	 * @param string $reg_url_link
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$reg_count = 1,
+		$base_code = '',
+		$reg_url_link = ''
+	) {
+		if (! empty($reg_url_link) && is_string($reg_url_link)) {
+			$this->reg_url_link = apply_filters(
+				'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+				$reg_url_link,
+				$reg_count,
+				$base_code,
+				$reg_url_link
+			);
+			return;
+		}
+		$reg_count = max(1, absint($reg_count));
+		$base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
+		if (empty($base_code) || ! is_string($base_code)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->reg_url_link = (string) apply_filters(
+			'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+			$reg_count . '-' . md5($base_code . microtime()),
+			$reg_count,
+			$base_code,
+			$reg_url_link
+		);
+	}
 
 
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_url_link;
-    }
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_url_link;
+	}
 }

core/domain/entities/GenericAddress.php

Indentation +201 added lines, -201 removed lines

@@ -12,205 +12,205 @@
  */
 class GenericAddress implements \EEI_Address
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    private $_address = '';
-
-    private $_address2 = '';
-
-    private $_city = '';
-
-    private $_state_ID = '';
-
-    private $_state_obj = '';
-
-    private $_zip = '';
-
-    private $_country_ID = '';
-
-    private $_country_obj = '';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * @param string               $address
-     * @param string               $address2
-     * @param string               $city
-     * @param \EE_State | string   $state
-     * @param string               $zip
-     * @param \EE_Country | string $country
-     * @return GenericAddress
-     */
-    public function __construct($address, $address2, $city, $state, $zip, $country)
-    {
-        $this->_address = $address;
-        $this->_address2 = $address2;
-        $this->_city = $city;
-        if ($state instanceof \EE_State) {
-            $this->_state_obj = $state;
-        } else {
-            $this->_state_ID = $state;
-            $this->_state_obj = $this->_get_state_obj();
-        }
-        $this->_zip = $zip;
-        if ($country instanceof \EE_Country) {
-            $this->_country_obj = $country;
-        } else {
-            $this->_country_ID = $country;
-            $this->_country_obj = $this->_get_country_obj();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address()
-    {
-        return $this->_address;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->_address2;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function city()
-    {
-        return $this->_city;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * @return \EE_State
-     */
-    private function _get_state_obj()
-    {
-        return $this->_state_obj instanceof \EE_State
-            ? $this->_state_obj
-            : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->_state_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->abbrev()
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_State
-     */
-    public function state_obj()
-    {
-        return $this->_state_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_obj()->abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    private function _get_country_obj()
-    {
-        return $this->_country_obj instanceof \EE_Country
-            ? $this->_country_obj
-            : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->_country_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof \EE_Country
-            ? $this->country_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->_country_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->_zip;
-    }
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	private $_address = '';
+
+	private $_address2 = '';
+
+	private $_city = '';
+
+	private $_state_ID = '';
+
+	private $_state_obj = '';
+
+	private $_zip = '';
+
+	private $_country_ID = '';
+
+	private $_country_obj = '';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * @param string               $address
+	 * @param string               $address2
+	 * @param string               $city
+	 * @param \EE_State | string   $state
+	 * @param string               $zip
+	 * @param \EE_Country | string $country
+	 * @return GenericAddress
+	 */
+	public function __construct($address, $address2, $city, $state, $zip, $country)
+	{
+		$this->_address = $address;
+		$this->_address2 = $address2;
+		$this->_city = $city;
+		if ($state instanceof \EE_State) {
+			$this->_state_obj = $state;
+		} else {
+			$this->_state_ID = $state;
+			$this->_state_obj = $this->_get_state_obj();
+		}
+		$this->_zip = $zip;
+		if ($country instanceof \EE_Country) {
+			$this->_country_obj = $country;
+		} else {
+			$this->_country_ID = $country;
+			$this->_country_obj = $this->_get_country_obj();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->_address;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->_address2;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->_city;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * @return \EE_State
+	 */
+	private function _get_state_obj()
+	{
+		return $this->_state_obj instanceof \EE_State
+			? $this->_state_obj
+			: \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->_state_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->abbrev()
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->_state_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_obj()->abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	private function _get_country_obj()
+	{
+		return $this->_country_obj instanceof \EE_Country
+			? $this->_country_obj
+			: \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->_country_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof \EE_Country
+			? $this->country_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->_country_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->_zip;
+	}
 }

core/domain/services/wp_queries/EventListQuery.php

Spacing +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
                 // set the property value
                 $this->{$property} = $value;
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -188,7 +188,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

Indentation +194 added lines, -194 removed lines

@@ -15,198 +15,198 @@
  */
 class EventListQuery extends WP_Query
 {
-    /**
-     * @var string $title
-     */
-    private $title;
-
-    /**
-     * @var integer $limit
-     */
-    private $limit = 10;
-
-    /**
-     * @var string $css_class
-     */
-    private $css_class;
-
-    /**
-     * @var boolean $show_expired
-     */
-    private $show_expired = false;
-
-    /**
-     * @var string $month
-     */
-    private $month;
-
-    /**
-     * @var string $category_slug
-     */
-    private $category_slug;
-
-    /**
-     * @var string $order_by
-     */
-    private $order_by;
-
-    /**
-     * @var string $sort
-     */
-    private $sort;
-
-    /**
-     * @var boolean $show_title
-     */
-    private $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args)
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // set the property value
-                $this->{$property} = $value;
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title')
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title'),
-            10,
-            1
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            array($this, 'event_list_css'),
-            10,
-            1
-        );
-    }
-
-
-    private function getQueryArgs(array $args)
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            )
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title()
-    {
-        return filter_var(
-            $this->show_title,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	/**
+	 * @var string $title
+	 */
+	private $title;
+
+	/**
+	 * @var integer $limit
+	 */
+	private $limit = 10;
+
+	/**
+	 * @var string $css_class
+	 */
+	private $css_class;
+
+	/**
+	 * @var boolean $show_expired
+	 */
+	private $show_expired = false;
+
+	/**
+	 * @var string $month
+	 */
+	private $month;
+
+	/**
+	 * @var string $category_slug
+	 */
+	private $category_slug;
+
+	/**
+	 * @var string $order_by
+	 */
+	private $order_by;
+
+	/**
+	 * @var string $sort
+	 */
+	private $sort;
+
+	/**
+	 * @var boolean $show_title
+	 */
+	private $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args)
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// set the property value
+				$this->{$property} = $value;
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title')
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title'),
+			10,
+			1
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			array($this, 'event_list_css'),
+			10,
+			1
+		);
+	}
+
+
+	private function getQueryArgs(array $args)
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			)
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title()
+	{
+		return filter_var(
+			$this->show_title,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

core/domain/services/validation/email/strategies/Basic.php

Spacing +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function validate($email_address)
     {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
+        if ( ! preg_match('/^.+\@\S+$/', $email_address)) {
             // email not in correct {string}@{string} format
             throw new EmailValidationException(
                 esc_html__('Email does not have the required @ sign.', 'event_espresso')
@@ -49,7 +49,7 @@ 
                 esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
             );
         }
-        if ($local[ $localLen - 1 ] === '.') {
+        if ($local[$localLen - 1] === '.') {
             // local part starts or ends with '.'
             throw new EmailValidationException(
                 esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')

Indentation +102 added lines, -102 removed lines

@@ -14,112 +14,112 @@
  */
 class Basic implements EmailValidatorInterface
 {
-    /**
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
-            // email not in correct {string}@{string} format
-            throw new EmailValidationException(
-                esc_html__('Email does not have the required @ sign.', 'event_espresso')
-            );
-        }
-        $atIndex = $this->getAtIndex($email_address);
-        $local = $this->getLocalPartOfEmail($email_address, $atIndex);
-        $localLen = strlen($local);
-        if ($localLen < 1) {
-            // no local part
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is required.', 'event_espresso')
-            );
-        }
-        if ($localLen > 64) {
-            // local part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
-            );
-        }
-        if ($local[0] === '.') {
-            // local part starts with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
-            );
-        }
-        if ($local[ $localLen - 1 ] === '.') {
-            // local part starts or ends with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $local)) {
-            // local part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__(
-                    'Email local-part (before the @) must not have two consecutive periods.',
-                    'event_espresso'
-                )
-            );
-        }
-        $domain = $this->getDomainPartOfEmail($email_address, $atIndex);
-        $domainLen = strlen($domain);
-        if ($domainLen < 1) {
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is required.', 'event_espresso')
-            );
-        }
-        if ($domainLen > 255) {
-            // domain part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is too long.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $domain)) {
-            // domain part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+	/**
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		if (! preg_match('/^.+\@\S+$/', $email_address)) {
+			// email not in correct {string}@{string} format
+			throw new EmailValidationException(
+				esc_html__('Email does not have the required @ sign.', 'event_espresso')
+			);
+		}
+		$atIndex = $this->getAtIndex($email_address);
+		$local = $this->getLocalPartOfEmail($email_address, $atIndex);
+		$localLen = strlen($local);
+		if ($localLen < 1) {
+			// no local part
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is required.', 'event_espresso')
+			);
+		}
+		if ($localLen > 64) {
+			// local part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
+			);
+		}
+		if ($local[0] === '.') {
+			// local part starts with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
+			);
+		}
+		if ($local[ $localLen - 1 ] === '.') {
+			// local part starts or ends with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $local)) {
+			// local part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__(
+					'Email local-part (before the @) must not have two consecutive periods.',
+					'event_espresso'
+				)
+			);
+		}
+		$domain = $this->getDomainPartOfEmail($email_address, $atIndex);
+		$domainLen = strlen($domain);
+		if ($domainLen < 1) {
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is required.', 'event_espresso')
+			);
+		}
+		if ($domainLen > 255) {
+			// domain part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is too long.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $domain)) {
+			// domain part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * returns the location of the @ symbol
-     *
-     * @param string $email_address
-     * @return bool|string
-     */
-    protected function getAtIndex($email_address)
-    {
-        return strrpos($email_address, '@');
-    }
+	/**
+	 * returns the location of the @ symbol
+	 *
+	 * @param string $email_address
+	 * @return bool|string
+	 */
+	protected function getAtIndex($email_address)
+	{
+		return strrpos($email_address, '@');
+	}
 
 
-    /**
-     * Gets the local part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getLocalPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, 0, $atIndex);
-    }
+	/**
+	 * Gets the local part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getLocalPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, 0, $atIndex);
+	}
 
 
-    /**
-     * Gets the domain part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getDomainPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, $atIndex + 1);
-    }
+	/**
+	 * Gets the domain part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getDomainPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, $atIndex + 1);
+	}
 }