eventespresso / event-espresso-core

core/services/locators/FqcnLocator.php

Indentation +143 added lines, -143 removed lines

@@ -17,147 +17,147 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param array $partial_namespace
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function FindFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            $file = \EEH_File::standardise_directory_separators($file);
-            foreach ($this->namespaces as $namespace => $base_dir) {
-                $namespace .= Psr4Autoloader::NS;
-                if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                        array($base_dir, DS, '.php'),
-                        array($namespace, Psr4Autoloader::NS, ''),
-                        $file
-                    );
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments then loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the first element, so pull that from the array
-        $namespace = array_shift($namespace_segments);
-        // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param array $partial_namespace
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function FindFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			$file = \EEH_File::standardise_directory_separators($file);
+			foreach ($this->namespaces as $namespace => $base_dir) {
+				$namespace .= Psr4Autoloader::NS;
+				if (strpos($file, $base_dir) === 0) {
+					$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+						array($base_dir, DS, '.php'),
+						array($namespace, Psr4Autoloader::NS, ''),
+						$file
+					);
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments then loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the first element, so pull that from the array
+		$namespace = array_shift($namespace_segments);
+		// check if there's a base directory registered for that namespace
+		$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, $namespace_segments) . DS;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -36,13 +36,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -77,12 +77,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -118,7 +118,7 @@ 
             foreach ($this->namespaces as $namespace => $base_dir) {
                 $namespace .= Psr4Autoloader::NS;
                 if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                    $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                         array($base_dir, DS, '.php'),
                         array($namespace, Psr4Autoloader::NS, ''),
                         $file
@@ -151,13 +151,13 @@ 
         // we're only interested in the first element, so pull that from the array
         $namespace = array_shift($namespace_segments);
         // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+        $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
         // nope? then the incoming namespace is invalid
         if (empty($prefix) || empty($prefix[0])) {
             throw new InvalidClassException($partial_namespace);
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
+        return $prefix[0].implode(DS, $namespace_segments).DS;
     }
 }

core/services/database/TableManager.php

Indentation +225 added lines, -225 removed lines

@@ -13,248 +13,248 @@
 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(
-                    __('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(
+					__('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')
-    {
-        // 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')
+	{
+		// 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(
-                    __(
-                        '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(
+					__(
+						'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;
+	}
 }

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);

core/services/commands/CommandHandlerManager.php

Indentation +93 added lines, -93 removed lines

@@ -18,104 +18,104 @@
 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
-     *
-     * @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
+	 *
+	 * @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);
-        $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);
-    }
+	/**
+	 * @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);
+		$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);
+	}
 }

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.',

core/services/notices/Notice.php

Indentation +249 added lines, -249 removed lines

@@ -14,253 +14,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 = $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 = $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 = $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 = $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 = $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 = $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 = $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 = $line;
+	}
+
+
+	/**
+	 * @param boolean $dismissible
+	 */
+	private function setDismissible($dismissible = true)
+	{
+		$this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN);
+	}
 }

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,

core/libraries/iframe_display/Iframe.php

Indentation +332 added lines, -332 removed lines

@@ -18,371 +18,371 @@
 class Iframe
 {
 
-    /*
+	/*
     * HTML for notices and ajax gif
     * @var string $title
     */
-    protected $title = '';
+	protected $title = '';
 
-    /*
+	/*
     * HTML for the content being displayed
     * @var string $content
     */
-    protected $content = '';
+	protected $content = '';
 
-    /*
+	/*
     * whether or not to call wp_head() and wp_footer()
     * @var boolean $enqueue_wp_assets
     */
-    protected $enqueue_wp_assets = false;
+	protected $enqueue_wp_assets = false;
 
-    /*
+	/*
     * an array of CSS URLs
     * @var array $css
     */
-    protected $css = array();
+	protected $css = array();
 
-    /*
+	/*
     * an array of JS URLs to be set in the HTML header.
     * @var array $header_js
     */
-    protected $header_js = array();
+	protected $header_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for header JS
     * @var array $footer_js
     */
-    protected $header_js_attributes = array();
+	protected $header_js_attributes = array();
 
-    /*
+	/*
     * an array of JS URLs to be displayed before the HTML </body> tag
     * @var array $footer_js
     */
-    protected $footer_js = array();
+	protected $footer_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for footer JS
     * @var array $footer_js_attributes
     */
-    protected $footer_js_attributes = array();
+	protected $footer_js_attributes = array();
 
-    /*
+	/*
     * an array of JSON vars to be set in the HTML header.
     * @var array $localized_vars
     */
-    protected $localized_vars = array();
-
-
-    /**
-     * Iframe constructor
-     *
-     * @param string $title
-     * @param string $content
-     * @throws DomainException
-     */
-    public function __construct($title, $content)
-    {
-        global $wp_version;
-        if (! defined('EE_IFRAME_DIR_URL')) {
-            define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
-        }
-        $this->setContent($content);
-        $this->setTitle($title);
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
-                array(
-                    'site_theme'       => get_stylesheet_directory_uri() . DS
-                                          . 'style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
-                    'espresso_default' => EE_GLOBAL_ASSETS_URL
-                                          . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
-                array(
-                    'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
-                    'espresso_core' => EE_GLOBAL_ASSETS_URL
-                                       . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        if (apply_filters(
-            'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
-            false
-        )) {
-            $this->addStylesheets(
-                apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
-                    array('default_theme_stylesheet' => get_stylesheet_uri()),
-                    $this
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $title
-     * @throws DomainException
-     */
-    public function setTitle($title)
-    {
-        if (empty($title)) {
-            throw new DomainException(
-                esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->title = $title;
-    }
-
-
-    /**
-     * @param string $content
-     * @throws DomainException
-     */
-    public function setContent($content)
-    {
-        if (empty($content)) {
-            throw new DomainException(
-                esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->content = $content;
-    }
-
-
-    /**
-     * @param boolean $enqueue_wp_assets
-     */
-    public function setEnqueueWpAssets($enqueue_wp_assets)
-    {
-        $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param array $stylesheets
-     * @throws DomainException
-     */
-    public function addStylesheets(array $stylesheets)
-    {
-        if (empty($stylesheets)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($stylesheets as $handle => $stylesheet) {
-            $this->css[ $handle ] = $stylesheet;
-        }
-    }
-
-
-    /**
-     * @param array $scripts
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScripts(array $scripts, $add_to_header = false)
-    {
-        if (empty($scripts)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add Javascript to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($scripts as $handle => $script) {
-            if ($add_to_header) {
-                $this->header_js[ $handle ] = $script;
-            } else {
-                $this->footer_js[ $handle ] = $script;
-            }
-        }
-    }
-
-
-    /**
-     * @param array $script_attributes
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScriptAttributes(array $script_attributes, $add_to_header = false)
-    {
-        if (empty($script_attributes)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of strings, is required to add attributes to iframe Javascript.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($script_attributes as $handle => $script_attribute) {
-            if ($add_to_header) {
-                $this->header_js_attributes[ $handle ] = $script_attribute;
-            } else {
-                $this->footer_js_attributes[ $handle ] = $script_attribute;
-            }
-        }
-    }
-
-
-    /**
-     * @param array  $vars
-     * @param string $var_name
-     * @throws DomainException
-     */
-    public function addLocalizedVars(array $vars, $var_name = 'eei18n')
-    {
-        if (empty($vars)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($vars as $handle => $var) {
-            if ($var_name === 'eei18n') {
-                EE_Registry::$i18n_js_strings[ $handle ] = $var;
-            } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
-                $this->localized_vars[ $var_name ] = $var;
-            } else {
-                if (! isset($this->localized_vars[ $var_name ])) {
-                    $this->localized_vars[ $var_name ] = array();
-                }
-                $this->localized_vars[ $var_name ][ $handle ] = $var;
-            }
-        }
-    }
-
-
-    /**
-     * @param string $utm_content
-     * @throws DomainException
-     */
-    public function display($utm_content = '')
-    {
-        $this->content .= EEH_Template::powered_by_event_espresso(
-            '',
-            '',
-            ! empty($utm_content) ? array('utm_content' => $utm_content) : array()
-        );
-        EE_System::do_not_cache();
-        echo $this->getTemplate();
-        exit;
-    }
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function getTemplate()
-    {
-        return EEH_Template::display_template(
-            __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
-            array(
-                'title'                => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
-                    $this->title,
-                    $this
-                ),
-                'content'              => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
-                    $this->content,
-                    $this
-                ),
-                'enqueue_wp_assets'    => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
-                    $this->enqueue_wp_assets,
-                    $this
-                ),
-                'css'                  => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
-                    $this->css,
-                    $this
-                ),
-                'header_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
-                    $this->header_js,
-                    $this
-                ),
-                'header_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
-                    $this->header_js_attributes,
-                    $this
-                ),
-                'footer_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
-                    $this->footer_js,
-                    $this
-                ),
-                'footer_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
-                    $this->footer_js_attributes,
-                    $this
-                ),
-                'eei18n'               => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
-                    EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
-                    $this
-                ),
-                'notices'              => EEH_Template::display_template(
-                    EE_TEMPLATES . 'espresso-ajax-notices.template.php',
-                    array(),
-                    true
-                ),
-            ),
-            true,
-            true
-        );
-    }
-
-
-    /**
-     * localizeJsonVars
-     *
-     * @return string
-     */
-    public function localizeJsonVars()
-    {
-        $JSON = '';
-        foreach ((array) $this->localized_vars as $var_name => $vars) {
-            $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
-            $JSON .= "/* <![CDATA[ */ var {$var_name} = ";
-            $JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
-            $JSON .= '; /* ]]> */';
-        }
-        return $JSON;
-    }
-
-
-    /**
-     * @param bool|int|float|string|array $var
-     * @return array
-     */
-    public function encodeJsonVars($var)
-    {
-        if (is_array($var)) {
-            $localized_vars = array();
-            foreach ((array) $var as $key => $value) {
-                $localized_vars[ $key ] = $this->encodeJsonVars($value);
-            }
-            return $localized_vars;
-        }
-        if (is_scalar($var)) {
-            return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
-        }
-        return null;
-    }
+	protected $localized_vars = array();
+
+
+	/**
+	 * Iframe constructor
+	 *
+	 * @param string $title
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function __construct($title, $content)
+	{
+		global $wp_version;
+		if (! defined('EE_IFRAME_DIR_URL')) {
+			define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
+		}
+		$this->setContent($content);
+		$this->setTitle($title);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
+				array(
+					'site_theme'       => get_stylesheet_directory_uri() . DS
+										  . 'style.css?ver=' . EVENT_ESPRESSO_VERSION,
+					'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+					'espresso_default' => EE_GLOBAL_ASSETS_URL
+										  . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
+				array(
+					'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
+					'espresso_core' => EE_GLOBAL_ASSETS_URL
+									   . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		if (apply_filters(
+			'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
+			false
+		)) {
+			$this->addStylesheets(
+				apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
+					array('default_theme_stylesheet' => get_stylesheet_uri()),
+					$this
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $title
+	 * @throws DomainException
+	 */
+	public function setTitle($title)
+	{
+		if (empty($title)) {
+			throw new DomainException(
+				esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->title = $title;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function setContent($content)
+	{
+		if (empty($content)) {
+			throw new DomainException(
+				esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->content = $content;
+	}
+
+
+	/**
+	 * @param boolean $enqueue_wp_assets
+	 */
+	public function setEnqueueWpAssets($enqueue_wp_assets)
+	{
+		$this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param array $stylesheets
+	 * @throws DomainException
+	 */
+	public function addStylesheets(array $stylesheets)
+	{
+		if (empty($stylesheets)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($stylesheets as $handle => $stylesheet) {
+			$this->css[ $handle ] = $stylesheet;
+		}
+	}
+
+
+	/**
+	 * @param array $scripts
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScripts(array $scripts, $add_to_header = false)
+	{
+		if (empty($scripts)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add Javascript to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($scripts as $handle => $script) {
+			if ($add_to_header) {
+				$this->header_js[ $handle ] = $script;
+			} else {
+				$this->footer_js[ $handle ] = $script;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array $script_attributes
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScriptAttributes(array $script_attributes, $add_to_header = false)
+	{
+		if (empty($script_attributes)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of strings, is required to add attributes to iframe Javascript.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($script_attributes as $handle => $script_attribute) {
+			if ($add_to_header) {
+				$this->header_js_attributes[ $handle ] = $script_attribute;
+			} else {
+				$this->footer_js_attributes[ $handle ] = $script_attribute;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array  $vars
+	 * @param string $var_name
+	 * @throws DomainException
+	 */
+	public function addLocalizedVars(array $vars, $var_name = 'eei18n')
+	{
+		if (empty($vars)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($vars as $handle => $var) {
+			if ($var_name === 'eei18n') {
+				EE_Registry::$i18n_js_strings[ $handle ] = $var;
+			} elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
+				$this->localized_vars[ $var_name ] = $var;
+			} else {
+				if (! isset($this->localized_vars[ $var_name ])) {
+					$this->localized_vars[ $var_name ] = array();
+				}
+				$this->localized_vars[ $var_name ][ $handle ] = $var;
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $utm_content
+	 * @throws DomainException
+	 */
+	public function display($utm_content = '')
+	{
+		$this->content .= EEH_Template::powered_by_event_espresso(
+			'',
+			'',
+			! empty($utm_content) ? array('utm_content' => $utm_content) : array()
+		);
+		EE_System::do_not_cache();
+		echo $this->getTemplate();
+		exit;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function getTemplate()
+	{
+		return EEH_Template::display_template(
+			__DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
+			array(
+				'title'                => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
+					$this->title,
+					$this
+				),
+				'content'              => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
+					$this->content,
+					$this
+				),
+				'enqueue_wp_assets'    => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
+					$this->enqueue_wp_assets,
+					$this
+				),
+				'css'                  => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
+					$this->css,
+					$this
+				),
+				'header_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
+					$this->header_js,
+					$this
+				),
+				'header_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
+					$this->header_js_attributes,
+					$this
+				),
+				'footer_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
+					$this->footer_js,
+					$this
+				),
+				'footer_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
+					$this->footer_js_attributes,
+					$this
+				),
+				'eei18n'               => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
+					EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
+					$this
+				),
+				'notices'              => EEH_Template::display_template(
+					EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+					array(),
+					true
+				),
+			),
+			true,
+			true
+		);
+	}
+
+
+	/**
+	 * localizeJsonVars
+	 *
+	 * @return string
+	 */
+	public function localizeJsonVars()
+	{
+		$JSON = '';
+		foreach ((array) $this->localized_vars as $var_name => $vars) {
+			$this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
+			$JSON .= "/* <![CDATA[ */ var {$var_name} = ";
+			$JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
+			$JSON .= '; /* ]]> */';
+		}
+		return $JSON;
+	}
+
+
+	/**
+	 * @param bool|int|float|string|array $var
+	 * @return array
+	 */
+	public function encodeJsonVars($var)
+	{
+		if (is_array($var)) {
+			$localized_vars = array();
+			foreach ((array) $var as $key => $value) {
+				$localized_vars[ $key ] = $this->encodeJsonVars($value);
+			}
+			return $localized_vars;
+		}
+		if (is_scalar($var)) {
+			return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
+		}
+		return null;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -83,7 +83,7 @@ 
     public function __construct($title, $content)
     {
         global $wp_version;
-        if (! defined('EE_IFRAME_DIR_URL')) {
+        if ( ! defined('EE_IFRAME_DIR_URL')) {
             define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
         }
         $this->setContent($content);
@@ -92,11 +92,11 @@ 
             apply_filters(
                 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
                 array(
-                    'site_theme'       => get_stylesheet_directory_uri() . DS
-                                          . 'style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+                    'site_theme'       => get_stylesheet_directory_uri().DS
+                                          . 'style.css?ver='.EVENT_ESPRESSO_VERSION,
+                    'dashicons'        => includes_url('css/dashicons.min.css?ver='.$wp_version),
                     'espresso_default' => EE_GLOBAL_ASSETS_URL
-                                          . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                                          . 'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -105,9 +105,9 @@ 
             apply_filters(
                 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
                 array(
-                    'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
+                    'jquery'        => includes_url('js/jquery/jquery.js?ver='.$wp_version),
                     'espresso_core' => EE_GLOBAL_ASSETS_URL
-                                       . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+                                       . 'scripts/espresso_core.js?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -181,7 +181,7 @@ 
             );
         }
         foreach ($stylesheets as $handle => $stylesheet) {
-            $this->css[ $handle ] = $stylesheet;
+            $this->css[$handle] = $stylesheet;
         }
     }
 
@@ -203,9 +203,9 @@ 
         }
         foreach ($scripts as $handle => $script) {
             if ($add_to_header) {
-                $this->header_js[ $handle ] = $script;
+                $this->header_js[$handle] = $script;
             } else {
-                $this->footer_js[ $handle ] = $script;
+                $this->footer_js[$handle] = $script;
             }
         }
     }
@@ -228,9 +228,9 @@ 
         }
         foreach ($script_attributes as $handle => $script_attribute) {
             if ($add_to_header) {
-                $this->header_js_attributes[ $handle ] = $script_attribute;
+                $this->header_js_attributes[$handle] = $script_attribute;
             } else {
-                $this->footer_js_attributes[ $handle ] = $script_attribute;
+                $this->footer_js_attributes[$handle] = $script_attribute;
             }
         }
     }
@@ -253,14 +253,14 @@ 
         }
         foreach ($vars as $handle => $var) {
             if ($var_name === 'eei18n') {
-                EE_Registry::$i18n_js_strings[ $handle ] = $var;
+                EE_Registry::$i18n_js_strings[$handle] = $var;
             } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
-                $this->localized_vars[ $var_name ] = $var;
+                $this->localized_vars[$var_name] = $var;
             } else {
-                if (! isset($this->localized_vars[ $var_name ])) {
-                    $this->localized_vars[ $var_name ] = array();
+                if ( ! isset($this->localized_vars[$var_name])) {
+                    $this->localized_vars[$var_name] = array();
                 }
-                $this->localized_vars[ $var_name ][ $handle ] = $var;
+                $this->localized_vars[$var_name][$handle] = $var;
             }
         }
     }
@@ -290,7 +290,7 @@ 
     public function getTemplate()
     {
         return EEH_Template::display_template(
-            __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
+            __DIR__.DIRECTORY_SEPARATOR.'iframe_wrapper.template.php',
             array(
                 'title'                => apply_filters(
                     'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
@@ -334,11 +334,11 @@ 
                 ),
                 'eei18n'               => apply_filters(
                     'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
-                    EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
+                    EE_Registry::localize_i18n_js_strings().$this->localizeJsonVars(),
                     $this
                 ),
                 'notices'              => EEH_Template::display_template(
-                    EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+                    EE_TEMPLATES.'espresso-ajax-notices.template.php',
                     array(),
                     true
                 ),
@@ -358,9 +358,9 @@ 
     {
         $JSON = '';
         foreach ((array) $this->localized_vars as $var_name => $vars) {
-            $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
+            $this->localized_vars[$var_name] = $this->encodeJsonVars($vars);
             $JSON .= "/* <![CDATA[ */ var {$var_name} = ";
-            $JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
+            $JSON .= wp_json_encode($this->localized_vars[$var_name]);
             $JSON .= '; /* ]]> */';
         }
         return $JSON;
@@ -376,7 +376,7 @@ 
         if (is_array($var)) {
             $localized_vars = array();
             foreach ((array) $var as $key => $value) {
-                $localized_vars[ $key ] = $this->encodeJsonVars($value);
+                $localized_vars[$key] = $this->encodeJsonVars($value);
             }
             return $localized_vars;
         }

core/libraries/iframe_display/IframeEmbedButton.php

Indentation +245 added lines, -245 removed lines

@@ -13,274 +13,274 @@
 {
 
 
-    /**
-     * @var string $iframe_name
-     */
-    private $iframe_name;
+	/**
+	 * @var string $iframe_name
+	 */
+	private $iframe_name;
 
-    /**
-     * @var string $route_name
-     */
-    private $route_name;
+	/**
+	 * @var string $route_name
+	 */
+	private $route_name;
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var boolean $append_filterable_content
-     */
-    private $append_filterable_content;
+	/**
+	 * @var boolean $append_filterable_content
+	 */
+	private $append_filterable_content;
 
 
-    /**
-     * IframeEmbedButton constructor.
-     *
-     * @param string $iframe_name i18n name for the iframe. This will be used in HTML
-     * @param string $route_name  the name of the registered route
-     * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
-     *                            will most likely be "event" since that's the only usage atm
-     */
-    public function __construct($iframe_name, $route_name, $slug = 'event')
-    {
-        $this->iframe_name = $iframe_name;
-        $this->route_name = $route_name;
-        $this->slug = $slug;
-    }
+	/**
+	 * IframeEmbedButton constructor.
+	 *
+	 * @param string $iframe_name i18n name for the iframe. This will be used in HTML
+	 * @param string $route_name  the name of the registered route
+	 * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
+	 *                            will most likely be "event" since that's the only usage atm
+	 */
+	public function __construct($iframe_name, $route_name, $slug = 'event')
+	{
+		$this->iframe_name = $iframe_name;
+		$this->route_name = $route_name;
+		$this->slug = $slug;
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButtonFilter()
-    {
-        // add button for iframe code to event editor.
-        add_filter(
-            'get_sample_permalink_html',
-            array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
-            10,
-            2
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButtonFilter()
+	{
+		// add button for iframe code to event editor.
+		add_filter(
+			'get_sample_permalink_html',
+			array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
+			10,
+			2
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * @param $permalink_string
-     * @param $id
-     * @return string
-     */
-    public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
-    {
-        return $this->eventEditorIframeEmbedButton(
-            $permalink_string,
-            $id
-        );
-    }
+	/**
+	 * @param $permalink_string
+	 * @param $id
+	 * @return string
+	 */
+	public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
+	{
+		return $this->eventEditorIframeEmbedButton(
+			$permalink_string,
+			$id
+		);
+	}
 
 
-    /**
-     * iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string
-     * @param int    $id
-     * @return string
-     */
-    public function eventEditorIframeEmbedButton(
-        $permalink_string,
-        $id
-    ) {
-        // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
-            $post = get_post($id);
-            // if NOT event then let's get out.
-            if ($post->post_type !== 'espresso_events') {
-                return $permalink_string;
-            }
-            $permalink_string .= $this->embedButtonHtml(
-                array($this->slug => $id),
-                'button-small'
-            );
-        }
-        return $permalink_string;
-    }
+	/**
+	 * iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @return string
+	 */
+	public function eventEditorIframeEmbedButton(
+		$permalink_string,
+		$id
+	) {
+		// make sure this is ONLY when editing and the event id has been set.
+		if (! empty($id)) {
+			$post = get_post($id);
+			// if NOT event then let's get out.
+			if ($post->post_type !== 'espresso_events') {
+				return $permalink_string;
+			}
+			$permalink_string .= $this->embedButtonHtml(
+				array($this->slug => $id),
+				'button-small'
+			);
+		}
+		return $permalink_string;
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
-     *
-     * @param string $action name of the WP do_action() to hook into
-     */
-    public function addActionIframeEmbedButton($action)
-    {
-        // add button for iframe code to event editor.
-        add_action(
-            $action,
-            array($this, 'addActionIframeEmbedButtonCallback'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
+	 *
+	 * @param string $action name of the WP do_action() to hook into
+	 */
+	public function addActionIframeEmbedButton($action)
+	{
+		// add button for iframe code to event editor.
+		add_action(
+			$action,
+			array($this, 'addActionIframeEmbedButtonCallback'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function addActionIframeEmbedButtonCallback()
-    {
-        echo $this->embedButtonHtml();
-    }
+	/**
+	 * @return void
+	 */
+	public function addActionIframeEmbedButtonCallback()
+	{
+		echo $this->embedButtonHtml();
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
-     *
-     * @param string $filter     name of the WP apply_filters() to hook into
-     * @param bool   $append     if true, will add iframe embed button to end of content,
-     *                           else if false, will add to the beginning of the content
-     */
-    public function addFilterIframeEmbedButton($filter, $append = true)
-    {
-        $this->append_filterable_content = $append;
-        // add button for iframe code to event editor.
-        add_filter(
-            $filter,
-            array($this, 'addFilterIframeEmbedButtonCallback'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
+	 *
+	 * @param string $filter     name of the WP apply_filters() to hook into
+	 * @param bool   $append     if true, will add iframe embed button to end of content,
+	 *                           else if false, will add to the beginning of the content
+	 */
+	public function addFilterIframeEmbedButton($filter, $append = true)
+	{
+		$this->append_filterable_content = $append;
+		// add button for iframe code to event editor.
+		add_filter(
+			$filter,
+			array($this, 'addFilterIframeEmbedButtonCallback'),
+			10
+		);
+	}
 
 
-    /**
-     * @param array|string $filterable_content
-     * @return array|string
-     */
-    public function addFilterIframeEmbedButtonCallback($filterable_content)
-    {
-        $embedButtonHtml = $this->embedButtonHtml();
-        if (is_array($filterable_content)) {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content + array($this->route_name => $embedButtonHtml)
-                : array($this->route_name => $embedButtonHtml) + $filterable_content;
-        } else {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
-        }
-        return $filterable_content;
-    }
+	/**
+	 * @param array|string $filterable_content
+	 * @return array|string
+	 */
+	public function addFilterIframeEmbedButtonCallback($filterable_content)
+	{
+		$embedButtonHtml = $this->embedButtonHtml();
+		if (is_array($filterable_content)) {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content + array($this->route_name => $embedButtonHtml)
+				: array($this->route_name => $embedButtonHtml) + $filterable_content;
+		} else {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content . $embedButtonHtml
+				: $embedButtonHtml . $filterable_content;
+		}
+		return $filterable_content;
+	}
 
 
-    /**
-     * iframe_embed_html
-     *
-     * @param array  $query_args
-     * @param string $button_class
-     * @return string
-     */
-    public function embedButtonHtml($query_args = array(), $button_class = '')
-    {
-        // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array) $query_args + array($this->route_name => 'iframe');
-        $query_args = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
-            $query_args
-        );
-        // add this route to our localized vars
-        $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
-            ? \EE_Registry::$i18n_js_strings['iframe_module_routes']
-            : array();
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
-        \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
-        $iframe_embed_html = \EEH_HTML::link(
-            '#',
-            sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
-            sprintf(
-                esc_html__(
-                    'click here to generate code for embedding %1$s iframe into another site.',
-                    'event_espresso'
-                ),
-                \EEH_Inflector::add_indefinite_article($this->iframe_name)
-            ),
-            "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
-            '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
-        );
-        $iframe_embed_html .= \EEH_HTML::div(
-            '',
-            "{$this->route_name}-iframe-js",
-            'iframe-embed-wrapper-js',
-            'display:none;'
-        );
-        $iframe_embed_html .= esc_html(
-            \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
-                '',
-                '',
-                'width:100%; height: 500px;'
-            )
-        );
-        $iframe_embed_html .= \EEH_HTML::divx();
-        return $iframe_embed_html;
-    }
+	/**
+	 * iframe_embed_html
+	 *
+	 * @param array  $query_args
+	 * @param string $button_class
+	 * @return string
+	 */
+	public function embedButtonHtml($query_args = array(), $button_class = '')
+	{
+		// incoming args will replace the defaults listed here in the second array (union preserves first array)
+		$query_args = (array) $query_args + array($this->route_name => 'iframe');
+		$query_args = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
+			$query_args
+		);
+		// add this route to our localized vars
+		$iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
+			? \EE_Registry::$i18n_js_strings['iframe_module_routes']
+			: array();
+		$iframe_module_routes[ $this->route_name ] = $this->route_name;
+		\EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
+		$iframe_embed_html = \EEH_HTML::link(
+			'#',
+			sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
+			sprintf(
+				esc_html__(
+					'click here to generate code for embedding %1$s iframe into another site.',
+					'event_espresso'
+				),
+				\EEH_Inflector::add_indefinite_article($this->iframe_name)
+			),
+			"{$this->route_name}-iframe-embed-trigger-js",
+			'iframe-embed-trigger-js button ' . $button_class,
+			'',
+			' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+		);
+		$iframe_embed_html .= \EEH_HTML::div(
+			'',
+			"{$this->route_name}-iframe-js",
+			'iframe-embed-wrapper-js',
+			'display:none;'
+		);
+		$iframe_embed_html .= esc_html(
+			\EEH_HTML::div(
+				'<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+				'',
+				'',
+				'width:100%; height: 500px;'
+			)
+		);
+		$iframe_embed_html .= \EEH_HTML::divx();
+		return $iframe_embed_html;
+	}
 
 
-    /**
-     * enqueue iframe button js
-     */
-    public function embedButtonAssets()
-    {
-        \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
-            'copy and paste the following into any other site\'s content to display this event:',
-            'event_espresso'
-        );
-        \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
-            'click anywhere outside of this window to close it.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('iframe_embed_button');
-    }
+	/**
+	 * enqueue iframe button js
+	 */
+	public function embedButtonAssets()
+	{
+		\EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
+			'copy and paste the following into any other site\'s content to display this event:',
+			'event_espresso'
+		);
+		\EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
+			'click anywhere outside of this window to close it.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'iframe_embed_button',
+			plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('iframe_embed_button');
+	}
 
 
-    /**
-     * generates embed button sections for admin pages
-     *
-     * @param array $embed_buttons
-     * @return string
-     */
-    public function addIframeEmbedButtonsSection(array $embed_buttons)
-    {
-        $embed_buttons = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
-            $embed_buttons
-        );
-        if (empty($embed_buttons)) {
-            return '';
-        }
-        // add button for iframe code to event editor.
-        $html = \EEH_HTML::br(2);
-        $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
-        $html .= \EEH_HTML::p(
-            esc_html__(
-                'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
-                'event_espresso'
-            )
-        );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
-        $html .= \EEH_HTML::br(2);
-        return $html;
-    }
+	/**
+	 * generates embed button sections for admin pages
+	 *
+	 * @param array $embed_buttons
+	 * @return string
+	 */
+	public function addIframeEmbedButtonsSection(array $embed_buttons)
+	{
+		$embed_buttons = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
+			$embed_buttons
+		);
+		if (empty($embed_buttons)) {
+			return '';
+		}
+		// add button for iframe code to event editor.
+		$html = \EEH_HTML::br(2);
+		$html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
+		$html .= \EEH_HTML::p(
+			esc_html__(
+				'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
+				'event_espresso'
+			)
+		);
+		$html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+		$html .= \EEH_HTML::br(2);
+		return $html;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -96,7 +96,7 @@ 
         $id
     ) {
         // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             // if NOT event then let's get out.
             if ($post->post_type !== 'espresso_events') {
@@ -169,8 +169,8 @@ 
                 : array($this->route_name => $embedButtonHtml) + $filterable_content;
         } else {
             $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
+                ? $filterable_content.$embedButtonHtml
+                : $embedButtonHtml.$filterable_content;
         }
         return $filterable_content;
     }
@@ -195,7 +195,7 @@ 
         $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
             ? \EE_Registry::$i18n_js_strings['iframe_module_routes']
             : array();
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
+        $iframe_module_routes[$this->route_name] = $this->route_name;
         \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
         $iframe_embed_html = \EEH_HTML::link(
             '#',
@@ -208,9 +208,9 @@ 
                 \EEH_Inflector::add_indefinite_article($this->iframe_name)
             ),
             "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
+            'iframe-embed-trigger-js button '.$button_class,
             '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+            ' data-iframe_embed_button="#'.$this->route_name.'-iframe-js" tabindex="-1"'
         );
         $iframe_embed_html .= \EEH_HTML::div(
             '',
@@ -220,7 +220,7 @@ 
         );
         $iframe_embed_html .= esc_html(
             \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+                '<iframe src="'.add_query_arg($query_args, site_url()).'" width="100%" height="100%"></iframe>',
                 '',
                 '',
                 'width:100%; height: 500px;'
@@ -246,7 +246,7 @@ 
         );
         wp_register_script(
             'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+            plugin_dir_url(__FILE__).'iframe-embed-button.js',
             array('ee-dialog'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -279,7 +279,7 @@ 
                 'event_espresso'
             )
         );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+        $html .= ' &nbsp; '.implode(' &nbsp; ', $embed_buttons).' ';
         $html .= \EEH_HTML::br(2);
         return $html;
     }

core/libraries/rest_api/controllers/Base.php

Indentation +334 added lines, -334 removed lines

@@ -22,338 +22,338 @@
 class Base
 {
 
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = array();
-
-
-    public function __construct()
-    {
-        $this->debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
-        // we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo($key, $info)
-    {
-        $this->debug_info[ $key ] = $info;
-    }
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
-        }
-    }
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response)
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array) $wp_error->errors as $code => $messages) {
-            foreach ((array) $messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices()
-    {
-        $headers = array();
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
-                          . EEH_Inflector::humanize($notice_type)
-                          . '['
-                          . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string $route
-     * @return string
-     */
-    public function getRequestedVersion($route = null)
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            // skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param \WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(\WP_REST_Request $request)
-    {
-        // $request->get_params();
-        return array_merge(
-            (array) $request->get_body_params(),
-            (array) $request->get_json_params()
-        );
-        // return array_diff_key(
-        //    $request->get_params(),
-        //     $request->get_url_params(),
-        //     $request->get_query_params()
-        // );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = array();
+
+
+	public function __construct()
+	{
+		$this->debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
+		// we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo($key, $info)
+	{
+		$this->debug_info[ $key ] = $info;
+	}
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[ $prefix . $header_key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response)
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array) $wp_error->errors as $code => $messages) {
+			foreach ((array) $messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices()
+	{
+		$headers = array();
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers[ 'X-EE4-Notices-'
+						  . EEH_Inflector::humanize($notice_type)
+						  . '['
+						  . $notice_code
+						  . ']' ] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function getRequestedVersion($route = null)
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			// skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[ $i ])) {
+					$success = false;
+				} else {
+					$indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(\WP_REST_Request $request)
+	{
+		// $request->get_params();
+		return array_merge(
+			(array) $request->get_body_params(),
+			(array) $request->get_json_params()
+		);
+		// return array_diff_key(
+		//    $request->get_params(),
+		//     $request->get_url_params(),
+		//     $request->get_query_params()
+		// );
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -96,7 +96,7 @@ 
      */
     protected function setDebugInfo($key, $info)
     {
-        $this->debug_info[ $key ] = $info;
+        $this->debug_info[$key] = $info;
     }
 
 
@@ -113,11 +113,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -147,7 +147,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response)
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -190,7 +190,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -249,15 +249,15 @@ 
         $headers = array();
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
+                $headers['X-EE4-Notices-'
                           . EEH_Inflector::humanize($notice_type)
                           . '['
                           . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
+                          . ']'] = strip_tags($sub_notice);
             }
         }
         return apply_filters(
@@ -286,7 +286,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -320,14 +320,14 @@ 
         if (is_array($matches)) {
             // skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

core/libraries/rest_api/controllers/config/Read.php

Indentation +77 added lines, -77 removed lines

@@ -20,85 +20,85 @@
 class Read
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return EE_Config|WP_Error
-     */
-    public static function handleRequest(WP_REST_Request $request, $version)
-    {
-        $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
-            return EE_Config::instance();
-        } else {
-            return new WP_Error(
-                'cannot_read_config',
-                sprintf(
-                    __(
-                        'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
-                        'event_espresso'
-                    ),
-                    $cap
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return EE_Config|WP_Error
+	 */
+	public static function handleRequest(WP_REST_Request $request, $version)
+	{
+		$cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
+			return EE_Config::instance();
+		} else {
+			return new WP_Error(
+				'cannot_read_config',
+				sprintf(
+					__(
+						'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
+						'event_espresso'
+					),
+					$cap
+				),
+				array('status' => 403)
+			);
+		}
+	}
 
 
-    /**
-     * Handles the request for public site info
-     *
-     * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
-     *                                                           current user could be authenticated using basic auth
-     *                                                           data
-     * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
-     *                                                           basic auth data was somehow received
-     * @param WP_REST_Request  $request
-     * @param string           $version
-     * @return array|WP_Error
-     */
-    public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-        // @codingStandardsIgnoreStart
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            // @codingStandardsIgnoreEnd
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
-            array(
-                'default_timezone' => array(
-                    'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                    'string' => get_option('timezone_string'),
-                    'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-                ),
-                'default_currency' => EE_Config::instance()->currency,
-                'authentication'   => array(
-                    'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
-                    'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
-                    'warning'                      => $warning,
-                ),
-            )
-        );
-    }
+	/**
+	 * Handles the request for public site info
+	 *
+	 * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
+	 *                                                           current user could be authenticated using basic auth
+	 *                                                           data
+	 * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
+	 *                                                           basic auth data was somehow received
+	 * @param WP_REST_Request  $request
+	 * @param string           $version
+	 * @return array|WP_Error
+	 */
+	public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+		// @codingStandardsIgnoreStart
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			// @codingStandardsIgnoreEnd
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
+			array(
+				'default_timezone' => array(
+					'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+					'string' => get_option('timezone_string'),
+					'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+				),
+				'default_currency' => EE_Config::instance()->currency,
+				'authentication'   => array(
+					'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+					'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
+					'warning'                      => $warning,
+				),
+			)
+		);
+	}
 }
 
 // End of file Read.php

core/libraries/rest_api/controllers/model/Read.php

Indentation +1319 added lines, -1319 removed lines

@@ -35,1323 +35,1323 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->fields_calculator = new CalculatedModelFields();
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version    The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model);
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return array();
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     */
-    protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @param string          $related_model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $related_model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return WP_Error|array
-     * @throws RestException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return array|WP_Error
-     * @throws EE_Error
-     */
-    public function getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     */
-    protected function setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request $rest_request
-     * @param string          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->getModelVersionInfo(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                $timezone = $field_value->getTimezone();
-                EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                $result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $field_value,
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                $result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $field_value,
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     */
-    protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param EEM_Base         $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param array           $entity_array
-     * @param array           $db_row
-     * @return array the modified entity
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
-                                                                                             instanceof
-                                                                                             WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function removeModelNamesFromArray($arr)
-    {
-        return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @return \stdClass the _calculations item in the entity
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
-                    null,
-                    $this->fields_calculator->retrieveCalculatedFieldValue(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext($context)
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return EEM_Base::caps_read;
-        }
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validateDefaultQueryParams($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = EEM_Base::default_where_conditions_all;
-        }
-        if (in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )) {
-            return $default_query_params;
-        } else {
-            return EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-    /**
-     * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param EEM_Base $model
-     * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
-     * @return array like what EEM_Base::get_all() expects or FALSE to indicate
-     *                                    that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string) $query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_parameters['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_parameters['default_where_conditions']
-            );
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extractIncludesForThisModel($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array|WP_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                array_shift($model_rows),
-                $request
-            );
-        } else {
-            // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                // you got shafted- it existed but we didn't want to tell you!
-                return new WP_Error(
-                    'rest_user_cannot_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                // it's not you. It just doesn't exist
-                return new WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->fields_calculator = new CalculatedModelFields();
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version    The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return array();
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 */
+	protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @param string          $related_model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$related_model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return WP_Error|array
+	 * @throws RestException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return array|WP_Error
+	 * @throws EE_Error
+	 */
+	public function getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 */
+	protected function setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request $rest_request
+	 * @param string          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->getModelVersionInfo(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				$timezone = $field_value->getTimezone();
+				EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+				$result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$field_value,
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				EEH_DTT_Helper::setTimezone($field_value, $timezone);
+				$result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$field_value,
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 */
+	protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param EEM_Base         $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array           $entity_array
+	 * @param array           $db_row
+	 * @return array the modified entity
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+																							 instanceof
+																							 WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function removeModelNamesFromArray($arr)
+	{
+		return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @return \stdClass the _calculations item in the entity
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
+					null,
+					$this->fields_calculator->retrieveCalculatedFieldValue(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext($context)
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return EEM_Base::caps_read;
+		}
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validateDefaultQueryParams($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = EEM_Base::default_where_conditions_all;
+		}
+		if (in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)) {
+			return $default_query_params;
+		} else {
+			return EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+	/**
+	 * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
+	 * @return array like what EEM_Base::get_all() expects or FALSE to indicate
+	 *                                    that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string) $query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_parameters['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_parameters['default_where_conditions']
+			);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extractIncludesForThisModel($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array|WP_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				array_shift($model_rows),
+				$request
+			);
+		} else {
+			// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				// you got shafted- it existed but we didn't want to tell you!
+				return new WP_Error(
+					'rest_user_cannot_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						strtolower($model->get_this_model_name()),
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					array('status' => 403)
+				);
+			} else {
+				// it's not you. It just doesn't exist
+				return new WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -64,7 +64,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -102,7 +102,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -159,11 +159,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -172,9 +172,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -196,9 +196,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -238,7 +238,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -283,7 +283,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -298,7 +298,7 @@ 
                 );
             }
             $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -335,7 +335,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -347,7 +347,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -382,7 +382,7 @@ 
         $context = $this->validateContext($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         // check if they can access the 1st model object
@@ -399,7 +399,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('main model query params', $restricted_query_params);
         $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $model->exists($restricted_query_params)
         )
@@ -432,13 +432,13 @@ 
         }
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -489,7 +489,7 @@ 
      */
     public function getEntitiesFromRelation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -531,7 +531,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -564,7 +564,7 @@ 
      */
     public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -645,8 +645,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -656,7 +656,7 @@ 
                     )
                 );
             }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
+            $model_object_classname = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -667,13 +667,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -682,7 +682,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -690,19 +690,19 @@ 
                 $field_value = $field_obj->prepare_for_set_from_db($field_value);
                 $timezone = $field_value->getTimezone();
                 EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                $result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $result[$field_name.'_gmt'] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $field_value,
                     $this->getModelVersionInfo()->requestedVersion()
                 );
                 EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                $result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $result[$field_name] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $field_value,
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -754,7 +754,7 @@ 
     protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -779,7 +779,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -795,12 +795,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -829,13 +829,13 @@ 
         $db_row = array()
     ) {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -881,7 +881,7 @@ 
                     $relation_obj,
                     $pretend_related_request
                 );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results
                                                                                              instanceof
                                                                                              WP_Error
                     ? null
@@ -1013,7 +1013,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1038,7 +1038,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = EEM_Base::default_where_conditions_all;
         }
         if (in_array(
@@ -1121,14 +1121,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
+            if ( ! is_array($query_parameters['limit'])) {
                 $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -1174,9 +1174,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1194,9 +1194,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1228,17 +1228,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1277,9 +1277,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1319,7 +1319,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 array_shift($model_rows),
@@ -1329,10 +1329,10 @@ 
             // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
             $lowercase_model_name = strtolower($model->get_this_model_name());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 // you got shafted- it existed but we didn't want to tell you!
                 return new WP_Error(
-                    'rest_user_cannot_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,