eventespresso / event-espresso-core

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

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;

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 = esc_html__('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 = esc_html__('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;
+	}
 }

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_Psr4AutoloaderInit.core.php

Indentation +34 added lines, -34 removed lines

@@ -17,38 +17,38 @@
 {
 
 
-    /**
-     * @type \EventEspresso\core\Psr4Autoloader
-     */
-    protected static $psr4_loader;
-
-
-    /**
-     * @return \EventEspresso\core\Psr4Autoloader
-     */
-    public function initializeAutoloader()
-    {
-        static $initialized = false;
-        if (! $initialized) {
-            // instantiate PSR4 autoloader
-            espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
-            EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
-            // register the autoloader
-            EE_Psr4AutoloaderInit::$psr4_loader->register();
-            // register the base directories for the namespace prefix
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
-            $initialized = true;
-        }
-    }
-
-
-    /**
-     * @return \EventEspresso\core\Psr4Autoloader
-     */
-    public static function psr4_loader()
-    {
-        return self::$psr4_loader;
-    }
+	/**
+	 * @type \EventEspresso\core\Psr4Autoloader
+	 */
+	protected static $psr4_loader;
+
+
+	/**
+	 * @return \EventEspresso\core\Psr4Autoloader
+	 */
+	public function initializeAutoloader()
+	{
+		static $initialized = false;
+		if (! $initialized) {
+			// instantiate PSR4 autoloader
+			espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
+			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
+			// register the autoloader
+			EE_Psr4AutoloaderInit::$psr4_loader->register();
+			// register the base directories for the namespace prefix
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
+			$initialized = true;
+		}
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\Psr4Autoloader
+	 */
+	public static function psr4_loader()
+	{
+		return self::$psr4_loader;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -29,15 +29,15 @@
     public function initializeAutoloader()
     {
         static $initialized = false;
-        if (! $initialized) {
+        if ( ! $initialized) {
             // instantiate PSR4 autoloader
-            espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
+            espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
             EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
             // register the autoloader
             EE_Psr4AutoloaderInit::$psr4_loader->register();
             // register the base directories for the namespace prefix
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
             $initialized = true;
         }

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/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 +267 added lines, -267 removed lines

@@ -18,271 +18,271 @@
 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;
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data = $request->requestParams();
-        $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'] = esc_html__('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'           => esc_html__('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(
-                    esc_html__(
-                        '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(
-                    esc_html__(
-                        '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;
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data = $request->requestParams();
+		$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'] = esc_html__('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'           => esc_html__('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(
+					esc_html__(
+						'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(
+					esc_html__(
+						'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);
+	}
 }

core/libraries/messages/EE_Message_Repository.lib.php

Spacing +7 added lines, -7 removed lines

@@ -99,7 +99,7 @@ 
     {
         $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
 
-        if (! $do_hooks_only) {
+        if ( ! $do_hooks_only) {
             $this->rewind();
             // exit early if there is nothing to save.
             if ($this->count() < 1) {
@@ -155,7 +155,7 @@ 
     public function get_generation_data()
     {
         // first verify we're at a valid iterator point.
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return array();
         }
         $info = $this->getInfo();
@@ -170,7 +170,7 @@ 
      */
     public function get_data_handler()
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return '';
         }
         $info = $this->getInfo();
@@ -185,7 +185,7 @@ 
      */
     public function is_preview()
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return false;
         }
         $info = $this->getInfo();
@@ -200,7 +200,7 @@ 
      */
     public function is_test_send()
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return false;
         }
         $info = $this->getInfo();
@@ -214,7 +214,7 @@ 
      */
     protected function _maybe_persist_attached_data()
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return;
         }
 
@@ -237,7 +237,7 @@ 
      */
     public function count_by_priority_and_status($priority, $status = array())
     {
-        if (! empty($status)) {
+        if ( ! empty($status)) {
             $status = is_array($status) ? $status : array($status);
         }
 

Indentation +226 added lines, -226 removed lines

@@ -12,257 +12,257 @@
 {
 
 
-    /**
-     *    EE_Message_Repository constructor
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message';
-        parent::__construct();
-    }
+	/**
+	 *    EE_Message_Repository constructor
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message';
+		parent::__construct();
+	}
 
 
-    /**
-     * Add the EE_Message to the repository.
-     * This also ensures that the MSG_token is saves as a part of the info for retrieval.
-     *
-     * @param EE_Message $message
-     * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
-     * @return bool
-     */
-    public function add($message, $info = null)
-    {
-        $attached = parent::add($message);
-        // ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array) $info;
-        $data = $this->_init_data($info, $attached, $message);
-        if ($attached) {
-            $this->set_info($message, $data);
-        }
-        return $attached;
-    }
+	/**
+	 * Add the EE_Message to the repository.
+	 * This also ensures that the MSG_token is saves as a part of the info for retrieval.
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
+	 * @return bool
+	 */
+	public function add($message, $info = null)
+	{
+		$attached = parent::add($message);
+		// ensure $info is an array if not already
+		$info = $info === null ? $info = array() : (array) $info;
+		$data = $this->_init_data($info, $attached, $message);
+		if ($attached) {
+			$this->set_info($message, $data);
+		}
+		return $attached;
+	}
 
 
-    /**
-     * Initializes the data from the incoming info.
-     *
-     * @param array      $info     incoming data.
-     * @param bool       $attached Indicates whether the object was attached successfully.
-     * @param EE_Message $message
-     * @return array
-     */
-    protected function _init_data($info, $attached, $message)
-    {
-        $data = array(
-            'test_send'               => false,
-            'preview'                 => false,
-            'data_handler_class_name' => '',
-            'data'                    => array(
-                'MSG_generation_data' => array(),
-            ),
-        );
-        if (isset($info['preview'])) {
-            $data['preview'] = $info['preview'];
-            unset($info['preview']);
-        }
-        if (isset($info['test_send'])) {
-            $data['test_send'] = $info['test_send'];
-            unset($info['test_send']);
-        }
-        if (isset($info['data_handler_class_name'])) {
-            $data['data_handler_class_name'] = $info['data_handler_class_name'];
-            unset($info['data_handler_class_name']);
-        }
-        if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
-            $generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
-            // if data isn't in $info...let's see if its available via the message object
-            $generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
-            // still empty then let's just use info
-            $generation_data                     = ! $generation_data ? $info : $generation_data;
-            $data['data']['MSG_generation_data'] = $generation_data;
-        }
-        return $data;
-    }
+	/**
+	 * Initializes the data from the incoming info.
+	 *
+	 * @param array      $info     incoming data.
+	 * @param bool       $attached Indicates whether the object was attached successfully.
+	 * @param EE_Message $message
+	 * @return array
+	 */
+	protected function _init_data($info, $attached, $message)
+	{
+		$data = array(
+			'test_send'               => false,
+			'preview'                 => false,
+			'data_handler_class_name' => '',
+			'data'                    => array(
+				'MSG_generation_data' => array(),
+			),
+		);
+		if (isset($info['preview'])) {
+			$data['preview'] = $info['preview'];
+			unset($info['preview']);
+		}
+		if (isset($info['test_send'])) {
+			$data['test_send'] = $info['test_send'];
+			unset($info['test_send']);
+		}
+		if (isset($info['data_handler_class_name'])) {
+			$data['data_handler_class_name'] = $info['data_handler_class_name'];
+			unset($info['data_handler_class_name']);
+		}
+		if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
+			$generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
+			// if data isn't in $info...let's see if its available via the message object
+			$generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
+			// still empty then let's just use info
+			$generation_data                     = ! $generation_data ? $info : $generation_data;
+			$data['data']['MSG_generation_data'] = $generation_data;
+		}
+		return $data;
+	}
 
 
-    /**
-     * Save all EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
-     * @return array array(
-     *                  'updated' => 0, //count of how many messages updated
-     *                  'notupdated' => 0, //count of how many messages not updated.
-     *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
-     *                  )
-     */
-    public function saveAll($do_hooks_only = false)
-    {
-        $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
+	/**
+	 * Save all EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
+	 * @return array array(
+	 *                  'updated' => 0, //count of how many messages updated
+	 *                  'notupdated' => 0, //count of how many messages not updated.
+	 *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
+	 *                  )
+	 */
+	public function saveAll($do_hooks_only = false)
+	{
+		$save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
 
-        if (! $do_hooks_only) {
-            $this->rewind();
-            // exit early if there is nothing to save.
-            if ($this->count() < 1) {
-                return $save_tracking;
-            }
+		if (! $do_hooks_only) {
+			$this->rewind();
+			// exit early if there is nothing to save.
+			if ($this->count() < 1) {
+				return $save_tracking;
+			}
 
-            while ($this->valid()) {
-                $saved = $this->current()->save();
-                if ($saved === false) {
-                    $save_tracking['errors'][] = $this->current()->MSG_token();
-                } elseif ($saved) {
-                    $save_tracking['updated']++;
-                } else {
-                    $save_tracking['notupdated']++;
-                }
-                // maybe persist generation data if this is an incomplete EE_Message.
-                $this->_maybe_persist_attached_data();
+			while ($this->valid()) {
+				$saved = $this->current()->save();
+				if ($saved === false) {
+					$save_tracking['errors'][] = $this->current()->MSG_token();
+				} elseif ($saved) {
+					$save_tracking['updated']++;
+				} else {
+					$save_tracking['notupdated']++;
+				}
+				// maybe persist generation data if this is an incomplete EE_Message.
+				$this->_maybe_persist_attached_data();
 
-                $this->next();
-            }
-        }
-        do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
-        return $save_tracking;
-    }
+				$this->next();
+			}
+		}
+		do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
+		return $save_tracking;
+	}
 
 
-    /**
-     * Retrieves a EE_Message from the repository that matches the given token.
-     *
-     * @param string $token Token.
-     * @return EE_Message | null
-     */
-    public function getMessageByToken($token)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->MSG_token() === $token) {
-                $message = $this->current();
-                $this->rewind();
-                return $message;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * Retrieves a EE_Message from the repository that matches the given token.
+	 *
+	 * @param string $token Token.
+	 * @return EE_Message | null
+	 */
+	public function getMessageByToken($token)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->MSG_token() === $token) {
+				$message = $this->current();
+				$this->rewind();
+				return $message;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
-     *
-     * @return array();
-     */
-    public function get_generation_data()
-    {
-        // first verify we're at a valid iterator point.
-        if (! $this->valid()) {
-            return array();
-        }
-        $info = $this->getInfo();
-        return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-    }
+	/**
+	 * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
+	 *
+	 * @return array();
+	 */
+	public function get_generation_data()
+	{
+		// first verify we're at a valid iterator point.
+		if (! $this->valid()) {
+			return array();
+		}
+		$info = $this->getInfo();
+		return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+	}
 
 
-    /**
-     * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
-     *
-     * @return string
-     */
-    public function get_data_handler()
-    {
-        if (! $this->valid()) {
-            return '';
-        }
-        $info = $this->getInfo();
-        return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-    }
+	/**
+	 * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
+	 *
+	 * @return string
+	 */
+	public function get_data_handler()
+	{
+		if (! $this->valid()) {
+			return '';
+		}
+		$info = $this->getInfo();
+		return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+	}
 
 
-    /**
-     * Returns whether this EE_Message is for a preview or not.
-     *
-     * @return bool
-     */
-    public function is_preview()
-    {
-        if (! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['preview'];
-    }
+	/**
+	 * Returns whether this EE_Message is for a preview or not.
+	 *
+	 * @return bool
+	 */
+	public function is_preview()
+	{
+		if (! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['preview'];
+	}
 
 
-    /**
-     * Returns whether the current message pointed to is for a test send.
-     *
-     * @return bool
-     */
-    public function is_test_send()
-    {
-        if (! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['test_send'];
-    }
+	/**
+	 * Returns whether the current message pointed to is for a test send.
+	 *
+	 * @return bool
+	 */
+	public function is_test_send()
+	{
+		if (! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['test_send'];
+	}
 
 
-    /**
-     *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
-     *  data is attached for later retrieval (batch generation).
-     */
-    protected function _maybe_persist_attached_data()
-    {
-        if (! $this->valid()) {
-            return;
-        }
+	/**
+	 *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
+	 *  data is attached for later retrieval (batch generation).
+	 */
+	protected function _maybe_persist_attached_data()
+	{
+		if (! $this->valid()) {
+			return;
+		}
 
-        $info                    = $this->getInfo();
-        $data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-        $data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-        if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
-            $this->current()->set_generation_data($data);
-            $this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
-        }
-    }
+		$info                    = $this->getInfo();
+		$data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+		$data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+		if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
+			$this->current()->set_generation_data($data);
+			$this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
+		}
+	}
 
 
-    /**
-     * This method returns a count of messages in the repository that have a given priority.
-     *
-     * @param int   $priority the priority that is being filtered for the count.
-     * @param array $status   the optional status(es) that will also be filtered by when priority matches.
-     * @return int  count of messages in the queue matching the conditions.
-     */
-    public function count_by_priority_and_status($priority, $status = array())
-    {
-        if (! empty($status)) {
-            $status = is_array($status) ? $status : array($status);
-        }
+	/**
+	 * This method returns a count of messages in the repository that have a given priority.
+	 *
+	 * @param int   $priority the priority that is being filtered for the count.
+	 * @param array $status   the optional status(es) that will also be filtered by when priority matches.
+	 * @return int  count of messages in the queue matching the conditions.
+	 */
+	public function count_by_priority_and_status($priority, $status = array())
+	{
+		if (! empty($status)) {
+			$status = is_array($status) ? $status : array($status);
+		}
 
-        $count = 0;
-        $this->rewind();
-        while ($this->valid()) {
-            if (
-                $this->current()->priority() === $priority && (($status && in_array(
-                    $this->current()->STS_ID(),
-                    $status
-                )) || ! $status)
-            ) {
-                $count++;
-            }
-            $this->next();
-        }
-        return $count;
-    }
+		$count = 0;
+		$this->rewind();
+		while ($this->valid()) {
+			if (
+				$this->current()->priority() === $priority && (($status && in_array(
+					$this->current()->STS_ID(),
+					$status
+				)) || ! $status)
+			) {
+				$count++;
+			}
+			$this->next();
+		}
+		return $count;
+	}
 
 
-    /**
-     * @return EE_Message
-     */
-    public function current()
-    {
-        return parent::current();
-    }
+	/**
+	 * @return EE_Message
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
 }

core/libraries/messages/EE_Messages_Template_Pack_Collection.lib.php

Indentation +14 added lines, -14 removed lines

@@ -11,19 +11,19 @@
 {
 
 
-    public function __construct()
-    {
-        $this->interface = 'EE_Messages_Template_Pack';
-    }
+	public function __construct()
+	{
+		$this->interface = 'EE_Messages_Template_Pack';
+	}
 
-    public function get_by_name($template_pack_name)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->dbref == $template_pack_name) {
-                return $this->current();
-            }
-            $this->next();
-        }
-    }
+	public function get_by_name($template_pack_name)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->dbref == $template_pack_name) {
+				return $this->current();
+			}
+			$this->next();
+		}
+	}
 }

core/libraries/messages/EE_Message_Factory.lib.php

Indentation +171 added lines, -171 removed lines

@@ -15,175 +15,175 @@
 {
 
 
-    /**
-     * @type EE_Message_Factory $_instance
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-
-
-    /**
-     * EE_Message_Factory constructor.
-     *
-     * @access protected
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     */
-    protected function __construct(
-        EE_Message_Resource_Manager $Message_Resource_Manager
-    ) {
-        $this->_message_resource_manager = $Message_Resource_Manager;
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     * @return \EE_Message_Factory instance
-     */
-    public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
-            self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * @access public
-     * @param  array $props_n_values
-     * @return EE_Message
-     */
-    public static function create($props_n_values = array())
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_create($props_n_values);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger_and_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger_and_message_type($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_message_type($message);
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  array $props_n_values
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _create($props_n_values = array())
-    {
-        $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
-            $message = EE_Message::new_instance_from_db($props_n_values);
-        } else {
-            $message = EE_Message::new_instance($props_n_values);
-            $new_instance = true;
-        }
-        return $this->_set_messenger_and_message_type($message, $new_instance);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message = $this->_set_messenger($message);
-        $message = $this->_set_message_type($message, $new_instance);
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger(EE_Message $message)
-    {
-        $messenger = $this->_message_resource_manager->get_messenger($message->messenger());
-        if ($messenger instanceof EE_messenger) {
-            $message->set_messenger_object($messenger);
-        }
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message_type = $this->_message_resource_manager->get_message_type($message->message_type());
-        if ($message_type instanceof EE_message_type) {
-            $message->set_message_type_object($message_type, $new_instance);
-        }
-        return $message;
-    }
+	/**
+	 * @type EE_Message_Factory $_instance
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+
+
+	/**
+	 * EE_Message_Factory constructor.
+	 *
+	 * @access protected
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 */
+	protected function __construct(
+		EE_Message_Resource_Manager $Message_Resource_Manager
+	) {
+		$this->_message_resource_manager = $Message_Resource_Manager;
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 * @return \EE_Message_Factory instance
+	 */
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  array $props_n_values
+	 * @return EE_Message
+	 */
+	public static function create($props_n_values = array())
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger_and_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  array $props_n_values
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _create($props_n_values = array())
+	{
+		$new_instance = false;
+		if (! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
+		} else {
+			$message = EE_Message::new_instance($props_n_values);
+			$new_instance = true;
+		}
+		return $this->_set_messenger_and_message_type($message, $new_instance);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger(EE_Message $message)
+	{
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
+		}
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
+		}
+		return $message;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
     public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
+        if ( ! self::$_instance instanceof EE_Message_Factory) {
             self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
         }
         return self::$_instance;
@@ -127,7 +127,7 @@ 
     protected function _create($props_n_values = array())
     {
         $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
+        if ( ! empty($props_n_values['MSG_ID'])) {
             $message = EE_Message::new_instance_from_db($props_n_values);
         } else {
             $message = EE_Message::new_instance($props_n_values);

core/libraries/messages/data_class/EE_Messages_Addressee.class.php

Indentation +295 added lines, -295 removed lines

@@ -15,299 +15,299 @@
 {
 
 
-    /**
-     * Identifier properties for the recipient
-     */
-
-    /**
-     * if available we'll use this to set the fname and lname (admin)
-     *
-     * @var int
-     */
-    public $user_id;
-
-    /**
-     * this will always be the admin fname (set later via incoming user_id)
-     *
-     * @var string
-     */
-    public $fname;
-
-    /**
-     * this will always be the admin lname (set later via incoming user_id)
-     *
-     * @var string
-     */
-    public $lname;
-
-    /**
-     * @var int
-     */
-    public $primary_registration_id;
-
-    /**
-     * @var int
-     */
-    public $attendee_registration_id;
-
-    /**
-     * This is should represent the data object that can be used to regenerate this addressee if needed.
-     * It is saved to the MSG_recipient_ID column in the generated EE_Message using this data.
-     *
-     * @var int
-     */
-    public $recipient_id;
-
-    /**
-     * This represents the reference to the EE_Base_Class child that the $recipient_ID is for (eg. 'Registration',
-     * 'Attendee') It is saved to the MSG_recipient_type column in the generated EE_Message using this data.
-     *
-     * @var string
-     */
-    public $recipient_type;
-
-    /**
-     * communication related
-     */
-    /**
-     * @var string
-     */
-    public $attendee_email;
-
-    /**
-     * @var string
-     */
-    public $primary_attendee_email;
-
-    /**
-     * @var string
-     */
-    public $admin_email;
-
-
-
-    /**
-     * Attendee related
-     */
-
-    /**
-     * holds the attendee object for the primary attendee
-     *
-     * @var EE_Attendee
-     */
-    public $primary_att_obj;
-
-    /**
-     * holds the registration object for the primary attendee
-     *
-     * @var EE_Registration
-     */
-    public $primary_reg_obj;
-
-    /**
-     * holds the attendee object for an attendee
-     *
-     * @var EE_Attendee
-     */
-    public $att_obj;
-
-    /**
-     * holds the registration object for an attendee
-     *
-     * @var EE_Registration
-     */
-    public $reg_obj;
-
-    /**
-     * array of EE_Question objects (indexed by EE_Answer->ID())
-     *
-     * @var EE_Question[]
-     */
-    public $questions;
-
-    /**
-     * array of EE_Answer objects
-     *
-     * @var EE_Answer[]
-     */
-    public $answers;
-
-
-
-    /**
-     * event related
-     */
-
-    /**
-     * This will hold all event info/
-     * @var EE_Event[]
-     */
-    public $events;
-
-    /**
-     * holds all the attendees for an event.
-     *
-     * @var EE_Attendee[]
-     */
-    public $attendees;
-
-    /**
-     * holds all the purchased tickets for an event
-     *
-     * @var EE_Ticket[]
-     */
-    public $tickets;
-
-    /**
-     * holds an array of line items indexed by parent ticket line item ids and values are array of children of that
-     * line item
-     *
-     * @var EE_Line_Item[]
-     */
-    public $line_items_with_children;
-
-    /**
-     * holds all the datetimes accessed via the tickets purchased for the event
-     *
-     * @var EE_Datetime[]
-     */
-    public $datetimes;
-
-    /**
-     * holds all registrations for a transaction (with cached relations on that registration)
-     *
-     * @var EE_Registration[]
-     */
-    public $registrations;
-
-
-
-    /**
-     * txn related
-     */
-
-    /**
-     * @var array
-     */
-    public $billing;
-
-    /**
-     *total taxes
-     *
-     * @var array
-     */
-    public $taxes;
-
-    /**
-     * @var EE_Line_Item[]
-     */
-    public $tax_line_items;
-
-    /**
-     * @var EE_Line_Item[]
-     */
-    public $additional_line_items;
-
-    /**
-     * @var EE_Line_Item
-     */
-    public $grand_total_line_item;
-
-    /**
-     * @var EE_Transaction
-     */
-    public $txn;
-
-    /**
-     * @var EE_Payment
-     */
-    public $payment;
-
-    /**
-     * @var EE_Payment[]
-     */
-    public $payments;
-
-    /**
-     * @var EE_Transaction[]
-     */
-    public $txn_objs;
-
-    /**
-     * @var EE_Registration[]
-     */
-    public $reg_objs;
-
-    /**
-     * total number of ALL tickets purchased for the txn.
-     *
-     * @var int
-     */
-    public $total_ticket_count;
-
-
-
-    /**
-     * things that get set later by parsers
-     */
-
-    /**
-     * @var string $event_list
-     */
-    public $event_list;
-
-    /**
-     * @var string
-     */
-    public $attendee_list;
-
-
-
-    /**
-     * This just holds the incoming data
-     *
-     * @var array
-     */
-    protected $_data;
-
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @param array $addressee_data We're expecting an incoming array of data that will be used to fill the properties
-     *                              for the object.
-     */
-    public function __construct($addressee_data)
-    {
-        $this->_data = $addressee_data;
-        $this->_set_properties();
-    }
-
-
-
-    /**
-     * This simply loops through the data and makes sure that each item is present in the incoming data.  If it is then
-     * it is assigned to the property.
-     *
-     * @access protected
-     * @return void.
-     */
-    protected function _set_properties()
-    {
-        foreach ($this->_data as $prop => $value) {
-            if (property_exists($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-        // if user_id present we'll use this to set the fname and lname and admin_email.
-        if (! empty($this->user_id)) {
-            $this->user_id = (int) $this->user_id;
-            $user = get_userdata($this->user_id);
-            $this->fname = $user->user_firstname;
-            $this->lname = $user->user_lastname;
-            $this->admin_email = $user->user_email;
-        }
-    }
+	/**
+	 * Identifier properties for the recipient
+	 */
+
+	/**
+	 * if available we'll use this to set the fname and lname (admin)
+	 *
+	 * @var int
+	 */
+	public $user_id;
+
+	/**
+	 * this will always be the admin fname (set later via incoming user_id)
+	 *
+	 * @var string
+	 */
+	public $fname;
+
+	/**
+	 * this will always be the admin lname (set later via incoming user_id)
+	 *
+	 * @var string
+	 */
+	public $lname;
+
+	/**
+	 * @var int
+	 */
+	public $primary_registration_id;
+
+	/**
+	 * @var int
+	 */
+	public $attendee_registration_id;
+
+	/**
+	 * This is should represent the data object that can be used to regenerate this addressee if needed.
+	 * It is saved to the MSG_recipient_ID column in the generated EE_Message using this data.
+	 *
+	 * @var int
+	 */
+	public $recipient_id;
+
+	/**
+	 * This represents the reference to the EE_Base_Class child that the $recipient_ID is for (eg. 'Registration',
+	 * 'Attendee') It is saved to the MSG_recipient_type column in the generated EE_Message using this data.
+	 *
+	 * @var string
+	 */
+	public $recipient_type;
+
+	/**
+	 * communication related
+	 */
+	/**
+	 * @var string
+	 */
+	public $attendee_email;
+
+	/**
+	 * @var string
+	 */
+	public $primary_attendee_email;
+
+	/**
+	 * @var string
+	 */
+	public $admin_email;
+
+
+
+	/**
+	 * Attendee related
+	 */
+
+	/**
+	 * holds the attendee object for the primary attendee
+	 *
+	 * @var EE_Attendee
+	 */
+	public $primary_att_obj;
+
+	/**
+	 * holds the registration object for the primary attendee
+	 *
+	 * @var EE_Registration
+	 */
+	public $primary_reg_obj;
+
+	/**
+	 * holds the attendee object for an attendee
+	 *
+	 * @var EE_Attendee
+	 */
+	public $att_obj;
+
+	/**
+	 * holds the registration object for an attendee
+	 *
+	 * @var EE_Registration
+	 */
+	public $reg_obj;
+
+	/**
+	 * array of EE_Question objects (indexed by EE_Answer->ID())
+	 *
+	 * @var EE_Question[]
+	 */
+	public $questions;
+
+	/**
+	 * array of EE_Answer objects
+	 *
+	 * @var EE_Answer[]
+	 */
+	public $answers;
+
+
+
+	/**
+	 * event related
+	 */
+
+	/**
+	 * This will hold all event info/
+	 * @var EE_Event[]
+	 */
+	public $events;
+
+	/**
+	 * holds all the attendees for an event.
+	 *
+	 * @var EE_Attendee[]
+	 */
+	public $attendees;
+
+	/**
+	 * holds all the purchased tickets for an event
+	 *
+	 * @var EE_Ticket[]
+	 */
+	public $tickets;
+
+	/**
+	 * holds an array of line items indexed by parent ticket line item ids and values are array of children of that
+	 * line item
+	 *
+	 * @var EE_Line_Item[]
+	 */
+	public $line_items_with_children;
+
+	/**
+	 * holds all the datetimes accessed via the tickets purchased for the event
+	 *
+	 * @var EE_Datetime[]
+	 */
+	public $datetimes;
+
+	/**
+	 * holds all registrations for a transaction (with cached relations on that registration)
+	 *
+	 * @var EE_Registration[]
+	 */
+	public $registrations;
+
+
+
+	/**
+	 * txn related
+	 */
+
+	/**
+	 * @var array
+	 */
+	public $billing;
+
+	/**
+	 *total taxes
+	 *
+	 * @var array
+	 */
+	public $taxes;
+
+	/**
+	 * @var EE_Line_Item[]
+	 */
+	public $tax_line_items;
+
+	/**
+	 * @var EE_Line_Item[]
+	 */
+	public $additional_line_items;
+
+	/**
+	 * @var EE_Line_Item
+	 */
+	public $grand_total_line_item;
+
+	/**
+	 * @var EE_Transaction
+	 */
+	public $txn;
+
+	/**
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+	/**
+	 * @var EE_Payment[]
+	 */
+	public $payments;
+
+	/**
+	 * @var EE_Transaction[]
+	 */
+	public $txn_objs;
+
+	/**
+	 * @var EE_Registration[]
+	 */
+	public $reg_objs;
+
+	/**
+	 * total number of ALL tickets purchased for the txn.
+	 *
+	 * @var int
+	 */
+	public $total_ticket_count;
+
+
+
+	/**
+	 * things that get set later by parsers
+	 */
+
+	/**
+	 * @var string $event_list
+	 */
+	public $event_list;
+
+	/**
+	 * @var string
+	 */
+	public $attendee_list;
+
+
+
+	/**
+	 * This just holds the incoming data
+	 *
+	 * @var array
+	 */
+	protected $_data;
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @param array $addressee_data We're expecting an incoming array of data that will be used to fill the properties
+	 *                              for the object.
+	 */
+	public function __construct($addressee_data)
+	{
+		$this->_data = $addressee_data;
+		$this->_set_properties();
+	}
+
+
+
+	/**
+	 * This simply loops through the data and makes sure that each item is present in the incoming data.  If it is then
+	 * it is assigned to the property.
+	 *
+	 * @access protected
+	 * @return void.
+	 */
+	protected function _set_properties()
+	{
+		foreach ($this->_data as $prop => $value) {
+			if (property_exists($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+		// if user_id present we'll use this to set the fname and lname and admin_email.
+		if (! empty($this->user_id)) {
+			$this->user_id = (int) $this->user_id;
+			$user = get_userdata($this->user_id);
+			$this->fname = $user->user_firstname;
+			$this->lname = $user->user_lastname;
+			$this->admin_email = $user->user_email;
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -302,7 +302,7 @@
             }
         }
         // if user_id present we'll use this to set the fname and lname and admin_email.
-        if (! empty($this->user_id)) {
+        if ( ! empty($this->user_id)) {
             $this->user_id = (int) $this->user_id;
             $user = get_userdata($this->user_id);
             $this->fname = $user->user_firstname;