eventespresso / event-espresso-core

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/EE_Messages_Processor.lib.php

Indentation +582 added lines, -582 removed lines

@@ -12,590 +12,590 @@
 {
 
 
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @type EE_Messages_Queue
-     */
-    protected $_queue;
-
-    /**
-     * @type  EE_Messages_Generator
-     */
-    protected $_generator;
-
-
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct(EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->_message_resource_manager = $message_resource_manager;
-        $this->_init_queue_and_generator();
-    }
-
-
-
-
-    /**
-     * This method sets (or resets) the various properties for use.
-     *
-     * - $_queue = holds the messages queue
-     * - $_generator = holds the messages generator
-     */
-    protected function _init_queue_and_generator()
-    {
-        $this->_generator = EE_Registry::factory('EE_Messages_Generator');
-        $this->_queue = $this->_generator->generation_queue();
-    }
-
-
-
-
-    /**
-     * This returns the current set queue.
-     * @return EE_Messages_Queue
-     */
-    public function get_queue()
-    {
-        return $this->_queue;
-    }
-
-
-
-    /**
-     * This method can be utilized to process messages from a queue and they will be processed immediately on the same request.
-     * Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes client code
-     * has already filtered those if necessary).
-     *
-     * @param EE_Messages_Queue $queue_to_process
-     * @return bool  true for success false for error.
-     */
-    public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
-    {
-        $success = false;
-        $messages_to_send = array();
-        $messages_to_generate = array();
-        // loop through and setup the various messages from the queue so we know what is being processed
-        $queue_to_process->get_message_repository()->rewind();
-        foreach ($queue_to_process->get_message_repository() as $message) {
-            if ($message->STS_ID() === EEM_Message::status_incomplete) {
-                $messages_to_generate[] = $message;
-                continue;
-            }
-
-            if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $messages_to_send[] = $message;
-                continue;
-            }
-        }
-
-        // do generation/sends
-        if ($messages_to_generate) {
-            $success = $this->batch_generate_from_queue($messages_to_generate, true);
-        }
-
-        if ($messages_to_send) {
-            $sent = $this->batch_send_from_queue($messages_to_send, true);
-            // if there was messages to generate and it failed, then we override any success value for the sending process
-            // otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
-            // Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
-            // all messages processing on the same request.
-            $success = $messages_to_generate && ! $success ? false : $sent;
-        }
-        return $success;
-    }
-
-
-    /**
-     * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
-     *
-     * @param  EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
-     * @param  bool         $clear_queue Whether to ensure a fresh queue or not.
-     *
-     * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
-     *                                   generated messages.
-     */
-    public function batch_generate_from_queue($messages = array(), $clear_queue = false)
-    {
-        if ($this->_build_queue_for_generation($messages, $clear_queue)) {
-            $new_queue = $this->_generator->generate();
-            if ($new_queue instanceof EE_Messages_Queue) {
-                // unlock queue
-                $this->_queue->unlock_queue();
-                $new_queue->initiate_request_by_priority('send');
-                return $new_queue;
-            }
-        }
-        $this->_queue->unlock_queue();
-        return false;
-    }
-
-
-
-    /**
-     * This method preps a queue for generation.
-     *
-     * @since    4.9.0
-     *
-     * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
-     *
-     * @param   bool       $clear_queue This indicates whether the existing queue should be dumped or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no generation please.
-     */
-    protected function _build_queue_for_generation($messages = array(), $clear_queue = false)
-    {
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        if ($messages) {
-            // if generation is locked then get out now because that means processing is already happening.
-            if ($this->_queue->is_locked()) {
-                return false;
-            }
-
-            $this->_queue->lock_queue();
-            $messages = is_array($messages) ? $messages : array( $messages );
-            foreach ($messages as $message) {
-                if ($message instanceof EE_Message) {
-                    $data = $message->all_extra_meta_array();
-                    $this->_queue->add($message, $data);
-                }
-            }
-            return true;
-        } else {
-            return $this->_queue->get_batch_to_generate();
-        }
-    }
-
-
-    /**
-     * This method preps a queue for sending.
-     *
-     * @param EE_Message[] $messages
-     * @param bool  $clear_queue Used to indicate whether to start with a fresh queue or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no queue prepped.
-     */
-    protected function _build_queue_for_sending($messages, $clear_queue = false)
-    {
-        // if sending is locked then get out now because that means processing is already happening.
-        if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->_queue->lock_queue(EE_Messages_Queue::action_sending);
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        $messages = is_array($messages) ? $messages : array( $messages );
-
-        foreach ($messages as $message) {
-            $this->_queue->add($message);
-        }
-        return true;
-    }
-
-
-    /**
-     * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls EE_Message_Queue::execute()
-     * to iterate and send unsent messages.
-     *
-     * @param EE_Message[] $messages    If an array of messages is sent in then use it.
-     *
-     * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
-     *
-     * @return EE_Messages_Queue
-     */
-    public function batch_send_from_queue($messages = array(), $clear_queue = false)
-    {
-
-        if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
-            $this->_queue->execute();
-            $this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
-        } else {
-            // get messages to send and execute.
-            $this->_queue->get_to_send_batch_and_send();
-        }
-        // note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
-        // messages in the queue and decide how to handle at that point.
-        return $this->_queue;
-    }
-
-
-
-
-
-
-    /**
-     * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
-     * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
-     * messages in the queue, leaving it up to the caller to do so.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     * @return EE_Messages_Queue
-     */
-    public function generate_and_return($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate(false);
-    }
-
-
-
-
-    /**
-     * Executes the generator generate method on the current internal queue, and returns the generated queue.
-     * @param  bool     $persist    Indicate whether to instruct the generator to persist the generated queue (true) or not (false).
-     * @return EE_Messages_Queue
-     */
-    public function generate_queue($persist = true)
-    {
-        return $this->_generator->generate($persist);
-    }
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @type EE_Messages_Queue
+	 */
+	protected $_queue;
+
+	/**
+	 * @type  EE_Messages_Generator
+	 */
+	protected $_generator;
+
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct(EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->_message_resource_manager = $message_resource_manager;
+		$this->_init_queue_and_generator();
+	}
+
+
+
+
+	/**
+	 * This method sets (or resets) the various properties for use.
+	 *
+	 * - $_queue = holds the messages queue
+	 * - $_generator = holds the messages generator
+	 */
+	protected function _init_queue_and_generator()
+	{
+		$this->_generator = EE_Registry::factory('EE_Messages_Generator');
+		$this->_queue = $this->_generator->generation_queue();
+	}
+
+
+
+
+	/**
+	 * This returns the current set queue.
+	 * @return EE_Messages_Queue
+	 */
+	public function get_queue()
+	{
+		return $this->_queue;
+	}
+
+
+
+	/**
+	 * This method can be utilized to process messages from a queue and they will be processed immediately on the same request.
+	 * Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes client code
+	 * has already filtered those if necessary).
+	 *
+	 * @param EE_Messages_Queue $queue_to_process
+	 * @return bool  true for success false for error.
+	 */
+	public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
+	{
+		$success = false;
+		$messages_to_send = array();
+		$messages_to_generate = array();
+		// loop through and setup the various messages from the queue so we know what is being processed
+		$queue_to_process->get_message_repository()->rewind();
+		foreach ($queue_to_process->get_message_repository() as $message) {
+			if ($message->STS_ID() === EEM_Message::status_incomplete) {
+				$messages_to_generate[] = $message;
+				continue;
+			}
+
+			if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$messages_to_send[] = $message;
+				continue;
+			}
+		}
+
+		// do generation/sends
+		if ($messages_to_generate) {
+			$success = $this->batch_generate_from_queue($messages_to_generate, true);
+		}
+
+		if ($messages_to_send) {
+			$sent = $this->batch_send_from_queue($messages_to_send, true);
+			// if there was messages to generate and it failed, then we override any success value for the sending process
+			// otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
+			// Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
+			// all messages processing on the same request.
+			$success = $messages_to_generate && ! $success ? false : $sent;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
+	 *
+	 * @param  EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
+	 * @param  bool         $clear_queue Whether to ensure a fresh queue or not.
+	 *
+	 * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
+	 *                                   generated messages.
+	 */
+	public function batch_generate_from_queue($messages = array(), $clear_queue = false)
+	{
+		if ($this->_build_queue_for_generation($messages, $clear_queue)) {
+			$new_queue = $this->_generator->generate();
+			if ($new_queue instanceof EE_Messages_Queue) {
+				// unlock queue
+				$this->_queue->unlock_queue();
+				$new_queue->initiate_request_by_priority('send');
+				return $new_queue;
+			}
+		}
+		$this->_queue->unlock_queue();
+		return false;
+	}
+
+
+
+	/**
+	 * This method preps a queue for generation.
+	 *
+	 * @since    4.9.0
+	 *
+	 * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
+	 *
+	 * @param   bool       $clear_queue This indicates whether the existing queue should be dumped or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no generation please.
+	 */
+	protected function _build_queue_for_generation($messages = array(), $clear_queue = false)
+	{
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		if ($messages) {
+			// if generation is locked then get out now because that means processing is already happening.
+			if ($this->_queue->is_locked()) {
+				return false;
+			}
+
+			$this->_queue->lock_queue();
+			$messages = is_array($messages) ? $messages : array( $messages );
+			foreach ($messages as $message) {
+				if ($message instanceof EE_Message) {
+					$data = $message->all_extra_meta_array();
+					$this->_queue->add($message, $data);
+				}
+			}
+			return true;
+		} else {
+			return $this->_queue->get_batch_to_generate();
+		}
+	}
+
+
+	/**
+	 * This method preps a queue for sending.
+	 *
+	 * @param EE_Message[] $messages
+	 * @param bool  $clear_queue Used to indicate whether to start with a fresh queue or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no queue prepped.
+	 */
+	protected function _build_queue_for_sending($messages, $clear_queue = false)
+	{
+		// if sending is locked then get out now because that means processing is already happening.
+		if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->_queue->lock_queue(EE_Messages_Queue::action_sending);
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		$messages = is_array($messages) ? $messages : array( $messages );
+
+		foreach ($messages as $message) {
+			$this->_queue->add($message);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls EE_Message_Queue::execute()
+	 * to iterate and send unsent messages.
+	 *
+	 * @param EE_Message[] $messages    If an array of messages is sent in then use it.
+	 *
+	 * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
+	 *
+	 * @return EE_Messages_Queue
+	 */
+	public function batch_send_from_queue($messages = array(), $clear_queue = false)
+	{
+
+		if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
+			$this->_queue->execute();
+			$this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
+		} else {
+			// get messages to send and execute.
+			$this->_queue->get_to_send_batch_and_send();
+		}
+		// note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
+		// messages in the queue and decide how to handle at that point.
+		return $this->_queue;
+	}
+
+
+
+
+
+
+	/**
+	 * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
+	 * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
+	 * messages in the queue, leaving it up to the caller to do so.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_and_return($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(false);
+	}
+
+
+
+
+	/**
+	 * Executes the generator generate method on the current internal queue, and returns the generated queue.
+	 * @param  bool     $persist    Indicate whether to instruct the generator to persist the generated queue (true) or not (false).
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_queue($persist = true)
+	{
+		return $this->_generator->generate($persist);
+	}
 
 
 
 
-    /**
-     * Queue for generation.  Note this does NOT persist to the db.  Client code should call get_message_repository()->save() if desire
-     * to persist.  This method is provided to client code to decide what it wants to do with queued messages for generation.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send             Whether this item is for a test send or not.
-     * @return  EE_Messages_Queue
-     */
-    public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if ($message_to_generate->valid()) {
-            $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send);
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the generation queue
-     * and then persists to storage.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    public function batch_queue_for_generation_and_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        $this->_queue->save();
-    }
-
-
-
-
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the generation
-     * queue.  Does NOT persist to storage (unless there is an error.
-     * Client code can retrieve the generated queue by calling EEM_Messages_Processor::get_queue()
-     *
-     * @param EE_Message_To_Generate[]  $messages_to_generate
-     */
-    public function batch_queue_for_generation_no_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-    }
-
-
-
-
-    /**
-     * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
-     * objects.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    protected function _queue_for_generation_loop($messages_to_generate)
-    {
-        // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
-            $messages_to_generate = array( $messages_to_generate );
-        }
-
-        foreach ($messages_to_generate as $message_to_generate) {
-            if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
-                $this->queue_for_generation($message_to_generate);
-            }
-        }
-    }
-
-
-
-
-
-    /**
-     * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
-     * queued for sending).
-     * @param  EE_Message_To_Generate[]
-     * @return EE_Messages_Queue
-     */
-    public function generate_and_queue_for_sending($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate(true);
-    }
-
-
-
-
-
-    /**
-     * Generate for preview and execute right away.
-     *
-     * @param   EE_Message_To_Generate $message_to_generate
-     * @param   bool                   $test_send                Whether this is a test send or not.
-     * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
-     */
-    public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if (! $message_to_generate->valid()) {
-            EE_Error::add_error(
-                __('Unable to generate preview because of invalid data', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // just make sure preview is set on the $message_to_generate (in case client forgot)
-        $message_to_generate->set_preview(true);
-        $this->_init_queue_and_generator();
-        $this->queue_for_generation($message_to_generate, $test_send);
-        $generated_queue = $this->_generator->generate(false);
-        if ($generated_queue->execute(false)) {
-            // the first queue item should be the preview
-            $generated_queue->get_message_repository()->rewind();
-            if (! $generated_queue->get_message_repository()->valid()) {
-                return $generated_queue;
-            }
-            return $generated_queue;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * This queues for sending.
-     * The messenger send now method is also verified to see if sending immediately is requested.
-     * otherwise its just saved to the queue.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return bool true or false for success.
-     */
-    public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return false;
-        }
-        $this->_init_queue_and_generator();
-        $message = $message_to_generate->get_EE_Message();
-        $this->_queue->add($message);
-        if ($message->send_now()) {
-            $this->_queue->execute(false);
-        } else {
-            $this->_queue->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * This generates and sends from the given EE_Message_To_Generate class immediately.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return EE_Messages_Queue | null
-     */
-    public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return null;
-        }
-        // is there supposed to be a sending messenger for this message?
-        if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
-            // make sure it's valid, but if it's not,
-            // then set the value of $sending_messenger to an EE_Error object
-            // so that downstream code can easily see that things went wrong.
-            $sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
-                ? $message_to_generate->sending_messenger()
-                : new EE_Error(
-                    __(
-                        'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
-                        'event_espresso'
-                    )
-                );
-        } else {
-            $sending_messenger = null;
-        }
-
-        if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
-            $this->_init_queue_and_generator();
-            $this->_queue->add($message_to_generate->get_EE_Message());
-            $this->_queue->execute(false, $sending_messenger);
-            return $this->_queue;
-        } elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
-            $generated_queue = $this->generate_and_return(array( $message_to_generate ));
-            $generated_queue->execute(false, $sending_messenger);
-            return $generated_queue;
-        }
-        return null;
-    }
-
-
-
-
-    /**
-     * Creates mtg objects for all active messengers and queues for generation.
-     * This method also calls the execute by priority method on the queue which will optionally kick off a new non-blocking
-     * request to complete the action if the priority for the message requires immediate action.
-     * @param string $message_type
-     * @param mixed  $data   The data being used for generation.
-     * @param bool   $persist   Whether to persist the queued messages to the db or not.
-     */
-    public function generate_for_all_active_messengers($message_type, $data, $persist = true)
-    {
-        $messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
-        if ($persist) {
-            $this->batch_queue_for_generation_and_persist($messages_to_generate);
-            $this->_queue->initiate_request_by_priority();
-        } else {
-            $this->batch_queue_for_generation_no_persist($messages_to_generate);
-        }
-    }
-
-
-
-
-    /**
-     * This simply loops through all active messengers and takes care of setting up the
-     * EE_Message_To_Generate objects.
-     * @param $message_type
-     * @param $data
-     *
-     * @return EE_Message_To_Generate[]
-     */
-    public function setup_mtgs_for_all_active_messengers($message_type, $data)
-    {
-        $messages_to_generate = array();
-        foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
-            $message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
-            if ($message_to_generate->valid()) {
-                $messages_to_generate[] = $message_to_generate;
-            }
-        }
-        return $messages_to_generate;
-    }
-
-
-
-
-    /**
-     * This accepts an array of EE_Message::MSG_ID values and will use that to retrieve the objects from the database
-     * and send.
-     * @param array $message_ids
-     */
-    public function setup_messages_from_ids_and_send($message_ids)
-    {
-        $this->_init_queue_and_generator();
-        $messages = EEM_Message::instance()->get_all(array(
-            array(
-                'MSG_ID' => array( 'IN', $message_ids ),
-                'STS_ID' => array(
-                    'IN',
-                    array_merge(
-                        EEM_Message::instance()->stati_indicating_sent(),
-                        array( EEM_Message::status_retry )
-                    ),
-                ),
-            ),
-        ));
-        // set the Messages to resend.
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $message->set_STS_ID(EEM_Message::status_resend);
-                $this->_queue->add($message);
-            }
-        }
-
-        $this->_queue->initiate_request_by_priority('send');
-    }
-
-
-
-    /**
-     * This method checks for registration IDs in the request via the given key and creates the messages to generate
-     * objects from them, then returns the array of messages to generate objects.
-     * Note, this sets up registrations for the registration family of message types.
-     *
-     * @param string $registration_ids_key  This is used to indicate what represents the registration ids in the request.
-     *
-     * @return EE_Message_To_Generate[]
-     */
-    public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $regs_to_send = array();
-        $regIDs = EE_Registry::instance()->REQ->get($registration_ids_key);
-        if (empty($regIDs)) {
-            EE_Error::add_error(__('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // make sure is an array
-        $regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
-
-        foreach ($regIDs as $regID) {
-            $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
-                EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
-                return false;
-            }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
-        }
-
-        $messages_to_generate = array();
-
-        foreach ($regs_to_send as $status_group) {
-            foreach ($status_group as $status_id => $registrations) {
-                $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
-                    continue;
-                }
-                $messages_to_generate = array_merge(
-                    $messages_to_generate,
-                    $this->setup_mtgs_for_all_active_messengers(
-                        $message_type,
-                        array( $registrations, $status_id )
-                    )
-                );
-            }
-        }
-
-        return $messages_to_generate;
-    }
+	/**
+	 * Queue for generation.  Note this does NOT persist to the db.  Client code should call get_message_repository()->save() if desire
+	 * to persist.  This method is provided to client code to decide what it wants to do with queued messages for generation.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send             Whether this item is for a test send or not.
+	 * @return  EE_Messages_Queue
+	 */
+	public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if ($message_to_generate->valid()) {
+			$this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send);
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the generation queue
+	 * and then persists to storage.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	public function batch_queue_for_generation_and_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		$this->_queue->save();
+	}
+
+
+
+
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the generation
+	 * queue.  Does NOT persist to storage (unless there is an error.
+	 * Client code can retrieve the generated queue by calling EEM_Messages_Processor::get_queue()
+	 *
+	 * @param EE_Message_To_Generate[]  $messages_to_generate
+	 */
+	public function batch_queue_for_generation_no_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+	}
+
+
+
+
+	/**
+	 * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
+	 * objects.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	protected function _queue_for_generation_loop($messages_to_generate)
+	{
+		// make sure is in an array.
+		if (! is_array($messages_to_generate)) {
+			$messages_to_generate = array( $messages_to_generate );
+		}
+
+		foreach ($messages_to_generate as $message_to_generate) {
+			if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
+				$this->queue_for_generation($message_to_generate);
+			}
+		}
+	}
+
+
+
+
+
+	/**
+	 * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
+	 * queued for sending).
+	 * @param  EE_Message_To_Generate[]
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_and_queue_for_sending($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(true);
+	}
+
+
+
+
+
+	/**
+	 * Generate for preview and execute right away.
+	 *
+	 * @param   EE_Message_To_Generate $message_to_generate
+	 * @param   bool                   $test_send                Whether this is a test send or not.
+	 * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
+	 */
+	public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if (! $message_to_generate->valid()) {
+			EE_Error::add_error(
+				__('Unable to generate preview because of invalid data', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// just make sure preview is set on the $message_to_generate (in case client forgot)
+		$message_to_generate->set_preview(true);
+		$this->_init_queue_and_generator();
+		$this->queue_for_generation($message_to_generate, $test_send);
+		$generated_queue = $this->_generator->generate(false);
+		if ($generated_queue->execute(false)) {
+			// the first queue item should be the preview
+			$generated_queue->get_message_repository()->rewind();
+			if (! $generated_queue->get_message_repository()->valid()) {
+				return $generated_queue;
+			}
+			return $generated_queue;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * This queues for sending.
+	 * The messenger send now method is also verified to see if sending immediately is requested.
+	 * otherwise its just saved to the queue.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return bool true or false for success.
+	 */
+	public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return false;
+		}
+		$this->_init_queue_and_generator();
+		$message = $message_to_generate->get_EE_Message();
+		$this->_queue->add($message);
+		if ($message->send_now()) {
+			$this->_queue->execute(false);
+		} else {
+			$this->_queue->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * This generates and sends from the given EE_Message_To_Generate class immediately.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return EE_Messages_Queue | null
+	 */
+	public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return null;
+		}
+		// is there supposed to be a sending messenger for this message?
+		if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
+			// make sure it's valid, but if it's not,
+			// then set the value of $sending_messenger to an EE_Error object
+			// so that downstream code can easily see that things went wrong.
+			$sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
+				? $message_to_generate->sending_messenger()
+				: new EE_Error(
+					__(
+						'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
+						'event_espresso'
+					)
+				);
+		} else {
+			$sending_messenger = null;
+		}
+
+		if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
+			$this->_init_queue_and_generator();
+			$this->_queue->add($message_to_generate->get_EE_Message());
+			$this->_queue->execute(false, $sending_messenger);
+			return $this->_queue;
+		} elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
+			$generated_queue = $this->generate_and_return(array( $message_to_generate ));
+			$generated_queue->execute(false, $sending_messenger);
+			return $generated_queue;
+		}
+		return null;
+	}
+
+
+
+
+	/**
+	 * Creates mtg objects for all active messengers and queues for generation.
+	 * This method also calls the execute by priority method on the queue which will optionally kick off a new non-blocking
+	 * request to complete the action if the priority for the message requires immediate action.
+	 * @param string $message_type
+	 * @param mixed  $data   The data being used for generation.
+	 * @param bool   $persist   Whether to persist the queued messages to the db or not.
+	 */
+	public function generate_for_all_active_messengers($message_type, $data, $persist = true)
+	{
+		$messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
+		if ($persist) {
+			$this->batch_queue_for_generation_and_persist($messages_to_generate);
+			$this->_queue->initiate_request_by_priority();
+		} else {
+			$this->batch_queue_for_generation_no_persist($messages_to_generate);
+		}
+	}
+
+
+
+
+	/**
+	 * This simply loops through all active messengers and takes care of setting up the
+	 * EE_Message_To_Generate objects.
+	 * @param $message_type
+	 * @param $data
+	 *
+	 * @return EE_Message_To_Generate[]
+	 */
+	public function setup_mtgs_for_all_active_messengers($message_type, $data)
+	{
+		$messages_to_generate = array();
+		foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
+			$message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
+			if ($message_to_generate->valid()) {
+				$messages_to_generate[] = $message_to_generate;
+			}
+		}
+		return $messages_to_generate;
+	}
+
+
+
+
+	/**
+	 * This accepts an array of EE_Message::MSG_ID values and will use that to retrieve the objects from the database
+	 * and send.
+	 * @param array $message_ids
+	 */
+	public function setup_messages_from_ids_and_send($message_ids)
+	{
+		$this->_init_queue_and_generator();
+		$messages = EEM_Message::instance()->get_all(array(
+			array(
+				'MSG_ID' => array( 'IN', $message_ids ),
+				'STS_ID' => array(
+					'IN',
+					array_merge(
+						EEM_Message::instance()->stati_indicating_sent(),
+						array( EEM_Message::status_retry )
+					),
+				),
+			),
+		));
+		// set the Messages to resend.
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$message->set_STS_ID(EEM_Message::status_resend);
+				$this->_queue->add($message);
+			}
+		}
+
+		$this->_queue->initiate_request_by_priority('send');
+	}
+
+
+
+	/**
+	 * This method checks for registration IDs in the request via the given key and creates the messages to generate
+	 * objects from them, then returns the array of messages to generate objects.
+	 * Note, this sets up registrations for the registration family of message types.
+	 *
+	 * @param string $registration_ids_key  This is used to indicate what represents the registration ids in the request.
+	 *
+	 * @return EE_Message_To_Generate[]
+	 */
+	public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$regs_to_send = array();
+		$regIDs = EE_Registry::instance()->REQ->get($registration_ids_key);
+		if (empty($regIDs)) {
+			EE_Error::add_error(__('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// make sure is an array
+		$regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
+
+		foreach ($regIDs as $regID) {
+			$reg = EEM_Registration::instance()->get_one_by_ID($regID);
+			if (! $reg instanceof EE_Registration) {
+				EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
+				return false;
+			}
+			$regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+		}
+
+		$messages_to_generate = array();
+
+		foreach ($regs_to_send as $status_group) {
+			foreach ($status_group as $status_id => $registrations) {
+				$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
+				if (! $message_type) {
+					continue;
+				}
+				$messages_to_generate = array_merge(
+					$messages_to_generate,
+					$this->setup_mtgs_for_all_active_messengers(
+						$message_type,
+						array( $registrations, $status_id )
+					)
+				);
+			}
+		}
+
+		return $messages_to_generate;
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -165,7 +165,7 @@ 
             }
 
             $this->_queue->lock_queue();
-            $messages = is_array($messages) ? $messages : array( $messages );
+            $messages = is_array($messages) ? $messages : array($messages);
             foreach ($messages as $message) {
                 if ($message instanceof EE_Message) {
                     $data = $message->all_extra_meta_array();
@@ -200,7 +200,7 @@ 
             $this->_init_queue_and_generator();
         }
 
-        $messages = is_array($messages) ? $messages : array( $messages );
+        $messages = is_array($messages) ? $messages : array($messages);
 
         foreach ($messages as $message) {
             $this->_queue->add($message);
@@ -333,8 +333,8 @@ 
     protected function _queue_for_generation_loop($messages_to_generate)
     {
         // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
-            $messages_to_generate = array( $messages_to_generate );
+        if ( ! is_array($messages_to_generate)) {
+            $messages_to_generate = array($messages_to_generate);
         }
 
         foreach ($messages_to_generate as $message_to_generate) {
@@ -374,7 +374,7 @@ 
      */
     public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             EE_Error::add_error(
                 __('Unable to generate preview because of invalid data', 'event_espresso'),
                 __FILE__,
@@ -391,7 +391,7 @@ 
         if ($generated_queue->execute(false)) {
             // the first queue item should be the preview
             $generated_queue->get_message_repository()->rewind();
-            if (! $generated_queue->get_message_repository()->valid()) {
+            if ( ! $generated_queue->get_message_repository()->valid()) {
                 return $generated_queue;
             }
             return $generated_queue;
@@ -410,7 +410,7 @@ 
      */
     public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false;
         }
         $this->_init_queue_and_generator();
@@ -432,7 +432,7 @@ 
      */
     public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return null;
         }
         // is there supposed to be a sending messenger for this message?
@@ -458,7 +458,7 @@ 
             $this->_queue->execute(false, $sending_messenger);
             return $this->_queue;
         } elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
-            $generated_queue = $this->generate_and_return(array( $message_to_generate ));
+            $generated_queue = $this->generate_and_return(array($message_to_generate));
             $generated_queue->execute(false, $sending_messenger);
             return $generated_queue;
         }
@@ -523,12 +523,12 @@ 
         $this->_init_queue_and_generator();
         $messages = EEM_Message::instance()->get_all(array(
             array(
-                'MSG_ID' => array( 'IN', $message_ids ),
+                'MSG_ID' => array('IN', $message_ids),
                 'STS_ID' => array(
                     'IN',
                     array_merge(
                         EEM_Message::instance()->stati_indicating_sent(),
-                        array( EEM_Message::status_retry )
+                        array(EEM_Message::status_retry)
                     ),
                 ),
             ),
@@ -567,15 +567,15 @@ 
         }
 
         // make sure is an array
-        $regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
+        $regIDs = is_array($regIDs) ? $regIDs : array($regIDs);
 
         foreach ($regIDs as $regID) {
             $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
                 return false;
             }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+            $regs_to_send[$reg->transaction_ID()][$reg->status_ID()][] = $reg;
         }
 
         $messages_to_generate = array();
@@ -583,14 +583,14 @@ 
         foreach ($regs_to_send as $status_group) {
             foreach ($status_group as $status_id => $registrations) {
                 $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
+                if ( ! $message_type) {
                     continue;
                 }
                 $messages_to_generate = array_merge(
                     $messages_to_generate,
                     $this->setup_mtgs_for_all_active_messengers(
                         $message_type,
-                        array( $registrations, $status_id )
+                        array($registrations, $status_id)
                     )
                 );
             }

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;

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

Indentation +132 added lines, -132 removed lines

@@ -18,136 +18,136 @@
 
 
 
-    /**
-     * For the constructor of this special preview class.
-     *
-     * The data is expected to be an array that came from the $_POST and $_GET and should have at least one property from the list looked for.
-     *
-     * @param EE_Registration|array $data
-     * @throws \EE_Error
-     */
-    public function __construct($data)
-    {
-        $filtered_reg_status = null;
-
-        if (! is_array($data) && $data instanceof EE_Registration) {
-            $this->reg_obj = $data;
-        } else {
-            $this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
-            $filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
-        }
-
-        if (! $this->reg_obj instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
-                    'EE_Messages_REG_incoming_data',
-                    'EE_Registration'
-                )
-            );
-        }
-
-        $data = array(
-            'reg_obj' => $this->reg_obj,
-            'filtered_reg_status' => $filtered_reg_status
-            );
-
-        parent::__construct($data);
-    }
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param mixed $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        $prepped_data = array();
-        if (! is_array($data) && $data instanceof EE_Registration) {
-            $prepped_data['Registration'] = $data->ID();
-            return $prepped_data;
-        } elseif (! is_array($data)) {
-            return array();
-        } else {
-            if ($data[0] instanceof EE_Registration) {
-                $prepped_data['Registration'] = $data[0];
-            }
-            if (! empty($data[1])) {
-                $prepped_data['filter'] = $data[1];
-            }
-        }
-
-        return $prepped_data;
-    }
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param $data
-     *
-     * @return mixed
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        $registration = null;
-        // $data['Registration'] could be either an ID (back compat) or a registration object (prepped using old system).
-        if (isset($data['Registration'])) {
-            $registration = $data['Registration'] instanceof EE_Registration
-                ? $data['Registration']
-                : EEM_Registration::instance()->get_one_by_ID($data['Registration']);
-        }
-        $prepped_data = array(
-            0 => $registration,
-            1 => isset($data['filter']) ? $data['filter'] : null
-        );
-        return $prepped_data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     * @return void
-     */
-    protected function _setup_data()
-    {
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        $this->filtered_reg_status = $this->_data['filtered_reg_status'];
-        // get txn
-        $this->txn = $this->reg_obj->transaction();
-        // possible session stuff?
-        $session = $this->txn->session_data();
-        $session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
-
-        // other data from the session (if possible)
-        $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
-        $this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
-        $this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
-        $this->init_access = $this->last_access = '';
-
-        $this->payment = $this->txn->get_first_related('Payment');
-        // if there is no payments associated with the transaction
-        // then we just create a default payment object for potential parsing.
-        $this->payment = empty($this->payment)
-            ? EE_Payment::new_instance(
-                array(
-                    'STS_ID'               => EEM_Payment::status_id_pending,
-                    'PAY_timestamp'        => time(),
-                    'PMD_ID'               => $this->txn->payment_method_ID(),
-                    'PAY_gateway_response' => $this->txn->gateway_response_on_transaction(),
-                )
-            )
-            : $this->payment;
-
-
-        // get reg_objs for txn
-        $this->reg_objs = $this->txn->registrations();
-
-        // now we can set things up like we do for other handlers
-
-        $this->_assemble_data();
-    }
+	/**
+	 * For the constructor of this special preview class.
+	 *
+	 * The data is expected to be an array that came from the $_POST and $_GET and should have at least one property from the list looked for.
+	 *
+	 * @param EE_Registration|array $data
+	 * @throws \EE_Error
+	 */
+	public function __construct($data)
+	{
+		$filtered_reg_status = null;
+
+		if (! is_array($data) && $data instanceof EE_Registration) {
+			$this->reg_obj = $data;
+		} else {
+			$this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
+			$filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
+		}
+
+		if (! $this->reg_obj instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
+					'EE_Messages_REG_incoming_data',
+					'EE_Registration'
+				)
+			);
+		}
+
+		$data = array(
+			'reg_obj' => $this->reg_obj,
+			'filtered_reg_status' => $filtered_reg_status
+			);
+
+		parent::__construct($data);
+	}
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param mixed $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		$prepped_data = array();
+		if (! is_array($data) && $data instanceof EE_Registration) {
+			$prepped_data['Registration'] = $data->ID();
+			return $prepped_data;
+		} elseif (! is_array($data)) {
+			return array();
+		} else {
+			if ($data[0] instanceof EE_Registration) {
+				$prepped_data['Registration'] = $data[0];
+			}
+			if (! empty($data[1])) {
+				$prepped_data['filter'] = $data[1];
+			}
+		}
+
+		return $prepped_data;
+	}
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param $data
+	 *
+	 * @return mixed
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		$registration = null;
+		// $data['Registration'] could be either an ID (back compat) or a registration object (prepped using old system).
+		if (isset($data['Registration'])) {
+			$registration = $data['Registration'] instanceof EE_Registration
+				? $data['Registration']
+				: EEM_Registration::instance()->get_one_by_ID($data['Registration']);
+		}
+		$prepped_data = array(
+			0 => $registration,
+			1 => isset($data['filter']) ? $data['filter'] : null
+		);
+		return $prepped_data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 * @return void
+	 */
+	protected function _setup_data()
+	{
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		$this->filtered_reg_status = $this->_data['filtered_reg_status'];
+		// get txn
+		$this->txn = $this->reg_obj->transaction();
+		// possible session stuff?
+		$session = $this->txn->session_data();
+		$session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
+
+		// other data from the session (if possible)
+		$this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
+		$this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
+		$this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
+		$this->init_access = $this->last_access = '';
+
+		$this->payment = $this->txn->get_first_related('Payment');
+		// if there is no payments associated with the transaction
+		// then we just create a default payment object for potential parsing.
+		$this->payment = empty($this->payment)
+			? EE_Payment::new_instance(
+				array(
+					'STS_ID'               => EEM_Payment::status_id_pending,
+					'PAY_timestamp'        => time(),
+					'PMD_ID'               => $this->txn->payment_method_ID(),
+					'PAY_gateway_response' => $this->txn->gateway_response_on_transaction(),
+				)
+			)
+			: $this->payment;
+
+
+		// get reg_objs for txn
+		$this->reg_objs = $this->txn->registrations();
+
+		// now we can set things up like we do for other handlers
+
+		$this->_assemble_data();
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -30,14 +30,14 @@ 
     {
         $filtered_reg_status = null;
 
-        if (! is_array($data) && $data instanceof EE_Registration) {
+        if ( ! is_array($data) && $data instanceof EE_Registration) {
             $this->reg_obj = $data;
         } else {
             $this->reg_obj = is_array($data) && isset($data[0]) && $data[0] instanceof EE_Registration ? $data[0] : null;
             $filtered_reg_status = is_array($data) && ! empty($data[1]) ? $data[1] : null;
         }
 
-        if (! $this->reg_obj instanceof EE_Registration) {
+        if ( ! $this->reg_obj instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     __('%1$s requires the incoming data argument to be an instance of %2$s or an array where the first value is an instance of %2$s', 'event_espresso'),
@@ -65,16 +65,16 @@ 
     public static function convert_data_for_persistent_storage($data)
     {
         $prepped_data = array();
-        if (! is_array($data) && $data instanceof EE_Registration) {
+        if ( ! is_array($data) && $data instanceof EE_Registration) {
             $prepped_data['Registration'] = $data->ID();
             return $prepped_data;
-        } elseif (! is_array($data)) {
+        } elseif ( ! is_array($data)) {
             return array();
         } else {
             if ($data[0] instanceof EE_Registration) {
                 $prepped_data['Registration'] = $data[0];
             }
-            if (! empty($data[1])) {
+            if ( ! empty($data[1])) {
                 $prepped_data['filter'] = $data[1];
             }
         }
@@ -120,7 +120,7 @@ 
         $this->txn = $this->reg_obj->transaction();
         // possible session stuff?
         $session = $this->txn->session_data();
-        $session_data =  $session instanceof EE_Session ? $session->get_session_data() : array();
+        $session_data = $session instanceof EE_Session ? $session->get_session_data() : array();
 
         // other data from the session (if possible)
         $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';

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

Spacing +65 added lines, -65 removed lines

@@ -98,71 +98,71 @@ 
         // we'll actually use the generated line_item identifiers for our loop
         $dtts = $tkts = array();
         foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
+            if ( ! $event instanceof EE_Event) {
                 continue;
             }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
+            $this->_events[$id]['ID']       = $id;
+            $this->_events[$id]['name']     = $event->get('EVT_name');
             $datetime                       = $event->get_first_related('Datetime');
             $tickets                        = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
                 'Ticket',
                 array('default_where_conditions' => 'none')
             ) : array();
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = array();
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = array();
+            $this->_events[$id]['event']    = $event;
+            $this->_events[$id]['reg_objs'] = array();
+            $this->_events[$id]['tkt_objs'] = $tickets;
+            $this->_events[$id]['dtt_objs'] = array();
             
             $dttcache = array();
             $tkts     = array();
             foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
+                if ( ! $ticket instanceof EE_Ticket) {
                     continue;
                 }
-                $reldatetime                     = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = array();
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
+                $reldatetime = $ticket->datetimes();
+                $tkts[$ticket->ID()]             = array();
+                $tkts[$ticket->ID()]['ticket']   = $ticket;
+                $tkts[$ticket->ID()]['dtt_objs'] = $reldatetime;
+                $tkts[$ticket->ID()]['att_objs'] = $attendees;
+                $tkts[$ticket->ID()]['count']    = count($attendees);
+                $tkts[$ticket->ID()]['EE_Event'] = $event;
                 foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']               = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]             = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]             = $event;
-                        $dttcache[ $datetime->ID() ]                       = $datetime;
+                    if ($datetime instanceof EE_Datetime && ! isset($dtts[$datetime->ID()])) {
+                        $this->_events[$id]['dtt_objs'][$datetime->ID()] = $datetime;
+                        $dtts[$datetime->ID()]['datetime']               = $datetime;
+                        $dtts[$datetime->ID()]['tkt_objs'][]             = $ticket;
+                        $dtts[$datetime->ID()]['evt_objs'][]             = $event;
+                        $dttcache[$datetime->ID()]                       = $datetime;
                     }
                 }
             }
             
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
+            $this->_events[$id]['total_attendees'] = count($attendees);
+            $this->_events[$id]['att_objs']        = $attendees;
             
             // let's also setup the dummy attendees property!
             foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
+                if ( ! $attendee instanceof EE_Attendee) {
                     continue;
                 }
-                $this->_attendees[ $att_key ]['line_ref'][] = $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
+                $this->_attendees[$att_key]['line_ref'][] = $id; // so later it can be determined what events this attendee registered for!
+                $this->_attendees[$att_key]['evt_objs'][] = $event;
+                $this->_attendees[$att_key]['att_obj']    = $attendee;
                 // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+                $this->_attendees[$att_key]['attendee_email'] = $attendee->email();
+                $this->_attendees[$att_key]['tkt_objs']       = $tickets;
                 if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+                    $this->_attendees[$att_key]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+                    $this->_attendees[$att_key]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+                    $this->_attendees[$att_key]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
                 } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+                    $this->_attendees[$att_key]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+                    $this->_attendees[$att_key]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+                    $this->_attendees[$att_key]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
                 } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+                    $this->_attendees[$att_key]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+                    $this->_attendees[$att_key]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+                    $this->_attendees[$att_key]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
                 }
             }
         }
@@ -261,7 +261,7 @@ 
             /** @var $email string */
             /** @var $phone string */
             /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
+            $attendees[$attid] = EE_Attendee::new_instance(
                 array(
                     'ATT_fname'    => $fname,
                     'ATT_lname'    => $lname,
@@ -367,8 +367,8 @@ 
         $qsts = array();
         // first the questions
         foreach ($quests_array as $qst) {
-            $qstobj                  = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+            $qstobj = array_combine($qst_columns, $qst);
+            $qsts[$qstobj['QST_ID']] = EE_Question::new_instance($qstobj);
         }
         
         // now the answers (and we'll setup our arrays)
@@ -376,8 +376,8 @@ 
         foreach ($ans_array as $ans) {
             $ansobj                             = array_combine($ans_columns, $ans);
             $ansobj                             = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+            $q_n_as['answers'][$ansobj->ID()]   = $ansobj;
+            $q_n_as['questions'][$ansobj->ID()] = $qsts[$ansobj->get('QST_ID')];
         }
         
         return $q_n_as;
@@ -461,11 +461,11 @@ 
             $regtxn = $this->txn->ID();
             $regcnt = 1;
             foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
+                foreach ($this->_events[$evtid]['tkt_objs'] as $ticket) {
+                    if ( ! $ticket instanceof EE_Ticket) {
                         continue;
                     }
-                    $reg_array                                        = array(
+                    $reg_array = array(
                         'EVT_ID'           => $evtid,
                         'ATT_ID'           => $regatt,
                         'TXN_ID'           => $regtxn,
@@ -474,18 +474,18 @@ 
                         'REG_date'         => time(),
                         'REG_final_price'  => $ticket->get('TKT_price'),
                         'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+                        'REG_code'         => $regid.'-dummy-generated-code',
+                        'REG_url_link'     => $regcnt.'-daafpapasdlfakasdfpqasdfasdf',
                         'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+                        'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
                         'REG_att_is_going' => true,
                         'REG_ID'           => $regid
                     );
                     $REG_OBJ                                          = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]              = $REG_OBJ;
+                    $this->_attendees[$key]['reg_objs'][$regid]       = $REG_OBJ;
+                    $this->_events[$evtid]['reg_objs'][] = $REG_OBJ;
                     $this->reg_objs[]                                 = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+                    $this->tickets[$ticket->ID()]['reg_objs'][$regid] = $REG_OBJ;
                     
                     $regcnt++;
                     $regid++;
@@ -523,18 +523,18 @@ 
         $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
         $line_items       = array();
         foreach ($event_line_items as $line_id => $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+            if ( ! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
                 continue;
             }
             $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
             foreach ($ticket_line_items as $ticket_line_id => $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             = $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+                $this->tickets[$ticket_line_item->OBJ_ID()]['line_item']      = $ticket_line_item;
+                $this->tickets[$ticket_line_item->OBJ_ID()]['sub_line_items'] = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['children']              = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['EE_Ticket']             = $this->tickets[$ticket_line_item->OBJ_ID()]['ticket'];
             }
         }
         
@@ -549,15 +549,15 @@ 
         
         // add additional details for each registration
         foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 continue;
             }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+            $this->_registrations[$reg->ID()]['tkt_obj']  = $this->tickets[$reg->get('TKT_ID')]['ticket'];
+            $this->_registrations[$reg->ID()]['evt_obj']  = $this->_events[$reg->get('EVT_ID')]['event'];
+            $this->_registrations[$reg->ID()]['reg_obj']  = $reg;
+            $this->_registrations[$reg->ID()]['ans_objs'] = $this->_attendees[$reg->get('ATT_ID')]['ans_objs'];
+            $this->_registrations[$reg->ID()]['att_obj']  = $this->_attendees[$reg->get('ATT_ID')]['att_obj'];
+            $this->_registrations[$reg->ID()]['dtt_objs'] = $this->tickets[$reg->get('TKT_ID')]['dtt_objs'];
         }
         
         

Indentation +580 added lines, -580 removed lines

@@ -18,584 +18,584 @@
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
 
-    // some specific properties we need for this class
-    private $_events = array();
-    private $_attendees = array();
-    private $_registrations = array();
-
-
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     */
-    public function __construct($data = array())
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : array();
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws \EE_Error
-     */
-    private function _setup_attendees_events()
-    {
-
-        // setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-
-        // if empty $data we'll do a query to get some events from the server. otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-
-        $answers_n_questions = $this->_get_some_q_and_as();
-
-        if (count($events) < 1) {
-            throw new EE_Error(__(
-                'We can\'t generate a preview for you because there are no active events in your database',
-                'event_espresso'
-            ));
-        }
-
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-
-
-        // we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = array();
-        foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
-            $datetime                       = $event->get_first_related('Datetime');
-            $tickets                        = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
-                'Ticket',
-                array('default_where_conditions' => 'none')
-            ) : array();
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = array();
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = array();
-
-            $dttcache = array();
-            $tkts     = array();
-            foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                     = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = array();
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']               = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]             = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]             = $event;
-                        $dttcache[ $datetime->ID() ]                       = $datetime;
-                    }
-                }
-            }
-
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
-
-            // let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[ $att_key ]['line_ref'][] = $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
-                // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-    }
-
-
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     */
-    private function _get_some_attendees()
-    {
-        // let's just setup a dummy array of various attendee details
-        $dummy_attendees = array(
-            0 => array(
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991'
-            ),
-            1 => array(
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992'
-            ),
-            2 => array(
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993'
-            ),
-        );
-
-        // let's generate the attendee objects
-        $attendees = array();
-        $var_array = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid'
-        );
-
-        // EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
-                array(
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid
-                )
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     * @return array
-     */
-    private function _get_some_q_and_as()
-    {
-
-
-        $quests_array = array(
-            0 => array(
-                555,
-                __('What is your favorite planet?', 'event_espresso'),
-                0
-            ),
-            1 => array(
-                556,
-                __('What is your favorite food?', 'event_espresso'),
-                0
-            ),
-            2 => array(
-                557,
-                __('How many lightyears have you travelled', 'event_espresso'),
-                0
-            )
-        );
-
-
-        $ans_array = array(
-            0 => array(
-                999,
-                555,
-                'Tattoine'
-            ),
-            1 => array(
-                1000,
-                555,
-                'Alderaan'
-            ),
-            2 => array(
-                1001,
-                555,
-                'Dantooine'
-            ),
-            3 => array(
-                1002,
-                556,
-                'Fish Fingers'
-            ),
-            4 => array(
-                1003,
-                556,
-                'Sushi'
-            ),
-            5 => array(
-                1004,
-                556,
-                'Water'
-            ),
-            6 => array(
-                1005,
-                557,
-                'A lot',
-            ),
-            7 => array(
-                1006,
-                557,
-                "That's none of your business."
-            ),
-            8 => array(
-                1007,
-                557,
-                "People less travel me then."
-            )
-        );
-
-        $qst_columns = array('QST_ID', 'QST_display_text', 'QST_system');
-        $ans_columns = array('ANS_ID', 'QST_ID', 'ANS_value');
-
-        // EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        // EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-
-        $qsts = array();
-        // first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                  = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
-        }
-
-        // now the answers (and we'll setup our arrays)
-        $q_n_as = array();
-        foreach ($ans_array as $ans) {
-            $ansobj                             = array_combine($ans_columns, $ans);
-            $ansobj                             = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
-        }
-
-        return $q_n_as;
-    }
-
-
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param  array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     */
-    private function _get_some_events($event_ids = array())
-    {
-
-        // HEY, if we have an evt_id then we want to make sure we use that for the preview (because a specific event template is being viewed);
-        $event_ids = isset($_REQUEST['evt_id']) && ! empty($_REQUEST['evt_id'])
-            ? array($_REQUEST['evt_id'])
-            : $event_ids;
-
-        $limit = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-
-        $where = ! empty($event_ids)
-            ? array(
-                'EVT_ID'                 => array('IN', $event_ids),
-                'Datetime.Ticket.TKT_ID' => array('>', 1)
-            )
-            : array('Datetime.Ticket.TKT_ID' => array('>', 1));
-
-        $events = EE_Registry::instance()->load_model('Event')->get_all(array($where, 'limit' => $limit));
-
-        return $events;
-    }
-
-
-    protected function _setup_data()
-    {
-
-        // need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-
-
-        // add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-
-
-        // setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            array(
-                'TXN_timestamp'    => time(), // unix timestamp
-                'TXN_total'        => 0, // txn_total
-                'TXN_paid'         => 0, // txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
-                'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, // hash salt blank as well
-                'TXN_ID'           => 999999
-            )
-        );
-
-
-        // setup reg_objects
-        // note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = array();
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            // note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                        = array(
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => EEM_Registration::status_id_pending_payment,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid
-                    );
-                    $REG_OBJ                                          = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]              = $REG_OBJ;
-                    $this->reg_objs[]                                 = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
-
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-
-
-        // setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-
-        // add tickets
-        foreach ($this->tickets as $tktid => $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-
-        $shipping_line_item = EE_Line_Item::new_instance(array(
-            'LIN_name'       => __('Shipping Surcharge', 'event_espresso'),
-            'LIN_desc'       => __('Sent via Millenium Falcon', 'event_espresso'),
-            'LIN_unit_price' => 20,
-            'LIN_quantity'   => 1,
-            'LIN_is_taxable' => true,
-            'LIN_total'      => 20,
-            'LIN_type'       => EEM_Line_Item::type_line_item
-        ));
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = array($shipping_line_item);
-
-        // now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-
-        // now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = array();
-        foreach ($event_line_items as $line_id => $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_id => $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             = $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
-            }
-        }
-
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-
-        // add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-
-
-        // add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
-        }
-
-
-        // events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-
-        $attendees_to_shift = $this->_attendees;
-
-        // setup primary attendee property
-        $this->primary_attendee_data = array(
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
-
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
-
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
-
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
-
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs'])
-        );
-
-        // reg_info property
-        // note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = array();
-
-        // let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
-        // the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+	// some specific properties we need for this class
+	private $_events = array();
+	private $_attendees = array();
+	private $_registrations = array();
+
+
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 */
+	public function __construct($data = array())
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : array();
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws \EE_Error
+	 */
+	private function _setup_attendees_events()
+	{
+
+		// setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+
+		// if empty $data we'll do a query to get some events from the server. otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+
+		$answers_n_questions = $this->_get_some_q_and_as();
+
+		if (count($events) < 1) {
+			throw new EE_Error(__(
+				'We can\'t generate a preview for you because there are no active events in your database',
+				'event_espresso'
+			));
+		}
+
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+
+
+		// we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = array();
+		foreach ($events as $id => $event) {
+			if (! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[ $id ]['ID']       = $id;
+			$this->_events[ $id ]['name']     = $event->get('EVT_name');
+			$datetime                       = $event->get_first_related('Datetime');
+			$tickets                        = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
+				'Ticket',
+				array('default_where_conditions' => 'none')
+			) : array();
+			$this->_events[ $id ]['event']    = $event;
+			$this->_events[ $id ]['reg_objs'] = array();
+			$this->_events[ $id ]['tkt_objs'] = $tickets;
+			$this->_events[ $id ]['dtt_objs'] = array();
+
+			$dttcache = array();
+			$tkts     = array();
+			foreach ($tickets as $ticket) {
+				if (! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                     = $ticket->datetimes();
+				$tkts[ $ticket->ID() ]             = array();
+				$tkts[ $ticket->ID() ]['ticket']   = $ticket;
+				$tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
+				$tkts[ $ticket->ID() ]['att_objs'] = $attendees;
+				$tkts[ $ticket->ID() ]['count']    = count($attendees);
+				$tkts[ $ticket->ID() ]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
+						$this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
+						$dtts[ $datetime->ID() ]['datetime']               = $datetime;
+						$dtts[ $datetime->ID() ]['tkt_objs'][]             = $ticket;
+						$dtts[ $datetime->ID() ]['evt_objs'][]             = $event;
+						$dttcache[ $datetime->ID() ]                       = $datetime;
+					}
+				}
+			}
+
+			$this->_events[ $id ]['total_attendees'] = count($attendees);
+			$this->_events[ $id ]['att_objs']        = $attendees;
+
+			// let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if (! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[ $att_key ]['line_ref'][] = $id;  // so later it can be determined what events this attendee registered for!
+				$this->_attendees[ $att_key ]['evt_objs'][] = $event;
+				$this->_attendees[ $att_key ]['att_obj']    = $attendee;
+				// $this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
+				$this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+	}
+
+
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 */
+	private function _get_some_attendees()
+	{
+		// let's just setup a dummy array of various attendee details
+		$dummy_attendees = array(
+			0 => array(
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991'
+			),
+			1 => array(
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992'
+			),
+			2 => array(
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993'
+			),
+		);
+
+		// let's generate the attendee objects
+		$attendees = array();
+		$var_array = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid'
+		);
+
+		// EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[ $attid ] = EE_Attendee::new_instance(
+				array(
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid
+				)
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 * @return array
+	 */
+	private function _get_some_q_and_as()
+	{
+
+
+		$quests_array = array(
+			0 => array(
+				555,
+				__('What is your favorite planet?', 'event_espresso'),
+				0
+			),
+			1 => array(
+				556,
+				__('What is your favorite food?', 'event_espresso'),
+				0
+			),
+			2 => array(
+				557,
+				__('How many lightyears have you travelled', 'event_espresso'),
+				0
+			)
+		);
+
+
+		$ans_array = array(
+			0 => array(
+				999,
+				555,
+				'Tattoine'
+			),
+			1 => array(
+				1000,
+				555,
+				'Alderaan'
+			),
+			2 => array(
+				1001,
+				555,
+				'Dantooine'
+			),
+			3 => array(
+				1002,
+				556,
+				'Fish Fingers'
+			),
+			4 => array(
+				1003,
+				556,
+				'Sushi'
+			),
+			5 => array(
+				1004,
+				556,
+				'Water'
+			),
+			6 => array(
+				1005,
+				557,
+				'A lot',
+			),
+			7 => array(
+				1006,
+				557,
+				"That's none of your business."
+			),
+			8 => array(
+				1007,
+				557,
+				"People less travel me then."
+			)
+		);
+
+		$qst_columns = array('QST_ID', 'QST_display_text', 'QST_system');
+		$ans_columns = array('ANS_ID', 'QST_ID', 'ANS_value');
+
+		// EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		// EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+
+		$qsts = array();
+		// first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                  = array_combine($qst_columns, $qst);
+			$qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+		}
+
+		// now the answers (and we'll setup our arrays)
+		$q_n_as = array();
+		foreach ($ans_array as $ans) {
+			$ansobj                             = array_combine($ans_columns, $ans);
+			$ansobj                             = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
+			$q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+		}
+
+		return $q_n_as;
+	}
+
+
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param  array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 */
+	private function _get_some_events($event_ids = array())
+	{
+
+		// HEY, if we have an evt_id then we want to make sure we use that for the preview (because a specific event template is being viewed);
+		$event_ids = isset($_REQUEST['evt_id']) && ! empty($_REQUEST['evt_id'])
+			? array($_REQUEST['evt_id'])
+			: $event_ids;
+
+		$limit = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+
+		$where = ! empty($event_ids)
+			? array(
+				'EVT_ID'                 => array('IN', $event_ids),
+				'Datetime.Ticket.TKT_ID' => array('>', 1)
+			)
+			: array('Datetime.Ticket.TKT_ID' => array('>', 1));
+
+		$events = EE_Registry::instance()->load_model('Event')->get_all(array($where, 'limit' => $limit));
+
+		return $events;
+	}
+
+
+	protected function _setup_data()
+	{
+
+		// need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+
+
+		// add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+
+
+		// setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			array(
+				'TXN_timestamp'    => time(), // unix timestamp
+				'TXN_total'        => 0, // txn_total
+				'TXN_paid'         => 0, // txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
+				'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, // hash salt blank as well
+				'TXN_ID'           => 999999
+			)
+		);
+
+
+		// setup reg_objects
+		// note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = array();
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			// note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
+					if (! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                        = array(
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => EEM_Registration::status_id_pending_payment,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid
+					);
+					$REG_OBJ                                          = EE_Registration::new_instance($reg_array);
+					$this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
+					$this->_events[ $evtid ]['reg_objs'][]              = $REG_OBJ;
+					$this->reg_objs[]                                 = $REG_OBJ;
+					$this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+
+
+		// setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+
+		// add tickets
+		foreach ($this->tickets as $tktid => $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+
+		$shipping_line_item = EE_Line_Item::new_instance(array(
+			'LIN_name'       => __('Shipping Surcharge', 'event_espresso'),
+			'LIN_desc'       => __('Sent via Millenium Falcon', 'event_espresso'),
+			'LIN_unit_price' => 20,
+			'LIN_quantity'   => 1,
+			'LIN_is_taxable' => true,
+			'LIN_total'      => 20,
+			'LIN_type'       => EEM_Line_Item::type_line_item
+		));
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = array($shipping_line_item);
+
+		// now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+
+		// now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = array();
+		foreach ($event_line_items as $line_id => $line_item) {
+			if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_id => $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['EE_Ticket']             = $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+			}
+		}
+
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+
+		// add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+
+
+		// add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if (! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
+			$this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
+			$this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
+			$this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
+			$this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
+			$this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+		}
+
+
+		// events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+
+		$attendees_to_shift = $this->_attendees;
+
+		// setup primary attendee property
+		$this->primary_attendee_data = array(
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
+
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
+
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
+
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
+
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs'])
+		);
+
+		// reg_info property
+		// note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = array();
+
+		// let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
+		// the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
 }

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

Indentation +136 added lines, -136 removed lines

@@ -14,141 +14,141 @@
 class EE_Messages_Gateways_incoming_data extends EE_Messages_incoming_data
 {
 
-    /**
-     * This holds the incoming payment object
-     * @var EE_Payment
-     */
-    public $payment;
-
-
-
-    /**
-     * incoming data is expected to be a EE_Transaction object and (possibly) EE_Payment object in an array.
-     *
-     * @param array $data
-     * @throws EE_Error
-     */
-    public function __construct($data)
-    {
-
-        // test for valid params
-        if (! ( $data[0] instanceof EE_Transaction )) {
-            throw new EE_Error(__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
-        }
-
-        if (empty($data[1]) || ! $data[1] instanceof  EE_Payment) {
-            $pmt_obj = $this->_get_empty_payment_obj($data[0]);
-        }
-
-        if (! empty($data[2])) {
-            $filtered_reg_status = $data[2];
-        }
+	/**
+	 * This holds the incoming payment object
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+
+
+	/**
+	 * incoming data is expected to be a EE_Transaction object and (possibly) EE_Payment object in an array.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 */
+	public function __construct($data)
+	{
+
+		// test for valid params
+		if (! ( $data[0] instanceof EE_Transaction )) {
+			throw new EE_Error(__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
+		}
+
+		if (empty($data[1]) || ! $data[1] instanceof  EE_Payment) {
+			$pmt_obj = $this->_get_empty_payment_obj($data[0]);
+		}
+
+		if (! empty($data[2])) {
+			$filtered_reg_status = $data[2];
+		}
 
-        $data = array(
-            'txn_obj' => $data[0],
-            'pmt_obj' => isset($pmt_obj) ? $pmt_obj : $data[1],
-            'filtered_reg_status' => isset($filtered_reg_status) ? $filtered_reg_status : null
-            );
-        parent::__construct($data);
-    }
-
-
-
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        $prepped_data = array();
-
-        if ($data[0] instanceof EE_Transaction) {
-            $prepped_data['Transaction'] = $data[0]->ID();
-        }
-
-        if (isset($data[1]) && $data[1] instanceof EE_Payment) {
-            $prepped_data['Payment'] = $data[1]->ID();
-        }
-
-        if (! empty($data[2])) {
-            $prepped_data['filter'] = $data[2];
-        }
-
-        return $prepped_data;
-    }
-
-
-
-
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array  $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        $prepped_data = array(
-            0 => isset($data['Transaction']) ? EEM_Transaction::instance()->get_one_by_ID($data['Transaction']) : null,
-            1 => isset($data['Payment']) ? EEM_Payment::instance()->get_one_by_ID($data['Payment']) : null,
-            2 => isset($data['filter']) ? $data['filter'] : null
-        );
-        return $prepped_data;
-    }
-
-
-    /**
-     * This sets up an empty EE_Payment object for the purpose of shortcode parsing.  Note that this doesn't actually get saved to the db.
-     * @param \EE_Transaction $txn
-     * @return \EE_Payment
-     */
-    private function _get_empty_payment_obj(EE_Transaction $txn)
-    {
-        $PMT = EE_Payment::new_instance(array(
-            'STS_ID' => EEM_Payment::status_id_pending,
-            'PAY_timestamp' => time(),
-            'PMD_ID' => $txn->payment_method_ID(),
-            'PAY_gateway_response' => $txn->gateway_response_on_transaction(),
-            ));
-        return $PMT;
-    }
-
-
-
-    /**
-     * _setup_data
-     *
-     * @throws EE_Error
-     */
-    protected function _setup_data()
-    {
-
-        $this->reg_info = array();
-
-        $this->txn = $this->_data['txn_obj'];
-        $this->payment = $this->_data['pmt_obj'];
-        $this->filtered_reg_status = $this->_data['filtered_reg_status'];
-        $this->incoming_data = $this->_data;
-
-        $session_data = $this->txn->session_data();
-
-
-        // other data from the session (if possible)
-        $this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
-        $this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
-        $this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
-        $this->init_access = $this->last_access = '';
-        // get all non-trashed registrations
-        $this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));
-        $this->_assemble_data();
-    }
+		$data = array(
+			'txn_obj' => $data[0],
+			'pmt_obj' => isset($pmt_obj) ? $pmt_obj : $data[1],
+			'filtered_reg_status' => isset($filtered_reg_status) ? $filtered_reg_status : null
+			);
+		parent::__construct($data);
+	}
+
+
+
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		$prepped_data = array();
+
+		if ($data[0] instanceof EE_Transaction) {
+			$prepped_data['Transaction'] = $data[0]->ID();
+		}
+
+		if (isset($data[1]) && $data[1] instanceof EE_Payment) {
+			$prepped_data['Payment'] = $data[1]->ID();
+		}
+
+		if (! empty($data[2])) {
+			$prepped_data['filter'] = $data[2];
+		}
+
+		return $prepped_data;
+	}
+
+
+
+
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array  $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		$prepped_data = array(
+			0 => isset($data['Transaction']) ? EEM_Transaction::instance()->get_one_by_ID($data['Transaction']) : null,
+			1 => isset($data['Payment']) ? EEM_Payment::instance()->get_one_by_ID($data['Payment']) : null,
+			2 => isset($data['filter']) ? $data['filter'] : null
+		);
+		return $prepped_data;
+	}
+
+
+	/**
+	 * This sets up an empty EE_Payment object for the purpose of shortcode parsing.  Note that this doesn't actually get saved to the db.
+	 * @param \EE_Transaction $txn
+	 * @return \EE_Payment
+	 */
+	private function _get_empty_payment_obj(EE_Transaction $txn)
+	{
+		$PMT = EE_Payment::new_instance(array(
+			'STS_ID' => EEM_Payment::status_id_pending,
+			'PAY_timestamp' => time(),
+			'PMD_ID' => $txn->payment_method_ID(),
+			'PAY_gateway_response' => $txn->gateway_response_on_transaction(),
+			));
+		return $PMT;
+	}
+
+
+
+	/**
+	 * _setup_data
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _setup_data()
+	{
+
+		$this->reg_info = array();
+
+		$this->txn = $this->_data['txn_obj'];
+		$this->payment = $this->_data['pmt_obj'];
+		$this->filtered_reg_status = $this->_data['filtered_reg_status'];
+		$this->incoming_data = $this->_data;
+
+		$session_data = $this->txn->session_data();
+
+
+		// other data from the session (if possible)
+		$this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
+		$this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
+		$this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
+		$this->init_access = $this->last_access = '';
+		// get all non-trashed registrations
+		$this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));
+		$this->_assemble_data();
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
     {
 
         // test for valid params
-        if (! ( $data[0] instanceof EE_Transaction )) {
+        if ( ! ($data[0] instanceof EE_Transaction)) {
             throw new EE_Error(__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
         }
 
@@ -40,7 +40,7 @@ 
             $pmt_obj = $this->_get_empty_payment_obj($data[0]);
         }
 
-        if (! empty($data[2])) {
+        if ( ! empty($data[2])) {
             $filtered_reg_status = $data[2];
         }
 
@@ -75,7 +75,7 @@ 
             $prepped_data['Payment'] = $data[1]->ID();
         }
 
-        if (! empty($data[2])) {
+        if ( ! empty($data[2])) {
             $prepped_data['filter'] = $data[2];
         }
 

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

Indentation +168 added lines, -168 removed lines

@@ -17,172 +17,172 @@
 {
 
 
-    /**
-     * Constructor.
-     *
-     * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
-     * @throws EE_Error
-     * @access protected
-     */
-    public function __construct($data = array())
-    {
-
-        // validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
-            throw new EE_Error(
-                esc_html__(
-                    'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
-                    'event_espresso'
-                )
-            );
-        }
-        parent::__construct($data);
-    }
-
-
-    /**
-     * setup the data.
-     * Sets up the expected data object for the messages prep using incoming registration objects.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @access protected
-     */
-    protected function _setup_data()
-    {
-        // we'll loop through each contact and setup the data needed.  Note that many properties will just be set as
-        // empty because this data handler is for a very specific set of data (i.e. just what's related to the
-        // registration).
-
-        $this->reg_objs = $this->data();
-        $this->txn      = $this->_maybe_get_transaction();
-        $this->_assemble_data();
-    }
-
-
-    /**
-     * If the incoming registrations all share the same transaction then this will return the transaction object shared
-     * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
-     * one transaction.
-     *
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _maybe_get_transaction()
-    {
-        $transactions = array();
-        foreach ($this->reg_objs as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $transaction = $registration->transaction();
-                if ($transaction instanceof EE_Transaction) {
-                    $transactions[ $transaction->ID() ] = $transaction;
-                }
-            }
-        }
-        return count($transactions) === 1 ? reset($transactions) : null;
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $registrations The incoming data to be prepped.
-     * @return EE_Registration[] The data being prepared for the db
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function convert_data_for_persistent_storage($registrations)
-    {
-        if (! self::validateRegistrationsForConversion($registrations)) {
-            return array();
-        }
-
-        // is this an array of ints?
-        $first_item = reset($registrations);
-        if (is_int($first_item)) {
-            return $registrations;
-        }
-
-        // k nope so let's pull from the registrations
-        $registration_ids = array_filter(
-            array_map(
-                function ($registration) {
-                    if ($registration instanceof EE_Registration) {
-                        return $registration->ID();
-                    }
-                    return false;
-                },
-                $registrations
-            )
-        );
-
-        return $registration_ids;
-    }
-
-
-    /**
-     * This validates incoming registrations (considers whether they are ids or EE_Registration objects.
-     *
-     * @param array $registrations Could be EE_Registration[] or int[]
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function validateRegistrationsForConversion($registrations)
-    {
-        if (is_array($registrations)) {
-            $first_item = reset($registrations);
-            if ($first_item instanceof EE_Registration) {
-                return true;
-            }
-            if (is_int($first_item)) {
-                // k let's some basic validation here.  This isn't foolproof but better than nothing.
-                // the purpose of this validation is to verify that the ids sent in match valid registrations existing
-                // in the db.  If the count is different, then we know they aren't valid.
-                $count_for_ids = EEM_Registration::instance()->count(
-                    array(
-                        array(
-                            'REG_ID' => array('IN', $registrations)
-                        )
-                    )
-                );
-                return $count_for_ids === count($registrations);
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        // since this was added later, we need to account of possible back compat issues where data already queued for
-        // generation is in the old format, which is an array of EE_Registration objects.  So if that's the case, then
-        // let's just return them
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10127
-        if (is_array($data) && reset($data) instanceof EE_Registration) {
-            return $data;
-        }
-
-        $registrations = is_array($data)
-            ? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
-            : array();
-        return $registrations;
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	public function __construct($data = array())
+	{
+
+		// validate that the first element in the array is an EE_Registration object.
+		if (! reset($data) instanceof EE_Registration) {
+			throw new EE_Error(
+				esc_html__(
+					'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
+					'event_espresso'
+				)
+			);
+		}
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * setup the data.
+	 * Sets up the expected data object for the messages prep using incoming registration objects.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @access protected
+	 */
+	protected function _setup_data()
+	{
+		// we'll loop through each contact and setup the data needed.  Note that many properties will just be set as
+		// empty because this data handler is for a very specific set of data (i.e. just what's related to the
+		// registration).
+
+		$this->reg_objs = $this->data();
+		$this->txn      = $this->_maybe_get_transaction();
+		$this->_assemble_data();
+	}
+
+
+	/**
+	 * If the incoming registrations all share the same transaction then this will return the transaction object shared
+	 * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
+	 * one transaction.
+	 *
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _maybe_get_transaction()
+	{
+		$transactions = array();
+		foreach ($this->reg_objs as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$transaction = $registration->transaction();
+				if ($transaction instanceof EE_Transaction) {
+					$transactions[ $transaction->ID() ] = $transaction;
+				}
+			}
+		}
+		return count($transactions) === 1 ? reset($transactions) : null;
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $registrations The incoming data to be prepped.
+	 * @return EE_Registration[] The data being prepared for the db
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function convert_data_for_persistent_storage($registrations)
+	{
+		if (! self::validateRegistrationsForConversion($registrations)) {
+			return array();
+		}
+
+		// is this an array of ints?
+		$first_item = reset($registrations);
+		if (is_int($first_item)) {
+			return $registrations;
+		}
+
+		// k nope so let's pull from the registrations
+		$registration_ids = array_filter(
+			array_map(
+				function ($registration) {
+					if ($registration instanceof EE_Registration) {
+						return $registration->ID();
+					}
+					return false;
+				},
+				$registrations
+			)
+		);
+
+		return $registration_ids;
+	}
+
+
+	/**
+	 * This validates incoming registrations (considers whether they are ids or EE_Registration objects.
+	 *
+	 * @param array $registrations Could be EE_Registration[] or int[]
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function validateRegistrationsForConversion($registrations)
+	{
+		if (is_array($registrations)) {
+			$first_item = reset($registrations);
+			if ($first_item instanceof EE_Registration) {
+				return true;
+			}
+			if (is_int($first_item)) {
+				// k let's some basic validation here.  This isn't foolproof but better than nothing.
+				// the purpose of this validation is to verify that the ids sent in match valid registrations existing
+				// in the db.  If the count is different, then we know they aren't valid.
+				$count_for_ids = EEM_Registration::instance()->count(
+					array(
+						array(
+							'REG_ID' => array('IN', $registrations)
+						)
+					)
+				);
+				return $count_for_ids === count($registrations);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		// since this was added later, we need to account of possible back compat issues where data already queued for
+		// generation is in the old format, which is an array of EE_Registration objects.  So if that's the case, then
+		// let's just return them
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10127
+		if (is_array($data) && reset($data) instanceof EE_Registration) {
+			return $data;
+		}
+
+		$registrations = is_array($data)
+			? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
+			: array();
+		return $registrations;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
     {
 
         // validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
+        if ( ! reset($data) instanceof EE_Registration) {
             throw new EE_Error(
                 esc_html__(
                     'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
@@ -77,7 +77,7 @@ 
             if ($registration instanceof EE_Registration) {
                 $transaction = $registration->transaction();
                 if ($transaction instanceof EE_Transaction) {
-                    $transactions[ $transaction->ID() ] = $transaction;
+                    $transactions[$transaction->ID()] = $transaction;
                 }
             }
         }
@@ -97,7 +97,7 @@ 
      */
     public static function convert_data_for_persistent_storage($registrations)
     {
-        if (! self::validateRegistrationsForConversion($registrations)) {
+        if ( ! self::validateRegistrationsForConversion($registrations)) {
             return array();
         }
 
@@ -110,7 +110,7 @@ 
         // k nope so let's pull from the registrations
         $registration_ids = array_filter(
             array_map(
-                function ($registration) {
+                function($registration) {
                     if ($registration instanceof EE_Registration) {
                         return $registration->ID();
                     }

core/libraries/messages/validators/email/EE_Messages_Email_Payment_Refund_Validator.class.php

Indentation +33 added lines, -33 removed lines

@@ -15,37 +15,37 @@
 {
 
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'payment_refund';
-
-        parent::__construct($fields, $context);
-    }
-
-    /**
-     * at this point no custom validation needed for this messenger/message_type combo.
-     */
-    protected function _modify_validator()
-    {
-        $new_config = $this->_messenger->get_validator_config();
-
-        // modify just event_list
-        $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
-            );
-        $new_config['ticket_list'] = array(
-            'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
-            );
-        $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
-            );
-        $this->_messenger->set_validator_config($new_config);
-
-        if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
-        }
-
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
-    }
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'payment_refund';
+
+		parent::__construct($fields, $context);
+	}
+
+	/**
+	 * at this point no custom validation needed for this messenger/message_type combo.
+	 */
+	protected function _modify_validator()
+	{
+		$new_config = $this->_messenger->get_validator_config();
+
+		// modify just event_list
+		$new_config['event_list'] = array(
+			'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+			);
+		$new_config['ticket_list'] = array(
+			'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
+			);
+		$new_config['content'] = array(
+			'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+			);
+		$this->_messenger->set_validator_config($new_config);
+
+		if ($this->_context != 'admin') {
+			$this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+		}
+
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -32,18 +32,18 @@
 
         // modify just event_list
         $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
             );
         $new_config['ticket_list'] = array(
             'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
             );
         $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+            'shortcodes' => array('event_list', 'attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
             );
         $this->_messenger->set_validator_config($new_config);
 
         if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+            $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
         }
 
         $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');