eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Unknown_1_0_0.core.php

Indentation +40 added lines, -40 removed lines

@@ -18,44 +18,44 @@
 class EE_DMS_Unknown_1_0_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * Returns whether or not this data migration script can operate on the given version of the database.
-     * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
-     * it's passed a string like '3.1.38B', it should return true
-     *
-     * @param string $version_string
-     * @return boolean
-     */
-    public function can_migrate_from_version($version_string)
-    {
-        return false;
-    }
-
-    public function schema_changes_after_migration()
-    {
-        return;
-    }
-
-    public function schema_changes_before_migration()
-    {
-        return;
-    }
-
-
-    /**
-     * All children of this must call parent::__construct() at the end of their constructor or suffer the consequences!
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_migration_stages = array();
-        $this->_pretty_name = __("Fatal Uncatchable Error Occurred", "event_espresso");
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-    public function migration_page_hooks()
-    {
-    }
+	/**
+	 * Returns whether or not this data migration script can operate on the given version of the database.
+	 * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
+	 * it's passed a string like '3.1.38B', it should return true
+	 *
+	 * @param string $version_string
+	 * @return boolean
+	 */
+	public function can_migrate_from_version($version_string)
+	{
+		return false;
+	}
+
+	public function schema_changes_after_migration()
+	{
+		return;
+	}
+
+	public function schema_changes_before_migration()
+	{
+		return;
+	}
+
+
+	/**
+	 * All children of this must call parent::__construct() at the end of their constructor or suffer the consequences!
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_migration_stages = array();
+		$this->_pretty_name = __("Fatal Uncatchable Error Occurred", "event_espresso");
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+	public function migration_page_hooks()
+	{
+	}
 }

core/data_migration_scripts/4_9_0_stages/EE_DMS_4_9_0_Answers_With_No_Registration.dmsstage.php

Indentation +38 added lines, -38 removed lines

@@ -15,44 +15,44 @@
 
 
 
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_9_0_Answers_With_No_Registration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = __('Answer Cleanup', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_9_0_Answers_With_No_Registration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = __('Answer Cleanup', 'event_espresso');
+		parent::__construct();
+	}
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
-     * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
-     * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
-     * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
-     * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
-        );
-        $this->set_completed();
-        return 1;
-    }
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
+	 * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
+	 * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
+	 * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
+	 * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		$wpdb->delete(
+			$wpdb->prefix . 'esp_answer',
+			array( 'REG_ID' => 0 ),
+			array( '%d' )
+		);
+		$this->set_completed();
+		return 1;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -48,9 +48,9 @@
     {
         global $wpdb;
         $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
+            $wpdb->prefix.'esp_answer',
+            array('REG_ID' => 0),
+            array('%d')
         );
         $this->set_completed();
         return 1;

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Spacing +4 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
      */
     public function add_error($error, $force = false)
     {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
+        if ( ! defined('EE_DMS_ERROR_LIMIT')) {
             $limit = 50;
         } else {
             $limit = EE_DMS_ERROR_LIMIT;
@@ -201,7 +201,7 @@ 
                 $this->_errors[] = "Limit reached; removed first half of errors to save space";
                 $this->_errors[] = $error;
             } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
+                $this->_errors[$limit] = 'More, but limit reached...';
             }
         } else {
             $this->_errors[] = $error;
@@ -343,7 +343,7 @@ 
         $new_columns_and_values_for_string = array();
         $count = 0;
         foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+            $new_columns_and_values_for_string[] = " $column => $value (".$data_types[$count++].")";
         }
         return sprintf(
             __(
@@ -374,7 +374,7 @@ 
         foreach ($array_of_data as $name => $value) {
             $unserialized_data = @unserialize($value);
             if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
+                $fields_to_include[$name] = $value;
             }
         }
         return wp_json_encode($fields_to_include);

Indentation +404 added lines, -404 removed lines

@@ -17,408 +17,408 @@
 abstract class EE_Data_Migration_Class_Base
 {
 
-    /**
-     * @var $records_to_migrate int count of all that have been migrated
-     */
-    protected $_records_to_migrate = 0;
-
-    /**
-     *
-     * @var $records_migrated int
-     */
-    protected $_records_migrated = 0;
-
-    /**
-     * Whether this migration script is done or not. This COULD be deduced by
-     * _records_to_migrate and _records_migrated, but that might nto be accurate
-     *
-     * @var string one of EE_Data_migration_Manager::status_* constants
-     */
-    protected $_status = null;
-
-    /**
-     * internationalized name of this class. Convention is to NOT restate that
-     * this class if a migration script or a migration script stage
-     *
-     * @var string (i18ned)
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var array
-     */
-    protected $_errors = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * Just initializes the status of the migration
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_table_manager = $table_manager;
-        $this->_table_analysis = $table_analysis;
-        $this->set_status(EE_Data_Migration_Manager::status_continue);
-    }
-
-
-    /**
-     * Just gets the pretty name for this migration script or stage
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function pretty_name()
-    {
-        if ($this->_pretty_name === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_pretty_name;
-    }
-
-    /**
-     *
-     * @return int
-     */
-    public function count_records_to_migrate()
-    {
-        if ($this->_records_to_migrate == null) {
-            $this->_records_to_migrate = $this->_count_records_to_migrate();
-        }
-        return $this->_records_to_migrate;
-    }
-
-    /**
-     * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
-     * EE_Data_migration_Script_Stage
-     *
-     * @return int
-     */
-    abstract public function count_records_migrated();
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    abstract protected function _count_records_to_migrate();
-
-    /**
-     * Returns a string indicating the migration script's status.
-     *
-     * @return string one of EE_Data_Migration_Manager::status_* constants
-     * @throws EE_Error
-     */
-    public function get_status()
-    {
-        if ($this->_status === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_status;
-    }
-
-    /**
-     *
-     * @param string $status
-     * @return void
-     */
-    protected function set_status($status)
-    {
-        $this->_status = $status;
-    }
-
-    /**
-     * @return array of strings
-     */
-    abstract public function get_errors();
-
-    /**
-     * Returns the last error that occurred. If none occurred, returns null
-     *
-     * @return string
-     */
-    public function get_last_error()
-    {
-        $errors = $this->get_errors();
-        if ($errors) {
-            return end($errors);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Adds an error to the array of errors on this class.
-     *
-     * @param string  $error a string describing the error that will be useful for debugging. Consider including all
-     *                       the data that led to the error, and a stack trace etc.
-     * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
-     *                       already at their limit, we will purposefully forget the first half
-     */
-    public function add_error($error, $force = false)
-    {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
-            $limit = 50;
-        } else {
-            $limit = EE_DMS_ERROR_LIMIT;
-        }
-        // make sure errors is an array, see ticket #8261
-        if (is_string($this->_errors)) {
-            $this->_errors = array($this->_errors);
-        }
-        if (count($this->_errors) >= $limit) {
-            if ($force) {
-                // get rid of the first half of the errors and any above the limit
-                $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
-                $this->_errors[] = "Limit reached; removed first half of errors to save space";
-                $this->_errors[] = $error;
-            } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
-            }
-        } else {
-            $this->_errors[] = $error;
-        }
-    }
-
-    /**
-     * Indicates there was a fatal error and the migration cannot possibly continue
-     *
-     * @return boolean
-     */
-    public function is_broken()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     * @deprecated since 4.6.12
-     */
-    public function is_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->is_broken();
-    }
-
-    /**
-     * Sets the status to as having a fatal error
-     */
-    public function set_broken()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     *
-     * @deprecated since 4.6.12
-     */
-    public function set_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->set_broken();
-    }
-
-    /**
-     * Checks if this thing believes it is completed
-     *
-     * @return boolean
-     */
-    public function is_completed()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
-     *
-     * @return boolean
-     */
-    public function has_more_to_do()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_continue;
-    }
-
-    /**
-     * Marks that we believe this migration thing is completed
-     */
-    public function set_completed()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_continue;
-        $this->add_error(__('Reattempt migration', 'event_espresso'), true);
-    }
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = get_object_vars($this);
-        $properties['class'] = get_class($this);
-        unset($properties['_migration_script']);
-        unset($properties['_table_manager']);
-        unset($properties['_table_analysis']);
-        return $properties;
-    }
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    abstract public function instantiate_from_array_of_properties($array_of_properties);
-
-    /**
-     * Convenience method for showing a database insertion error
-     *
-     * @param string $old_table
-     * @param array  $old_row_as_array
-     * @param string $new_table
-     * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
-     * @return string
-     */
-    protected function _create_error_message_for_db_insertion(
-        $old_table,
-        $old_row_as_array,
-        $new_table,
-        $new_row_as_array,
-        $data_types
-    ) {
-        global $wpdb;
-        $old_columns_and_values_for_string = array();
-        foreach ($old_row_as_array as $column => $value) {
-            $old_columns_and_values_for_string[] = "$column => $value";
-        }
-        $new_columns_and_values_for_string = array();
-        $count = 0;
-        foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
-        }
-        return sprintf(
-            __(
-                'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
-                'event_espresso'
-            ),
-            implode(", ", $new_columns_and_values_for_string),
-            $new_table,
-            implode(", ", $old_columns_and_values_for_string),
-            $old_table,
-            '<br/>',
-            $wpdb->last_error
-        );
-    }
-
-
-    /**
-     * Same as json_encode, just avoids putting
-     * serialized arrays into the http build query, as that would
-     *
-     * @param array $array_of_data
-     * @return string
-     */
-    protected function _json_encode($array_of_data)
-    {
-        // we'd rather NOT serialize the transaction details
-        $fields_to_include = array();
-        foreach ($array_of_data as $name => $value) {
-            $unserialized_data = @unserialize($value);
-            if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
-            }
-        }
-        return wp_json_encode($fields_to_include);
-    }
-
-    /**
-     * Gets the table manager (or throws an exception if it cannot be retrieved)
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var $records_to_migrate int count of all that have been migrated
+	 */
+	protected $_records_to_migrate = 0;
+
+	/**
+	 *
+	 * @var $records_migrated int
+	 */
+	protected $_records_migrated = 0;
+
+	/**
+	 * Whether this migration script is done or not. This COULD be deduced by
+	 * _records_to_migrate and _records_migrated, but that might nto be accurate
+	 *
+	 * @var string one of EE_Data_migration_Manager::status_* constants
+	 */
+	protected $_status = null;
+
+	/**
+	 * internationalized name of this class. Convention is to NOT restate that
+	 * this class if a migration script or a migration script stage
+	 *
+	 * @var string (i18ned)
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_errors = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_table_manager = $table_manager;
+		$this->_table_analysis = $table_analysis;
+		$this->set_status(EE_Data_Migration_Manager::status_continue);
+	}
+
+
+	/**
+	 * Just gets the pretty name for this migration script or stage
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		if ($this->_pretty_name === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_pretty_name;
+	}
+
+	/**
+	 *
+	 * @return int
+	 */
+	public function count_records_to_migrate()
+	{
+		if ($this->_records_to_migrate == null) {
+			$this->_records_to_migrate = $this->_count_records_to_migrate();
+		}
+		return $this->_records_to_migrate;
+	}
+
+	/**
+	 * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
+	 * EE_Data_migration_Script_Stage
+	 *
+	 * @return int
+	 */
+	abstract public function count_records_migrated();
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	abstract protected function _count_records_to_migrate();
+
+	/**
+	 * Returns a string indicating the migration script's status.
+	 *
+	 * @return string one of EE_Data_Migration_Manager::status_* constants
+	 * @throws EE_Error
+	 */
+	public function get_status()
+	{
+		if ($this->_status === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_status;
+	}
+
+	/**
+	 *
+	 * @param string $status
+	 * @return void
+	 */
+	protected function set_status($status)
+	{
+		$this->_status = $status;
+	}
+
+	/**
+	 * @return array of strings
+	 */
+	abstract public function get_errors();
+
+	/**
+	 * Returns the last error that occurred. If none occurred, returns null
+	 *
+	 * @return string
+	 */
+	public function get_last_error()
+	{
+		$errors = $this->get_errors();
+		if ($errors) {
+			return end($errors);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Adds an error to the array of errors on this class.
+	 *
+	 * @param string  $error a string describing the error that will be useful for debugging. Consider including all
+	 *                       the data that led to the error, and a stack trace etc.
+	 * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
+	 *                       already at their limit, we will purposefully forget the first half
+	 */
+	public function add_error($error, $force = false)
+	{
+		if (! defined('EE_DMS_ERROR_LIMIT')) {
+			$limit = 50;
+		} else {
+			$limit = EE_DMS_ERROR_LIMIT;
+		}
+		// make sure errors is an array, see ticket #8261
+		if (is_string($this->_errors)) {
+			$this->_errors = array($this->_errors);
+		}
+		if (count($this->_errors) >= $limit) {
+			if ($force) {
+				// get rid of the first half of the errors and any above the limit
+				$this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
+				$this->_errors[] = "Limit reached; removed first half of errors to save space";
+				$this->_errors[] = $error;
+			} else {
+				$this->_errors[ $limit ] = 'More, but limit reached...';
+			}
+		} else {
+			$this->_errors[] = $error;
+		}
+	}
+
+	/**
+	 * Indicates there was a fatal error and the migration cannot possibly continue
+	 *
+	 * @return boolean
+	 */
+	public function is_broken()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 * @deprecated since 4.6.12
+	 */
+	public function is_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->is_broken();
+	}
+
+	/**
+	 * Sets the status to as having a fatal error
+	 */
+	public function set_broken()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 *
+	 * @deprecated since 4.6.12
+	 */
+	public function set_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->set_broken();
+	}
+
+	/**
+	 * Checks if this thing believes it is completed
+	 *
+	 * @return boolean
+	 */
+	public function is_completed()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
+	 *
+	 * @return boolean
+	 */
+	public function has_more_to_do()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_continue;
+	}
+
+	/**
+	 * Marks that we believe this migration thing is completed
+	 */
+	public function set_completed()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_continue;
+		$this->add_error(__('Reattempt migration', 'event_espresso'), true);
+	}
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = get_object_vars($this);
+		$properties['class'] = get_class($this);
+		unset($properties['_migration_script']);
+		unset($properties['_table_manager']);
+		unset($properties['_table_analysis']);
+		return $properties;
+	}
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	abstract public function instantiate_from_array_of_properties($array_of_properties);
+
+	/**
+	 * Convenience method for showing a database insertion error
+	 *
+	 * @param string $old_table
+	 * @param array  $old_row_as_array
+	 * @param string $new_table
+	 * @param array  $new_row_as_array columns=>values like used in wpdb->insert
+	 * @param array  $data_types       numerically indexed
+	 * @return string
+	 */
+	protected function _create_error_message_for_db_insertion(
+		$old_table,
+		$old_row_as_array,
+		$new_table,
+		$new_row_as_array,
+		$data_types
+	) {
+		global $wpdb;
+		$old_columns_and_values_for_string = array();
+		foreach ($old_row_as_array as $column => $value) {
+			$old_columns_and_values_for_string[] = "$column => $value";
+		}
+		$new_columns_and_values_for_string = array();
+		$count = 0;
+		foreach ($new_row_as_array as $column => $value) {
+			$new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+		}
+		return sprintf(
+			__(
+				'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
+				'event_espresso'
+			),
+			implode(", ", $new_columns_and_values_for_string),
+			$new_table,
+			implode(", ", $old_columns_and_values_for_string),
+			$old_table,
+			'<br/>',
+			$wpdb->last_error
+		);
+	}
+
+
+	/**
+	 * Same as json_encode, just avoids putting
+	 * serialized arrays into the http build query, as that would
+	 *
+	 * @param array $array_of_data
+	 * @return string
+	 */
+	protected function _json_encode($array_of_data)
+	{
+		// we'd rather NOT serialize the transaction details
+		$fields_to_include = array();
+		foreach ($array_of_data as $name => $value) {
+			$unserialized_data = @unserialize($value);
+			if ($unserialized_data === false) {
+				$fields_to_include[ $name ] = $value;
+			}
+		}
+		return wp_json_encode($fields_to_include);
+	}
+
+	/**
+	 * Gets the table manager (or throws an exception if it cannot be retrieved)
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/data_migration_scripts/4_8_0_stages/EE_DMS_4_8_0_event_subtotals.dmsstage.php

Indentation +73 added lines, -73 removed lines

@@ -11,77 +11,77 @@
  */
 class EE_DMS_4_8_0_event_subtotals extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_line_item';
-        $this->_extra_where_sql = ' WHERE LIN_type="sub-total" AND LIN_code="pre-tax-subtotal"';
-        $this->_pretty_name = __('Event Sub-total line items', 'event_espresso');
-        parent::__construct();
-    }
-    protected function _migrate_old_row($line_item_row)
-    {
-        global $wpdb;
-        // what event is this line item for? this can be found by looking at its transaction's registration's EVT_ID
-        $event_id = $wpdb->get_var($wpdb->prepare('SELECT EVT_ID FROM ' . $wpdb->prefix . 'esp_registration WHERE TXN_ID=%d LIMIT 1', $line_item_row['TXN_ID']));
-        $new_line_item_data = array(
-                    'LIN_code' => 'event-' . $event_id,
-                    'TXN_ID' => $line_item_row['TXN_ID'],
-                    'LIN_name' => __('Event', 'event_espresso'),
-                    'LIN_desc' => $line_item_row['LIN_desc'],
-                    'LIN_unit_price' => $line_item_row['LIN_unit_price'],
-                    'LIN_percent' => $line_item_row['LIN_percent'],
-                    'LIN_is_taxable' => $line_item_row['LIN_is_taxable'],
-                    'LIN_order' => $line_item_row['LIN_order'],
-                    'LIN_total' => $line_item_row['LIN_total'],
-                    'LIN_quantity' => $line_item_row['LIN_quantity'],
-                    'LIN_parent' => $line_item_row['LIN_ID'],
-                    'LIN_type' => 'sub-total',
-                    'OBJ_type' => 'Event',
-                    'OBJ_ID' => $event_id,
-                );
-        $new_line_item_datatypes = array(
-                    '%s',// LIN_code
-                    '%d',// TXN_ID
-                    '%s',// LIN_name
-                    '%s',// LIN_desc
-                    '%f',// LIN_unit_price
-                    '%f',// LIN_percent
-                    '%d',// LIN_is_taxable
-                    '%d',// LIN_order
-                    '%f',// LIN_total
-                    '%d',// LIN_quantity
-                    '%d',// LIN_parent
-                    '%s',// LIN_type
-                    '%s',// OBJ_type
-                    '%d',// OBJ_ID
-                );
-        // insert the new event subtotal line item, pointing to this line item
-        $success = $wpdb->insert($this->_old_table, $new_line_item_data, $new_line_item_datatypes);
-        if (! $success) {
-            $this->add_error($this->_create_error_message_for_db_insertion($this->_old_table, $line_item_row, $this->_old_table, $new_line_item_data, $new_line_item_datatypes));
-        }
-        $new_line_item_id = $wpdb->insert_id;
-        $this->get_migration_script()->set_mapping($this->_old_table, $line_item_row['LIN_ID'], $this->_old_table, $new_line_item_id);
-        $query = $wpdb->prepare(
-            "UPDATE {$this->_old_table} SET LIN_parent=%d WHERE LIN_parent = %d AND LIN_ID != %d LIMIT 100",
-            $new_line_item_id,
-            $line_item_row['LIN_ID'],
-            $new_line_item_id
-        );
-        $success = $wpdb->query($query);
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    __('Error updating rows to new event subtotal %1$s from %2$s. Error was: %3$s, while using query %4$s which had a result of %5$s', 'event_espresso'),
-                    $new_line_item_id,
-                    $line_item_row['LIN_ID'],
-                    $wpdb->last_error,
-                    $query,
-                    $success
-                )
-            );
-        }
-        return 1;
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_line_item';
+		$this->_extra_where_sql = ' WHERE LIN_type="sub-total" AND LIN_code="pre-tax-subtotal"';
+		$this->_pretty_name = __('Event Sub-total line items', 'event_espresso');
+		parent::__construct();
+	}
+	protected function _migrate_old_row($line_item_row)
+	{
+		global $wpdb;
+		// what event is this line item for? this can be found by looking at its transaction's registration's EVT_ID
+		$event_id = $wpdb->get_var($wpdb->prepare('SELECT EVT_ID FROM ' . $wpdb->prefix . 'esp_registration WHERE TXN_ID=%d LIMIT 1', $line_item_row['TXN_ID']));
+		$new_line_item_data = array(
+					'LIN_code' => 'event-' . $event_id,
+					'TXN_ID' => $line_item_row['TXN_ID'],
+					'LIN_name' => __('Event', 'event_espresso'),
+					'LIN_desc' => $line_item_row['LIN_desc'],
+					'LIN_unit_price' => $line_item_row['LIN_unit_price'],
+					'LIN_percent' => $line_item_row['LIN_percent'],
+					'LIN_is_taxable' => $line_item_row['LIN_is_taxable'],
+					'LIN_order' => $line_item_row['LIN_order'],
+					'LIN_total' => $line_item_row['LIN_total'],
+					'LIN_quantity' => $line_item_row['LIN_quantity'],
+					'LIN_parent' => $line_item_row['LIN_ID'],
+					'LIN_type' => 'sub-total',
+					'OBJ_type' => 'Event',
+					'OBJ_ID' => $event_id,
+				);
+		$new_line_item_datatypes = array(
+					'%s',// LIN_code
+					'%d',// TXN_ID
+					'%s',// LIN_name
+					'%s',// LIN_desc
+					'%f',// LIN_unit_price
+					'%f',// LIN_percent
+					'%d',// LIN_is_taxable
+					'%d',// LIN_order
+					'%f',// LIN_total
+					'%d',// LIN_quantity
+					'%d',// LIN_parent
+					'%s',// LIN_type
+					'%s',// OBJ_type
+					'%d',// OBJ_ID
+				);
+		// insert the new event subtotal line item, pointing to this line item
+		$success = $wpdb->insert($this->_old_table, $new_line_item_data, $new_line_item_datatypes);
+		if (! $success) {
+			$this->add_error($this->_create_error_message_for_db_insertion($this->_old_table, $line_item_row, $this->_old_table, $new_line_item_data, $new_line_item_datatypes));
+		}
+		$new_line_item_id = $wpdb->insert_id;
+		$this->get_migration_script()->set_mapping($this->_old_table, $line_item_row['LIN_ID'], $this->_old_table, $new_line_item_id);
+		$query = $wpdb->prepare(
+			"UPDATE {$this->_old_table} SET LIN_parent=%d WHERE LIN_parent = %d AND LIN_ID != %d LIMIT 100",
+			$new_line_item_id,
+			$line_item_row['LIN_ID'],
+			$new_line_item_id
+		);
+		$success = $wpdb->query($query);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					__('Error updating rows to new event subtotal %1$s from %2$s. Error was: %3$s, while using query %4$s which had a result of %5$s', 'event_espresso'),
+					$new_line_item_id,
+					$line_item_row['LIN_ID'],
+					$wpdb->last_error,
+					$query,
+					$success
+				)
+			);
+		}
+		return 1;
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -14,7 +14,7 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_line_item';
+        $this->_old_table = $wpdb->prefix.'esp_line_item';
         $this->_extra_where_sql = ' WHERE LIN_type="sub-total" AND LIN_code="pre-tax-subtotal"';
         $this->_pretty_name = __('Event Sub-total line items', 'event_espresso');
         parent::__construct();
@@ -23,9 +23,9 @@ 
     {
         global $wpdb;
         // what event is this line item for? this can be found by looking at its transaction's registration's EVT_ID
-        $event_id = $wpdb->get_var($wpdb->prepare('SELECT EVT_ID FROM ' . $wpdb->prefix . 'esp_registration WHERE TXN_ID=%d LIMIT 1', $line_item_row['TXN_ID']));
+        $event_id = $wpdb->get_var($wpdb->prepare('SELECT EVT_ID FROM '.$wpdb->prefix.'esp_registration WHERE TXN_ID=%d LIMIT 1', $line_item_row['TXN_ID']));
         $new_line_item_data = array(
-                    'LIN_code' => 'event-' . $event_id,
+                    'LIN_code' => 'event-'.$event_id,
                     'TXN_ID' => $line_item_row['TXN_ID'],
                     'LIN_name' => __('Event', 'event_espresso'),
                     'LIN_desc' => $line_item_row['LIN_desc'],
@@ -41,24 +41,24 @@ 
                     'OBJ_ID' => $event_id,
                 );
         $new_line_item_datatypes = array(
-                    '%s',// LIN_code
-                    '%d',// TXN_ID
-                    '%s',// LIN_name
-                    '%s',// LIN_desc
-                    '%f',// LIN_unit_price
-                    '%f',// LIN_percent
-                    '%d',// LIN_is_taxable
-                    '%d',// LIN_order
-                    '%f',// LIN_total
-                    '%d',// LIN_quantity
-                    '%d',// LIN_parent
-                    '%s',// LIN_type
-                    '%s',// OBJ_type
-                    '%d',// OBJ_ID
+                    '%s', // LIN_code
+                    '%d', // TXN_ID
+                    '%s', // LIN_name
+                    '%s', // LIN_desc
+                    '%f', // LIN_unit_price
+                    '%f', // LIN_percent
+                    '%d', // LIN_is_taxable
+                    '%d', // LIN_order
+                    '%f', // LIN_total
+                    '%d', // LIN_quantity
+                    '%d', // LIN_parent
+                    '%s', // LIN_type
+                    '%s', // OBJ_type
+                    '%d', // OBJ_ID
                 );
         // insert the new event subtotal line item, pointing to this line item
         $success = $wpdb->insert($this->_old_table, $new_line_item_data, $new_line_item_datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->_create_error_message_for_db_insertion($this->_old_table, $line_item_row, $this->_old_table, $new_line_item_data, $new_line_item_datatypes));
         }
         $new_line_item_id = $wpdb->insert_id;

core/data_migration_scripts/4_2_0_stages/EE_DMS_4_2_0_datetime_fields.dmsstage.php

Indentation +43 added lines, -43 removed lines

@@ -8,49 +8,49 @@
 
 class EE_DMS_4_2_0_datetime_fields extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Datetime Fields", "event_espresso");
-        $this->_old_table = $wpdb->prefix . "esp_datetime";
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Datetime Fields", "event_espresso");
+		$this->_old_table = $wpdb->prefix . "esp_datetime";
+		parent::__construct();
+	}
 
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach question_group_question entry with this QST_ID, we want to set its
-        // QSG_order equal to this question's QST_order
-        global $wpdb;
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach question_group_question entry with this QST_ID, we want to set its
+		// QSG_order equal to this question's QST_order
+		global $wpdb;
 
-        $updated = $wpdb->update(
-            $this->_old_table,
-            array(
-                'DTT_name' => '',
-                'DTT_description' => '',
-            ),
-            array(
-                'DTT_ID' => $old_row['DTT_ID'],
-            ),
-            array(
-                '%s',// DTT_name,
-                '%s',// DTT_description
-            ),
-            array(
-                '%d',// DTT_ID
-            )
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    __(
-                        "Error in updating table %s setting DTT_name = '' and DTT_description = '' where DTT_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $old_row['QST_ID']
-                )
-            );
-        }
-        // nothing to map really
-    }
+		$updated = $wpdb->update(
+			$this->_old_table,
+			array(
+				'DTT_name' => '',
+				'DTT_description' => '',
+			),
+			array(
+				'DTT_ID' => $old_row['DTT_ID'],
+			),
+			array(
+				'%s',// DTT_name,
+				'%s',// DTT_description
+			),
+			array(
+				'%d',// DTT_ID
+			)
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					__(
+						"Error in updating table %s setting DTT_name = '' and DTT_description = '' where DTT_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$old_row['QST_ID']
+				)
+			);
+		}
+		// nothing to map really
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -12,7 +12,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = __("Datetime Fields", "event_espresso");
-        $this->_old_table = $wpdb->prefix . "esp_datetime";
+        $this->_old_table = $wpdb->prefix."esp_datetime";
         parent::__construct();
     }
 
@@ -32,11 +32,11 @@ 
                 'DTT_ID' => $old_row['DTT_ID'],
             ),
             array(
-                '%s',// DTT_name,
-                '%s',// DTT_description
+                '%s', // DTT_name,
+                '%s', // DTT_description
             ),
             array(
-                '%d',// DTT_ID
+                '%d', // DTT_ID
             )
         );
         if (false === $updated) {

core/data_migration_scripts/EE_Data_Migration_Script_Stage.core.php

Indentation +90 added lines, -90 removed lines

@@ -37,103 +37,103 @@
  */
 abstract class EE_Data_Migration_Script_Stage extends EE_Data_Migration_Class_Base
 {
-    /**
-     * The migration script this is a stage of
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    protected $_migration_script;
+	/**
+	 * The migration script this is a stage of
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	protected $_migration_script;
 
-    /**
-     * This should eb called to essentially 'finalize' construction of the stage.
-     * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
-     * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
-     *
-     * @param EE_Data_Migration_Script_Base $migration_script
-     */
-    public function _construct_finalize($migration_script)
-    {
-        $this->_migration_script = $migration_script;
-    }
+	/**
+	 * This should eb called to essentially 'finalize' construction of the stage.
+	 * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
+	 * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
+	 *
+	 * @param EE_Data_Migration_Script_Base $migration_script
+	 */
+	public function _construct_finalize($migration_script)
+	{
+		$this->_migration_script = $migration_script;
+	}
 
-    /**
-     * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
-     * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
-     * needs to catch exceptions and decide what's a fatal error and what isn't.
-     *
-     * @param int $num_items_to_migrate
-     * @return int
-     */
-    public function migration_step($num_items_to_migrate = 50)
-    {
-        // before we run the migration step, we want ot take note of warnings that get outputted
-        ob_start();
-        $items_migrated = $this->_migration_step($num_items_to_migrate);
-        $output = ob_get_contents();
-        ob_end_clean();
-        if ($output) {
-            $this->add_error($output);
-        }
-        $this->_records_migrated += $items_migrated;
-        return $items_migrated;
-    }
+	/**
+	 * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
+	 * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
+	 * needs to catch exceptions and decide what's a fatal error and what isn't.
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int
+	 */
+	public function migration_step($num_items_to_migrate = 50)
+	{
+		// before we run the migration step, we want ot take note of warnings that get outputted
+		ob_start();
+		$items_migrated = $this->_migration_step($num_items_to_migrate);
+		$output = ob_get_contents();
+		ob_end_clean();
+		if ($output) {
+			$this->add_error($output);
+		}
+		$this->_records_migrated += $items_migrated;
+		return $items_migrated;
+	}
 
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
-     * very least we MUST report/return 50 items migrated)
-     *
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    abstract protected function _migration_step($num_items_to_migrate = 50);
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
+	 * very least we MUST report/return 50 items migrated)
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	abstract protected function _migration_step($num_items_to_migrate = 50);
 
-    /**
-     * Counts the records that have been migrated so far
-     *
-     * @return int
-     */
-    public function count_records_migrated()
-    {
-        return $this->_records_migrated;
-    }
+	/**
+	 * Counts the records that have been migrated so far
+	 *
+	 * @return int
+	 */
+	public function count_records_migrated()
+	{
+		return $this->_records_migrated;
+	}
 
-    /**
-     * returns an array of strings describing errors
-     *
-     * @return array
-     */
-    public function get_errors()
-    {
-        return $this->_errors;
-    }
+	/**
+	 * returns an array of strings describing errors
+	 *
+	 * @return array
+	 */
+	public function get_errors()
+	{
+		return $this->_errors;
+	}
 
 
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    public function instantiate_from_array_of_properties($array_of_properties)
-    {
-        unset($array_of_properties['class']);
-        foreach ($array_of_properties as $property_name => $property_value) {
-            $this->{$property_name} = $property_value;
-        }
-    }
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	public function instantiate_from_array_of_properties($array_of_properties)
+	{
+		unset($array_of_properties['class']);
+		foreach ($array_of_properties as $property_name => $property_value) {
+			$this->{$property_name} = $property_value;
+		}
+	}
 
-    /**
-     * Gets the script this is a stage of
-     *
-     * @return EE_Data_Migration_Script_Base
-     */
-    protected function get_migration_script()
-    {
-        return $this->_migration_script;
-    }
+	/**
+	 * Gets the script this is a stage of
+	 *
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	protected function get_migration_script()
+	{
+		return $this->_migration_script;
+	}
 }

core/EE_Object_Repository.core.php

Indentation +86 added lines, -86 removed lines

@@ -16,98 +16,98 @@
 abstract class EE_Object_Repository extends EE_Object_Collection implements EEI_Repository
 {
 
-    /**
-     * default persist method called on repository objects if none supplied
-     *
-     * @type string $persist_method
-     */
-    protected $persist_method;
+	/**
+	 * default persist method called on repository objects if none supplied
+	 *
+	 * @type string $persist_method
+	 */
+	protected $persist_method;
 
 
-    /**
-     * _call_user_func_array_on_current
-     *
-     * calls the supplied callback method name on the current repository object,
-     * an array of arguments can also be supplied that will be passed along to the callback method,
-     * where each element of the $arguments array corresponds to a parameter for the callback method
-     * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
-     * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
-     *
-     * @access public
-     * @param string $callback  name of method found on object to be called.
-     * @param array  $arguments arrays of arguments that will be passed to the object's callback method
-     * @return bool | int
-     */
-    protected function _call_user_func_array_on_current($callback = '', $arguments = array())
-    {
-        if ($callback !== '' && method_exists($this->current(), $callback)) {
-            return call_user_func_array(array($this->current(), $callback), $arguments);
-        }
-        return false;
-    }
+	/**
+	 * _call_user_func_array_on_current
+	 *
+	 * calls the supplied callback method name on the current repository object,
+	 * an array of arguments can also be supplied that will be passed along to the callback method,
+	 * where each element of the $arguments array corresponds to a parameter for the callback method
+	 * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
+	 * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
+	 *
+	 * @access public
+	 * @param string $callback  name of method found on object to be called.
+	 * @param array  $arguments arrays of arguments that will be passed to the object's callback method
+	 * @return bool | int
+	 */
+	protected function _call_user_func_array_on_current($callback = '', $arguments = array())
+	{
+		if ($callback !== '' && method_exists($this->current(), $callback)) {
+			return call_user_func_array(array($this->current(), $callback), $arguments);
+		}
+		return false;
+	}
 
 
-    /**
-     * _call_user_func_on_all
-     *
-     * calls the supplied callback method name on ALL repository objects,
-     *
-     * @access public
-     * @param string $callback name of method found on repository objects to be called
-     * @return bool | int
-     */
-    protected function _call_user_func_on_all($callback = '')
-    {
-        $success = true;
-        if ($this->valid()) {
-            $this->rewind();
-            while ($this->valid()) {
-                // any negative result will toggle success to false
-                $success = $this->_call_user_func_array_on_current($callback) ? $success : false;
-                $this->next();
-            }
-            $this->rewind();
-        }
-        return $success;
-    }
+	/**
+	 * _call_user_func_on_all
+	 *
+	 * calls the supplied callback method name on ALL repository objects,
+	 *
+	 * @access public
+	 * @param string $callback name of method found on repository objects to be called
+	 * @return bool | int
+	 */
+	protected function _call_user_func_on_all($callback = '')
+	{
+		$success = true;
+		if ($this->valid()) {
+			$this->rewind();
+			while ($this->valid()) {
+				// any negative result will toggle success to false
+				$success = $this->_call_user_func_array_on_current($callback) ? $success : false;
+				$this->next();
+			}
+			$this->rewind();
+		}
+		return $success;
+	}
 
 
-    /**
-     * persist
-     *
-     * primarily used for saving EE_Base_Class classes to the database,
-     * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
-     * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
-     * arguments can also be supplied that will be passed along to the object's persistence method
-     *
-     * @access public
-     * @param string $persistence_callback                                    name of method found on object that can
-     *                                                                        be used for persisting the object
-     *                                                                        defaults to
-     *                                                                        EE_Object_Repository::$persist_method
-     * @param array  $persistence_arguments                                   arrays of arguments that will be passed
-     *                                                                        to the object's persistence method
-     * @return bool | int
-     */
-    public function persist($persistence_callback = '', $persistence_arguments = array())
-    {
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
-        return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
-    }
+	/**
+	 * persist
+	 *
+	 * primarily used for saving EE_Base_Class classes to the database,
+	 * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
+	 * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
+	 * arguments can also be supplied that will be passed along to the object's persistence method
+	 *
+	 * @access public
+	 * @param string $persistence_callback                                    name of method found on object that can
+	 *                                                                        be used for persisting the object
+	 *                                                                        defaults to
+	 *                                                                        EE_Object_Repository::$persist_method
+	 * @param array  $persistence_arguments                                   arrays of arguments that will be passed
+	 *                                                                        to the object's persistence method
+	 * @return bool | int
+	 */
+	public function persist($persistence_callback = '', $persistence_arguments = array())
+	{
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
+		return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
+	}
 
 
-    /**
-     * persist_all
-     *
-     * calls \EE_Object_Repository::persist() on all objects within the repository
-     *
-     * @access public
-     * @param string $persistence_callback name of method found on object that can be used for persisting the object
-     * @return bool | int
-     */
-    public function persist_all($persistence_callback = '')
-    {
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
-        return $this->_call_user_func_on_all($persistence_callback);
-    }
+	/**
+	 * persist_all
+	 *
+	 * calls \EE_Object_Repository::persist() on all objects within the repository
+	 *
+	 * @access public
+	 * @param string $persistence_callback name of method found on object that can be used for persisting the object
+	 * @return bool | int
+	 */
+	public function persist_all($persistence_callback = '')
+	{
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
+		return $this->_call_user_func_on_all($persistence_callback);
+	}
 }

core/EE_Request_Handler.core.php

Indentation +365 added lines, -365 removed lines

@@ -12,369 +12,369 @@
 final class EE_Request_Handler implements InterminableInterface
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var array $_notice
-     */
-    private $_notice = array();
-
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var string $_output
-     */
-    private $_output = '';
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-
-    /**
-     * @param  EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-        $this->ajax = $this->request->ajax;
-        $this->front_ajax = $this->request->front_ajax;
-        do_action('AHEE__EE_Request_Handler__construct__complete');
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parse_request($wp = null)
-    {
-        // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $this->set_request_vars($wp);
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_request_vars($wp = null)
-    {
-        if (! is_admin()) {
-            // set request post_id
-            $this->request->set('post_id', $this->get_post_id_from_request($wp));
-            // set request post name
-            $this->request->set('post_name', $this->get_post_name_from_request($wp));
-            // set request post_type
-            $this->request->set('post_type', $this->get_post_type_from_request($wp));
-            // true or false ? is this page being used by EE ?
-            $this->set_espresso_page();
-        }
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return int
-     */
-    public function get_post_id_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_id = null;
-        if (isset($wp->query_vars['p'])) {
-            $post_id = $wp->query_vars['p'];
-        }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
-            $post_id = $wp->query_vars['page_id'];
-        }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
-            $post_id = basename($wp->request);
-        }
-        return $post_id;
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return string
-     */
-    public function get_post_name_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_name = null;
-        if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
-            $post_name = $wp->query_vars['name'];
-        }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
-            $post_name = $wp->query_vars['pagename'];
-        }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
-            $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
-                /** @type WPDB $wpdb */
-                global $wpdb;
-                $SQL =
-                    "SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
-                $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                if ($possible_post_name) {
-                    $post_name = $possible_post_name;
-                }
-            }
-        }
-        if (! $post_name && $this->get('post_id')) {
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            $SQL =
-                "SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return mixed
-     */
-    public function get_post_type_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        return isset($wp->query_vars['post_type'])
-            ? $wp->query_vars['post_type']
-            : null;
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param  WP $wp
-     * @return string
-     */
-    public function get_current_page_permalink($wp = null)
-    {
-        $post_id = $this->get_post_id_from_request($wp);
-        if ($post_id) {
-            $current_page_permalink = get_permalink($post_id);
-        } else {
-            if (! $wp instanceof WP) {
-                global $wp;
-            }
-            if ($wp->request) {
-                $current_page_permalink = site_url($wp->request);
-            } else {
-                $current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
-            }
-        }
-        return $current_page_permalink;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function test_for_espresso_page()
-    {
-        global $wp;
-        /** @type EE_CPT_Strategy $EE_CPT_Strategy */
-        $EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
-        $espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        $post_types = (array) $this->get('post_type');
-        foreach ($post_types as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    $post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
-                        ? $post_type_CPT_endpoints[ $this->get('post_type') ]
-                        : '';
-                    // if the post type matches on of our then set the endpoint
-                    if ($post_name) {
-                        $this->set('post_name', $post_name);
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function set_notice($key, $value)
-    {
-        $this->_notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function get_notice($key)
-    {
-        return isset($this->_notice[ $key ])
-            ? $this->_notice[ $key ]
-            : null;
-    }
-
-
-    /**
-     * @param $string
-     * @return void
-     */
-    public function add_output($string)
-    {
-        $this->_output .= $string;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_output()
-    {
-        return $this->_output;
-    }
-
-
-    /**
-     * @param $item
-     * @param $key
-     */
-    public function sanitize_text_field_for_array_walk(&$item, &$key)
-    {
-        $item = strpos($item, 'email') !== false
-            ? sanitize_email($item)
-            : sanitize_text_field($item);
-    }
-
-
-    /**
-     * @param null|bool $value
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_espresso_page($value = null)
-    {
-        $this->request->set(
-            'is_espresso_page',
-            ! empty($value)
-                ? $value
-                : $this->test_for_espresso_page()
-        );
-    }
-
-
-    /**
-     * @return    mixed
-     */
-    public function is_espresso_page()
-    {
-        return $this->request->is_set('is_espresso_page');
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->request->params();
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request->set($key, $value, $override_ee);
-    }
-
-
-    /**
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request->get($key, $default);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param $key
-     * @return    boolean
-     */
-    public function is_set($key)
-    {
-        return $this->request->is_set($key);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param $key
-     * @return    void
-     */
-    public function un_set($key)
-    {
-        $this->request->un_set($key);
-    }
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var array $_notice
+	 */
+	private $_notice = array();
+
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var string $_output
+	 */
+	private $_output = '';
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+
+	/**
+	 * @param  EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+		$this->ajax = $this->request->ajax;
+		$this->front_ajax = $this->request->front_ajax;
+		do_action('AHEE__EE_Request_Handler__construct__complete');
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parse_request($wp = null)
+	{
+		// if somebody forgot to provide us with WP, that's ok because its global
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$this->set_request_vars($wp);
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_request_vars($wp = null)
+	{
+		if (! is_admin()) {
+			// set request post_id
+			$this->request->set('post_id', $this->get_post_id_from_request($wp));
+			// set request post name
+			$this->request->set('post_name', $this->get_post_name_from_request($wp));
+			// set request post_type
+			$this->request->set('post_type', $this->get_post_type_from_request($wp));
+			// true or false ? is this page being used by EE ?
+			$this->set_espresso_page();
+		}
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return int
+	 */
+	public function get_post_id_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_id = null;
+		if (isset($wp->query_vars['p'])) {
+			$post_id = $wp->query_vars['p'];
+		}
+		if (! $post_id && isset($wp->query_vars['page_id'])) {
+			$post_id = $wp->query_vars['page_id'];
+		}
+		if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+			$post_id = basename($wp->request);
+		}
+		return $post_id;
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return string
+	 */
+	public function get_post_name_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_name = null;
+		if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
+			$post_name = $wp->query_vars['name'];
+		}
+		if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+			$post_name = $wp->query_vars['pagename'];
+		}
+		if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+			$possible_post_name = basename($wp->request);
+			if (! is_numeric($possible_post_name)) {
+				/** @type WPDB $wpdb */
+				global $wpdb;
+				$SQL =
+					"SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
+				$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+				if ($possible_post_name) {
+					$post_name = $possible_post_name;
+				}
+			}
+		}
+		if (! $post_name && $this->get('post_id')) {
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			$SQL =
+				"SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return mixed
+	 */
+	public function get_post_type_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		return isset($wp->query_vars['post_type'])
+			? $wp->query_vars['post_type']
+			: null;
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param  WP $wp
+	 * @return string
+	 */
+	public function get_current_page_permalink($wp = null)
+	{
+		$post_id = $this->get_post_id_from_request($wp);
+		if ($post_id) {
+			$current_page_permalink = get_permalink($post_id);
+		} else {
+			if (! $wp instanceof WP) {
+				global $wp;
+			}
+			if ($wp->request) {
+				$current_page_permalink = site_url($wp->request);
+			} else {
+				$current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
+			}
+		}
+		return $current_page_permalink;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function test_for_espresso_page()
+	{
+		global $wp;
+		/** @type EE_CPT_Strategy $EE_CPT_Strategy */
+		$EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
+		$espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		$post_types = (array) $this->get('post_type');
+		foreach ($post_types as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[ $post_type ])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->get('post_name')) {
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					$post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
+						? $post_type_CPT_endpoints[ $this->get('post_type') ]
+						: '';
+					// if the post type matches on of our then set the endpoint
+					if ($post_name) {
+						$this->set('post_name', $post_name);
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->_notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function get_notice($key)
+	{
+		return isset($this->_notice[ $key ])
+			? $this->_notice[ $key ]
+			: null;
+	}
+
+
+	/**
+	 * @param $string
+	 * @return void
+	 */
+	public function add_output($string)
+	{
+		$this->_output .= $string;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_output()
+	{
+		return $this->_output;
+	}
+
+
+	/**
+	 * @param $item
+	 * @param $key
+	 */
+	public function sanitize_text_field_for_array_walk(&$item, &$key)
+	{
+		$item = strpos($item, 'email') !== false
+			? sanitize_email($item)
+			: sanitize_text_field($item);
+	}
+
+
+	/**
+	 * @param null|bool $value
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_espresso_page($value = null)
+	{
+		$this->request->set(
+			'is_espresso_page',
+			! empty($value)
+				? $value
+				: $this->test_for_espresso_page()
+		);
+	}
+
+
+	/**
+	 * @return    mixed
+	 */
+	public function is_espresso_page()
+	{
+		return $this->request->is_set('is_espresso_page');
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->request->params();
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request->set($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request->get($key, $default);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param $key
+	 * @return    boolean
+	 */
+	public function is_set($key)
+	{
+		return $this->request->is_set($key);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param $key
+	 * @return    void
+	 */
+	public function un_set($key)
+	{
+		$this->request->un_set($key);
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -65,7 +65,7 @@ 
     public function parse_request($wp = null)
     {
         // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $this->set_request_vars($wp);
@@ -80,7 +80,7 @@ 
      */
     public function set_request_vars($wp = null)
     {
-        if (! is_admin()) {
+        if ( ! is_admin()) {
             // set request post_id
             $this->request->set('post_id', $this->get_post_id_from_request($wp));
             // set request post name
@@ -99,17 +99,17 @@ 
      */
     public function get_post_id_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_id = null;
         if (isset($wp->query_vars['p'])) {
             $post_id = $wp->query_vars['p'];
         }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
+        if ( ! $post_id && isset($wp->query_vars['page_id'])) {
             $post_id = $wp->query_vars['page_id'];
         }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+        if ( ! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
             $post_id = basename($wp->request);
         }
         return $post_id;
@@ -122,19 +122,19 @@ 
      */
     public function get_post_name_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_name = null;
         if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
             $post_name = $wp->query_vars['name'];
         }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+        if ( ! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
             $post_name = $wp->query_vars['pagename'];
         }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+        if ( ! $post_name && $wp->request !== null && ! empty($wp->request)) {
             $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
+            if ( ! is_numeric($possible_post_name)) {
                 /** @type WPDB $wpdb */
                 global $wpdb;
                 $SQL =
@@ -145,7 +145,7 @@ 
                 }
             }
         }
-        if (! $post_name && $this->get('post_id')) {
+        if ( ! $post_name && $this->get('post_id')) {
             /** @type WPDB $wpdb */
             global $wpdb;
             $SQL =
@@ -165,7 +165,7 @@ 
      */
     public function get_post_type_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         return isset($wp->query_vars['post_type'])
@@ -186,7 +186,7 @@ 
         if ($post_id) {
             $current_page_permalink = get_permalink($post_id);
         } else {
-            if (! $wp instanceof WP) {
+            if ( ! $wp instanceof WP) {
                 global $wp;
             }
             if ($wp->request) {
@@ -212,7 +212,7 @@ 
         $espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
         if (is_array($espresso_CPT_taxonomies)) {
             foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
+                if (isset($wp->query_vars, $wp->query_vars[$espresso_CPT_taxonomy])) {
                     return true;
                 }
             }
@@ -223,12 +223,12 @@ 
         $post_types = (array) $this->get('post_type');
         foreach ($post_types as $post_type) {
             // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
+            if (isset($post_type_CPT_endpoints[$post_type])) {
                 // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
+                if ( ! $this->get('post_name')) {
                     // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    $post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
-                        ? $post_type_CPT_endpoints[ $this->get('post_type') ]
+                    $post_name = isset($post_type_CPT_endpoints[$this->get('post_type')])
+                        ? $post_type_CPT_endpoints[$this->get('post_type')]
                         : '';
                     // if the post type matches on of our then set the endpoint
                     if ($post_name) {
@@ -248,7 +248,7 @@ 
      */
     public function set_notice($key, $value)
     {
-        $this->_notice[ $key ] = $value;
+        $this->_notice[$key] = $value;
     }
 
 
@@ -258,8 +258,8 @@ 
      */
     public function get_notice($key)
     {
-        return isset($this->_notice[ $key ])
-            ? $this->_notice[ $key ]
+        return isset($this->_notice[$key])
+            ? $this->_notice[$key]
             : null;
     }
 

core/admin/EE_Help_Tour.core.php

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

Indentation +265 added lines, -265 removed lines

@@ -15,269 +15,269 @@
 abstract class EE_Help_Tour extends EE_Base
 {
 
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = __('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => __('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            // set to false or yoursite.com
-            'cookieDomain'          => false,
-            // Where the tip be attached if not inline
-            // 'tipContainer' => 'body',
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = __('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => __('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			// set to false or yoursite.com
+			'cookieDomain'          => false,
+			// Where the tip be attached if not inline
+			// 'tipContainer' => 'body',
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }