eventespresso / event-espresso-core

core/EE_Config.core.php

Indentation +40 added lines, -40 removed lines

@@ -155,12 +155,12 @@ 
 	 */
 	public static function reset( $hard_reset = false, $reinstantiate = true ) {
 		if ( self::$_instance instanceof EE_Config ) {
-            if ($hard_reset) {
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
+			if ($hard_reset) {
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
 		}
 		self::$_instance = null;
 		//we don't need to reset the static properties imo because those should
@@ -2211,7 +2211,7 @@ 
 		$table_analysis = EE_Registry::instance()->create( 'TableAnalysis', array(), true );
 		// get country code from organization settings or use default
 		$ORG_CNT = isset( EE_Registry::instance()->CFG->organization )
-		           && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
 			? EE_Registry::instance()->CFG->organization->CNT_ISO
 			: '';
 		// but override if requested
@@ -2521,12 +2521,12 @@ 
 	public $help_tour_activation;
 
 	/**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
 	 */
 	private $encode_session_data = false;
 
@@ -2591,21 +2591,21 @@ 
 
 
 
-    /**
-     * @return boolean
-     */
-    public function encode_session_data() {
-        return filter_var( $this->encode_session_data, FILTER_VALIDATE_BOOLEAN );
-    }
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data() {
+		return filter_var( $this->encode_session_data, FILTER_VALIDATE_BOOLEAN );
+	}
 
 
 
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data( $encode_session_data ) {
-        $this->encode_session_data = filter_var( $encode_session_data, FILTER_VALIDATE_BOOLEAN );
-    }
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data( $encode_session_data ) {
+		$this->encode_session_data = filter_var( $encode_session_data, FILTER_VALIDATE_BOOLEAN );
+	}
 
 
 
@@ -2649,13 +2649,13 @@ 
 	public $current_espresso_theme;
 
 	/**
-	* @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-	*/
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
 	public $EED_Ticket_Selector;
 
 	/**
-	* @var EE_Event_Single_Config $EED_Event_Single
-	*/
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
 	public $EED_Event_Single;
 
 	/**
@@ -2981,8 +2981,8 @@ 
 	 */
 	public function max_input_vars_limit_check( $input_count = 0 ) {
 		if ( ! empty( $this->php->max_input_vars )
-		     && ( $input_count >= $this->php->max_input_vars )
-		     && ( PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9 )
+			 && ( $input_count >= $this->php->max_input_vars )
+			 && ( PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9 )
 		) {
 			return sprintf(
 				__(
@@ -3026,22 +3026,22 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 

Spacing +398 added lines, -398 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -133,7 +133,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EE_Config ) {
+		if ( ! self::$_instance instanceof EE_Config) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -153,8 +153,8 @@ 
 	 *                               site was put into maintenance mode)
 	 * @return EE_Config
 	 */
-	public static function reset( $hard_reset = false, $reinstantiate = true ) {
-		if ( self::$_instance instanceof EE_Config ) {
+	public static function reset($hard_reset = false, $reinstantiate = true) {
+		if (self::$_instance instanceof EE_Config) {
             if ($hard_reset) {
                 self::$_instance->_addon_option_names = array();
                 self::$_instance->_initialize_config();
@@ -166,7 +166,7 @@ 
 		//we don't need to reset the static properties imo because those should
 		//only change when a module is added or removed. Currently we don't
 		//support removing a module during a request when it previously existed
-		if ( $reinstantiate ) {
+		if ($reinstantiate) {
 			return self::instance();
 		} else {
 			return null;
@@ -181,8 +181,8 @@ 
 	 * @access    private
 	 */
 	private function __construct() {
-		do_action( 'AHEE__EE_Config__construct__begin', $this );
-		EE_Config::$_logging_enabled = apply_filters( 'FHEE__EE_Config___construct__logging_enabled', false );
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
 		// setup empty config classes
 		$this->_initialize_config();
 		// load existing EE site settings
@@ -192,17 +192,17 @@ 
 		//  register shortcodes and modules
 		add_action(
 			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-			array( $this, 'register_shortcodes_and_modules' ),
+			array($this, 'register_shortcodes_and_modules'),
 			999
 		);
 		//  initialize shortcodes and modules
-		add_action( 'AHEE__EE_System__core_loaded_and_ready', array( $this, 'initialize_shortcodes_and_modules' ) );
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
 		// register widgets
-		add_action( 'widgets_init', array( $this, 'widgets_init' ), 10 );
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
 		// shutdown
-		add_action( 'shutdown', array( $this, 'shutdown' ), 10 );
+		add_action('shutdown', array($this, 'shutdown'), 10);
 		// construct__end hook
-		do_action( 'AHEE__EE_Config__construct__end', $this );
+		do_action('AHEE__EE_Config__construct__end', $this);
 		// hardcoded hack
 		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
 	}
@@ -224,7 +224,7 @@ 
 	 * @return string current theme set.
 	 */
 	public static function get_current_theme() {
-		return isset( self::$_instance->template_settings->current_espresso_theme )
+		return isset(self::$_instance->template_settings->current_espresso_theme)
 			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
 	}
 
@@ -239,7 +239,7 @@ 
 	private function _initialize_config() {
 		EE_Config::trim_log();
 		//set defaults
-		$this->_addon_option_names = get_option( EE_Config::ADDON_OPTION_NAMES, array() );
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
 		$this->addons = new stdClass();
 		// set _module_route_map
 		EE_Config::$_module_route_map = array();
@@ -259,9 +259,9 @@ 
 	 */
 	private function _load_core_config() {
 		// load_core_config__start hook
-		do_action( 'AHEE__EE_Config___load_core_config__start', $this );
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
 		$espresso_config = $this->get_espresso_config();
-		foreach ( $espresso_config as $config => $settings ) {
+		foreach ($espresso_config as $config => $settings) {
 			// load_core_config__start hook
 			$settings = apply_filters(
 				'FHEE__EE_Config___load_core_config__config_settings',
@@ -269,22 +269,22 @@ 
 				$config,
 				$this
 			);
-			if ( is_object( $settings ) && property_exists( $this, $config ) ) {
-				$this->{$config} = apply_filters( 'FHEE__EE_Config___load_core_config__' . $config, $settings );
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings);
 				//call configs populate method to ensure any defaults are set for empty values.
-				if ( method_exists( $settings, 'populate' ) ) {
+				if (method_exists($settings, 'populate')) {
 					$this->{$config}->populate();
 				}
-				if ( method_exists( $settings, 'do_hooks' ) ) {
+				if (method_exists($settings, 'do_hooks')) {
 					$this->{$config}->do_hooks();
 				}
 			}
 		}
-		if ( apply_filters( 'FHEE__EE_Config___load_core_config__update_espresso_config', false ) ) {
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
 			$this->update_espresso_config();
 		}
 		// load_core_config__end hook
-		do_action( 'AHEE__EE_Config___load_core_config__end', $this );
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
 	}
 
 
@@ -299,23 +299,23 @@ 
 		$this->core = $this->core instanceof EE_Core_Config
 			? $this->core
 			: new EE_Core_Config();
-		$this->core = apply_filters( 'FHEE__EE_Config___initialize_config__core', $this->core );
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
 		$this->organization = $this->organization instanceof EE_Organization_Config
 			? $this->organization
 			: new EE_Organization_Config();
-		$this->organization = apply_filters( 'FHEE__EE_Config___initialize_config__organization', $this->organization );
+		$this->organization = apply_filters('FHEE__EE_Config___initialize_config__organization', $this->organization);
 		$this->currency = $this->currency instanceof EE_Currency_Config
 			? $this->currency
 			: new EE_Currency_Config();
-		$this->currency = apply_filters( 'FHEE__EE_Config___initialize_config__currency', $this->currency );
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
 		$this->registration = $this->registration instanceof EE_Registration_Config
 			? $this->registration
 			: new EE_Registration_Config();
-		$this->registration = apply_filters( 'FHEE__EE_Config___initialize_config__registration', $this->registration );
+		$this->registration = apply_filters('FHEE__EE_Config___initialize_config__registration', $this->registration);
 		$this->admin = $this->admin instanceof EE_Admin_Config
 			? $this->admin
 			: new EE_Admin_Config();
-		$this->admin = apply_filters( 'FHEE__EE_Config___initialize_config__admin', $this->admin );
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
 		$this->template_settings = $this->template_settings instanceof EE_Template_Config
 			? $this->template_settings
 			: new EE_Template_Config();
@@ -326,19 +326,19 @@ 
 		$this->map_settings = $this->map_settings instanceof EE_Map_Config
 			? $this->map_settings
 			: new EE_Map_Config();
-		$this->map_settings = apply_filters( 'FHEE__EE_Config___initialize_config__map_settings', $this->map_settings );
+		$this->map_settings = apply_filters('FHEE__EE_Config___initialize_config__map_settings', $this->map_settings);
 		$this->environment = $this->environment instanceof EE_Environment_Config
 			? $this->environment
 			: new EE_Environment_Config();
-		$this->environment = apply_filters( 'FHEE__EE_Config___initialize_config__environment', $this->environment );
+		$this->environment = apply_filters('FHEE__EE_Config___initialize_config__environment', $this->environment);
 		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
 			? $this->tax_settings
 			: new EE_Tax_Config();
-		$this->tax_settings = apply_filters( 'FHEE__EE_Config___initialize_config__tax_settings', $this->tax_settings );
+		$this->tax_settings = apply_filters('FHEE__EE_Config___initialize_config__tax_settings', $this->tax_settings);
 		$this->gateway = $this->gateway instanceof EE_Gateway_Config
 			? $this->gateway
 			: new EE_Gateway_Config();
-		$this->gateway = apply_filters( 'FHEE__EE_Config___initialize_config__gateway', $this->gateway );
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
 	}
 
 
@@ -353,7 +353,7 @@ 
 		// grab espresso configuration
 		return apply_filters(
 			'FHEE__EE_Config__get_espresso_config__CFG',
-			get_option( EE_Config::OPTION_NAME, array() )
+			get_option(EE_Config::OPTION_NAME, array())
 		);
 	}
 
@@ -367,12 +367,12 @@ 
 	 * @param        $old_value
 	 * @param        $value
 	 */
-	public function double_check_config_comparison( $option = '', $old_value, $value ) {
+	public function double_check_config_comparison($option = '', $old_value, $value) {
 		// make sure we're checking the ee config
-		if ( $option === EE_Config::OPTION_NAME ) {
+		if ($option === EE_Config::OPTION_NAME) {
 			// run a loose comparison of the old value against the new value for type and properties,
 			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-			if ( $value != $old_value ) {
+			if ($value != $old_value) {
 				// if they are NOT the same, then remove the hook,
 				// which means the subsequent update results will be based solely on the update query results
 				// the reason we do this is because, as stated above,
@@ -387,7 +387,7 @@ 
 				// the string it sees in the db looks the same as the new one it has been passed!!!
 				// This results in the query returning an "affected rows" value of ZERO,
 				// which gets returned immediately by WP update_option and looks like an error.
-				remove_action( 'update_option', array( $this, 'check_config_updated' ) );
+				remove_action('update_option', array($this, 'check_config_updated'));
 			}
 		}
 	}
@@ -401,11 +401,11 @@ 
 	 */
 	protected function _reset_espresso_addon_config() {
 		$this->_addon_option_names = array();
-		foreach ( $this->addons as $addon_name => $addon_config_obj ) {
-			$addon_config_obj = maybe_unserialize( $addon_config_obj );
-			$config_class = get_class( $addon_config_obj );
-			if ( $addon_config_obj instanceof $config_class && ! $addon_config_obj instanceof __PHP_Incomplete_Class ) {
-				$this->update_config( 'addons', $addon_name, $addon_config_obj, false );
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			$config_class = get_class($addon_config_obj);
+			if ($addon_config_obj instanceof $config_class && ! $addon_config_obj instanceof __PHP_Incomplete_Class) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
 			}
 			$this->addons->{$addon_name} = null;
 		}
@@ -421,22 +421,22 @@ 
 	 * @param   bool $add_error
 	 * @return   bool
 	 */
-	public function update_espresso_config( $add_success = false, $add_error = true ) {
+	public function update_espresso_config($add_success = false, $add_error = true) {
 		// don't allow config updates during WP heartbeats
-		if ( \EE_Registry::instance()->REQ->get( 'action', '' ) === 'heartbeat' ) {
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
 			return false;
 		}
 		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
 		//$clone = clone( self::$_instance );
 		//self::$_instance = NULL;
-		do_action( 'AHEE__EE_Config__update_espresso_config__begin', $this );
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
 		$this->_reset_espresso_addon_config();
 		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
 		// but BEFORE the actual update occurs
-		add_action( 'update_option', array( $this, 'double_check_config_comparison' ), 1, 3 );
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
 		// now update "ee_config"
-		$saved = update_option( EE_Config::OPTION_NAME, $this );
-		EE_Config::log( EE_Config::OPTION_NAME );
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		EE_Config::log(EE_Config::OPTION_NAME);
 		// if not saved... check if the hook we just added still exists;
 		// if it does, it means one of two things:
 		// 		that update_option bailed at the ( $value === $old_value ) conditional,
@@ -447,17 +447,17 @@ 
 		// but just means no update occurred, so don't display an error to the user.
 		// BUT... if update_option returns FALSE, AND the hook is missing,
 		// then it means that something truly went wrong
-		$saved = ! $saved ? has_action( 'update_option', array( $this, 'double_check_config_comparison' ) ) : $saved;
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
 		// remove our action since we don't want it in the system anymore
-		remove_action( 'update_option', array( $this, 'double_check_config_comparison' ), 1 );
-		do_action( 'AHEE__EE_Config__update_espresso_config__end', $this, $saved );
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
 		//self::$_instance = $clone;
 		//unset( $clone );
 		// if config remains the same or was updated successfully
-		if ( $saved ) {
-			if ( $add_success ) {
+		if ($saved) {
+			if ($add_success) {
 				EE_Error::add_success(
-					__( 'The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso' ),
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
 					__FILE__,
 					__FUNCTION__,
 					__LINE__
@@ -465,9 +465,9 @@ 
 			}
 			return true;
 		} else {
-			if ( $add_error ) {
+			if ($add_error) {
 				EE_Error::add_error(
-					__( 'The Event Espresso Configuration Settings were not updated.', 'event_espresso' ),
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
 					__FILE__,
 					__FUNCTION__,
 					__LINE__
@@ -496,16 +496,16 @@ 
 		$name = '',
 		$config_class = '',
 		$config_obj = null,
-		$tests_to_run = array( 1, 2, 3, 4, 5, 6, 7, 8 ),
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
 		$display_errors = true
 	) {
 		try {
-			foreach ( $tests_to_run as $test ) {
-				switch ( $test ) {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
 					// TEST #1 : check that section was set
 					case 1 :
-						if ( empty( $section ) ) {
-							if ( $display_errors ) {
+						if (empty($section)) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
 										__(
@@ -521,11 +521,11 @@ 
 						break;
 					// TEST #2 : check that settings section exists
 					case 2 :
-						if ( ! isset( $this->{$section} ) ) {
-							if ( $display_errors ) {
+						if ( ! isset($this->{$section} )) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
-										__( 'The "%s" configuration section does not exist.', 'event_espresso' ),
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
 										$section
 									)
 								);
@@ -536,9 +536,9 @@ 
 					// TEST #3 : check that section is the proper format
 					case 3 :
 						if (
-						! ( $this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass )
+						! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
 						) {
-							if ( $display_errors ) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
 										__(
@@ -554,8 +554,8 @@ 
 						break;
 					// TEST #4 : check that config section name has been set
 					case 4 :
-						if ( empty( $name ) ) {
-							if ( $display_errors ) {
+						if (empty($name)) {
+							if ($display_errors) {
 								throw new EE_Error(
 									__(
 										'No name has been provided for the specific configuration section.',
@@ -568,8 +568,8 @@ 
 						break;
 					// TEST #5 : check that a config class name has been set
 					case 5 :
-						if ( empty( $config_class ) ) {
-							if ( $display_errors ) {
+						if (empty($config_class)) {
+							if ($display_errors) {
 								throw new EE_Error(
 									__(
 										'No class name has been provided for the specific configuration section.',
@@ -582,8 +582,8 @@ 
 						break;
 					// TEST #6 : verify config class is accessible
 					case 6 :
-						if ( ! class_exists( $config_class ) ) {
-							if ( $display_errors ) {
+						if ( ! class_exists($config_class)) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
 										__(
@@ -599,11 +599,11 @@ 
 						break;
 					// TEST #7 : check that config has even been set
 					case 7 :
-						if ( ! isset( $this->{$section}->{$name} ) ) {
-							if ( $display_errors ) {
+						if ( ! isset($this->{$section}->{$name} )) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
-										__( 'No configuration has been set for "%1$s->%2$s".', 'event_espresso' ),
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
 										$section,
 										$name
 									)
@@ -612,13 +612,13 @@ 
 							return false;
 						} else {
 							// and make sure it's not serialized
-							$this->{$section}->{$name} = maybe_unserialize( $this->{$section}->{$name} );
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name} );
 						}
 						break;
 					// TEST #8 : check that config is the requested type
 					case 8 :
-						if ( ! $this->{$section}->{$name} instanceof $config_class ) {
-							if ( $display_errors ) {
+						if ( ! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
 										__(
@@ -636,12 +636,12 @@ 
 						break;
 					// TEST #9 : verify config object
 					case 9 :
-						if ( ! $config_obj instanceof EE_Config_Base ) {
-							if ( $display_errors ) {
+						if ( ! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
 								throw new EE_Error(
 									sprintf(
-										__( 'The "%s" class is not an instance of EE_Config_Base.', 'event_espresso' ),
-										print_r( $config_obj, true )
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
 									)
 								);
 							}
@@ -650,7 +650,7 @@ 
 						break;
 				}
 			}
-		} catch ( EE_Error $e ) {
+		} catch (EE_Error $e) {
 			$e->get_error();
 		}
 		// you have successfully run the gauntlet
@@ -667,8 +667,8 @@ 
 	 * @param        string $name
 	 * @return        string
 	 */
-	private function _generate_config_option_name( $section = '', $name = '' ) {
-		return 'ee_config-' . strtolower( $section . '-' . str_replace( array( 'EE_', 'EED_' ), '', $name ) );
+	private function _generate_config_option_name($section = '', $name = '') {
+		return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name));
 	}
 
 
@@ -682,10 +682,10 @@ 
 	 * @param    string $name
 	 * @return    string
 	 */
-	private function _set_config_class( $config_class = '', $name = '' ) {
-		return ! empty( $config_class )
+	private function _set_config_class($config_class = '', $name = '') {
+		return ! empty($config_class)
 			? $config_class
-			: str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $name ) ) ) . '_Config';
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config';
 	}
 
 
@@ -700,36 +700,36 @@ 
 	 * @param    EE_Config_Base $config_obj
 	 * @return    EE_Config_Base
 	 */
-	public function set_config( $section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null ) {
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null) {
 		// ensure config class is set to something
-		$config_class = $this->_set_config_class( $config_class, $name );
+		$config_class = $this->_set_config_class($config_class, $name);
 		// run tests 1-4, 6, and 7 to verify all config params are set and valid
-		if ( ! $this->_verify_config_params( $section, $name, $config_class, null, array( 1, 2, 3, 4, 5, 6 ) ) ) {
+		if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
 			return null;
 		}
-		$config_option_name = $this->_generate_config_option_name( $section, $name );
+		$config_option_name = $this->_generate_config_option_name($section, $name);
 		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-		if ( ! isset( $this->_addon_option_names[ $config_option_name ] ) ) {
-			$this->_addon_option_names[ $config_option_name ] = $config_class;
+		if ( ! isset($this->_addon_option_names[$config_option_name])) {
+			$this->_addon_option_names[$config_option_name] = $config_class;
 			$this->update_addon_option_names();
 		}
 		// verify the incoming config object but suppress errors
-		if ( ! $this->_verify_config_params( $section, $name, $config_class, $config_obj, array( 9 ), false ) ) {
+		if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
 			$config_obj = new $config_class();
 		}
-		if ( get_option( $config_option_name ) ) {
-			EE_Config::log( $config_option_name );
-			update_option( $config_option_name, $config_obj );
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
 			$this->{$section}->{$name} = $config_obj;
 			return $this->{$section}->{$name};
 		} else {
 			// create a wp-option for this config
-			if ( add_option( $config_option_name, $config_obj, '', 'no' ) ) {
-				$this->{$section}->{$name} = maybe_unserialize( $config_obj );
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
 				return $this->{$section}->{$name};
 			} else {
 				EE_Error::add_error(
-					sprintf( __( 'The "%s" could not be saved to the database.', 'event_espresso' ), $config_class ),
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
 					__FILE__,
 					__FUNCTION__,
 					__LINE__
@@ -752,46 +752,46 @@ 
 	 * @param    bool                  $throw_errors
 	 * @return    bool
 	 */
-	public function update_config( $section = '', $name = '', $config_obj = '', $throw_errors = true ) {
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true) {
 		// don't allow config updates during WP heartbeats
-		if ( \EE_Registry::instance()->REQ->get( 'action', '' ) === 'heartbeat' ) {
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
 			return false;
 		}
-		$config_obj = maybe_unserialize( $config_obj );
+		$config_obj = maybe_unserialize($config_obj);
 		// get class name of the incoming object
-		$config_class = get_class( $config_obj );
+		$config_class = get_class($config_obj);
 		// run tests 1-5 and 9 to verify config
 		if ( ! $this->_verify_config_params(
 			$section,
 			$name,
 			$config_class,
 			$config_obj,
-			array( 1, 2, 3, 4, 7, 9 )
+			array(1, 2, 3, 4, 7, 9)
 		)
 		) {
 			return false;
 		}
-		$config_option_name = $this->_generate_config_option_name( $section, $name );
+		$config_option_name = $this->_generate_config_option_name($section, $name);
 		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-		if ( ! isset( $this->_addon_option_names[ $config_option_name ] ) ) {
+		if ( ! isset($this->_addon_option_names[$config_option_name])) {
 			// save new config to db
-			if( $this->set_config( $section, $name, $config_class, $config_obj ) ) {
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
 				return true;
 			}
 		} else {
 			// first check if the record already exists
-			$existing_config = get_option( $config_option_name );
-			$config_obj = serialize( $config_obj );
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
 			// just return if db record is already up to date (NOT type safe comparison)
-			if ( $existing_config == $config_obj ) {
+			if ($existing_config == $config_obj) {
 				$this->{$section}->{$name} = $config_obj;
 				return true;
-			} else if ( update_option( $config_option_name, $config_obj ) ) {
-				EE_Config::log( $config_option_name );
+			} else if (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
 				// update wp-option for this config class
 				$this->{$section}->{$name} = $config_obj;
 				return true;
-			} elseif ( $throw_errors ) {
+			} elseif ($throw_errors) {
 				EE_Error::add_error(
 					sprintf(
 						__(
@@ -799,7 +799,7 @@ 
 							'event_espresso'
 						),
 						$config_class,
-						'EE_Config->' . $section . '->' . $name
+						'EE_Config->'.$section.'->'.$name
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -821,34 +821,34 @@ 
 	 * @param    string $config_class
 	 * @return    mixed EE_Config_Base | NULL
 	 */
-	public function get_config( $section = '', $name = '', $config_class = '' ) {
+	public function get_config($section = '', $name = '', $config_class = '') {
 		// ensure config class is set to something
-		$config_class = $this->_set_config_class( $config_class, $name );
+		$config_class = $this->_set_config_class($config_class, $name);
 		// run tests 1-4, 6 and 7 to verify that all params have been set
-		if ( ! $this->_verify_config_params( $section, $name, $config_class, null, array( 1, 2, 3, 4, 5, 6 ) ) ) {
+		if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
 			return null;
 		}
 		// now test if the requested config object exists, but suppress errors
-		if ( $this->_verify_config_params( $section, $name, $config_class, null, array( 7, 8 ), false ) ) {
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
 			// config already exists, so pass it back
 			return $this->{$section}->{$name};
 		}
 		// load config option from db if it exists
-		$config_obj = $this->get_config_option( $this->_generate_config_option_name( $section, $name ) );
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
 		// verify the newly retrieved config object, but suppress errors
-		if ( $this->_verify_config_params( $section, $name, $config_class, $config_obj, array( 9 ), false ) ) {
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
 			// config is good, so set it and pass it back
 			$this->{$section}->{$name} = $config_obj;
 			return $this->{$section}->{$name};
 		}
 		// oops! $config_obj is not already set and does not exist in the db, so create a new one
-		$config_obj = $this->set_config( $section, $name, $config_class );
+		$config_obj = $this->set_config($section, $name, $config_class);
 		// verify the newly created config object
-		if ( $this->_verify_config_params( $section, $name, $config_class, $config_obj, array( 9 ) ) ) {
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
 			return $this->{$section}->{$name};
 		} else {
 			EE_Error::add_error(
-				sprintf( __( 'The "%s" could not be retrieved from the database.', 'event_espresso' ), $config_class ),
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -866,11 +866,11 @@ 
 	 * @param    string $config_option_name
 	 * @return    mixed EE_Config_Base | FALSE
 	 */
-	public function get_config_option( $config_option_name = '' ) {
+	public function get_config_option($config_option_name = '') {
 		// retrieve the wp-option for this config class.
-		$config_option = maybe_unserialize( get_option( $config_option_name, array() ) );
-		if ( empty( $config_option ) ) {
-			EE_Config::log( $config_option_name . '-NOT-FOUND' );
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name.'-NOT-FOUND');
 		}
 		return $config_option;
 	}
@@ -882,17 +882,17 @@ 
 	 *
 	 * @param string $config_option_name
 	 */
-	public static function log( $config_option_name = '' ) {
-		if ( EE_Config::logging_enabled() && ! empty( $config_option_name ) ) {
-			$config_log = get_option( EE_Config::LOG_NAME, array() );
+	public static function log($config_option_name = '') {
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
 			//copy incoming $_REQUEST and sanitize it so we can save it
 			$_request = $_REQUEST;
-			array_walk_recursive( $_request, 'sanitize_text_field' );
-			$config_log[ (string) microtime( true ) ] = array(
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[(string) microtime(true)] = array(
 				'config_name' => $config_option_name,
 				'request'     => $_request,
 			);
-			update_option( EE_Config::LOG_NAME, $config_log );
+			update_option(EE_Config::LOG_NAME, $config_log);
 		}
 	}
 
@@ -903,15 +903,15 @@ 
 	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
 	 */
 	public static function trim_log() {
-		if ( ! EE_Config::logging_enabled() ) {
+		if ( ! EE_Config::logging_enabled()) {
 			return;
 		}
-		$config_log = maybe_unserialize( get_option( EE_Config::LOG_NAME, array() ) );
-		$log_length = count( $config_log );
-		if ( $log_length > EE_Config::LOG_LENGTH ) {
-			ksort( $config_log );
-			$config_log = array_slice( $config_log, $log_length - EE_Config::LOG_LENGTH, null, true );
-			update_option( EE_Config::LOG_NAME, $config_log );
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
 		}
 	}
 
@@ -926,14 +926,14 @@ 
 	 * @return    string
 	 */
 	public static function get_page_for_posts() {
-		$page_for_posts = get_option( 'page_for_posts' );
-		if ( ! $page_for_posts ) {
+		$page_for_posts = get_option('page_for_posts');
+		if ( ! $page_for_posts) {
 			return 'posts';
 		}
 		/** @type WPDB $wpdb */
 		global $wpdb;
 		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-		return $wpdb->get_var( $wpdb->prepare( $SQL, $page_for_posts ) );
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
 	}
 
 
@@ -989,17 +989,17 @@ 
 			)
 		) {
 			// grab list of installed widgets
-			$widgets_to_register = glob( EE_WIDGETS . '*', GLOB_ONLYDIR );
+			$widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR);
 			// filter list of modules to register
 			$widgets_to_register = apply_filters(
 				'FHEE__EE_Config__register_widgets__widgets_to_register',
 				$widgets_to_register
 			);
-			if ( ! empty( $widgets_to_register ) ) {
+			if ( ! empty($widgets_to_register)) {
 				// cycle thru widget folders
-				foreach ( $widgets_to_register as $widget_path ) {
+				foreach ($widgets_to_register as $widget_path) {
 					// add to list of installed widget modules
-					EE_Config::register_ee_widget( $widget_path );
+					EE_Config::register_ee_widget($widget_path);
 				}
 			}
 			// filter list of installed modules
@@ -1019,57 +1019,57 @@ 
 	 * @param    string $widget_path - full path up to and including widget folder
 	 * @return    void
 	 */
-	public static function register_ee_widget( $widget_path = null ) {
-		do_action( 'AHEE__EE_Config__register_widget__begin', $widget_path );
+	public static function register_ee_widget($widget_path = null) {
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
 		$widget_ext = '.widget.php';
 		// make all separators match
-		$widget_path = rtrim( str_replace( '/\\', DS, $widget_path ), DS );
+		$widget_path = rtrim(str_replace('/\\', DS, $widget_path), DS);
 		// does the file path INCLUDE the actual file name as part of the path ?
-		if ( strpos( $widget_path, $widget_ext ) !== false ) {
+		if (strpos($widget_path, $widget_ext) !== false) {
 			// grab and shortcode file name from directory name and break apart at dots
-			$file_name = explode( '.', basename( $widget_path ) );
+			$file_name = explode('.', basename($widget_path));
 			// take first segment from file name pieces and remove class prefix if it exists
-			$widget = strpos( $file_name[0], 'EEW_' ) === 0 ? substr( $file_name[0], 4 ) : $file_name[0];
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
 			// sanitize shortcode directory name
-			$widget = sanitize_key( $widget );
+			$widget = sanitize_key($widget);
 			// now we need to rebuild the shortcode path
-			$widget_path = explode( DS, $widget_path );
+			$widget_path = explode(DS, $widget_path);
 			// remove last segment
-			array_pop( $widget_path );
+			array_pop($widget_path);
 			// glue it back together
-			$widget_path = implode( DS, $widget_path );
+			$widget_path = implode(DS, $widget_path);
 		} else {
 			// grab and sanitize widget directory name
-			$widget = sanitize_key( basename( $widget_path ) );
+			$widget = sanitize_key(basename($widget_path));
 		}
 		// create classname from widget directory name
-		$widget = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $widget ) ) );
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
 		// add class prefix
-		$widget_class = 'EEW_' . $widget;
+		$widget_class = 'EEW_'.$widget;
 		// does the widget exist ?
-		if ( ! is_readable( $widget_path . DS . $widget_class . $widget_ext ) ) {
+		if ( ! is_readable($widget_path.DS.$widget_class.$widget_ext)) {
 			$msg = sprintf(
 				__(
 					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
 					'event_espresso'
 				),
 				$widget_class,
-				$widget_path . DS . $widget_class . $widget_ext
+				$widget_path.DS.$widget_class.$widget_ext
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return;
 		}
 		// load the widget class file
-		require_once( $widget_path . DS . $widget_class . $widget_ext );
+		require_once($widget_path.DS.$widget_class.$widget_ext);
 		// verify that class exists
-		if ( ! class_exists( $widget_class ) ) {
-			$msg = sprintf( __( 'The requested %s widget class does not exist.', 'event_espresso' ), $widget_class );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return;
 		}
-		register_widget( $widget_class );
+		register_widget($widget_class);
 		// add to array of registered widgets
-		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path.DS.$widget_class.$widget_ext;
 	}
 
 
@@ -1082,17 +1082,17 @@ 
 	 */
 	private function _register_shortcodes() {
 		// grab list of installed shortcodes
-		$shortcodes_to_register = glob( EE_SHORTCODES . '*', GLOB_ONLYDIR );
+		$shortcodes_to_register = glob(EE_SHORTCODES.'*', GLOB_ONLYDIR);
 		// filter list of modules to register
 		$shortcodes_to_register = apply_filters(
 			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
 			$shortcodes_to_register
 		);
-		if ( ! empty( $shortcodes_to_register ) ) {
+		if ( ! empty($shortcodes_to_register)) {
 			// cycle thru shortcode folders
-			foreach ( $shortcodes_to_register as $shortcode_path ) {
+			foreach ($shortcodes_to_register as $shortcode_path) {
 				// add to list of installed shortcode modules
-				EE_Config::register_shortcode( $shortcode_path );
+				EE_Config::register_shortcode($shortcode_path);
 			}
 		}
 		// filter list of installed modules
@@ -1111,64 +1111,64 @@ 
 	 * @param    string $shortcode_path - full path up to and including shortcode folder
 	 * @return    bool
 	 */
-	public static function register_shortcode( $shortcode_path = null ) {
-		do_action( 'AHEE__EE_Config__register_shortcode__begin', $shortcode_path );
+	public static function register_shortcode($shortcode_path = null) {
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
 		$shortcode_ext = '.shortcode.php';
 		// make all separators match
-		$shortcode_path = str_replace( array( '\\', '/' ), DS, $shortcode_path );
+		$shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
 		// does the file path INCLUDE the actual file name as part of the path ?
-		if ( strpos( $shortcode_path, $shortcode_ext ) !== false ) {
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
 			// grab shortcode file name from directory name and break apart at dots
-			$shortcode_file = explode( '.', basename( $shortcode_path ) );
+			$shortcode_file = explode('.', basename($shortcode_path));
 			// take first segment from file name pieces and remove class prefix if it exists
-			$shortcode = strpos( $shortcode_file[0], 'EES_' ) === 0
-				? substr( $shortcode_file[0], 4 )
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
 				: $shortcode_file[0];
 			// sanitize shortcode directory name
-			$shortcode = sanitize_key( $shortcode );
+			$shortcode = sanitize_key($shortcode);
 			// now we need to rebuild the shortcode path
-			$shortcode_path = explode( DS, $shortcode_path );
+			$shortcode_path = explode(DS, $shortcode_path);
 			// remove last segment
-			array_pop( $shortcode_path );
+			array_pop($shortcode_path);
 			// glue it back together
-			$shortcode_path = implode( DS, $shortcode_path ) . DS;
+			$shortcode_path = implode(DS, $shortcode_path).DS;
 		} else {
 			// we need to generate the filename based off of the folder name
 			// grab and sanitize shortcode directory name
-			$shortcode = sanitize_key( basename( $shortcode_path ) );
-			$shortcode_path = rtrim( $shortcode_path, DS ) . DS;
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, DS).DS;
 		}
 		// create classname from shortcode directory or file name
-		$shortcode = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $shortcode ) ) );
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
 		// add class prefix
-		$shortcode_class = 'EES_' . $shortcode;
+		$shortcode_class = 'EES_'.$shortcode;
 		// does the shortcode exist ?
-		if ( ! is_readable( $shortcode_path . DS . $shortcode_class . $shortcode_ext ) ) {
+		if ( ! is_readable($shortcode_path.DS.$shortcode_class.$shortcode_ext)) {
 			$msg = sprintf(
 				__(
 					'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
 					'event_espresso'
 				),
 				$shortcode_class,
-				$shortcode_path . DS . $shortcode_class . $shortcode_ext
+				$shortcode_path.DS.$shortcode_class.$shortcode_ext
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// load the shortcode class file
-		require_once( $shortcode_path . $shortcode_class . $shortcode_ext );
+		require_once($shortcode_path.$shortcode_class.$shortcode_ext);
 		// verify that class exists
-		if ( ! class_exists( $shortcode_class ) ) {
+		if ( ! class_exists($shortcode_class)) {
 			$msg = sprintf(
-				__( 'The requested %s shortcode class does not exist.', 'event_espresso' ),
+				__('The requested %s shortcode class does not exist.', 'event_espresso'),
 				$shortcode_class
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		$shortcode = strtoupper( $shortcode );
+		$shortcode = strtoupper($shortcode);
 		// add to array of registered shortcodes
-		EE_Registry::instance()->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		EE_Registry::instance()->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
 		return true;
 	}
 
@@ -1182,22 +1182,22 @@ 
 	 */
 	private function _register_modules() {
 		// grab list of installed modules
-		$modules_to_register = glob( EE_MODULES . '*', GLOB_ONLYDIR );
+		$modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR);
 		// filter list of modules to register
 		$modules_to_register = apply_filters(
 			'FHEE__EE_Config__register_modules__modules_to_register',
 			$modules_to_register
 		);
-		if ( ! empty( $modules_to_register ) ) {
+		if ( ! empty($modules_to_register)) {
 			// loop through folders
-			foreach ( $modules_to_register as $module_path ) {
+			foreach ($modules_to_register as $module_path) {
 				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
 				if (
-					$module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-					&& $module_path !== EE_MODULES . 'gateways'
+					$module_path !== EE_MODULES.'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES.'gateways'
 				) {
 					// add to list of installed modules
-					EE_Config::register_module( $module_path );
+					EE_Config::register_module($module_path);
 				}
 			}
 		}
@@ -1217,39 +1217,39 @@ 
 	 * @param    string $module_path - full path up to and including module folder
 	 * @return    bool
 	 */
-	public static function register_module( $module_path = null ) {
-		do_action( 'AHEE__EE_Config__register_module__begin', $module_path );
+	public static function register_module($module_path = null) {
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
 		$module_ext = '.module.php';
 		// make all separators match
-		$module_path = str_replace( array( '\\', '/' ), DS, $module_path );
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
 		// does the file path INCLUDE the actual file name as part of the path ?
-		if ( strpos( $module_path, $module_ext ) !== false ) {
+		if (strpos($module_path, $module_ext) !== false) {
 			// grab and shortcode file name from directory name and break apart at dots
-			$module_file = explode( '.', basename( $module_path ) );
+			$module_file = explode('.', basename($module_path));
 			// now we need to rebuild the shortcode path
-			$module_path = explode( DS, $module_path );
+			$module_path = explode(DS, $module_path);
 			// remove last segment
-			array_pop( $module_path );
+			array_pop($module_path);
 			// glue it back together
-			$module_path = implode( DS, $module_path ) . DS;
+			$module_path = implode(DS, $module_path).DS;
 			// take first segment from file name pieces and sanitize it
-			$module = preg_replace( '/[^a-zA-Z0-9_\-]/', '', $module_file[0] );
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
 			// ensure class prefix is added
-			$module_class = strpos( $module, 'EED_' ) !== 0 ? 'EED_' . $module : $module;
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module;
 		} else {
 			// we need to generate the filename based off of the folder name
 			// grab and sanitize module name
-			$module = strtolower( basename( $module_path ) );
-			$module = preg_replace( '/[^a-z0-9_\-]/', '', $module );
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
 			// like trailingslashit()
-			$module_path = rtrim( $module_path, DS ) . DS;
+			$module_path = rtrim($module_path, DS).DS;
 			// create classname from module directory name
-			$module = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $module ) ) );
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
 			// add class prefix
-			$module_class = 'EED_' . $module;
+			$module_class = 'EED_'.$module;
 		}
 		// does the module exist ?
-		if ( ! is_readable( $module_path . DS . $module_class . $module_ext ) ) {
+		if ( ! is_readable($module_path.DS.$module_class.$module_ext)) {
 			$msg = sprintf(
 				__(
 					'The requested %s module file could not be found or is not readable due to file permissions.',
@@ -1257,19 +1257,19 @@ 
 				),
 				$module
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// load the module class file
-		require_once( $module_path . $module_class . $module_ext );
+		require_once($module_path.$module_class.$module_ext);
 		// verify that class exists
-		if ( ! class_exists( $module_class ) ) {
-			$msg = sprintf( __( 'The requested %s module class does not exist.', 'event_espresso' ), $module_class );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// add to array of registered modules
-		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext;
 		do_action(
 			'AHEE__EE_Config__register_module__complete',
 			$module_class,
@@ -1289,26 +1289,26 @@ 
 	 */
 	private function _initialize_shortcodes() {
 		// cycle thru shortcode folders
-		foreach ( EE_Registry::instance()->shortcodes as $shortcode => $shortcode_path ) {
+		foreach (EE_Registry::instance()->shortcodes as $shortcode => $shortcode_path) {
 			// add class prefix
-			$shortcode_class = 'EES_' . $shortcode;
+			$shortcode_class = 'EES_'.$shortcode;
 			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
 			// which set hooks ?
-			if ( is_admin() ) {
+			if (is_admin()) {
 				// fire immediately
-				call_user_func( array( $shortcode_class, 'set_hooks_admin' ) );
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
 			} else {
 				// delay until other systems are online
 				add_action(
 					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-					array( $shortcode_class, 'set_hooks' )
+					array($shortcode_class, 'set_hooks')
 				);
 				// convert classname to UPPERCASE and create WP shortcode.
-				$shortcode_tag = strtoupper( $shortcode );
+				$shortcode_tag = strtoupper($shortcode);
 				// but first check if the shortcode has already been added before assigning 'fallback_shortcode_processor'
-				if ( ! shortcode_exists( $shortcode_tag ) ) {
+				if ( ! shortcode_exists($shortcode_tag)) {
 					// NOTE: this shortcode declaration will get overridden if the shortcode is successfully detected in the post content in EE_Front_Controller->_initialize_shortcodes()
-					add_shortcode( $shortcode_tag, array( $shortcode_class, 'fallback_shortcode_processor' ) );
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
 				}
 			}
 		}
@@ -1325,17 +1325,17 @@ 
 	 */
 	private function _initialize_modules() {
 		// cycle thru shortcode folders
-		foreach ( EE_Registry::instance()->modules as $module_class => $module_path ) {
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
 			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
 			// which set hooks ?
-			if ( is_admin() ) {
+			if (is_admin()) {
 				// fire immediately
-				call_user_func( array( $module_class, 'set_hooks_admin' ) );
+				call_user_func(array($module_class, 'set_hooks_admin'));
 			} else {
 				// delay until other systems are online
 				add_action(
 					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-					array( $module_class, 'set_hooks' )
+					array($module_class, 'set_hooks')
 				);
 			}
 		}
@@ -1353,29 +1353,29 @@ 
 	 * @param    string $key         - url param key indicating a route is being called
 	 * @return    bool
 	 */
-	public static function register_route( $route = null, $module = null, $method_name = null, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__register_route__begin', $route, $module, $method_name );
-		$module = str_replace( 'EED_', '', $module );
-		$module_class = 'EED_' . $module;
-		if ( ! isset( EE_Registry::instance()->modules->{$module_class} ) ) {
-			$msg = sprintf( __( 'The module %s has not been registered.', 'event_espresso' ), $module );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee') {
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_'.$module;
+		if ( ! isset(EE_Registry::instance()->modules->{$module_class} )) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( empty( $route ) ) {
-			$msg = sprintf( __( 'No route has been supplied.', 'event_espresso' ), $route );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( ! method_exists( 'EED_' . $module, $method_name ) ) {
+		if ( ! method_exists('EED_'.$module, $method_name)) {
 			$msg = sprintf(
-				__( 'A valid class method for the %s route has not been supplied.', 'event_espresso' ),
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
 				$route
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		EE_Config::$_module_route_map[ $key ][ $route ] = array( 'EED_' . $module, $method_name );
+		EE_Config::$_module_route_map[$key][$route] = array('EED_'.$module, $method_name);
 		return true;
 	}
 
@@ -1389,11 +1389,11 @@ 
 	 * @param    string $key   - url param key indicating a route is being called
 	 * @return    string
 	 */
-	public static function get_route( $route = null, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__get_route__begin', $route );
-		$route = (string) apply_filters( 'FHEE__EE_Config__get_route', $route );
-		if ( isset( EE_Config::$_module_route_map[ $key ][ $route ] ) ) {
-			return EE_Config::$_module_route_map[ $key ][ $route ];
+	public static function get_route($route = null, $key = 'ee') {
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[$key][$route])) {
+			return EE_Config::$_module_route_map[$key][$route];
 		}
 		return null;
 	}
@@ -1423,49 +1423,49 @@ 
 	 * @param    string       $key     - url param key indicating a route is being called
 	 * @return    bool
 	 */
-	public static function register_forward( $route = null, $status = 0, $forward = null, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__register_forward', $route, $status, $forward );
-		if ( ! isset( EE_Config::$_module_route_map[ $key ][ $route ] ) || empty( $route ) ) {
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') {
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
 			$msg = sprintf(
-				__( 'The module route %s for this forward has not been registered.', 'event_espresso' ),
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
 				$route
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( empty( $forward ) ) {
-			$msg = sprintf( __( 'No forwarding route has been supplied.', 'event_espresso' ), $route );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( is_array( $forward ) ) {
-			if ( ! isset( $forward[1] ) ) {
+		if (is_array($forward)) {
+			if ( ! isset($forward[1])) {
 				$msg = sprintf(
-					__( 'A class method for the %s forwarding route has not been supplied.', 'event_espresso' ),
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
 					$route
 				);
-				EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 				return false;
 			}
-			if ( ! method_exists( $forward[0], $forward[1] ) ) {
+			if ( ! method_exists($forward[0], $forward[1])) {
 				$msg = sprintf(
-					__( 'The class method %s for the %s forwarding route is in invalid.', 'event_espresso' ),
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
 					$forward[1],
 					$route
 				);
-				EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 				return false;
 			}
-		} else if ( ! function_exists( $forward ) ) {
+		} else if ( ! function_exists($forward)) {
 			$msg = sprintf(
-				__( 'The function %s for the %s forwarding route is in invalid.', 'event_espresso' ),
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
 				$forward,
 				$route
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		EE_Config::$_module_forward_map[ $key ][ $route ][ absint( $status ) ] = $forward;
+		EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward;
 		return true;
 	}
 
@@ -1481,12 +1481,12 @@ 
 	 * @param    string  $key    - url param key indicating a route is being called
 	 * @return    string
 	 */
-	public static function get_forward( $route = null, $status = 0, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__get_forward__begin', $route, $status );
-		if ( isset( EE_Config::$_module_forward_map[ $key ][ $route ][ $status ] ) ) {
+	public static function get_forward($route = null, $status = 0, $key = 'ee') {
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) {
 			return apply_filters(
 				'FHEE__EE_Config__get_forward',
-				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				EE_Config::$_module_forward_map[$key][$route][$status],
 				$route,
 				$status
 			);
@@ -1508,17 +1508,17 @@ 
 	 * @param    string  $key    - url param key indicating a route is being called
 	 * @return    bool
 	 */
-	public static function register_view( $route = null, $status = 0, $view = null, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__register_view__begin', $route, $status, $view );
-		if ( ! isset( EE_Config::$_module_route_map[ $key ][ $route ] ) || empty( $route ) ) {
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') {
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
 			$msg = sprintf(
-				__( 'The module route %s for this view has not been registered.', 'event_espresso' ),
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
 				$route
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( ! is_readable( $view ) ) {
+		if ( ! is_readable($view)) {
 			$msg = sprintf(
 				__(
 					'The %s view file could not be found or is not readable due to file permissions.',
@@ -1526,10 +1526,10 @@ 
 				),
 				$view
 			);
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		EE_Config::$_module_view_map[ $key ][ $route ][ absint( $status ) ] = $view;
+		EE_Config::$_module_view_map[$key][$route][absint($status)] = $view;
 		return true;
 	}
 
@@ -1545,12 +1545,12 @@ 
 	 * @param    string  $key    - url param key indicating a route is being called
 	 * @return    string
 	 */
-	public static function get_view( $route = null, $status = 0, $key = 'ee' ) {
-		do_action( 'AHEE__EE_Config__get_view__begin', $route, $status );
-		if ( isset( EE_Config::$_module_view_map[ $key ][ $route ][ $status ] ) ) {
+	public static function get_view($route = null, $status = 0, $key = 'ee') {
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[$key][$route][$status])) {
 			return apply_filters(
 				'FHEE__EE_Config__get_view',
-				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				EE_Config::$_module_view_map[$key][$route][$status],
 				$route,
 				$status
 			);
@@ -1561,7 +1561,7 @@ 
 
 
 	public function update_addon_option_names() {
-		update_option( EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names );
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
 	}
 
 
@@ -1589,22 +1589,22 @@ 
 	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
 	 * @throws \EE_Error
 	 */
-	public function get_pretty( $property ) {
-		if ( ! property_exists( $this, $property ) ) {
+	public function get_pretty($property) {
+		if ( ! property_exists($this, $property)) {
 			throw new EE_Error(
 				sprintf(
 					__(
 						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
 						'event_espresso'
 					),
-					get_class( $this ),
+					get_class($this),
 					$property
 				)
 			);
 		}
 		//just handling escaping of strings for now.
-		if ( is_string( $this->{$property} ) ) {
-			return stripslashes( $this->{$property} );
+		if (is_string($this->{$property} )) {
+			return stripslashes($this->{$property} );
 		}
 		return $this->{$property};
 	}
@@ -1613,17 +1613,17 @@ 
 
 	public function populate() {
 		//grab defaults via a new instance of this class.
-		$class_name = get_class( $this );
+		$class_name = get_class($this);
 		$defaults = new $class_name;
 		//loop through the properties for this class and see if they are set.  If they are NOT, then grab the
 		//default from our $defaults object.
-		foreach ( get_object_vars( $defaults ) as $property => $value ) {
-			if ( $this->{$property} === null ) {
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
 				$this->{$property} = $value;
 			}
 		}
 		//cleanup
-		unset( $defaults );
+		unset($defaults);
 	}
 
 
@@ -1639,7 +1639,7 @@ 
 	 * @param $a
 	 * @return bool
 	 */
-	public function __isset( $a ) {
+	public function __isset($a) {
 		return false;
 	}
 
@@ -1651,7 +1651,7 @@ 
 	 * @param $a
 	 * @return bool
 	 */
-	public function __unset( $a ) {
+	public function __unset($a) {
 		return false;
 	}
 
@@ -1761,7 +1761,7 @@ 
 		$this->current_blog_id = get_current_blog_id();
 		$this->current_blog_id = $this->current_blog_id === NULL ? 1 : $this->current_blog_id;
 		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-		$this->ee_ueip_has_notified = is_main_site() ? get_option( 'ee_ueip_has_notified', false ) : true;
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
 		$this->post_shortcodes = array();
 		$this->module_route_map = array();
 		$this->module_forward_map = array();
@@ -1777,9 +1777,9 @@ 
 		$this->thank_you_page_url = '';
 		$this->cancel_page_url = '';
 		//cpt slugs
-		$this->event_cpt_slug = __( 'events', 'event_espresso' );
+		$this->event_cpt_slug = __('events', 'event_espresso');
 		//ueip constant check
-		if ( defined( 'EE_DISABLE_UXIP' ) && EE_DISABLE_UXIP ) {
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
 			$this->ee_ueip_optin = false;
 			$this->ee_ueip_has_notified = true;
 		}
@@ -1822,11 +1822,11 @@ 
 	 * @return    string
 	 */
 	public function reg_page_url() {
-		if ( ! $this->reg_page_url ) {
+		if ( ! $this->reg_page_url) {
 			$this->reg_page_url = add_query_arg(
-				array( 'uts' => time() ),
-				get_permalink( $this->reg_page_id )
-			) . '#checkout';
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			).'#checkout';
 		}
 		return $this->reg_page_url;
 	}
@@ -1841,12 +1841,12 @@ 
 	 * @access    public
 	 * @return    string
 	 */
-	public function txn_page_url( $query_args = array() ) {
-		if ( ! $this->txn_page_url ) {
-			$this->txn_page_url = get_permalink( $this->txn_page_id );
+	public function txn_page_url($query_args = array()) {
+		if ( ! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
 		}
-		if ( $query_args ) {
-			return add_query_arg( $query_args, $this->txn_page_url );
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
 		} else {
 			return $this->txn_page_url;
 		}
@@ -1862,12 +1862,12 @@ 
 	 * @access    public
 	 * @return    string
 	 */
-	public function thank_you_page_url( $query_args = array() ) {
-		if ( ! $this->thank_you_page_url ) {
-			$this->thank_you_page_url = get_permalink( $this->thank_you_page_id );
+	public function thank_you_page_url($query_args = array()) {
+		if ( ! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
 		}
-		if ( $query_args ) {
-			return add_query_arg( $query_args, $this->thank_you_page_url );
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
 		} else {
 			return $this->thank_you_page_url;
 		}
@@ -1882,8 +1882,8 @@ 
 	 * @return    string
 	 */
 	public function cancel_page_url() {
-		if ( ! $this->cancel_page_url ) {
-			$this->cancel_page_url = get_permalink( $this->cancel_page_id );
+		if ( ! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
 		}
 		return $this->cancel_page_url;
 	}
@@ -1912,22 +1912,22 @@ 
 	 */
 	protected function _get_main_ee_ueip_optin() {
 		//if this is the main site then we can just bypass our direct query.
-		if ( is_main_site() ) {
-			return get_option( 'ee_ueip_optin', false );
+		if (is_main_site()) {
+			return get_option('ee_ueip_optin', false);
 		}
 
 		//is this already cached for this request?  If so use it.
-		if ( ! empty( EE_Core_Config::$ee_ueip_option ) ) {
+		if ( ! empty(EE_Core_Config::$ee_ueip_option)) {
 			return EE_Core_Config::$ee_ueip_option;
 		}
 
 		global $wpdb;
 		$current_network_main_site = is_multisite() ? get_current_site() : null;
-		$current_main_site_id = ! empty( $current_network_main_site ) ? $current_network_main_site->blog_id : 1;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
 		$option = 'ee_ueip_optin';
 
 		//set correct table for query
-		$table_name = $wpdb->get_blog_prefix( $current_main_site_id ) . 'options';
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
 
 
 		//rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
@@ -1935,20 +1935,20 @@ 
 		//re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
 		//this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
 		//for the purpose of caching.
-		$pre = apply_filters( 'pre_option_' . $option, false, $option );
-		if ( false !== $pre ) {
+		$pre = apply_filters('pre_option_'.$option, false, $option);
+		if (false !== $pre) {
 			EE_Core_Config::$ee_ueip_option = $pre;
 			return EE_Core_Config::$ee_ueip_option;
 		}
 
-		$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", $option ) );
-		if ( is_object( $row ) ) {
+		$row = $wpdb->get_row($wpdb->prepare("SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", $option));
+		if (is_object($row)) {
 			$value = $row->option_value;
 		} else { //option does not exist so use default.
-			return apply_filters( 'default_option_' . $option, false, $option );
+			return apply_filters('default_option_'.$option, false, $option);
 		}
 
-		EE_Core_Config::$ee_ueip_option = apply_filters( 'option_' . $option, maybe_unserialize( $value ), $option );
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
 		return EE_Core_Config::$ee_ueip_option;
 	}
 
@@ -1964,7 +1964,7 @@ 
 		//reset all url properties
 		$this->_reset_urls();
 		//return what to save to db
-		return array_keys( get_object_vars( $this ) );
+		return array_keys(get_object_vars($this));
 	}
 
 }
@@ -2111,14 +2111,14 @@ 
 	 */
 	public function __construct() {
 		// set default organization settings
-		$this->name = get_bloginfo( 'name' );
+		$this->name = get_bloginfo('name');
 		$this->address_1 = '123 Onna Road';
 		$this->address_2 = 'PO Box 123';
 		$this->city = 'Inna City';
 		$this->STA_ID = 4;
 		$this->CNT_ISO = 'US';
 		$this->zip = '12345';
-		$this->email = get_bloginfo( 'admin_email' );
+		$this->email = get_bloginfo('admin_email');
 		$this->phone = '';
 		$this->vat = '123456789';
 		$this->logo_url = '';
@@ -2206,46 +2206,46 @@ 
 	 * @param string $CNT_ISO
 	 * @throws \EE_Error
 	 */
-	public function __construct( $CNT_ISO = '' ) {
+	public function __construct($CNT_ISO = '') {
 		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-		$table_analysis = EE_Registry::instance()->create( 'TableAnalysis', array(), true );
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
 		// get country code from organization settings or use default
-		$ORG_CNT = isset( EE_Registry::instance()->CFG->organization )
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
 		           && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
 			? EE_Registry::instance()->CFG->organization->CNT_ISO
 			: '';
 		// but override if requested
-		$CNT_ISO = ! empty( $CNT_ISO ) ? $CNT_ISO : $ORG_CNT;
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
 		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
 		if (
-			! empty( $CNT_ISO )
+			! empty($CNT_ISO)
 			&& EE_Maintenance_Mode::instance()->models_can_query()
-			&& $table_analysis->tableExists( EE_Registry::instance()->load_model( 'Country' )->table() )
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
 		) {
 			// retrieve the country settings from the db, just in case they have been customized
-			$country = EE_Registry::instance()->load_model( 'Country' )->get_one_by_ID( $CNT_ISO );
-			if ( $country instanceof EE_Country ) {
-				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-				$this->name = $country->currency_name_single();    // Dollar
-				$this->plural = $country->currency_name_plural();    // Dollars
-				$this->sign = $country->currency_sign();            // currency sign: $
-				$this->sign_b4 = $country->currency_sign_before();        // currency sign before or after: $TRUE  or  FALSE$
-				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-				$this->dec_mrk = $country->currency_decimal_mark();    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-				$this->thsnds = $country->currency_thousands_separator();    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code(); // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single(); // Dollar
+				$this->plural = $country->currency_name_plural(); // Dollars
+				$this->sign = $country->currency_sign(); // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(); // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(); // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(); // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
 			}
 		}
 		// fallback to hardcoded defaults, in case the above failed
-		if ( empty( $this->code ) ) {
+		if (empty($this->code)) {
 			// set default currency settings
-			$this->code = 'USD';    // currency code: USD, CAD, EUR
-			$this->name = __( 'Dollar', 'event_espresso' );    // Dollar
-			$this->plural = __( 'Dollars', 'event_espresso' );    // Dollars
-			$this->sign = '$';    // currency sign: $
-			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			$this->code = 'USD'; // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso'); // Dollar
+			$this->plural = __('Dollars', 'event_espresso'); // Dollars
+			$this->sign = '$'; // currency sign: $
+			$this->sign_b4 = true; // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2; // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ','; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
 		}
 	}
 }
@@ -2414,7 +2414,7 @@ 
 	 * @since 4.8.8.rc.019
 	 */
 	public function do_hooks() {
-		add_action( 'AHEE__EE_Config___load_core_config__end', array( $this, 'set_default_reg_status_on_EEM_Event' ) );
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
 	}
 
 
@@ -2423,7 +2423,7 @@ 
 	 * @return void
 	 */
 	public function set_default_reg_status_on_EEM_Event() {
-		EEM_Event::set_default_reg_status( $this->default_STS_ID );
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
 	}
 
 
@@ -2440,7 +2440,7 @@ 
 	/**
 	 * @param boolean $track_invalid_checkout_access
 	 */
-	public function set_track_invalid_checkout_access( $track_invalid_checkout_access ) {
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access) {
 		$this->track_invalid_checkout_access = filter_var(
 			$track_invalid_checkout_access,
 			FILTER_VALIDATE_BOOLEAN
@@ -2558,10 +2558,10 @@ 
 	 * @param bool $reset
 	 * @return string
 	 */
-	public function log_file_name( $reset = false ) {
-		if ( empty( $this->log_file_name ) || $reset ) {
-			$this->log_file_name = sanitize_key( 'espresso_log_' . md5( uniqid( '', true ) ) ) . '.txt';
-			EE_Config::instance()->update_espresso_config( false, false );
+	public function log_file_name($reset = false) {
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
 		}
 		return $this->log_file_name;
 	}
@@ -2572,10 +2572,10 @@ 
 	 * @param bool $reset
 	 * @return string
 	 */
-	public function debug_file_name( $reset = false ) {
-		if ( empty( $this->debug_file_name ) || $reset ) {
-			$this->debug_file_name = sanitize_key( 'espresso_debug_' . md5( uniqid( '', true ) ) ) . '.txt';
-			EE_Config::instance()->update_espresso_config( false, false );
+	public function debug_file_name($reset = false) {
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
 		}
 		return $this->debug_file_name;
 	}
@@ -2586,7 +2586,7 @@ 
 	 * @return string
 	 */
 	public function affiliate_id() {
-		return ! empty( $this->affiliate_id ) ? $this->affiliate_id : 'default';
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
 	}
 
 
@@ -2595,7 +2595,7 @@ 
      * @return boolean
      */
     public function encode_session_data() {
-        return filter_var( $this->encode_session_data, FILTER_VALIDATE_BOOLEAN );
+        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -2603,8 +2603,8 @@ 
     /**
      * @param boolean $encode_session_data
      */
-    public function set_encode_session_data( $encode_session_data ) {
-        $this->encode_session_data = filter_var( $encode_session_data, FILTER_VALIDATE_BOOLEAN );
+    public function set_encode_session_data($encode_session_data) {
+        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -2784,21 +2784,21 @@ 
 		$this->use_google_maps = true;
 		$this->google_map_api_key = '';
 		// for event details pages (reg page)
-		$this->event_details_map_width = 585;            // ee_map_width_single
-		$this->event_details_map_height = 362;            // ee_map_height_single
-		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
-		$this->event_details_display_nav = true;            // ee_map_nav_display_single
-		$this->event_details_nav_size = false;            // ee_map_nav_size_single
-		$this->event_details_control_type = 'default';        // ee_map_type_control_single
-		$this->event_details_map_align = 'center';            // ee_map_align_single
+		$this->event_details_map_width = 585; // ee_map_width_single
+		$this->event_details_map_height = 362; // ee_map_height_single
+		$this->event_details_map_zoom = 14; // ee_map_zoom_single
+		$this->event_details_display_nav = true; // ee_map_nav_display_single
+		$this->event_details_nav_size = false; // ee_map_nav_size_single
+		$this->event_details_control_type = 'default'; // ee_map_type_control_single
+		$this->event_details_map_align = 'center'; // ee_map_align_single
 		// for event list pages
-		$this->event_list_map_width = 300;            // ee_map_width
-		$this->event_list_map_height = 185;        // ee_map_height
-		$this->event_list_map_zoom = 12;            // ee_map_zoom
-		$this->event_list_display_nav = false;        // ee_map_nav_display
-		$this->event_list_nav_size = true;            // ee_map_nav_size
-		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
-		$this->event_list_map_align = 'center';            // ee_map_align
+		$this->event_list_map_width = 300; // ee_map_width
+		$this->event_list_map_height = 185; // ee_map_height
+		$this->event_list_map_zoom = 12; // ee_map_zoom
+		$this->event_list_display_nav = false; // ee_map_nav_display
+		$this->event_list_nav_size = true; // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown'; // ee_map_type_control
+		$this->event_list_map_align = 'center'; // ee_map_align
 	}
 
 }
@@ -2960,7 +2960,7 @@ 
 	 * @return void
 	 */
 	protected function _set_php_values() {
-		$this->php->max_input_vars = ini_get( 'max_input_vars' );
+		$this->php->max_input_vars = ini_get('max_input_vars');
 		$this->php->version = phpversion();
 	}
 
@@ -2979,10 +2979,10 @@ 
 	 * @type string $msg         Any message to be displayed.
 	 *                           }
 	 */
-	public function max_input_vars_limit_check( $input_count = 0 ) {
-		if ( ! empty( $this->php->max_input_vars )
-		     && ( $input_count >= $this->php->max_input_vars )
-		     && ( PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9 )
+	public function max_input_vars_limit_check($input_count = 0) {
+		if ( ! empty($this->php->max_input_vars)
+		     && ($input_count >= $this->php->max_input_vars)
+		     && (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
 		) {
 			return sprintf(
 				__(
@@ -3078,7 +3078,7 @@ 
 	 */
 	public function __construct() {
 		$this->payment_settings = array();
-		$this->active_gateways = array( 'Invoice' => false );
+		$this->active_gateways = array('Invoice' => false);
 	}
 }
 

core/helpers/EEH_File.helper.php

Indentation +2 added lines, -2 removed lines

@@ -325,8 +325,8 @@
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
 		//parent folder, "/var/something/"
 		$ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, DS, -2)
-            : strlen($file_or_folder_path);
+			? strrpos($file_or_folder_path, DS, -2)
+			: strlen($file_or_folder_path);
 		return substr($file_or_folder_path, 0, $ds + 1);
 	}
 

Spacing +176 added lines, -176 removed lines

@@ -12,8 +12,8 @@ 
  * @ version		 	4.0
  *
  */
-require_once( EE_HELPERS . 'EEH_Base.helper.php' );
-require_once( EE_INTERFACES . 'EEI_Interfaces.php' );
+require_once(EE_HELPERS.'EEH_Base.helper.php');
+require_once(EE_INTERFACES.'EEI_Interfaces.php');
 /**
  *
  * Class EEH_File
@@ -52,30 +52,30 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return WP_Filesystem_Base
 	 */
-	private static function _get_wp_filesystem( $filepath = null) {
-		if( apply_filters(
+	private static function _get_wp_filesystem($filepath = null) {
+		if (apply_filters(
 				'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
-				$filepath && EEH_File::is_in_uploads_folder( $filepath ),
-				$filepath ) ) {
-			if( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct ) {
-				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+				$filepath && EEH_File::is_in_uploads_folder($filepath),
+				$filepath )) {
+			if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+				require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
 				$method = 'direct';
-				$wp_filesystem_direct_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
+				$wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method);
 				//check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-				if ( ! defined('FS_CHMOD_DIR') ) {
-					define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
+				if ( ! defined('FS_CHMOD_DIR')) {
+					define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755));
 				}
-				if ( ! defined('FS_CHMOD_FILE') ) {
-					define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
+				if ( ! defined('FS_CHMOD_FILE')) {
+					define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644));
 				}
-				require_once( $wp_filesystem_direct_file );
-				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct( array() );
+				require_once($wp_filesystem_direct_file);
+				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
 			}
 			return EEH_File::$_wp_filesystem_direct;
 		}
 		global $wp_filesystem;
 		// no filesystem setup ???
-		if ( ! $wp_filesystem instanceof WP_Filesystem_Base ) {
+		if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
 			// if some eager beaver's just trying to get in there too early...
 			// let them do it, because we are one of those eager beavers! :P
 			/**
@@ -88,34 +88,34 @@ 
 			 * and there may be troubles if the WP files are owned by a different user
 			 * than the server user. But both of these issues should exist in 4.4 and earlier too
 			 */
-			if ( FALSE && ! did_action( 'wp_loaded' )) {
+			if (FALSE && ! did_action('wp_loaded')) {
 				$msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
-				if ( WP_DEBUG ) {
-					$msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+				if (WP_DEBUG) {
+					$msg .= '<br />'.__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
 				}
-				throw new EE_Error( $msg );
+				throw new EE_Error($msg);
 			} else {
 				// should be loaded if we are past the wp_loaded hook...
-				if ( ! function_exists( 'WP_Filesystem' )) {
-					require_once( ABSPATH . 'wp-admin/includes/file.php' );
-					require_once( ABSPATH . 'wp-admin/includes/template.php' );
+				if ( ! function_exists('WP_Filesystem')) {
+					require_once(ABSPATH.'wp-admin/includes/file.php');
+					require_once(ABSPATH.'wp-admin/includes/template.php');
 				}
 				// turn on output buffering so that we can capture the credentials form
 				ob_start();
-				$credentials = request_filesystem_credentials( '' );
+				$credentials = request_filesystem_credentials('');
 				// store credentials form for the time being
 				EEH_File::$_credentials_form = ob_get_clean();
 				// basically check for direct or previously configured access
-				if ( ! WP_Filesystem( $credentials ) ) {
+				if ( ! WP_Filesystem($credentials)) {
 					// if credentials do NOT exist
-					if ( $credentials === FALSE ) {
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
-						throw new EE_Error( __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
-					} elseif( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
+					if ($credentials === FALSE) {
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
+						throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
+					} elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
 						throw new EE_Error(
 								sprintf(
-										__( 'WP Filesystem Error: $1%s', 'event_espresso' ),
+										__('WP Filesystem Error: $1%s', 'event_espresso'),
 										$wp_filesystem->errors->get_error_message() ) );
 					}
 				}
@@ -128,8 +128,8 @@ 
 	 * display_request_filesystem_credentials_form
 	 */
 	public static function display_request_filesystem_credentials_form() {
-		if ( ! empty( EEH_File::$_credentials_form )) {
-			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+		if ( ! empty(EEH_File::$_credentials_form)) {
+			echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
 		}
 	}
 
@@ -147,29 +147,29 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function verify_filepath_and_permissions( $full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '' ) {
+	public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		if ( ! $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) )) {
-			$file_name = ! empty( $type_of_file ) ? $file_name . ' ' . $type_of_file : $file_name;
-			$file_name .= ! empty( $file_ext ) ? ' file' : ' folder';
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			$file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
 			$msg = sprintf(
-				__( 'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso' ),
+				__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
 				$file_name,
 				'<br />'
 			);
-			if ( EEH_File::exists( $full_file_path )) {
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, $type_of_file );
+			if (EEH_File::exists($full_file_path)) {
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
 			} else {
 				// no file permissions means the file was not found
 				$msg .= sprintf(
-					__( 'Please ensure the following path is correct: "%s".', 'event_espresso' ),
+					__('Please ensure the following path is correct: "%s".', 'event_espresso'),
 					$full_file_path
 				);
 			}
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				throw new EE_Error( $msg . '||' . $msg );
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				throw new EE_Error($msg.'||'.$msg);
 			}
 			return FALSE;
 		}
@@ -187,24 +187,24 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return string
 	 */
-	private static function _permissions_error_for_unreadable_filepath( $full_file_path = '', $type_of_file = '' ){
+	private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
 		// check file permissions
-		$perms = $wp_filesystem->getchmod( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
-		if ( $perms ) {
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		if ($perms) {
 			// file permissions exist, but way be set incorrectly
-			$type_of_file = ! empty( $type_of_file ) ? $type_of_file . ' ' : '';
-			$type_of_file .= ! empty( $type_of_file ) ? 'file' : 'folder';
+			$type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
 			return sprintf(
-				__( 'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso' ),
+				__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
 				$type_of_file,
 				$perms
 			);
 		} else {
 			// file exists but file permissions could not be read ?!?!
 			return sprintf(
-				__( 'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso' ),
+				__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
 				$full_file_path
 			);
 		}
@@ -222,35 +222,35 @@ 
 	 * can't write to it
 	 * @return bool false if folder isn't writable; true if it exists and is writeable,
 	 */
-	public static function ensure_folder_exists_and_is_writable( $folder = '' ){
-		if ( empty( $folder )) {
+	public static function ensure_folder_exists_and_is_writable($folder = '') {
+		if (empty($folder)) {
 			return false;
 		}
 		// remove ending DS
-		$folder = EEH_File::standardise_directory_separators( rtrim( $folder, '/\\' ));
-		$parent_folder = EEH_File::get_parent_folder( $folder );
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
 		// add DS to folder
-		$folder = EEH_File::end_with_directory_separator( $folder );
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $folder );
-		if ( ! $wp_filesystem->is_dir( EEH_File::convert_local_filepath_to_remote_filepath( $folder ) ) ) {
+		$folder = EEH_File::end_with_directory_separator($folder);
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
+		if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
 			//ok so it doesn't exist. Does its parent? Can we write to it?
-			if(	! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
 				return false;
 			}
-			if ( ! EEH_File::verify_is_writable( $parent_folder, 'folder' )) {
+			if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) {
 				return false;
 			} else {
-				if ( ! $wp_filesystem->mkdir( EEH_File::convert_local_filepath_to_remote_filepath(  $folder ) ) ) {
-					if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-						$msg = sprintf( __( '"%s" could not be created.', 'event_espresso' ), $folder );
-						$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $folder );
-						throw new EE_Error( $msg );
+				if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+					if (defined('WP_DEBUG') && WP_DEBUG) {
+						$msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
+						$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
+						throw new EE_Error($msg);
 					}
 					return false;
 				}
-				EEH_File::add_index_file( $folder );
+				EEH_File::add_index_file($folder);
 			}
-		} elseif ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
+		} elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) {
 			return false;
 		}
 		return true;
@@ -265,15 +265,15 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function verify_is_writable( $full_path = '', $file_or_folder = 'folder' ){
+	public static function verify_is_writable($full_path = '', $file_or_folder = 'folder') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_path );
-		$full_path = EEH_File::standardise_directory_separators( $full_path );
-		if ( ! $wp_filesystem->is_writable( EEH_File::convert_local_filepath_to_remote_filepath( $full_path ) ) ) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The "%1$s" %2$s is not writable.', 'event_espresso' ), $full_path, $file_or_folder );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_path );
-				throw new EE_Error( $msg );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
+		$full_path = EEH_File::standardise_directory_separators($full_path);
+		if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -290,25 +290,25 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function ensure_file_exists_and_is_writable( $full_file_path = '' ) {
+	public static function ensure_file_exists_and_is_writable($full_file_path = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		$parent_folder = EEH_File::get_parent_folder( $full_file_path );
-		if ( ! EEH_File::exists( $full_file_path )) {
-			if( ! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$parent_folder = EEH_File::get_parent_folder($full_file_path);
+		if ( ! EEH_File::exists($full_file_path)) {
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
 				return false;
 			}
-			if ( ! $wp_filesystem->touch( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ) {
-				if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-					$msg = sprintf( __( 'The "%s" file could not be created.', 'event_espresso' ), $full_file_path );
-					$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
-					throw new EE_Error( $msg );
+			if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+					throw new EE_Error($msg);
 				}
 				return false;
 			}
 		}
-		if ( ! EEH_File::verify_is_writable( $full_file_path, 'file' )) {
+		if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
 			return false;
 		}
 		return true;
@@ -320,7 +320,7 @@ 
 	 * @param string $file_or_folder_path
 	 * @return string parent folder, ENDING with a directory separator
 	 */
-	public static function get_parent_folder( $file_or_folder_path ) {
+	public static function get_parent_folder($file_or_folder_path) {
 		//find the last DS, ignoring a DS on the very end
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
 		//parent folder, "/var/something/"
@@ -342,12 +342,12 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return string
 	 */
-	public static function get_file_contents( $full_file_path = '' ){
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		if ( EEH_File::verify_filepath_and_permissions( $full_file_path, EEH_File::get_filename_from_filepath( $full_file_path ) , EEH_File::get_file_extension( $full_file_path ))) {
+	public static function get_file_contents($full_file_path = '') {
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
 			// load WP_Filesystem and set file permissions
-			$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
 		}
 		return '';
 	}
@@ -362,26 +362,26 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function write_to_file( $full_file_path = '', $file_contents = '', $file_type = '' ){
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		$file_type = ! empty( $file_type ) ? rtrim( $file_type, ' ' ) . ' ' : '';
-		$folder = EEH_File::remove_filename_from_filepath( $full_file_path );
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" is not writable.', 'event_espresso' ), $file_type, $full_file_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
-				throw new EE_Error( $msg );
+	public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') {
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
+		$folder = EEH_File::remove_filename_from_filepath($full_file_path);
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
 		// write the file
-		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ), $file_contents )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" could not be written to.', 'event_espresso' ), $file_type, $full_file_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, 'f' );
-				throw new EE_Error( $msg );
+		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -397,9 +397,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean
 	 */
-	public static function delete( $filepath, $recursive = false, $type = false ) {
+	public static function delete($filepath, $recursive = false, $type = false) {
 		$wp_filesystem = EEH_File::_get_wp_filesystem();
-		return $wp_filesystem->delete( $filepath, $recursive, $type ) ? TRUE : FALSE;
+		return $wp_filesystem->delete($filepath, $recursive, $type) ? TRUE : FALSE;
 	}
 
 
@@ -411,9 +411,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function exists( $full_file_path = '' ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		return $wp_filesystem->exists( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ? TRUE : FALSE;
+	public static function exists($full_file_path = '') {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? TRUE : FALSE;
 	}
 
 
@@ -426,9 +426,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function is_readable( $full_file_path = '' ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		if( $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath(  $full_file_path ) ) ) {
+	public static function is_readable($full_file_path = '') {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
 			return true;
 		} else {
 			return false;
@@ -444,8 +444,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function remove_filename_from_filepath( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_DIRNAME );
+	public static function remove_filename_from_filepath($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
 	}
 
 
@@ -455,8 +455,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function get_filename_from_filepath( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_BASENAME );
+	public static function get_filename_from_filepath($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
 	}
 
 
@@ -466,8 +466,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function get_file_extension( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_EXTENSION );
+	public static function get_file_extension($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
 	}
 
 
@@ -478,10 +478,10 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function add_htaccess_deny_from_all( $folder = '' ) {
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
-		if ( ! EEH_File::exists( $folder . '.htaccess' ) ) {
-			if ( ! EEH_File::write_to_file( $folder . '.htaccess', 'deny from all', '.htaccess' )) {
+	public static function add_htaccess_deny_from_all($folder = '') {
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if ( ! EEH_File::exists($folder.'.htaccess')) {
+			if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
 				return FALSE;
 			}
 		}
@@ -495,10 +495,10 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean
 	 */
-	public static function add_index_file( $folder ) {
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
-		if ( ! EEH_File::exists( $folder . 'index.php' ) ) {
-			if ( ! EEH_File::write_to_file( $folder . 'index.php', 'You are not permitted to read from this folder', '.php' )) {
+	public static function add_index_file($folder) {
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if ( ! EEH_File::exists($folder.'index.php')) {
+			if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) {
 				return false;
 			}
 		}
@@ -513,11 +513,11 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function get_classname_from_filepath_with_standard_filename( $file_path ){
+	public static function get_classname_from_filepath_with_standard_filename($file_path) {
 		//extract file from path
-		$filename = basename( $file_path );
+		$filename = basename($file_path);
 		//now remove the first period and everything after
-		$pos_of_first_period = strpos( $filename,'.' );
+		$pos_of_first_period = strpos($filename, '.');
 		return substr($filename, 0, $pos_of_first_period);
 	}
 
@@ -529,8 +529,8 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function standardise_directory_separators( $file_path ){
-		return str_replace( array( '\\', '/' ), DS, $file_path );
+	public static function standardise_directory_separators($file_path) {
+		return str_replace(array('\\', '/'), DS, $file_path);
 	}
 
 
@@ -541,8 +541,8 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function end_with_directory_separator( $file_path ){
-		return rtrim( $file_path, '/\\' ) . DS;
+	public static function end_with_directory_separator($file_path) {
+		return rtrim($file_path, '/\\').DS;
 	}
 
 
@@ -552,8 +552,8 @@ 
 	 * @param $file_path
 	 * @return string
 	 */
-	public static function standardise_and_end_with_directory_separator( $file_path ){
-		return self::end_with_directory_separator( self::standardise_directory_separators( $file_path ));
+	public static function standardise_and_end_with_directory_separator($file_path) {
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
 	}
 
 
@@ -570,21 +570,21 @@ 
 	 *		if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
 	 *		 and values are their filepaths
 	 */
-	public static function get_contents_of_folders( $folder_paths = array(), $index_numerically = FALSE ){
+	public static function get_contents_of_folders($folder_paths = array(), $index_numerically = FALSE) {
 		$class_to_folder_path = array();
-		foreach( $folder_paths as $folder_path ){
-			$folder_path = self::standardise_and_end_with_directory_separator( $folder_path );
+		foreach ($folder_paths as $folder_path) {
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
 			// load WP_Filesystem and set file permissions
-			$files_in_folder = glob( $folder_path . '*' );
+			$files_in_folder = glob($folder_path.'*');
 			$class_to_folder_path = array();
-			if ( $files_in_folder ) {
-				foreach( $files_in_folder as $file_path ){
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
 					//only add files, not folders
-					if ( ! is_dir( $file_path )) {
-						if ( $index_numerically ) {
+					if ( ! is_dir($file_path)) {
+						if ($index_numerically) {
 							$class_to_folder_path[] = $file_path;
 						} else {
-							$classname = self::get_classname_from_filepath_with_standard_filename( $file_path );
+							$classname = self::get_classname_from_filepath_with_standard_filename($file_path);
 							$class_to_folder_path[$classname] = $file_path;
 						}
 					}
@@ -604,39 +604,39 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean success
 	 */
-	public static function copy( $source_file, $destination_file, $overwrite = FALSE ){
-		$full_source_path = EEH_File::standardise_directory_separators( $source_file );
-		if( ! EEH_File::exists( $full_source_path ) ){
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso' ), $full_source_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path );
-				throw new EE_Error( $msg );
+	public static function copy($source_file, $destination_file, $overwrite = FALSE) {
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
+		if ( ! EEH_File::exists($full_source_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 
-		$full_dest_path = EEH_File::standardise_directory_separators( $destination_file );
-		$folder = EEH_File::remove_filename_from_filepath( $full_dest_path );
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The file located at "%2$s" is not writable.', 'event_espresso' ), $full_dest_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_dest_path );
-				throw new EE_Error( $msg );
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
+		$folder = EEH_File::remove_filename_from_filepath($full_dest_path);
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $destination_file );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
 		// write the file
 		if ( ! $wp_filesystem->copy(
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_source_path ),
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_dest_path ),
+						EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
+						EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
 						$overwrite )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso' ), $full_source_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path, 'f' );
-				throw new EE_Error( $msg );
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -648,9 +648,9 @@ 
 	 * @param string $filepath
 	 * @return boolean
 	 */
-	public static function is_in_uploads_folder( $filepath ) {
+	public static function is_in_uploads_folder($filepath) {
 		$uploads = wp_upload_dir();
-		return strpos( $filepath, $uploads[ 'basedir' ] ) === 0 ? true : false;
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
 	}
 
 	/**
@@ -665,9 +665,9 @@ 
 	 * @return string the remote filepath (eg the filepath the filesystem method, eg
 	 * ftp or ssh, will use to access the folder
 	 */
-	public static function convert_local_filepath_to_remote_filepath( $local_filepath ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $local_filepath );
-		return str_replace( WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath );
+	public static function convert_local_filepath_to_remote_filepath($local_filepath) {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
+		return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
 	}
 }
 // End of file EEH_File.helper.php

core/helpers/EEH_DTT_Helper.helper.php

Indentation +2 added lines, -3 removed lines

@@ -117,8 +117,8 @@ 
 		}
 		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()...
 		$timezone_string = $timezone_string !== false
-            ? $timezone_string
-            : EEH_DTT_Helper::get_timezone_string_from_abbreviations_list( $gmt_offset );
+			? $timezone_string
+			: EEH_DTT_Helper::get_timezone_string_from_abbreviations_list( $gmt_offset );
 		return $timezone_string;
 	}
 
@@ -819,7 +819,6 @@ 
 
 
 	/**
-
 	 *
 	 * 	 If the the first date starts at midnight on one day, and the next date ends at midnight on the
 	 * 	 very next day then this method will return true.

Spacing +142 added lines, -143 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -53,12 +53,12 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public static function get_valid_timezone_string( $timezone_string = '' ) {
+	public static function get_valid_timezone_string($timezone_string = '') {
 		// if passed a value, then use that, else get WP option
-		$timezone_string = ! empty( $timezone_string ) ? $timezone_string : get_option( 'timezone_string' );
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : get_option('timezone_string');
 		// value from above exists, use that, else get timezone string from gmt_offset
-		$timezone_string = ! empty( $timezone_string ) ? $timezone_string : EEH_DTT_Helper::get_timezone_string_from_gmt_offset();
-		EEH_DTT_Helper::validate_timezone( $timezone_string );
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : EEH_DTT_Helper::get_timezone_string_from_gmt_offset();
+		EEH_DTT_Helper::validate_timezone($timezone_string);
 		return $timezone_string;
 	}
 
@@ -74,18 +74,18 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public static function validate_timezone( $timezone_string, $throw_error = true ) {
+	public static function validate_timezone($timezone_string, $throw_error = true) {
 		// easiest way to test a timezone string is just see if it throws an error when you try to create a DateTimeZone object with it
 		try {
-			new DateTimeZone( $timezone_string );
-		} catch ( Exception $e ) {
+			new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
 			// sometimes we take exception to exceptions
-			if ( ! $throw_error ) {
+			if ( ! $throw_error) {
 				return false;
 			}
 			throw new EE_Error(
 				sprintf(
-					__( 'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', 'event_espresso' ),
+					__('The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', 'event_espresso'),
 					$timezone_string,
 					'<a href="http://www.php.net/manual/en/timezones.php">',
 					'</a>'
@@ -104,21 +104,21 @@ 
 	 * @param string $gmt_offset
 	 * @return string
 	 */
-	public static function get_timezone_string_from_gmt_offset( $gmt_offset = '' ) {
+	public static function get_timezone_string_from_gmt_offset($gmt_offset = '') {
 		$timezone_string = 'UTC';
-		$gmt_offset = ! empty( $gmt_offset ) ? $gmt_offset : get_option( 'gmt_offset' );
-		if ( $gmt_offset !== '' ) {
+		$gmt_offset = ! empty($gmt_offset) ? $gmt_offset : get_option('gmt_offset');
+		if ($gmt_offset !== '') {
 			// convert GMT offset to seconds
 			$gmt_offset = $gmt_offset * HOUR_IN_SECONDS;
 			// account for WP offsets that aren't valid UTC
-			$gmt_offset = EEH_DTT_Helper::adjust_invalid_gmt_offsets( $gmt_offset );
+			$gmt_offset = EEH_DTT_Helper::adjust_invalid_gmt_offsets($gmt_offset);
 			// although we don't know the TZ abbreviation, we know the UTC offset
-			$timezone_string = timezone_name_from_abbr( null, $gmt_offset );
+			$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
 		}
 		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()...
 		$timezone_string = $timezone_string !== false
             ? $timezone_string
-            : EEH_DTT_Helper::get_timezone_string_from_abbreviations_list( $gmt_offset );
+            : EEH_DTT_Helper::get_timezone_string_from_abbreviations_list($gmt_offset);
 		return $timezone_string;
 	}
 
@@ -129,15 +129,15 @@ 
 	 * @return int seconds offset
 	 */
 	public static function get_site_timezone_gmt_offset() {
-		$timezone_string = get_option( 'timezone_string' );
-		if ( $timezone_string ) {
+		$timezone_string = get_option('timezone_string');
+		if ($timezone_string) {
 			try {
-				$timezone = new DateTimeZone( $timezone_string );
-				return $timezone->getOffset( new DateTime() ); //in WordPress DateTime defaults to UTC
-			} catch( Exception $e ){}
+				$timezone = new DateTimeZone($timezone_string);
+				return $timezone->getOffset(new DateTime()); //in WordPress DateTime defaults to UTC
+			} catch (Exception $e) {}
 		}
-		$offset = get_option( 'gmt_offset' );
-		return (int) ( $offset * HOUR_IN_SECONDS );
+		$offset = get_option('gmt_offset');
+		return (int) ($offset * HOUR_IN_SECONDS);
 	}
 
 
@@ -149,10 +149,10 @@ 
 	 * @param int $gmt_offset
 	 * @return int
 	 */
-	public static function adjust_invalid_gmt_offsets( $gmt_offset = 0 ) {
+	public static function adjust_invalid_gmt_offsets($gmt_offset = 0) {
 		//make sure $gmt_offset is int
 		$gmt_offset = (int) $gmt_offset;
-		switch ( $gmt_offset ) {
+		switch ($gmt_offset) {
 
 			//			case -30600 :
 			//				$gmt_offset = -28800;
@@ -204,13 +204,13 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public static function get_timezone_string_from_abbreviations_list( $gmt_offset = 0 ) {
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0) {
 		$abbreviations = timezone_abbreviations_list();
-		foreach ( $abbreviations as $abbreviation ) {
-			foreach ( $abbreviation as $city ) {
-				if ( $city['offset'] === $gmt_offset && $city['dst'] === FALSE ) {
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $city) {
+				if ($city['offset'] === $gmt_offset && $city['dst'] === FALSE) {
 					// check if the timezone is valid but don't throw any errors if it isn't
-					if ( EEH_DTT_Helper::validate_timezone( $city['timezone_id'], false ) ) {
+					if (EEH_DTT_Helper::validate_timezone($city['timezone_id'], false)) {
 						return $city['timezone_id'];
 					}
 				}
@@ -218,7 +218,7 @@ 
 		}
 		throw new EE_Error(
 			sprintf(
-				__( 'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', 'event_espresso' ),
+				__('The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', 'event_espresso'),
 				$gmt_offset,
 				'<a href="http://www.php.net/manual/en/timezones.php">',
 				'</a>'
@@ -232,23 +232,23 @@ 
 	 * @access public
 	 * @param string $timezone_string
 	 */
-	public static function timezone_select_input( $timezone_string = '' ) {
+	public static function timezone_select_input($timezone_string = '') {
 		// get WP date time format
-		$datetime_format = get_option('date_format') . ' '  . get_option('time_format');
+		$datetime_format = get_option('date_format').' '.get_option('time_format');
 		// if passed a value, then use that, else get WP option
-		$timezone_string = ! empty( $timezone_string ) ? $timezone_string : get_option( 'timezone_string' );
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : get_option('timezone_string');
 		// check if the timezone is valid but don't throw any errors if it isn't
-		$timezone_string = EEH_DTT_Helper::validate_timezone( $timezone_string, false );
+		$timezone_string = EEH_DTT_Helper::validate_timezone($timezone_string, false);
 		$gmt_offset = get_option('gmt_offset');
 
 		$check_zone_info = true;
-		if ( empty( $timezone_string )) {
+		if (empty($timezone_string)) {
 			// Create a UTC+- zone if no timezone string exists
 			$check_zone_info = false;
-			if ( $gmt_offset > 0 ) {
-				$timezone_string = 'UTC+' . $gmt_offset;
-			} elseif ( $gmt_offset < 0 ) {
-				$timezone_string = 'UTC' . $gmt_offset;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+'.$gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC'.$gmt_offset;
 			} else {
 				$timezone_string = 'UTC';
 			}
@@ -270,11 +270,11 @@ 
 					__('%1$sUTC%2$s time is %3$s'),
 					'<abbr title="Coordinated Universal Time">',
 					'</abbr>',
-					'<code>' . date_i18n( $datetime_format , false, true ) . '</code>'
+					'<code>'.date_i18n($datetime_format, false, true).'</code>'
 				);
 				?></span>
-			<?php if ( ! empty( $timezone_string ) || ! empty( $gmt_offset )) : ?>
-				<br /><span><?php printf(__('Local time is %1$s'), '<code>' . date_i18n( $datetime_format ) . '</code>' ); ?></span>
+			<?php if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+				<br /><span><?php printf(__('Local time is %1$s'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span>
 		<?php endif; ?>
 
 				<?php if ($check_zone_info && $timezone_string) : ?>
@@ -306,10 +306,9 @@ 
 
 						if ($found) {
 							$message = $tr['isdst'] ?
-											__(' Daylight saving time begins on: %s.' ) :
-											__(' Standard time begins  on: %s.');
+											__(' Daylight saving time begins on: %s.') : __(' Standard time begins  on: %s.');
 							// Add the difference between the current offset and the new offset to ts to get the correct transition time from date_i18n().
-							printf( $message, '<code >' . date_i18n( $datetime_format, $tr['ts'] + ( $tz_offset - $tr['offset'] ) ). '</code >' );
+							printf($message, '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >');
 						} else {
 							_e('This timezone does not observe daylight saving time.');
 						}
@@ -339,14 +338,14 @@ 
 	 *
 	 * @return int      $unix_timestamp with the offset applied for the given timezone.
 	 */
-	public static function get_timestamp_with_offset( $unix_timestamp = 0, $timezone_string = '' ) {
+	public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '') {
 		$unix_timestamp = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
-		$timezone_string = self::get_valid_timezone_string( $timezone_string );
-		$TimeZone = new DateTimeZone( $timezone_string );
+		$timezone_string = self::get_valid_timezone_string($timezone_string);
+		$TimeZone = new DateTimeZone($timezone_string);
 
-		$DateTime = new DateTime( '@' . $unix_timestamp, $TimeZone );
-		$offset = timezone_offset_get( $TimeZone, $DateTime );
-		return (int)$DateTime->format( 'U' ) + (int)$offset;
+		$DateTime = new DateTime('@'.$unix_timestamp, $TimeZone);
+		$offset = timezone_offset_get($TimeZone, $DateTime);
+		return (int) $DateTime->format('U') + (int) $offset;
 	}
 
 
@@ -361,17 +360,17 @@ 
 	 * @param  string					$datetime_field_name 	the datetime fieldname to be manipulated
 	 * @return 	EE_Base_Class
 	 */
-	protected static function _set_date_time_field( EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name ) {
+	protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name) {
 		// grab current datetime format
 		$current_format = $obj->get_format();
 		// set new full timestamp format
-		$obj->set_date_format( EE_Datetime_Field::mysql_date_format );
-		$obj->set_time_format( EE_Datetime_Field::mysql_time_format );
+		$obj->set_date_format(EE_Datetime_Field::mysql_date_format);
+		$obj->set_time_format(EE_Datetime_Field::mysql_time_format);
 		// set the new date value using a full timestamp format so that no data is lost
-		$obj->set( $datetime_field_name, $DateTime->format( EE_Datetime_Field::mysql_timestamp_format ) );
+		$obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
 		// reset datetime formats
-		$obj->set_date_format( $current_format[0] );
-		$obj->set_time_format( $current_format[1] );
+		$obj->set_date_format($current_format[0]);
+		$obj->set_time_format($current_format[1]);
 		return $obj;
 	}
 
@@ -388,11 +387,11 @@ 
 	 * @param  integer 	$value    what you want to increment the time by
 	 * @return EE_Base_Class		   return the EE_Base_Class object so right away you can do something with it (chaining)
 	 */
-	public static function date_time_add( EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1 ) {
+	public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) {
 		//get the raw UTC date.
-		$DateTime = $obj->get_DateTime_object( $datetime_field_name );
-		$DateTime = EEH_DTT_Helper::calc_date( $DateTime, $period, $value );
-		return EEH_DTT_Helper::_set_date_time_field( $obj, $DateTime, $datetime_field_name );
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
 	}
 
 
@@ -407,11 +406,11 @@ 
 	 * @param int            $value
 	 * @return \EE_Base_Class
 	 */
-	public static function date_time_subtract( EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1 ) {
+	public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) {
 		//get the raw UTC date
-		$DateTime = $obj->get_DateTime_object( $datetime_field_name );
-		$DateTime = EEH_DTT_Helper::calc_date( $DateTime, $period, $value, '-' );
-		return EEH_DTT_Helper::_set_date_time_field( $obj, $DateTime, $datetime_field_name );
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
 	}
 
 
@@ -424,44 +423,44 @@ 
 	 * @return \DateTime return whatever type came in.
 	 * @throws \EE_Error
 	 */
-	protected static function _modify_datetime_object( DateTime $DateTime, $period = 'years', $value = 1, $operand = '+' ) {
-		if ( ! $DateTime instanceof DateTime ) {
+	protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+') {
+		if ( ! $DateTime instanceof DateTime) {
 			throw new EE_Error(
 				sprintf(
-					__( 'Expected a PHP DateTime object, but instead received %1$s', 'event_espresso' ),
-					print_r( $DateTime, true )
+					__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
+					print_r($DateTime, true)
 				)
 			);
 		}
-		switch ( $period ) {
+		switch ($period) {
 			case 'years' :
-				$value = 'P' . $value . 'Y';
+				$value = 'P'.$value.'Y';
 				break;
 			case 'months' :
-				$value = 'P' . $value . 'M';
+				$value = 'P'.$value.'M';
 				break;
 			case 'weeks' :
-				$value = 'P' . $value . 'W';
+				$value = 'P'.$value.'W';
 				break;
 			case 'days' :
-				$value = 'P' . $value . 'D';
+				$value = 'P'.$value.'D';
 				break;
 			case 'hours' :
-				$value = 'PT' . $value . 'H';
+				$value = 'PT'.$value.'H';
 				break;
 			case 'minutes' :
-				$value = 'PT' . $value . 'M';
+				$value = 'PT'.$value.'M';
 				break;
 			case 'seconds' :
-				$value = 'PT' . $value . 'S';
+				$value = 'PT'.$value.'S';
 				break;
 		}
-		switch ( $operand ) {
+		switch ($operand) {
 			case '+':
-				$DateTime->add( new DateInterval( $value ) );
+				$DateTime->add(new DateInterval($value));
 				break;
 			case '-':
-				$DateTime->sub( new DateInterval( $value ) );
+				$DateTime->sub(new DateInterval($value));
 				break;
 		}
 		return $DateTime;
@@ -477,16 +476,16 @@ 
 	 * @return \DateTime return whatever type came in.
 	 * @throws \EE_Error
 	 */
-	protected static function _modify_timestamp( $timestamp, $period = 'years', $value = 1, $operand = '+' ) {
-		if ( ! preg_match( EE_Datetime_Field::unix_timestamp_regex, $timestamp ) ) {
+	protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+') {
+		if ( ! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
 			throw new EE_Error(
 				sprintf(
-					__( 'Expected a Unix timestamp, but instead received %1$s', 'event_espresso' ),
-					print_r( $timestamp, true )
+					__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
+					print_r($timestamp, true)
 				)
 			);
 		}
-		switch ( $period ) {
+		switch ($period) {
 			case 'years' :
 				$value = YEAR_IN_SECONDS * $value;
 				break;
@@ -506,9 +505,9 @@ 
 				$value = MINUTE_IN_SECONDS * $value;
 				break;
 		}
-		switch ( $operand ) {
+		switch ($operand) {
 			case '+':
-				$timestamp  += $value;
+				$timestamp += $value;
 				break;
 			case '-':
 				$timestamp -= $value;
@@ -528,11 +527,11 @@ 
 	 * @param  string  $operand What operand you wish to use for the calculation
 	 * @return mixed string|DateTime          return whatever type came in.
 	 */
-	public static function calc_date( $DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+' ) {
-		if ( $DateTime_or_timestamp instanceof DateTime ) {
-			return EEH_DTT_Helper::_modify_datetime_object( $DateTime_or_timestamp, $period, $value, $operand );
-		} else if ( preg_match( EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp )) {
-			return EEH_DTT_Helper::_modify_timestamp( $DateTime_or_timestamp, $period, $value, $operand );
+	public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+') {
+		if ($DateTime_or_timestamp instanceof DateTime) {
+			return EEH_DTT_Helper::_modify_datetime_object($DateTime_or_timestamp, $period, $value, $operand);
+		} else if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
+			return EEH_DTT_Helper::_modify_timestamp($DateTime_or_timestamp, $period, $value, $operand);
 		} else {
 			//error
 			return $DateTime_or_timestamp;
@@ -562,24 +561,24 @@ 
 	 * 			'moment' => //date and time format.
 	 * 		)
 	 */
-	public static function convert_php_to_js_and_moment_date_formats( $date_format_string = null, $time_format_string = null ) {
-		if ( $date_format_string === null ) {
-			$date_format_string = get_option( 'date_format' );
+	public static function convert_php_to_js_and_moment_date_formats($date_format_string = null, $time_format_string = null) {
+		if ($date_format_string === null) {
+			$date_format_string = get_option('date_format');
 		}
 
-		if ( $time_format_string === null ) {
-			$time_format_string = get_option( 'time_format' );
+		if ($time_format_string === null) {
+			$time_format_string = get_option('time_format');
 		}
 
-		$date_format = self::_php_to_js_moment_converter( $date_format_string );
-		$time_format = self::_php_to_js_moment_converter( $time_format_string );
+		$date_format = self::_php_to_js_moment_converter($date_format_string);
+		$time_format = self::_php_to_js_moment_converter($time_format_string);
 
 		return array(
 			'js' => array(
 				'date' => $date_format['js'],
 				'time' => $time_format['js']
 				),
-			'moment' => $date_format['moment'] . ' ' . $time_format['moment' ]
+			'moment' => $date_format['moment'].' '.$time_format['moment']
 			);
 	}
 
@@ -593,7 +592,7 @@ 
 	 *
 	 * @return array js and moment formats.
 	 */
-	protected static function _php_to_js_moment_converter( $format_string ) {
+	protected static function _php_to_js_moment_converter($format_string) {
 		/**
 		 * This is a map of symbols for formats.
 		 * The index is the php symbol, the equivalent values are in the array.
@@ -750,15 +749,15 @@ 
 		$jquery_ui_format = "";
 		$moment_format = "";
 		$escaping = false;
-		for ( $i = 0; $i < strlen($format_string); $i++ ) {
+		for ($i = 0; $i < strlen($format_string); $i++) {
 			$char = $format_string[$i];
-			if ( $char === '\\' )  { // PHP date format escaping character
+			if ($char === '\\') { // PHP date format escaping character
 				$i++;
-				if ( $escaping ) {
+				if ($escaping) {
 					$jquery_ui_format .= $format_string[$i];
 					$moment_format .= $format_string[$i];
 				} else {
-					$jquery_ui_format .= '\'' . $format_string[$i];
+					$jquery_ui_format .= '\''.$format_string[$i];
 					$moment_format .= $format_string[$i];
 				}
 				$escaping = true;
@@ -777,7 +776,7 @@ 
 				}
 			}
 		}
-		return array( 'js' => $jquery_ui_format, 'moment' => $moment_format );
+		return array('js' => $jquery_ui_format, 'moment' => $moment_format);
 	}
 
 
@@ -792,25 +791,25 @@ 
 	 *                           		errors is returned.  So for client code calling, check for is_array() to
 	 *                           		indicate failed validations.
 	 */
-	public static function validate_format_string( $format_string ) {
+	public static function validate_format_string($format_string) {
 		$error_msg = array();
 		//time format checks
-		switch ( true ) {
-			case   strpos( $format_string, 'h' )  !== false  :
-			case   strpos( $format_string, 'g' ) !== false :
+		switch (true) {
+			case   strpos($format_string, 'h') !== false  :
+			case   strpos($format_string, 'g') !== false :
 				/**
 				 * if the time string has a lowercase 'h' which == 12 hour time format and there
 				 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
 				 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
 				 */
-				if ( strpos( strtoupper( $format_string ), 'A' )  === false ) {
-					$error_msg[] = __('There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".', 'event_espresso' );
+				if (strpos(strtoupper($format_string), 'A') === false) {
+					$error_msg[] = __('There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".', 'event_espresso');
 				}
 				break;
 
 		}
 
-		return empty( $error_msg ) ? true : $error_msg;
+		return empty($error_msg) ? true : $error_msg;
 	}
 
 
@@ -832,11 +831,11 @@ 
 	 * @param mixed $date_2
 	 * @return bool
 	 */
-	public static function dates_represent_one_24_hour_date( $date_1, $date_2 ) {
+	public static function dates_represent_one_24_hour_date($date_1, $date_2) {
 
 		if (
-			( ! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime ) ||
-			( $date_1->format( EE_Datetime_Field::mysql_time_format ) != '00:00:00' || $date_2->format( EE_Datetime_Field::mysql_time_format ) != '00:00:00' )
+			( ! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) ||
+			($date_1->format(EE_Datetime_Field::mysql_time_format) != '00:00:00' || $date_2->format(EE_Datetime_Field::mysql_time_format) != '00:00:00')
 		) {
 			return false;
 		}
@@ -853,11 +852,11 @@ 
 	 * @param string $field_for_interval  The Database field that is the interval is applied to in the query.
 	 * @return string
 	 */
-	public static function get_sql_query_interval_for_offset( $timezone_string, $field_for_interval ) {
+	public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval) {
 		try {
 			/** need to account for timezone offset on the selects */
-			$DateTimeZone = new DateTimeZone( $timezone_string );
-		} catch ( Exception $e ) {
+			$DateTimeZone = new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
 			$DateTimeZone = null;
 		}
 
@@ -865,10 +864,10 @@ 
 		 * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
 		 * Hence we do the calc for DateTimeZone::getOffset.
 		 */
-		$offset = $DateTimeZone instanceof DateTimeZone ? ( $DateTimeZone->getOffset( new DateTime('now') ) ) / HOUR_IN_SECONDS : get_option( 'gmt_offset' );
+		$offset = $DateTimeZone instanceof DateTimeZone ? ($DateTimeZone->getOffset(new DateTime('now'))) / HOUR_IN_SECONDS : get_option('gmt_offset');
 		$query_interval = $offset < 0
-			? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset*-1 . ' HOUR)'
-			: 'DATE_ADD(' . $field_for_interval .', INTERVAL ' . $offset . ' HOUR)';
+			? 'DATE_SUB('.$field_for_interval.', INTERVAL '.$offset * -1.' HOUR)'
+			: 'DATE_ADD('.$field_for_interval.', INTERVAL '.$offset.' HOUR)';
 		return $query_interval;
 	}
 
@@ -880,47 +879,47 @@ 
 	 * @return string
 	 */
 	public static function get_timezone_string_for_display() {
-		$pretty_timezone = apply_filters( 'FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '' );
-		if( ! empty( $pretty_timezone ) ) {
-			return esc_html( $pretty_timezone );
+		$pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
+		if ( ! empty($pretty_timezone)) {
+			return esc_html($pretty_timezone);
 		}
-		$timezone_string = get_option( 'timezone_string' );
-		if( $timezone_string ) {
+		$timezone_string = get_option('timezone_string');
+		if ($timezone_string) {
 			static $mo_loaded = false;
 			// Load translations for continents and cities just like wp_timezone_choice does
-			if ( ! $mo_loaded ) {
+			if ( ! $mo_loaded) {
 				$locale = get_locale();
-				$mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
-				load_textdomain( 'continents-cities', $mofile );
+				$mofile = WP_LANG_DIR.'/continents-cities-'.$locale.'.mo';
+				load_textdomain('continents-cities', $mofile);
 				$mo_loaded = true;
 			}
 			//well that was easy.
-			$parts = explode('/', $timezone_string );
+			$parts = explode('/', $timezone_string);
 			//remove the continent
-			unset( $parts[0] );
+			unset($parts[0]);
 			$t_parts = array();
-			foreach( $parts as $part ) {
-				$t_parts[] = translate( str_replace( '_', ' ', $part ), 'continents-cities' );
+			foreach ($parts as $part) {
+				$t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
 			}
-			return implode( ' - ', $t_parts );
+			return implode(' - ', $t_parts);
 		}
 		//they haven't set the timezone string, so let's return a string like "UTC+1"
-		$gmt_offset = get_option( 'gmt_offset' );
-		if( intval( $gmt_offset ) >= 0 ) {
+		$gmt_offset = get_option('gmt_offset');
+		if (intval($gmt_offset) >= 0) {
 			$prefix = '+';
 		} else {
 			$prefix = '';
 		}
-		$parts = explode( '.', (string) $gmt_offset );
-		if( count( $parts ) === 1 ) {
+		$parts = explode('.', (string) $gmt_offset);
+		if (count($parts) === 1) {
 			$parts[1] = '00';
 		} else {
 			//convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
 			//to minutes, eg 30 or 15, respectively
-			$hour_fraction = (float)( '0.' . $parts[1] );
-			$parts[1] = (string)$hour_fraction * 60;
+			$hour_fraction = (float) ('0.'.$parts[1]);
+			$parts[1] = (string) $hour_fraction * 60;
 		}
-		return sprintf( __( 'UTC%1$s', 'event_espresso' ), $prefix . implode( ':', $parts ) );
+		return sprintf(__('UTC%1$s', 'event_espresso'), $prefix.implode(':', $parts));
 	}
 
 

core/libraries/rest_api/Model_Data_Translator.php

Indentation +481 added lines, -481 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,485 +26,485 @@ 
 class Model_Data_Translator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const ee_inf_in_rest = null;
-
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_values_from_json(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $array_item,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_value_from_json(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    )
-    {
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        if ($field_obj instanceof \EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
-                $field_obj->get_timezone_offset(
-                    new \DateTimeZone($timezone_string)
-                )
-            );
-            $offset_string =
-                str_pad(
-                    floor($offset_secs / HOUR_IN_SECONDS),
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                )
-                . ':'
-                . str_pad(
-                    ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parse_timezone_offset($timezone_offset)
-    {
-        $first_char = substr((string)$timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @return mixed
-     */
-    public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = Model_Data_Translator::ee_inf_in_rest;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } else {
-                $new_value = $original_value;
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array     $inputted_query_params_of_this_type
-     * @param \EEM_Base $model
-     * @param string    $requested_version
-     * @return array
-     * @throws \DomainException
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_models(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if ( ! $field instanceof \EE_Model_Field_Base
-                 && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
-                $field = Model_Data_Translator::deduce_field_from_query_param(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-            } else {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            }
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
-                            $requested_version, $timezone);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
-                        $requested_version, $timezone);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function is_gmt_date_field_name($field_name)
-    {
-        return substr(
-                   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
-                   -4,
-                   4
-               ) === '_gmt';
-    }
-
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function remove_gmt_from_field_name($field_name)
-    {
-        if ( ! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepare_field_name_from_json($field_name)
-    {
-        if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return Model_Data_Translator::remove_gmt_from_field_name($field_name);
-        }
-        return $field_name;
-    }
-
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepare_field_names_from_json(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array     $model_query_params
-     * @param \EEM_Base $model
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws \EE_Error
-     */
-    public static function prepare_query_params_for_rest_api(
-        array $model_query_params,
-        \EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params, $model_query_params, $model, $requested_version);
-    }
-
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param \EEM_Base $model
-     * @param string    $requested_version                  eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_rest_api(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
-                $model
-            );
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
-                            $requested_version);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
-                        $requested_version);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param \EEM_Base $model
-     * @return \EE_Model_Field_Base
-     * @throws \EE_Error
-     */
-    public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
-    {
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
-        //which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
-                'event_espresso'), $query_param_name));
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
-        }
-        try {
-            return $model->field_settings_for($field_name);
-        } catch (\EE_Error $e) {
-            return null;
-        }
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const ee_inf_in_rest = null;
+
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_values_from_json(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$array_item,
+					$request_version
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_value_from_json(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	)
+	{
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		if ($field_obj instanceof \EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
+				$field_obj->get_timezone_offset(
+					new \DateTimeZone($timezone_string)
+				)
+			);
+			$offset_string =
+				str_pad(
+					floor($offset_secs / HOUR_IN_SECONDS),
+					2,
+					'0',
+					STR_PAD_LEFT
+				)
+				. ':'
+				. str_pad(
+					($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+					2,
+					'0',
+					STR_PAD_LEFT
+				);
+			$new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parse_timezone_offset($timezone_offset)
+	{
+		$first_char = substr((string)$timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string)$timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @return mixed
+	 */
+	public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = Model_Data_Translator::ee_inf_in_rest;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} else {
+				$new_value = $original_value;
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array     $inputted_query_params_of_this_type
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version
+	 * @return array
+	 * @throws \DomainException
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_models(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if ( ! $field instanceof \EE_Model_Field_Base
+				 && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
+				$field = Model_Data_Translator::deduce_field_from_query_param(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+			} else {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			}
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
+							$requested_version, $timezone);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
+						$requested_version, $timezone);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function is_gmt_date_field_name($field_name)
+	{
+		return substr(
+				   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
+				   -4,
+				   4
+			   ) === '_gmt';
+	}
+
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function remove_gmt_from_field_name($field_name)
+	{
+		if ( ! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepare_field_name_from_json($field_name)
+	{
+		if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return Model_Data_Translator::remove_gmt_from_field_name($field_name);
+		}
+		return $field_name;
+	}
+
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepare_field_names_from_json(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array     $model_query_params
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws \EE_Error
+	 */
+	public static function prepare_query_params_for_rest_api(
+		array $model_query_params,
+		\EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params, $model_query_params, $model, $requested_version);
+	}
+
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version                  eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_rest_api(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
+				$model
+			);
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
+							$requested_version);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
+						$requested_version);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Field_Base
+	 * @throws \EE_Error
+	 */
+	public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
+	{
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
+		//which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
+				'event_espresso'), $query_param_name));
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
+		}
+		try {
+			return $model->field_settings_for($field_name);
+		} catch (\EE_Error $e) {
+			return null;
+		}
+	}
 
 }

Spacing +3 added lines, -3 removed lines

@@ -148,7 +148,7 @@ 
                     '0',
                     STR_PAD_LEFT
                 );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+            $new_value = rest_parse_date($original_value.$offset_sign.$offset_string);
         } else {
             $new_value = $original_value;
         }
@@ -165,10 +165,10 @@ 
      */
     private static function parse_timezone_offset($timezone_offset)
     {
-        $first_char = substr((string)$timezone_offset, 0, 1);
+        $first_char = substr((string) $timezone_offset, 0, 1);
         if ($first_char === '+' || $first_char === '-') {
             $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
+            $offset_secs = substr((string) $timezone_offset, 1);
         } else {
             $offset_sign = '+';
             $offset_secs = $timezone_offset;

core/admin/EE_Admin.core.php

Indentation +21 added lines, -21 removed lines

@@ -167,11 +167,11 @@ 
 
 
 	/**
-	* init- should fire after shortcode, module,  addon, other plugin (default priority), and even EE_Front_Controller's init phases have run
-	*
-	* @access public
-	* @return void
-	*/
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even EE_Front_Controller's init phases have run
+	 *
+	 * @access public
+	 * @return void
+	 */
 	public function init() {
 		//only enable most of the EE_Admin IF we're not in full maintenance mode
 		if ( EE_Maintenance_Mode::instance()->models_can_query() ){
@@ -456,11 +456,11 @@ 
 
 
 	/**
-	* admin_init
-	*
-	* @access public
-	* @return void
-	*/
+	 * admin_init
+	 *
+	 * @access public
+	 * @return void
+	 */
 	public function admin_init() {
 
 		/**
@@ -612,24 +612,24 @@ 
 
 
 	/**
-	* 	dismiss_persistent_admin_notice
-	*
-	*	@access 	public
-	* 	@return 		void
-	*/
+	 * 	dismiss_persistent_admin_notice
+	 *
+	 *	@access 	public
+	 * 	@return 		void
+	 */
 	public function dismiss_ee_nag_notice_callback() {
 		EE_Error::dismiss_persistent_admin_notice();
 	}
 
 
 
-    /**
-     * @param array $elements
-     * @return array
-     * @throws \EE_Error
-     */
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws \EE_Error
+	 */
 	public function dashboard_glance_items($elements) {
-        $elements = is_array($elements) ? $elements : array($elements);
+		$elements = is_array($elements) ? $elements : array($elements);
 		$events = EEM_Event::instance()->count();
 		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce( array('page' => 'espresso_events'), admin_url('admin.php') );
 		$items['events']['text'] = sprintf( _n( '%s Event', '%s Events', $events ), number_format_i18n( $events ) );

Spacing +142 added lines, -142 removed lines

@@ -40,7 +40,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if (  ! self::$_instance instanceof EE_Admin ) {
+		if ( ! self::$_instance instanceof EE_Admin) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -57,30 +57,30 @@ 
 		// define global EE_Admin constants
 		$this->_define_all_constants();
 		// set autoloaders for our admin page classes based on included path information
-		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder( EE_ADMIN );
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
 		// admin hooks
-		add_filter( 'plugin_action_links', array( $this, 'filter_plugin_actions' ), 10, 2 );
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
 		// load EE_Request_Handler early
-		add_action( 'AHEE__EE_System__core_loaded_and_ready', array( $this, 'get_request' ));
-		add_action( 'AHEE__EE_System__initialize_last', array( $this, 'init' ));
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
 		// post shortcode tracking
 		add_action(
 			'AHEE__EE_System__initialize_last',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'set_hooks_admin' )
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'set_hooks_admin')
 		);
-		add_action( 'AHEE__EE_Admin_Page__route_admin_request', array( $this, 'route_admin_request' ), 100, 2 );
-		add_action( 'wp_loaded', array( $this, 'wp_loaded' ), 100 );
-		add_action( 'admin_init', array( $this, 'admin_init' ), 100 );
-		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ), 20 );
-		add_action( 'admin_notices', array( $this, 'display_admin_notices' ), 10 );
-		add_action( 'network_admin_notices', array( $this, 'display_admin_notices' ), 10 );
-		add_filter( 'pre_update_option', array( $this, 'check_for_invalid_datetime_formats' ), 100, 2 );
-		add_filter('admin_footer_text', array( $this, 'espresso_admin_footer' ));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
 
 		//reset Environment config (we only do this on admin page loads);
 		EE_Registry::instance()->CFG->environment->recheck_values();
 
-		do_action( 'AHEE__EE_Admin__loaded' );
+		do_action('AHEE__EE_Admin__loaded');
 	}
 
 
@@ -95,11 +95,11 @@ 
 	 * @return void
 	 */
 	private function _define_all_constants() {
-		define( 'EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/' );
-		define( 'EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/' );
-		define( 'EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS );
-		define( 'WP_ADMIN_PATH', ABSPATH . 'wp-admin/' );
-		define( 'WP_AJAX_URL', admin_url( 'admin-ajax.php' ));
+		define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+		define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+		define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates'.DS);
+		define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
+		define('WP_AJAX_URL', admin_url('admin-ajax.php'));
 	}
 
 
@@ -112,23 +112,23 @@ 
 	 * @param 	string 	$plugin
 	 * @return 	array
 	 */
-	public function filter_plugin_actions( $links, $plugin ) {
+	public function filter_plugin_actions($links, $plugin) {
 		// set $main_file in stone
 		static $main_file;
 		// if $main_file is not set yet
-		if ( ! $main_file ) {
-			$main_file = plugin_basename( EVENT_ESPRESSO_MAIN_FILE );
+		if ( ! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
 		}
-		 if ( $plugin === $main_file ) {
+		 if ($plugin === $main_file) {
 		 	// compare current plugin to this one
-			if ( EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance ) {
-				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings" title="Event Espresso is in maintenance mode.  Click this link to learn why.">' . __('Maintenance Mode Active', 'event_espresso' ) . '</a>';
-				array_unshift( $links, $maintenance_link );
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings" title="Event Espresso is in maintenance mode.  Click this link to learn why.">'.__('Maintenance Mode Active', 'event_espresso').'</a>';
+				array_unshift($links, $maintenance_link);
 			} else {
-				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">' . __( 'Settings', 'event_espresso' ) . '</a>';
-				$events_link = '<a href="admin.php?page=espresso_events">' . __( 'Events', 'event_espresso' ) . '</a>';
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'.__('Settings', 'event_espresso').'</a>';
+				$events_link = '<a href="admin.php?page=espresso_events">'.__('Events', 'event_espresso').'</a>';
 				// add before other links
-				array_unshift( $links, $org_settings_link, $events_link );
+				array_unshift($links, $org_settings_link, $events_link);
 			}
 		}
 		return $links;
@@ -143,8 +143,8 @@ 
 	 *	@return void
 	 */
 	public function get_request() {
-		EE_Registry::instance()->load_core( 'Request_Handler' );
-		EE_Registry::instance()->load_core( 'CPT_Strategy' );
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_core('CPT_Strategy');
 	}
 
 
@@ -156,11 +156,11 @@ 
 	 * @param array $admin_page_folder_names
 	 * @return array
 	 */
-	public function hide_admin_pages_except_maintenance_mode( $admin_page_folder_names = array() ){
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array()) {
 		return array(
-			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-			'about' => EE_ADMIN_PAGES . 'about' . DS,
-			'support' => EE_ADMIN_PAGES . 'support' . DS
+			'maintenance' => EE_ADMIN_PAGES.'maintenance'.DS,
+			'about' => EE_ADMIN_PAGES.'about'.DS,
+			'support' => EE_ADMIN_PAGES.'support'.DS
 		);
 	}
 
@@ -174,31 +174,31 @@ 
 	*/
 	public function init() {
 		//only enable most of the EE_Admin IF we're not in full maintenance mode
-		if ( EE_Maintenance_Mode::instance()->models_can_query() ){
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			//ok so we want to enable the entire admin
-			add_action( 'wp_ajax_dismiss_ee_nag_notice', array( $this, 'dismiss_ee_nag_notice_callback' ));
-			add_action( 'admin_notices', array( $this, 'get_persistent_admin_notices' ), 9 );
-			add_action( 'network_admin_notices', array( $this, 'get_persistent_admin_notices' ), 9 );
+			add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismiss_ee_nag_notice_callback'));
+			add_action('admin_notices', array($this, 'get_persistent_admin_notices'), 9);
+			add_action('network_admin_notices', array($this, 'get_persistent_admin_notices'), 9);
 			//at a glance dashboard widget
-			add_filter( 'dashboard_glance_items', array( $this, 'dashboard_glance_items' ), 10 );
+			add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
 			//filter for get_edit_post_link used on comments for custom post types
-			add_filter( 'get_edit_post_link', array( $this, 'modify_edit_post_link' ), 10, 2 );
+			add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
 		}
 		// run the admin page factory but ONLY if we are doing an ee admin ajax request
-		if ( !defined('DOING_AJAX') || EE_ADMIN_AJAX ) {
+		if ( ! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
 			try {
 				//this loads the controller for the admin pages which will setup routing etc
-				EE_Registry::instance()->load_core( 'Admin_Page_Loader' );
-			} catch ( EE_Error $e ) {
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
 				$e->get_error();
 			}
 		}
-		add_filter( 'content_save_pre', array( $this, 'its_eSpresso' ), 10, 1 );
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
 		//make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes' ), 10 );
-		add_action('admin_head', array( $this, 'register_custom_nav_menu_boxes' ), 10 );
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
 		//exclude EE critical pages from all nav menus and wp_list_pages
-		add_filter('nav_menu_meta_box_object', array( $this, 'remove_pages_from_nav_menu'), 10 );
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
 	}
 
 
@@ -211,9 +211,9 @@ 
 	 * @param  object $post_type WP post type object
 	 * @return object            WP post type object
 	 */
-	public function remove_pages_from_nav_menu( $post_type ) {
+	public function remove_pages_from_nav_menu($post_type) {
 		//if this isn't the "pages" post type let's get out
-		if ( $post_type->name !== 'page' ) {
+		if ($post_type->name !== 'page') {
 			return $post_type;
 		}
 		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
@@ -233,28 +233,28 @@ 
 	 */
 	public function enable_hidden_ee_nav_menu_metaboxes() {
 		global $wp_meta_boxes, $pagenow;
-		if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php' ) {
+		if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
 			return;
 		}
 		$user = wp_get_current_user();
 		//has this been done yet?
-		if ( get_user_option( 'ee_nav_menu_initialized', $user->ID ) ) {
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
 			return;
 		}
 
-		$hidden_meta_boxes = get_user_option( 'metaboxhidden_nav-menus', $user->ID );
-		$initial_meta_boxes = apply_filters( 'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes', array( 'nav-menu-theme-locations', 'add-page', 'add-custom-links', 'add-category', 'add-espresso_events', 'add-espresso_venues', 'add-espresso_event_categories', 'add-espresso_venue_categories', 'add-post-type-post', 'add-post-type-page' ) );
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters('FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes', array('nav-menu-theme-locations', 'add-page', 'add-custom-links', 'add-category', 'add-espresso_events', 'add-espresso_venues', 'add-espresso_event_categories', 'add-espresso_venue_categories', 'add-post-type-post', 'add-post-type-page'));
 
-		if ( is_array( $hidden_meta_boxes ) ) {
-			foreach ( $hidden_meta_boxes as $key => $meta_box_id ) {
-				if ( in_array( $meta_box_id, $initial_meta_boxes ) ) {
-					unset( $hidden_meta_boxes[ $key ] );
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes)) {
+					unset($hidden_meta_boxes[$key]);
 				}
 			}
 		}
 
-		update_user_option( $user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true );
-		update_user_option( $user->ID, 'ee_nav_menu_initialized', 1, true );
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
 	}
 
 
@@ -273,7 +273,7 @@ 
 	 * @return void
 	 */
 	public function register_custom_nav_menu_boxes() {
-		add_meta_box( 'add-extra-nav-menu-pages', __('Event Espresso Pages', 'event_espresso'), array( $this, 'ee_cpt_archive_pages' ), 'nav-menus', 'side', 'core' );
+		add_meta_box('add-extra-nav-menu-pages', __('Event Espresso Pages', 'event_espresso'), array($this, 'ee_cpt_archive_pages'), 'nav-menus', 'side', 'core');
 	}
 
 
@@ -289,16 +289,16 @@ 
 	 *
 	 * @return string  the (maybe) modified link
 	 */
-	public function modify_edit_post_link( $link, $id ) {
-		if ( ! $post = get_post( $id ) ){
+	public function modify_edit_post_link($link, $id) {
+		if ( ! $post = get_post($id)) {
 			return $link;
 		}
-		if ( $post->post_type === 'espresso_attendees' ) {
+		if ($post->post_type === 'espresso_attendees') {
 			$query_args = array(
 				'action' => 'edit_attendee',
 				'post' => $id
 			);
-			return EEH_URL::add_query_args_and_nonce( $query_args, admin_url('admin.php?page=espresso_registrations') );
+			return EEH_URL::add_query_args_and_nonce($query_args, admin_url('admin.php?page=espresso_registrations'));
 		}
 		return $link;
 	}
@@ -310,7 +310,7 @@ 
 		global $nav_menu_selected_id;
 
 		$db_fields = false;
-		$walker = new Walker_Nav_Menu_Checklist( $db_fields );
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
 		$current_tab = 'event-archives';
 
 		/*if ( ! empty( $_REQUEST['quick-search-posttype-' . $post_type_name] ) ) {
@@ -329,9 +329,9 @@ 
 		?>
 		<div id="posttype-extra-nav-menu-pages" class="posttypediv">
 			<ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
-				<li <?php echo ( 'event-archives' === $current_tab ? ' class="tabs"' : '' ); ?>>
-					<a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives" href="<?php if ( $nav_menu_selected_id ) {echo esc_url(add_query_arg('extra-nav-menu-pages-tab', 'event-archives', remove_query_arg($removed_args)));} ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
-						<?php _e( 'Event Archive Pages', 'event_espresso' ); ?>
+				<li <?php echo ('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
+					<a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives" href="<?php if ($nav_menu_selected_id) {echo esc_url(add_query_arg('extra-nav-menu-pages-tab', 'event-archives', remove_query_arg($removed_args))); } ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+						<?php _e('Event Archive Pages', 'event_espresso'); ?>
 					</a>
 				</li>
 			<?php /* // temporarily removing but leaving skeleton in place in case we ever decide to add more tabs.
@@ -349,13 +349,13 @@ 
  			<?php */ ?>
 
 			<div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-			echo ( 'event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive' );
+			echo ('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
 			?>">
 				<ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
 					<?php
 					$pages = $this->_get_extra_nav_menu_pages_items();
 					$args['walker'] = $walker;
-					echo walk_nav_menu_tree( array_map( array( $this, '_setup_extra_nav_menu_pages_items' ), $pages), 0, (object) $args );
+					echo walk_nav_menu_tree(array_map(array($this, '_setup_extra_nav_menu_pages_items'), $pages), 0, (object) $args);
 					?>
 				</ul>
 			</div><!-- /.tabs-panel -->
@@ -363,18 +363,18 @@ 
 			<p class="button-controls">
 				<span class="list-controls">
 					<a href="<?php
-						echo esc_url( add_query_arg(
+						echo esc_url(add_query_arg(
 							array(
 								'extra-nav-menu-pages-tab' => 'event-archives',
 								'selectall' => 1,
 							),
-							remove_query_arg( $removed_args )
+							remove_query_arg($removed_args)
 						));
 					?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All'); ?></a>
 				</span>
 
 				<span class="add-to-menu">
-					<input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( __( 'Add to Menu' ) ); ?>" name="add-post-type-menu-item" id="<?php esc_attr_e( 'submit-posttype-extra-nav-menu-pages' ); ?>" />
+					<input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e(__('Add to Menu')); ?>" name="add-post-type-menu-item" id="<?php esc_attr_e('submit-posttype-extra-nav-menu-pages'); ?>" />
 					<span class="spinner"></span>
 				</span>
 			</p>
@@ -395,10 +395,10 @@ 
 	private function _get_extra_nav_menu_pages_items() {
 		$menuitems[] = array(
 			'title' => __('Event List', 'event_espresso'),
-			'url' => get_post_type_archive_link( 'espresso_events' ),
+			'url' => get_post_type_archive_link('espresso_events'),
 			'description' => __('Archive page for all events.', 'event_espresso')
 		);
-		return apply_filters( 'FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems );
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
 	}
 
 
@@ -410,7 +410,7 @@ 
 	 * @param $menu_item_values
 	 * @return stdClass
 	 */
-	private function _setup_extra_nav_menu_pages_items( $menu_item_values ) {
+	private function _setup_extra_nav_menu_pages_items($menu_item_values) {
 		$menu_item = new stdClass();
 		$keys = array(
 			'ID' => 0,
@@ -430,8 +430,8 @@ 
 			'xfn' => ''
 		);
 
-		foreach ( $keys as $key => $value) {
-			$menu_item->{$key} = isset( $menu_item_values[ $key]) ? $menu_item_values[ $key] : $value;
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
 		}
 		return $menu_item;
 	}
@@ -470,9 +470,9 @@ 
 		 * - check if doing post processing of one of EE CPTs
 		 * - instantiate the corresponding EE CPT model for the post_type being processed.
 		 */
-		if ( isset( $_POST['action'], $_POST['post_type'] ) && $_POST['action'] === 'editpost' ) {
-			EE_Registry::instance()->load_core( 'Register_CPTs' );
-			EE_Register_CPTs::instantiate_cpt_models( $_POST['post_type'] );
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			EE_Registry::instance()->load_core('Register_CPTs');
+			EE_Register_CPTs::instantiate_cpt_models($_POST['post_type']);
 		}
 
 
@@ -481,8 +481,8 @@ 
 		 * 'options-reading.php' core WordPress admin settings page.  This is for user-proofing.
 		 */
 		global $pagenow;
-		if ( $pagenow === 'options-reading.php' ) {
-			add_filter( 'wp_dropdown_pages', array( $this, 'modify_dropdown_pages' ) );
+		if ($pagenow === 'options-reading.php') {
+			add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
 		}
 
 	}
@@ -494,25 +494,25 @@ 
 	 * @param string $output  Current output.
 	 * @return string
 	 */
-	public function modify_dropdown_pages( $output ) {
+	public function modify_dropdown_pages($output) {
 		//get critical pages
 		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
 
 		//split current output by line break for easier parsing.
-		$split_output = explode( "\n", $output );
+		$split_output = explode("\n", $output);
 
 		//loop through to remove any critical pages from the array.
-		foreach ( $critical_pages as $page_id ) {
-			$needle = 'value="' . $page_id . '"';
-			foreach( $split_output as $key => $haystack ) {
-				if( strpos( $haystack, $needle ) !== false ) {
-					unset( $split_output[$key] );
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="'.$page_id.'"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[$key]);
 				}
 			}
 		}
 
 		//replace output with the new contents
-		return implode( "\n", $split_output );
+		return implode("\n", $split_output);
 	}
 
 
@@ -526,36 +526,36 @@ 
 	public function enqueue_admin_scripts() {
 		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
 		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script calls.
-		wp_enqueue_script('ee-inject-wp', EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
+		wp_enqueue_script('ee-inject-wp', EE_ADMIN_URL.'assets/ee-cpt-wp-injects.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
 		// register cookie script for future dependencies
-		wp_register_script('jquery-cookie', EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js', array('jquery'), '2.1', TRUE );
+		wp_register_script('jquery-cookie', EE_THIRD_PARTY_URL.'joyride/jquery.cookie.js', array('jquery'), '2.1', TRUE);
 		// jquery_validate loading is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
-		if ( apply_filters( 'FHEE_load_jquery_validate', FALSE ) ) {
+		if (apply_filters('FHEE_load_jquery_validate', FALSE)) {
 			// register jQuery Validate
-			wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js', array('jquery'), '1.15.0', TRUE);
+			wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js', array('jquery'), '1.15.0', TRUE);
 		}
 		//joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again vai: add_filter('FHEE_load_joyride', '__return_true' );
-		if ( apply_filters( 'FHEE_load_joyride', FALSE ) ) {
+		if (apply_filters('FHEE_load_joyride', FALSE)) {
 			//joyride style
-			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-			wp_register_style('ee-joyride-css', EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css', array('joyride-css'), EVENT_ESPRESSO_VERSION );
-			wp_register_script('joyride-modernizr', EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js', array(), '2.1', TRUE );
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL.'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style('ee-joyride-css', EE_GLOBAL_ASSETS_URL.'css/ee-joyride-styles.css', array('joyride-css'), EVENT_ESPRESSO_VERSION);
+			wp_register_script('joyride-modernizr', EE_THIRD_PARTY_URL.'joyride/modernizr.mq.js', array(), '2.1', TRUE);
 			//joyride JS
-			wp_register_script('jquery-joyride', EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js', array('jquery-cookie', 'joyride-modernizr'), '2.1', TRUE );
+			wp_register_script('jquery-joyride', EE_THIRD_PARTY_URL.'joyride/jquery.joyride-2.1.js', array('jquery-cookie', 'joyride-modernizr'), '2.1', TRUE);
 			// wanna go for a joyride?
 			wp_enqueue_style('ee-joyride-css');
 			wp_enqueue_script('jquery-joyride');
 		}
 		//qtip is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again via: add_filter('FHEE_load_qtips', '__return_true' );
-		if ( apply_filters( 'FHEE_load_qtip', FALSE ) ) {
+		if (apply_filters('FHEE_load_qtip', FALSE)) {
 			EEH_Qtip_Loader::instance()->register_and_enqueue();
 		}
 		//accounting.js library
 		// @link http://josscrowcroft.github.io/accounting.js/
-		if ( apply_filters( 'FHEE_load_accounting_js', FALSE ) ) {
-			wp_register_script( 'ee-accounting', EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js', array('ee-accounting-core'), EVENT_ESPRESSO_VERSION, TRUE );
-			wp_register_script( 'ee-accounting-core', EE_THIRD_PARTY_URL . 'accounting/accounting.js', array('underscore'), '0.3.2', TRUE );
-			wp_enqueue_script( 'ee-accounting' );
+		if (apply_filters('FHEE_load_accounting_js', FALSE)) {
+			wp_register_script('ee-accounting', EE_GLOBAL_ASSETS_URL.'scripts/ee-accounting-config.js', array('ee-accounting-core'), EVENT_ESPRESSO_VERSION, TRUE);
+			wp_register_script('ee-accounting-core', EE_THIRD_PARTY_URL.'accounting/accounting.js', array('underscore'), '0.3.2', TRUE);
+			wp_enqueue_script('ee-accounting');
 			// array of settings to get converted to JSON array via wp_localize_script
 			$currency_config = array(
 				'currency' => array(
@@ -602,11 +602,11 @@ 
 	public function get_persistent_admin_notices() {
 		// http://www.example.com/wp-admin/admin.php?page=espresso_general_settings&action=critical_pages&critical_pages_nonce=2831ce0f30
 		$args = array(
-			'page' => EE_Registry::instance()->REQ->is_set( 'page' ) ? EE_Registry::instance()->REQ->get( 'page' ) : '',
-			'action' => EE_Registry::instance()->REQ->is_set( 'action' ) ? EE_Registry::instance()->REQ->get( 'action' ) : '',
+			'page' => EE_Registry::instance()->REQ->is_set('page') ? EE_Registry::instance()->REQ->get('page') : '',
+			'action' => EE_Registry::instance()->REQ->is_set('action') ? EE_Registry::instance()->REQ->get('action') : '',
 		);
-		$return_url = EE_Admin_Page::add_query_args_and_nonce( $args, EE_ADMIN_URL );
-		echo EE_Error::get_persistent_admin_notices( $return_url );
+		$return_url = EE_Admin_Page::add_query_args_and_nonce($args, EE_ADMIN_URL);
+		echo EE_Error::get_persistent_admin_notices($return_url);
 	}
 
 
@@ -631,24 +631,24 @@ 
 	public function dashboard_glance_items($elements) {
         $elements = is_array($elements) ? $elements : array($elements);
 		$events = EEM_Event::instance()->count();
-		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce( array('page' => 'espresso_events'), admin_url('admin.php') );
-		$items['events']['text'] = sprintf( _n( '%s Event', '%s Events', $events ), number_format_i18n( $events ) );
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(array('page' => 'espresso_events'), admin_url('admin.php'));
+		$items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events), number_format_i18n($events));
 		$items['events']['title'] = __('Click to view all Events', 'event_espresso');
 		$registrations = EEM_Registration::instance()->count(
 			array(
 				array(
-					'STS_ID' => array( '!=', EEM_Registration::status_id_incomplete )
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete)
 				)
 			)
 		);
-		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce( array('page' => 'espresso_registrations' ), admin_url('admin.php') );
-		$items['registrations']['text'] = sprintf( _n( '%s Registration', '%s Registrations', $registrations ), number_format_i18n($registrations) );
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(array('page' => 'espresso_registrations'), admin_url('admin.php'));
+		$items['registrations']['text'] = sprintf(_n('%s Registration', '%s Registrations', $registrations), number_format_i18n($registrations));
 		$items['registrations']['title'] = __('Click to view all registrations', 'event_espresso');
 
-		$items = (array) apply_filters( 'FHEE__EE_Admin__dashboard_glance_items__items', $items );
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
 
-		foreach ( $items as $type => $item_properties ) {
-			$elements[] = sprintf( '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>', $item_properties['url'], $item_properties['title'], $item_properties['text'] );
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf('<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>', $item_properties['url'], $item_properties['title'], $item_properties['text']);
 		}
 		return $elements;
 	}
@@ -665,31 +665,31 @@ 
 	 * @throws EE_Error
 	 * @return    string
 	 */
-	public function check_for_invalid_datetime_formats( $value, $option ) {
+	public function check_for_invalid_datetime_formats($value, $option) {
 		// check for date_format or time_format
-		switch ( $option ) {
+		switch ($option) {
 			case 'date_format' :
-				$date_time_format = $value . ' ' . get_option('time_format');
+				$date_time_format = $value.' '.get_option('time_format');
 				break;
 			case 'time_format' :
-				$date_time_format = get_option('date_format') . ' ' . $value;
+				$date_time_format = get_option('date_format').' '.$value;
 				break;
 			default :
 				$date_time_format = FALSE;
 		}
 		// do we have a date_time format to check ?
-		if ( $date_time_format ) {
-			$error_msg = EEH_DTT_Helper::validate_format_string( $date_time_format );
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
 
-			if ( is_array( $error_msg ) ) {
-				$msg = '<p>' . sprintf( __( 'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:', 'event_espresso' ), date( $date_time_format ) , $date_time_format  ) . '</p><p><ul>';
+			if (is_array($error_msg)) {
+				$msg = '<p>'.sprintf(__('The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:', 'event_espresso'), date($date_time_format), $date_time_format).'</p><p><ul>';
 
 
-				foreach ( $error_msg as $error ) {
-					$msg .= '<li>' . $error . '</li>';
+				foreach ($error_msg as $error) {
+					$msg .= '<li>'.$error.'</li>';
 				}
 
-				$msg .= '</ul></p><p>' . sprintf( __( '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s', 'event_espresso' ), '<span style="color:#D54E21;">', '</span>' ) . '</p>';
+				$msg .= '</ul></p><p>'.sprintf(__('%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s', 'event_espresso'), '<span style="color:#D54E21;">', '</span>').'</p>';
 
 				// trigger WP settings error
 				add_settings_error(
@@ -699,7 +699,7 @@ 
 				);
 
 				// set format to something valid
-				switch ( $option ) {
+				switch ($option) {
 					case 'date_format' :
 						$value = 'F j, Y';
 						break;
@@ -721,8 +721,8 @@ 
 	 * @param $content
 	 * @return    string
 	 */
-	public function its_eSpresso( $content ) {
-		return str_replace( '[EXPRESSO_', '[ESPRESSO_', $content );
+	public function its_eSpresso($content) {
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
 	}
 
 
@@ -734,7 +734,7 @@ 
 	 *  @return 	string
 	 */
 	public function espresso_admin_footer() {
-		return \EEH_Template::powered_by_event_espresso( 'aln-cntr', '', array( 'utm_content' => 'admin_footer' ));
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
 	}
 
 
@@ -753,12 +753,12 @@ 
 	 * @param array $config
 	 * @return void
 	 */
-	public static function register_ee_admin_page( $page_basename, $page_path, $config = array() ) {
-		EE_Error::doing_it_wrong( __METHOD__, sprintf( __('Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.', 'event_espresso'), $page_basename), '4.3' );
-		if ( class_exists( 'EE_Register_Admin_Page' ) ) {
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array()) {
+		EE_Error::doing_it_wrong(__METHOD__, sprintf(__('Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.', 'event_espresso'), $page_basename), '4.3');
+		if (class_exists('EE_Register_Admin_Page')) {
 			$config['page_path'] = $page_path;
 		}
-		EE_Register_Admin_Page::register( $page_basename, $config );
+		EE_Register_Admin_Page::register($page_basename, $config);
 
 	}
 
@@ -771,7 +771,7 @@ 
 	 * @param  \WP_Post $post
 	 * @return void
 	 */
-	public static function parse_post_content_on_save( $post_ID, $post ) {
+	public static function parse_post_content_on_save($post_ID, $post) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			__(
@@ -780,7 +780,7 @@ 
 			),
 			'4.8.41'
 		);
-		EventEspresso\core\admin\PostShortcodeTracking::parse_post_content_on_save( $post_ID, $post );
+		EventEspresso\core\admin\PostShortcodeTracking::parse_post_content_on_save($post_ID, $post);
 	}
 
 
@@ -793,7 +793,7 @@ 
 	 * @param  $value
 	 * @return void
 	 */
-	public function reset_page_for_posts_on_change( $option, $old_value, $value ) {
+	public function reset_page_for_posts_on_change($option, $old_value, $value) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			__(
@@ -802,7 +802,7 @@ 
 			),
 			'4.8.41'
 		);
-		EventEspresso\core\admin\PostShortcodeTracking::reset_page_for_posts_on_change( $option, $old_value, $value );
+		EventEspresso\core\admin\PostShortcodeTracking::reset_page_for_posts_on_change($option, $old_value, $value);
 	}
 
 }

core/db_models/fields/EE_Field_With_Model_Name.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
      * Returns the name of the model(s) pointed to
      *
      * @deprecated since version 4.6.7
-     * @return mixed string or array of strings
+     * @return string string or array of strings
      */
     function get_model_name_pointed_to()
     {

Spacing +2 added lines, -2 removed lines

@@ -70,10 +70,10 @@
         $model_names = array();
         if (is_array($this->_model_name_pointed_to)) {
             foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
+                $model_names[] = "EE_".$model_name;
             }
         } else {
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
+            $model_names = array("EE_".$this->_model_name_pointed_to);
         }
         return $model_names;
     }

Indentation +89 added lines, -89 removed lines

@@ -8,99 +8,99 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string or array
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string or array
+	 */
+	protected $_model_name_pointed_to;
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @deprecated since version 4.6.7
-     * @return mixed string or array of strings
-     */
-    function get_model_name_pointed_to()
-    {
-        EE_Error::doing_it_wrong('get_model_name_pointed_to',
-            __('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'), '4.6.7');
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @deprecated since version 4.6.7
+	 * @return mixed string or array of strings
+	 */
+	function get_model_name_pointed_to()
+	{
+		EE_Error::doing_it_wrong('get_model_name_pointed_to',
+			__('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'), '4.6.7');
+		return $this->_model_name_pointed_to;
+	}
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return array of model names pointed to by this field
-     */
-    function get_model_names_pointed_to()
-    {
-        if (is_array($this->_model_name_pointed_to)) {
-            return $this->_model_name_pointed_to;
-        } else {
-            return array($this->_model_name_pointed_to);
-        }
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return array of model names pointed to by this field
+	 */
+	function get_model_names_pointed_to()
+	{
+		if (is_array($this->_model_name_pointed_to)) {
+			return $this->_model_name_pointed_to;
+		} else {
+			return array($this->_model_name_pointed_to);
+		}
+	}
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return array
-     */
-    function get_model_class_names_pointed_to()
-    {
-        $model_names = array();
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return array
+	 */
+	function get_model_class_names_pointed_to()
+	{
+		$model_names = array();
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = array("EE_" . $this->_model_name_pointed_to);
+		}
+		return $model_names;
+	}
 
-    function is_model_obj_of_type_pointed_to($model_obj_or_ID)
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj_or_ID instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	function is_model_obj_of_type_pointed_to($model_obj_or_ID)
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 
-    /**
-     * This returns any elements used to represent this field in the json schema.
-     * Note: It is expected this will only return field specific elements such as "type" or "format".  Other details
-     * will have to be inferred from the other data injected into the object on construct (title, description etc).
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function get_schema()
-    {
-        return array(
-            'description' => $this->get_nicename(),
-            'type' => 'string'
-        );
-    }
+	/**
+	 * This returns any elements used to represent this field in the json schema.
+	 * Note: It is expected this will only return field specific elements such as "type" or "format".  Other details
+	 * will have to be inferred from the other data injected into the object on construct (title, description etc).
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function get_schema()
+	{
+		return array(
+			'description' => $this->get_nicename(),
+			'type' => 'string'
+		);
+	}
 }

core/db_models/fields/EE_Model_Field_Base.php

Doc Comments +2 added lines, -2 removed lines

@@ -30,9 +30,9 @@
     protected $_model_name;
 
     /**
-     * @param      $table_column
+     * @param      string $table_column
      * @param      $nicename
-     * @param      $nullable
+     * @param      boolean $nullable
      * @param null $default_value
      */
     function __construct($table_column, $nicename, $nullable, $default_value = null)

Spacing +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -139,7 +139,7 @@ 
      */
     function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
     /**

Indentation +220 added lines, -220 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -20,223 +20,223 @@ 
  */
 abstract class EE_Model_Field_Base
 {
-    var $_table_alias;
-    var $_table_column;
-    var $_name;
-    var $_nicename;
-    var $_nullable;
-    var $_default_value;
-    var $_other_config;
-    protected $_model_name;
-
-    /**
-     * @param      $table_column
-     * @param      $nicename
-     * @param      $nullable
-     * @param null $default_value
-     */
-    function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->_table_column  = $table_column;
-        $this->_nicename      = $nicename;
-        $this->_nullable      = $nullable;
-        $this->_default_value = $default_value;
-    }
-
-
-    /**
-     * @param $table_alias
-     * @param $name
-     * @param $model_name
-     */
-    function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_table_alias = $table_alias;
-        $this->_name        = $name;
-        $this->_model_name  = $model_name;
-        /**
-         * allow for changing the defaults
-         */
-        $this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
-            $this->_nicename, $this);
-        $this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
-            $this->_default_value, $this);
-    }
-
-    function get_table_alias()
-    {
-        return $this->_table_alias;
-    }
-
-    function get_table_column()
-    {
-        return $this->_table_column;
-    }
-
-    /**
-     * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
-     *
-     * @return string
-     */
-    function get_model_name()
-    {
-        return $this->_model_name;
-    }
-
-    /**
-     * @throws \EE_Error
-     * @return string
-     */
-    function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        } else {
-            throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                "event_espresso"), get_class($this)));
-        }
-    }
-
-    function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-    function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    function is_auto_increment()
-    {
-        return false;
-    }
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want ot serialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. We may want to add slashes, serialize it, etc.
-     * By default, we do nothing.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field.
-     * @return string
-     */
-    abstract function get_wpdb_data_type();
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    abstract public function get_schema();
-
-    /**
-     * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
-     * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
-     * want to see their value, then they shouldn't be db-only fields!)
-     * Eg, when doing events as custom post types, querying the post_type is essential, but
-     * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
-     * By default, all fields aren't db-only.
-     *
-     * @return boolean
-     */
-    function is_db_only_field()
-    {
-        return false;
-    }
+	var $_table_alias;
+	var $_table_column;
+	var $_name;
+	var $_nicename;
+	var $_nullable;
+	var $_default_value;
+	var $_other_config;
+	protected $_model_name;
+
+	/**
+	 * @param      $table_column
+	 * @param      $nicename
+	 * @param      $nullable
+	 * @param null $default_value
+	 */
+	function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->_table_column  = $table_column;
+		$this->_nicename      = $nicename;
+		$this->_nullable      = $nullable;
+		$this->_default_value = $default_value;
+	}
+
+
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 * @param $model_name
+	 */
+	function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_table_alias = $table_alias;
+		$this->_name        = $name;
+		$this->_model_name  = $model_name;
+		/**
+		 * allow for changing the defaults
+		 */
+		$this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
+			$this->_nicename, $this);
+		$this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
+			$this->_default_value, $this);
+	}
+
+	function get_table_alias()
+	{
+		return $this->_table_alias;
+	}
+
+	function get_table_column()
+	{
+		return $this->_table_column;
+	}
+
+	/**
+	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
+	 *
+	 * @return string
+	 */
+	function get_model_name()
+	{
+		return $this->_model_name;
+	}
+
+	/**
+	 * @throws \EE_Error
+	 * @return string
+	 */
+	function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		} else {
+			throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+				"event_espresso"), get_class($this)));
+		}
+	}
+
+	function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+	function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	function is_auto_increment()
+	{
+		return false;
+	}
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want ot serialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. We may want to add slashes, serialize it, etc.
+	 * By default, we do nothing.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field.
+	 * @return string
+	 */
+	abstract function get_wpdb_data_type();
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	abstract public function get_schema();
+
+	/**
+	 * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
+	 * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
+	 * want to see their value, then they shouldn't be db-only fields!)
+	 * Eg, when doing events as custom post types, querying the post_type is essential, but
+	 * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
+	 * By default, all fields aren't db-only.
+	 *
+	 * @return boolean
+	 */
+	function is_db_only_field()
+	{
+		return false;
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Primary_Key_Field_Base.php

Doc Comments +1 added lines

@@ -7,6 +7,7 @@
      *
      * @param string $table_column
      * @param string $nicename
+     * @param integer|null $default
      */
     public function __construct($table_column, $nicename, $default)
     {

Indentation +25 added lines, -25 removed lines

@@ -2,32 +2,32 @@
 
 abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name
 {
-    /**
-     * Overrides parent so it doesn't need to provide so many non-applicable fields
-     *
-     * @param string $table_column
-     * @param string $nicename
-     */
-    public function __construct($table_column, $nicename, $default)
-    {
-        parent::__construct($table_column, $nicename, false, $default, null);
-    }
+	/**
+	 * Overrides parent so it doesn't need to provide so many non-applicable fields
+	 *
+	 * @param string $table_column
+	 * @param string $nicename
+	 */
+	public function __construct($table_column, $nicename, $default)
+	{
+		parent::__construct($table_column, $nicename, false, $default, null);
+	}
 
-    /**
-     * @param $table_alias
-     * @param $name
-     */
-    function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::_construct_finalize($table_alias, $name, $model_name);
-    }
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 */
+	function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::_construct_finalize($table_alias, $name, $model_name);
+	}
 
 
-    public function get_schema()
-    {
-        $schema = parent::get_schema();
-        $schema['primary_key'] = true;
-        return $schema;
-    }
+	public function get_schema()
+	{
+		$schema = parent::get_schema();
+		$schema['primary_key'] = true;
+		return $schema;
+	}
 }

core/db_models/fields/EE_Primary_Key_String_Field.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
         return '%s';
     }
 
+    /**
+     * @param string $table_column
+     */
     public function __construct($table_column, $nicename)
     {
         parent::__construct($table_column, $nicename, null);

Indentation +21 added lines, -21 removed lines

@@ -3,27 +3,27 @@
 
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
-    function get_wpdb_data_type()
-    {
-        return '%s';
-    }
+	function get_wpdb_data_type()
+	{
+		return '%s';
+	}
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags($value_inputted_for_field_on_model_object);
+	}
 }
\ No newline at end of file