eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Type_Collection.lib.php

Indentation +164 added lines, -164 removed lines

@@ -14,168 +14,168 @@
 class EE_Message_Type_Collection extends EE_Object_Collection
 {
 
-    /**
-     * EE_Message_Type_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_message_type';
-    }
-
-
-
-    /**
-     * add
-     *
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::add($object, $info);
-    }
-
-
-
-    /**
-     * set_info
-     *
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::set_info($object, $info);
-    }
-
-
-
-    /**
-     * get_by_info
-     *
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info)
-    {
-        return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
-    }
-
-
-
-    /**
-     * has
-     *
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param object $object
-     * @return bool
-     */
-    public function has($object)
-    {
-        return parent::has($object);
-    }
-
-
-
-    /**
-     * has_by_name
-     *
-     * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
-     *
-     * @access public
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function has_by_name($message_type_name)
-    {
-        return $this->get_by_info($message_type_name) instanceof $this->interface ? true : false;
-    }
-
-
-
-    /**
-     * remove
-     *
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        return parent::remove($object);
-    }
-
-
-
-    /**
-     * set_current
-     *
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        parent::set_current($object);
-    }
-
-
-
-    /**
-     * set_current_by_info
-     *
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @access public
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        parent::set_current_by_info($info);
-    }
-
-
-
-    /**
-     * show_collection_classes
-     *
-     * displays list of collection classes if WP_DEBUG is on
-     *
-     * @access public
-     * @return void
-     */
-    public function show_collection_classes()
-    {
-        if (WP_DEBUG) {
-            $this->rewind();
-            while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
-                $this->next();
-            }
-        }
-    }
+	/**
+	 * EE_Message_Type_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_message_type';
+	}
+
+
+
+	/**
+	 * add
+	 *
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::add($object, $info);
+	}
+
+
+
+	/**
+	 * set_info
+	 *
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::set_info($object, $info);
+	}
+
+
+
+	/**
+	 * get_by_info
+	 *
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info)
+	{
+		return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
+	}
+
+
+
+	/**
+	 * has
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object)
+	{
+		return parent::has($object);
+	}
+
+
+
+	/**
+	 * has_by_name
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
+	 *
+	 * @access public
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function has_by_name($message_type_name)
+	{
+		return $this->get_by_info($message_type_name) instanceof $this->interface ? true : false;
+	}
+
+
+
+	/**
+	 * remove
+	 *
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		return parent::remove($object);
+	}
+
+
+
+	/**
+	 * set_current
+	 *
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		parent::set_current($object);
+	}
+
+
+
+	/**
+	 * set_current_by_info
+	 *
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @access public
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		parent::set_current_by_info($info);
+	}
+
+
+
+	/**
+	 * show_collection_classes
+	 *
+	 * displays list of collection classes if WP_DEBUG is on
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function show_collection_classes()
+	{
+		if (WP_DEBUG) {
+			$this->rewind();
+			while ($this->valid()) {
+				echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+				$this->next();
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
         if (WP_DEBUG) {
             $this->rewind();
             while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+                echo '<h5 style="color:#2EA2CC;">'.__CLASS__.' class : <span style="color:#E76700">'.$this->getInfo().'</span></h5>';
                 $this->next();
             }
         }

core/libraries/messages/defaults/EE_Messages_Template_Pack_Default.class.php

Indentation +63 added lines, -63 removed lines

@@ -11,71 +11,71 @@
 class EE_Messages_Template_Pack_Default extends EE_Messages_Template_Pack
 {
 
-    public function _set_props()
-    {
-        $this->label = __('Default', 'event_espresso');
-        $this->dbref = 'default';
-        $this->description = __('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
-        $this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
-        $this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
-        $this->_supports = array(
-            'email' => array(
-                'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
-                    'registration_summary',
-                'payment_declined', 'payment', 'payment_refund', 'payment_reminder'
-                ),
-            'html' => array(
-                'receipt', 'invoice'
-                )
-            );
-        $this->_default_variation_labels= array(
-            'email' => __('Default', 'event_espresso'),
-            'html' =>  __('Simple', 'event_espresso')
-             );
-        $this->_variations = array(
-            'html' => array(
-                'receipt' =>
-                    array(
-                    'bauhaus' => __('Bauhaus', 'event_espresso'),
-                    'ejs' => __('Elliot Jay Stocks', 'event_espresso'),
-                    'horizon' => __('Horizon', 'event_espresso'),
-                    'lola' => __('Lola', 'event_espresso'),
-                    'tranquility' => __('Tranquility', 'event_espresso'),
-                    'union' => __('Union', 'event_espresso'),
-                    ),
-                'invoice' =>
-                    array(
-                    'bauhaus' => __('Bauhaus', 'event_espresso'),
-                    'ejs' => __('Elliot Jay Stocks', 'event_espresso'),
-                    'horizon' => __('Horizon', 'event_espresso'),
-                    'lola' => __('Lola', 'event_espresso'),
-                    'tranquility' => __('Tranquility', 'event_espresso'),
-                    'union' => __('Union', 'event_espresso'),
-                    )
-                )
-            );
-    }
+	public function _set_props()
+	{
+		$this->label = __('Default', 'event_espresso');
+		$this->dbref = 'default';
+		$this->description = __('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
+		$this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
+		$this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
+		$this->_supports = array(
+			'email' => array(
+				'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
+					'registration_summary',
+				'payment_declined', 'payment', 'payment_refund', 'payment_reminder'
+				),
+			'html' => array(
+				'receipt', 'invoice'
+				)
+			);
+		$this->_default_variation_labels= array(
+			'email' => __('Default', 'event_espresso'),
+			'html' =>  __('Simple', 'event_espresso')
+			 );
+		$this->_variations = array(
+			'html' => array(
+				'receipt' =>
+					array(
+					'bauhaus' => __('Bauhaus', 'event_espresso'),
+					'ejs' => __('Elliot Jay Stocks', 'event_espresso'),
+					'horizon' => __('Horizon', 'event_espresso'),
+					'lola' => __('Lola', 'event_espresso'),
+					'tranquility' => __('Tranquility', 'event_espresso'),
+					'union' => __('Union', 'event_espresso'),
+					),
+				'invoice' =>
+					array(
+					'bauhaus' => __('Bauhaus', 'event_espresso'),
+					'ejs' => __('Elliot Jay Stocks', 'event_espresso'),
+					'horizon' => __('Horizon', 'event_espresso'),
+					'lola' => __('Lola', 'event_espresso'),
+					'tranquility' => __('Tranquility', 'event_espresso'),
+					'union' => __('Union', 'event_espresso'),
+					)
+				)
+			);
+	}
 
 
 
-    public function get_default_variation($messenger, $message_type, $type, $url, $file_extension)
-    {
-        $base = $url ? $this->_base_url : $this->_base_path;
-        $base_path = $this->_base_path;
-        // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
-        // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
-        // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
-        } else {
-            // no matches found so nothing is present.
-            $variation_path = '';
-        }
+	public function get_default_variation($messenger, $message_type, $type, $url, $file_extension)
+	{
+		$base = $url ? $this->_base_url : $this->_base_path;
+		$base_path = $this->_base_path;
+		// possible variation paths considering whether message type is present or not in the file name.
+		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
+		$default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
+		// first see if fully validated file exists.
+		if (is_readable($base_path . $path_string)) {
+			$variation_path = $base . $path_string;
+		// otherwise see if default exists.
+		} elseif (is_readable($base_path . $default_path_string)) {
+			$variation_path = $base . $default_path_string;
+		} else {
+			// no matches found so nothing is present.
+			$variation_path = '';
+		}
 
-        return $variation_path;
-    }
+		return $variation_path;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -16,8 +16,8 @@ 
         $this->label = __('Default', 'event_espresso');
         $this->dbref = 'default';
         $this->description = __('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
-        $this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
-        $this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
+        $this->_base_url = EE_PLUGIN_DIR_URL.'core/libraries/messages/defaults/default/';
+        $this->_base_path = EE_LIBRARIES.'messages/defaults/default/';
         $this->_supports = array(
             'email' => array(
                 'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
@@ -28,7 +28,7 @@ 
                 'receipt', 'invoice'
                 )
             );
-        $this->_default_variation_labels= array(
+        $this->_default_variation_labels = array(
             'email' => __('Default', 'event_espresso'),
             'html' =>  __('Simple', 'event_espresso')
              );
@@ -63,14 +63,14 @@ 
         $base = $url ? $this->_base_url : $this->_base_path;
         $base_path = $this->_base_path;
         // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
+        $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_default'.$file_extension;
+        $default_path_string = 'variations/'.$messenger.'_'.$type.'_default'.$file_extension;
         // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
+        if (is_readable($base_path.$path_string)) {
+            $variation_path = $base.$path_string;
         // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
+        } elseif (is_readable($base_path.$default_path_string)) {
+            $variation_path = $base.$default_path_string;
         } else {
             // no matches found so nothing is present.
             $variation_path = '';

core/libraries/messages/defaults/default/html_receipt_ticket_line_item_no_pms.template.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 <tr class="item">
     <td>[LINE_ITEM_NAME][LINE_ITEM_TAXABLE_*]</td>
     <td colspan="2">[LINE_ITEM_DESCRIPTION]
-        <p class="ticket-note"><?php echo sprintf(__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema=' . __('any', 'event_espresso') . ']'); ?></p>
+        <p class="ticket-note"><?php echo sprintf(__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema='.__('any', 'event_espresso').']'); ?></p>
     </td>
     <td class="item_c">[LINE_ITEM_QUANTITY]</td>
     <td class="item_c">[LINE_ITEM_AMOUNT]</td>

core/libraries/messages/defaults/default/html_receipt_event_list.template.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
  */
 ?>
 <h3 class="section-title event-name">
-    <img class="icon" src="<?php echo EE_IMAGES_URL . 'calendar_year-24x24.png'; ?>"><?php _e("Event Name:", "event_espresso") ?>
+    <img class="icon" src="<?php echo EE_IMAGES_URL.'calendar_year-24x24.png'; ?>"><?php _e("Event Name:", "event_espresso") ?>
     <span class="plain-text">[EVENT_NAME]</span>
     <span class="small-text link">( <a href="[EVENT_URL]"><?php _e('view', 'event_espresso'); ?></a> )</span>
 </h3>

core/libraries/messages/defaults/default/html_receipt_ticket_list.template.php

Spacing +3 added lines, -3 removed lines

@@ -22,13 +22,13 @@ 
         <div class="ticket-time-and-place-details">
             <div class="ticket-time-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo EE_IMAGES_URL . 'clock-16x16.png'; ?>"><?php _e('Date/Time:', 'event_espresso'); ?>
+                    <img class="icon" src="<?php echo EE_IMAGES_URL.'clock-16x16.png'; ?>"><?php _e('Date/Time:', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-dates">[DATETIME_LIST]</ul>
             </div>
             <div class="ticket-place-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo EE_IMAGES_URL . 'location-pin-16x16.png'; ?>"><?php _e('Venue', 'event_espresso'); ?>
+                    <img class="icon" src="<?php echo EE_IMAGES_URL.'location-pin-16x16.png'; ?>"><?php _e('Venue', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-venues">
                     <li>[VENUE_TITLE]
@@ -39,7 +39,7 @@ 
         </div>
         <div class="ticket-registrations-area">
             <h4 class="sub-section-title">
-                <img class="icon" src="<?php echo EE_IMAGES_URL . 'users-16x16.png'; ?>"><?php _e("Registration Details", "event_espresso"); ?>
+                <img class="icon" src="<?php echo EE_IMAGES_URL.'users-16x16.png'; ?>"><?php _e("Registration Details", "event_espresso"); ?>
                 <span class="small-text link">( <a class="print_button noPrint" href="[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]"><?php _e('edit', 'event_espresso'); ?></a> )</span>
             </h4>
             <ul class="ticket-registrations-list">[ATTENDEE_LIST]</ul>

core/libraries/messages/defaults/default/html_receipt_attendee_list.template.php

Spacing +2 added lines, -2 removed lines

@@ -6,11 +6,11 @@
 <li class="ticket-registration">
     <table class="registration-details">
         <tr class="odd">
-            <th><?php	_e('Attendee', 'event_espresso');?></th>
+            <th><?php	_e('Attendee', 'event_espresso'); ?></th>
             <td>[FNAME] [LNAME] ([ATTENDEE_EMAIL])</td>
         </tr>
         <tr>
-            <th><?php _e("Registration Code:", "event_espresso");?></th>
+            <th><?php _e("Registration Code:", "event_espresso"); ?></th>
             <td>[REGISTRATION_CODE] - <span class="[REGISTRATION_STATUS_ID]">[REGISTRATION_STATUS_LABEL]</span></td>
         </tr>
     </table>

core/libraries/messages/defaults/EE_Messages_Template_Defaults.lib.php

Indentation +228 added lines, -228 removed lines

@@ -15,232 +15,232 @@
 {
 
 
-    /**
-     * Used for holding the EE_Message_Template GRP_ID field value.
-     * @var [type]
-     */
-    protected $_GRP_ID;
-
-    /**
-     * holds the messenger object
-     *
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-    /**
-     * holds the message type object
-     *
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-    /**
-     * holds the fields used (this is retrieved from the messenger)
-     *
-     * @var array
-     */
-    protected $_fields;
-
-    /**
-     * holds the assembled template (with defaults) for creation in the database
-     *
-     * @var array
-     */
-    protected $_templates;
-
-    /**
-     * holds the contexts used (this is retrieved from the message type)
-     *
-     * @var array
-     */
-    protected $_contexts;
-
-
-    /**
-     *  @var EEM_Message_Template_Group
-     */
-    protected $_message_template_group_model;
-
-
-    /**
-     * @var EEM_Message_Template
-     */
-    protected $_message_template_model;
-
-
-    /**
-     * EE_Messages_Template_Defaults constructor.
-     *
-     * @param EE_messenger               $messenger
-     * @param EE_message_type            $message_type
-     * @param int                        $GRP_ID                      Optional.  If included then we're just regenerating
-     *                                                                the template fields for the given group not the
-     *                                                                message template group itself
-     * @param EEM_Message_Template_Group $message_template_group_model
-     * @param EEM_Message_Template       $message_template_model
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $GRP_ID = 0,
-        EEM_Message_Template_Group $message_template_group_model,
-        EEM_Message_Template $message_template_model
-    ) {
-        $this->_messenger = $messenger;
-        $this->_message_type = $message_type;
-        $this->_GRP_ID = $GRP_ID;
-        // set the model object
-        $this->_message_template_group_model = $message_template_group_model;
-        $this->_message_template_model = $message_template_model;
-        $this->_fields = $this->_messenger->get_template_fields();
-        $this->_contexts = $this->_message_type->get_contexts();
-    }
-
-
-    /**
-     * Setup the _template_data property.
-     * This method sets the _templates property array before templates are created.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference which will contain information
-     *                              about where to obtain the templates.
-     *
-     */
-    final private function _set_templates($template_pack)
-    {
-
-        // get the corresponding template pack object (if present.  If not then we just load the default and add a
-        // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
-        // the incoming template pack reference.
-        $class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
-
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
-                        'event_espresso'
-                    ),
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = 'EE_Messages_Template_Pack_Default';
-        }
-        /** @type EE_Messages_Template_Pack $template_pack */
-        $template_pack = new $class_name;
-
-        // get all the templates from the template pack.
-        $this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
-    }
-
-
-    /**
-     * Return the contexts for the message type as cached on this instance.
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-
-
-
-    /**
-     * public facing create new templates method
-     *
-     * @return mixed (array|bool)            success array or false.
-     */
-    public function create_new_templates()
-    {
-        $template_pack = 'default';
-        // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
-            $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
-            $template_pack = $message_template_group instanceof EE_Message_Template_Group
-                ? $message_template_group->get_template_pack_name()
-                : 'default';
-            // we also need to reset the template variation to default
-            $message_template_group->set_template_pack_variation('default');
-        }
-        return $this->_create_new_templates($template_pack);
-    }
-
-
-
-
-
-    /**
-     *  Handles creating new default templates.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference
-     *                              which will contain information about where to obtain the templates.
-     * @return mixed (array|bool)   success array or false.
-     */
-    protected function _create_new_templates($template_pack)
-    {
-
-        $this->_set_templates($template_pack);
-
-        // necessary properties are set, let's save the default templates
-        if (empty($this->_GRP_ID)) {
-            $main_template_data = array(
-                'MTP_messenger'    => $this->_messenger->name,
-                'MTP_message_type' => $this->_message_type->name,
-                'MTP_is_override'  => 0,
-                'MTP_deleted'      => 0,
-                'MTP_is_global'    => 1,
-                'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
-                'MTP_is_active'    => 1,
-            );
-            // let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
-            $grp_id = $this->_message_template_group_model->insert($main_template_data);
-            if (empty($grp_id)) {
-                return $grp_id;
-            }
-            $this->_GRP_ID = $grp_id;
-        }
-
-        $template_data = array( 'GRP_ID' => $this->_GRP_ID );
-
-        foreach ($this->_contexts as $context => $details) {
-            foreach ($this->_fields as $field => $field_type) {
-                if ($field != 'extra') {
-                    $template_data['MTP_context'] = $context;
-                    $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
-
-                    $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
-                                    'event_espresso'
-                                ),
-                                $this->_messenger->name,
-                                $this->_message_type->name,
-                                $context,
-                                $field
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                }
-            }
-        }
-
-        return array(
-            'GRP_ID'      => $this->_GRP_ID,
-            'MTP_context' => key($this->_contexts)
-        );
-    }
+	/**
+	 * Used for holding the EE_Message_Template GRP_ID field value.
+	 * @var [type]
+	 */
+	protected $_GRP_ID;
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+	/**
+	 * holds the fields used (this is retrieved from the messenger)
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+	/**
+	 * holds the assembled template (with defaults) for creation in the database
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+	/**
+	 * holds the contexts used (this is retrieved from the message type)
+	 *
+	 * @var array
+	 */
+	protected $_contexts;
+
+
+	/**
+	 *  @var EEM_Message_Template_Group
+	 */
+	protected $_message_template_group_model;
+
+
+	/**
+	 * @var EEM_Message_Template
+	 */
+	protected $_message_template_model;
+
+
+	/**
+	 * EE_Messages_Template_Defaults constructor.
+	 *
+	 * @param EE_messenger               $messenger
+	 * @param EE_message_type            $message_type
+	 * @param int                        $GRP_ID                      Optional.  If included then we're just regenerating
+	 *                                                                the template fields for the given group not the
+	 *                                                                message template group itself
+	 * @param EEM_Message_Template_Group $message_template_group_model
+	 * @param EEM_Message_Template       $message_template_model
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$GRP_ID = 0,
+		EEM_Message_Template_Group $message_template_group_model,
+		EEM_Message_Template $message_template_model
+	) {
+		$this->_messenger = $messenger;
+		$this->_message_type = $message_type;
+		$this->_GRP_ID = $GRP_ID;
+		// set the model object
+		$this->_message_template_group_model = $message_template_group_model;
+		$this->_message_template_model = $message_template_model;
+		$this->_fields = $this->_messenger->get_template_fields();
+		$this->_contexts = $this->_message_type->get_contexts();
+	}
+
+
+	/**
+	 * Setup the _template_data property.
+	 * This method sets the _templates property array before templates are created.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference which will contain information
+	 *                              about where to obtain the templates.
+	 *
+	 */
+	final private function _set_templates($template_pack)
+	{
+
+		// get the corresponding template pack object (if present.  If not then we just load the default and add a
+		// notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
+		// the incoming template pack reference.
+		$class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
+						'event_espresso'
+					),
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = 'EE_Messages_Template_Pack_Default';
+		}
+		/** @type EE_Messages_Template_Pack $template_pack */
+		$template_pack = new $class_name;
+
+		// get all the templates from the template pack.
+		$this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
+	}
+
+
+	/**
+	 * Return the contexts for the message type as cached on this instance.
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+
+
+
+	/**
+	 * public facing create new templates method
+	 *
+	 * @return mixed (array|bool)            success array or false.
+	 */
+	public function create_new_templates()
+	{
+		$template_pack = 'default';
+		// if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
+		if (! empty($this->_GRP_ID)) {
+			$message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
+			$template_pack = $message_template_group instanceof EE_Message_Template_Group
+				? $message_template_group->get_template_pack_name()
+				: 'default';
+			// we also need to reset the template variation to default
+			$message_template_group->set_template_pack_variation('default');
+		}
+		return $this->_create_new_templates($template_pack);
+	}
+
+
+
+
+
+	/**
+	 *  Handles creating new default templates.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference
+	 *                              which will contain information about where to obtain the templates.
+	 * @return mixed (array|bool)   success array or false.
+	 */
+	protected function _create_new_templates($template_pack)
+	{
+
+		$this->_set_templates($template_pack);
+
+		// necessary properties are set, let's save the default templates
+		if (empty($this->_GRP_ID)) {
+			$main_template_data = array(
+				'MTP_messenger'    => $this->_messenger->name,
+				'MTP_message_type' => $this->_message_type->name,
+				'MTP_is_override'  => 0,
+				'MTP_deleted'      => 0,
+				'MTP_is_global'    => 1,
+				'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
+				'MTP_is_active'    => 1,
+			);
+			// let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
+			$grp_id = $this->_message_template_group_model->insert($main_template_data);
+			if (empty($grp_id)) {
+				return $grp_id;
+			}
+			$this->_GRP_ID = $grp_id;
+		}
+
+		$template_data = array( 'GRP_ID' => $this->_GRP_ID );
+
+		foreach ($this->_contexts as $context => $details) {
+			foreach ($this->_fields as $field => $field_type) {
+				if ($field != 'extra') {
+					$template_data['MTP_context'] = $context;
+					$template_data['MTP_template_field'] = $field;
+					$template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
+
+					$MTP = $this->_message_template_model->insert($template_data);
+					if (! $MTP) {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
+									'event_espresso'
+								),
+								$this->_messenger->name,
+								$this->_message_type->name,
+								$context,
+								$field
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				}
+			}
+		}
+
+		return array(
+			'GRP_ID'      => $this->_GRP_ID,
+			'MTP_context' => key($this->_contexts)
+		);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -113,9 +113,9 @@ 
         // get the corresponding template pack object (if present.  If not then we just load the default and add a
         // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
         // the incoming template pack reference.
-        $class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+        $class_name = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
 
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -160,7 +160,7 @@ 
     {
         $template_pack = 'default';
         // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
+        if ( ! empty($this->_GRP_ID)) {
             $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
             $template_pack = $message_template_group instanceof EE_Message_Template_Group
                 ? $message_template_group->get_template_pack_name()
@@ -206,17 +206,17 @@ 
             $this->_GRP_ID = $grp_id;
         }
 
-        $template_data = array( 'GRP_ID' => $this->_GRP_ID );
+        $template_data = array('GRP_ID' => $this->_GRP_ID);
 
         foreach ($this->_contexts as $context => $details) {
             foreach ($this->_fields as $field => $field_type) {
                 if ($field != 'extra') {
                     $template_data['MTP_context'] = $context;
                     $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
+                    $template_data['MTP_content'] = $this->_templates[$context][$field];
 
                     $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
+                    if ( ! $MTP) {
                         EE_Error::add_error(
                             sprintf(
                                 __(

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