eventespresso / event-espresso-core

core/db_models/fields/EE_Post_Content_Field.php

Indentation +112 added lines, -112 removed lines

@@ -8,128 +8,128 @@
 class EE_Post_Content_Field extends EE_Text_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        if (! current_user_can('unfiltered_html')) {
-            $value = wp_kses("$value", wp_kses_allowed_html('post'));
-        }
-        return parent::prepare_for_set($value);
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		if (! current_user_can('unfiltered_html')) {
+			$value = wp_kses("$value", wp_kses_allowed_html('post'));
+		}
+		return parent::prepare_for_set($value);
+	}
 
 
 
-    /**
-     * Runs the content through `the_content`, or if prepares the content for placing in a form input
-     * @param string $value_on_field_to_be_outputted
-     * @param string   $schema possible values: 'form_input' or null (if null, will run through 'the_content')
-     * @return string
-     * @throws EE_Error when WP_DEBUG is on and recursive calling is detected
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        switch($schema){
-            case 'form_input':
-                return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-            case 'the_content':
+	/**
+	 * Runs the content through `the_content`, or if prepares the content for placing in a form input
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string   $schema possible values: 'form_input' or null (if null, will run through 'the_content')
+	 * @return string
+	 * @throws EE_Error when WP_DEBUG is on and recursive calling is detected
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		switch($schema){
+			case 'form_input':
+				return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+			case 'the_content':
 
-                if(doing_filter( 'the_content')){
-                    if( defined('WP_DEBUG') && WP_DEBUG){
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__('You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.', 'event_espresso'),
-                                'EE_Post_Content_Field::prepare_for_pretty_echoing',
-                                '$schema',
-                                'the_content',
-                                'the_content_wp_core_only'
-                            )
-                        );
-                    } else {
-                        return $this->prepare_for_pretty_echoing($value_on_field_to_be_outputted, 'the_content_wp_core_only');
-                    }
-                }
-                return apply_filters(
-                    'the_content',
-                    parent::prepare_for_pretty_echoing(
-                        $value_on_field_to_be_outputted,
-                        $schema
-                    )
-                );
-            case 'the_content_wp_core_only':
-            default:
-                self::_setup_the_content_wp_core_only_filters();
-                $return_value = apply_filters(
-                    'the_content_wp_core_only',
-                    parent::prepare_for_pretty_echoing(
-                        $value_on_field_to_be_outputted,
-                        $schema
-                    )
-                );
-                //ya know what? adding these filters is super fast. Let's just
-                //avoid needing to maintain global state and set this up as-needed
-                remove_all_filters('the_content_wp_core_only');
-                do_action( 'AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
-                return $return_value;
-        }
-    }
+				if(doing_filter( 'the_content')){
+					if( defined('WP_DEBUG') && WP_DEBUG){
+						throw new EE_Error(
+							sprintf(
+								esc_html__('You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.', 'event_espresso'),
+								'EE_Post_Content_Field::prepare_for_pretty_echoing',
+								'$schema',
+								'the_content',
+								'the_content_wp_core_only'
+							)
+						);
+					} else {
+						return $this->prepare_for_pretty_echoing($value_on_field_to_be_outputted, 'the_content_wp_core_only');
+					}
+				}
+				return apply_filters(
+					'the_content',
+					parent::prepare_for_pretty_echoing(
+						$value_on_field_to_be_outputted,
+						$schema
+					)
+				);
+			case 'the_content_wp_core_only':
+			default:
+				self::_setup_the_content_wp_core_only_filters();
+				$return_value = apply_filters(
+					'the_content_wp_core_only',
+					parent::prepare_for_pretty_echoing(
+						$value_on_field_to_be_outputted,
+						$schema
+					)
+				);
+				//ya know what? adding these filters is super fast. Let's just
+				//avoid needing to maintain global state and set this up as-needed
+				remove_all_filters('the_content_wp_core_only');
+				do_action( 'AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
+				return $return_value;
+		}
+	}
 
 
 
-    /**
-     * Verifies we've setup the standard WP core filters on  'the_content_wp_core_only' filter
-     */
-    protected static function _setup_the_content_wp_core_only_filters()
-    {
-        add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8);
-        add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8);
-        add_filter('the_content_wp_core_only', 'wptexturize', 10);
-        add_filter('the_content_wp_core_only', 'wpautop', 10);
-        add_filter('the_content_wp_core_only', 'shortcode_unautop', 10);
-        add_filter('the_content_wp_core_only', 'prepend_attachment', 10);
-        if(function_exists('wp_make_content_images_responsive')) {
-            add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10);
-        }
-        add_filter('the_content_wp_core_only', 'do_shortcode', 11);
-        add_filter('the_content_wp_core_only', 'convert_smilies', 20);
-    }
+	/**
+	 * Verifies we've setup the standard WP core filters on  'the_content_wp_core_only' filter
+	 */
+	protected static function _setup_the_content_wp_core_only_filters()
+	{
+		add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8);
+		add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8);
+		add_filter('the_content_wp_core_only', 'wptexturize', 10);
+		add_filter('the_content_wp_core_only', 'wpautop', 10);
+		add_filter('the_content_wp_core_only', 'shortcode_unautop', 10);
+		add_filter('the_content_wp_core_only', 'prepend_attachment', 10);
+		if(function_exists('wp_make_content_images_responsive')) {
+			add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10);
+		}
+		add_filter('the_content_wp_core_only', 'do_shortcode', 11);
+		add_filter('the_content_wp_core_only', 'convert_smilies', 20);
+	}
 
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the content as it exists in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            ),
-            'rendered' => array(
-                'description' =>  sprintf(
-                    __('%s - the content rendered for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the content as it exists in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			),
+			'rendered' => array(
+				'description' =>  sprintf(
+					__('%s - the content rendered for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			)
+		);
+	}
 }
\ No newline at end of file

Spacing +8 added lines, -8 removed lines

@@ -29,7 +29,7 @@ 
      */
     public function prepare_for_set($value)
     {
-        if (! current_user_can('unfiltered_html')) {
+        if ( ! current_user_can('unfiltered_html')) {
             $value = wp_kses("$value", wp_kses_allowed_html('post'));
         }
         return parent::prepare_for_set($value);
@@ -46,13 +46,13 @@ 
      */
     public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
     {
-        switch($schema){
+        switch ($schema) {
             case 'form_input':
                 return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
             case 'the_content':
 
-                if(doing_filter( 'the_content')){
-                    if( defined('WP_DEBUG') && WP_DEBUG){
+                if (doing_filter('the_content')) {
+                    if (defined('WP_DEBUG') && WP_DEBUG) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__('You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.', 'event_espresso'),
@@ -86,7 +86,7 @@ 
                 //ya know what? adding these filters is super fast. Let's just
                 //avoid needing to maintain global state and set this up as-needed
                 remove_all_filters('the_content_wp_core_only');
-                do_action( 'AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
+                do_action('AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
                 return $return_value;
         }
     }
@@ -98,13 +98,13 @@ 
      */
     protected static function _setup_the_content_wp_core_only_filters()
     {
-        add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8);
-        add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8);
+        add_filter('the_content_wp_core_only', array($GLOBALS['wp_embed'], 'run_shortcode'), 8);
+        add_filter('the_content_wp_core_only', array($GLOBALS['wp_embed'], 'autoembed'), 8);
         add_filter('the_content_wp_core_only', 'wptexturize', 10);
         add_filter('the_content_wp_core_only', 'wpautop', 10);
         add_filter('the_content_wp_core_only', 'shortcode_unautop', 10);
         add_filter('the_content_wp_core_only', 'prepend_attachment', 10);
-        if(function_exists('wp_make_content_images_responsive')) {
+        if (function_exists('wp_make_content_images_responsive')) {
             add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10);
         }
         add_filter('the_content_wp_core_only', 'do_shortcode', 11);

core/db_models/fields/EE_Model_Field_Base.php

Indentation +638 added lines, -639 removed lines

@@ -21,643 +21,642 @@
  */
 abstract class EE_Model_Field_Base implements HasSchemaInterface
 {
-    /**
-     * The alias for the table the column belongs to.
-     * @var string
-     */
-    protected $_table_alias;
-
-    /**
-     * The actual db column name for the table
-     * @var string
-     */
-    protected $_table_column;
-
-
-    /**
-     * The authoritative name for the table column (used by client code to reference the field).
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * A description for the field.
-     * @var string
-     */
-    protected $_nicename;
-
-
-    /**
-     * Whether the field is nullable or not
-     * @var bool
-     */
-    protected $_nullable;
-
-
-    /**
-     * What the default value for the field should be.
-     * @var mixed
-     */
-    protected $_default_value;
-
-
-    /**
-     * Other configuration for the field
-     * @var mixed
-     */
-    protected $_other_config;
-
-
-    /**
-     * The name of the model this field is instantiated for.
-     * @var string
-     */
-    protected $_model_name;
-
-
-    /**
-     * This should be a json-schema valid data type for the field.
-     * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-     * @var string
-     */
-    private $_schema_type = 'string';
-
-
-    /**
-     * If the schema has a defined format then it should be defined via this property.
-     * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-     * @var string
-     */
-    private $_schema_format = '';
-
-
-    /**
-     * Indicates that the value of the field is managed exclusively by the server/model and not something
-     * settable by client code.
-     * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
-     * @var bool
-     */
-    private $_schema_readonly = false;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->_table_column  = $table_column;
-        $this->_nicename      = $nicename;
-        $this->_nullable      = $nullable;
-        $this->_default_value = $default_value;
-    }
-
-
-    /**
-     * @param $table_alias
-     * @param $name
-     * @param $model_name
-     */
-    public function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_table_alias = $table_alias;
-        $this->_name        = $name;
-        $this->_model_name  = $model_name;
-        /**
-         * allow for changing the defaults
-         */
-        $this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
-            $this->_nicename, $this);
-        $this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
-            $this->_default_value, $this);
-    }
-
-    public function get_table_alias()
-    {
-        return $this->_table_alias;
-    }
-
-    public function get_table_column()
-    {
-        return $this->_table_column;
-    }
-
-    /**
-     * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
-     *
-     * @return string
-     */
-    public function get_model_name()
-    {
-        return $this->_model_name;
-    }
-
-    /**
-     * @throws \EE_Error
-     * @return string
-     */
-    public function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        } else {
-            throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                "event_espresso"), get_class($this)));
-        }
-    }
-
-    public function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-    public function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    public function is_auto_increment()
-    {
-        return false;
-    }
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    public function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        return $this->get_nicename();
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        if ($this->is_nullable()) {
-            $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
-                $this->_schema_type[] = 'null';
-            };
-        }
-        return $this->_schema_type;
-    }
-
-
-    /**
-     * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
-     * for this property.
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaType($type)
-    {
-        $this->validateSchemaType($type);
-        $this->_schema_type = $type;
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     *
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * By default this returns the scalar default value that was sent in on the class prepped according to the class type
-     * as the default.  However, when there are schema properties, then the default property is setup to mirror the
-     * property keys and correctly prepare the default according to that expected property value.
-     * The getSchema method validates whether the schema for default is setup correctly or not according to the schema type
-     *
-     * @return mixed
-     */
-    public function getSchemaDefault()
-    {
-        $default_value = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
-        $schema_properties = $this->getSchemaProperties();
-
-        //if this schema has properties than shape the default value to match the properties shape.
-        if ($schema_properties) {
-            $value_to_return = array();
-            foreach ($schema_properties as $property_key => $property_schema) {
-                switch ($property_key) {
-                    case 'pretty':
-                    case 'rendered':
-                        $value_to_return[$property_key] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
-                        break;
-                    default:
-                        $value_to_return[$property_key] = $default_value;
-                        break;
-                }
-            }
-            $default_value = $value_to_return;
-        }
-        return $default_value;
-    }
-
-
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return $this->_schema_format;
-    }
-
-
-    /**
-     * Sets the schema format property.
-     * @throws InvalidArgumentException
-     * @param string $format
-     */
-    protected function setSchemaFormat($format)
-    {
-        $this->validateSchemaFormat($format);
-        $this->_schema_format = $format;
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return $this->_schema_readonly;
-    }
-
-
-    /**
-     * This sets the value for the $_schema_readonly property.
-     * @param bool $readonly  (only explicit boolean values are accepted)
-     */
-    protected function setSchemaReadOnly($readonly)
-    {
-        if (! is_bool($readonly)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
-                    print_r($readonly, true)
-                )
-            );
-        }
-
-        $this->_schema_readonly = $readonly;
-    }
-
-
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field.
-     * @uses _get_wpdb_data_type()
-     *
-     * @return string
-     */
-    public function get_wpdb_data_type()
-    {
-        return $this->_get_wpdb_data_type();
-    }
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
-     * @param string $type  Included if a specific type is requested.
-     * @uses get_schema_type()
-     * @return string
-     */
-    protected function _get_wpdb_data_type($type='')
-    {
-        $type = empty($type) ? $this->getSchemaType() : $type;
-
-        //if type is an array, then different parsing is required.
-        if (is_array($type)) {
-            return $this->_get_wpdb_data_type_for_type_array($type);
-        }
-
-        $wpdb_type = '%s';
-        switch ($type) {
-            case 'number':
-                $wpdb_type = '%f';
-                break;
-            case 'integer':
-            case 'boolean':
-                $wpdb_type = '%d';
-                break;
-            case 'object':
-                $properties = $this->getSchemaProperties();
-                if (isset($properties['raw'], $properties['raw']['type'])) {
-                    $wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
-                }
-                break; //leave at default
-        }
-        return $wpdb_type;
-    }
-
-
-
-    protected function _get_wpdb_data_type_for_type_array($type)
-    {
-        $type = (array) $type;
-        //first let's flip because then we can do a faster key check
-        $type = array_flip($type);
-
-        //check for things that mean '%s'
-        if (isset($type['string'],$type['object'],$type['array'])) {
-            return '%s';
-        }
-
-        //if makes it past the above condition and there's float in the array
-        //then the type is %f
-        if (isset($type['number'])) {
-            return '%f';
-        }
-
-        //if it makes it above the above conditions and there is an integer in the array
-        //then the type is %d
-        if (isset($type['integer'])) {
-            return '%d';
-        }
-
-        //anything else is a string
-        return '%s';
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'readonly' => $this->getSchemaReadonly(),
-            'default' => $this->getSchemaDefault()
-        );
-
-        //optional properties of the schema
-        $enum = $this->getSchemaEnum();
-        $properties = $this->getSchemaProperties();
-        $format = $this->getSchemaFormat();
-        if ($enum) {
-            $schema['enum'] = $enum;
-        }
-
-        if ($properties) {
-            $schema['properties'] = $properties;
-        }
-
-        if ($format) {
-            $schema['format'] = $format;
-        }
-        return $schema;
-    }
-
-    /**
-     * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
-     * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
-     * want to see their value, then they shouldn't be db-only fields!)
-     * Eg, when doing events as custom post types, querying the post_type is essential, but
-     * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
-     * By default, all fields aren't db-only.
-     *
-     * @return boolean
-     */
-    public function is_db_only_field()
-    {
-        return false;
-    }
-
-
-    /**
-     * Validates the incoming string|array to ensure its an allowable type.
-     * @throws InvalidArgumentException
-     * @param string|array $type
-     */
-    private function validateSchemaType($type)
-    {
-        if (! (is_string($type) || is_array($type))) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
-                    print_r($type, true)
-                )
-            );
-        }
-
-        //validate allowable types.
-        //@link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-        $allowable_types = array_flip(
-            array(
-                'string',
-                'number',
-                'null',
-                'object',
-                'array',
-                'boolean',
-                'integer'
-            )
-        );
-
-        if (is_array($type)) {
-            foreach ($type as $item_in_type) {
-                $this->validateSchemaType($item_in_type);
-            }
-            return;
-        }
-
-        if (! isset($allowable_types[$type])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
-                    $type,
-                    implode(',', array_flip($allowable_types))
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Validates that the incoming format is an allowable string to use for the _schema_format property
-     * @throws InvalidArgumentException
-     * @param $format
-     */
-    private function validateSchemaFormat($format)
-    {
-        if (! is_string($format)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
-                    print_r($format, true)
-                )
-            );
-        }
-
-        //validate allowable format values
-        //@link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-        $allowable_formats = array_flip(
-            array(
-                'date-time',
-                'email',
-                'hostname',
-                'ipv4',
-                'ipv6',
-                'uri',
-                'uriref'
-            )
-        );
-
-        if (! isset($allowable_formats[$format])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
-                    $format,
-                    implode(',', array_flip($allowable_formats))
-                )
-            );
-        }
-    }
+	/**
+	 * The alias for the table the column belongs to.
+	 * @var string
+	 */
+	protected $_table_alias;
+
+	/**
+	 * The actual db column name for the table
+	 * @var string
+	 */
+	protected $_table_column;
+
+
+	/**
+	 * The authoritative name for the table column (used by client code to reference the field).
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * A description for the field.
+	 * @var string
+	 */
+	protected $_nicename;
+
+
+	/**
+	 * Whether the field is nullable or not
+	 * @var bool
+	 */
+	protected $_nullable;
+
+
+	/**
+	 * What the default value for the field should be.
+	 * @var mixed
+	 */
+	protected $_default_value;
+
+
+	/**
+	 * Other configuration for the field
+	 * @var mixed
+	 */
+	protected $_other_config;
+
+
+	/**
+	 * The name of the model this field is instantiated for.
+	 * @var string
+	 */
+	protected $_model_name;
+
+
+	/**
+	 * This should be a json-schema valid data type for the field.
+	 * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+	 * @var string
+	 */
+	private $_schema_type = 'string';
+
+
+	/**
+	 * If the schema has a defined format then it should be defined via this property.
+	 * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+	 * @var string
+	 */
+	private $_schema_format = '';
+
+
+	/**
+	 * Indicates that the value of the field is managed exclusively by the server/model and not something
+	 * settable by client code.
+	 * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
+	 * @var bool
+	 */
+	private $_schema_readonly = false;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->_table_column  = $table_column;
+		$this->_nicename      = $nicename;
+		$this->_nullable      = $nullable;
+		$this->_default_value = $default_value;
+	}
+
+
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 * @param $model_name
+	 */
+	public function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_table_alias = $table_alias;
+		$this->_name        = $name;
+		$this->_model_name  = $model_name;
+		/**
+		 * allow for changing the defaults
+		 */
+		$this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
+			$this->_nicename, $this);
+		$this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
+			$this->_default_value, $this);
+	}
+
+	public function get_table_alias()
+	{
+		return $this->_table_alias;
+	}
+
+	public function get_table_column()
+	{
+		return $this->_table_column;
+	}
+
+	/**
+	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
+	 *
+	 * @return string
+	 */
+	public function get_model_name()
+	{
+		return $this->_model_name;
+	}
+
+	/**
+	 * @throws \EE_Error
+	 * @return string
+	 */
+	public function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		} else {
+			throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+				"event_espresso"), get_class($this)));
+		}
+	}
+
+	public function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+	public function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	public function is_auto_increment()
+	{
+		return false;
+	}
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	public function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		return $this->get_nicename();
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		if ($this->is_nullable()) {
+			$this->_schema_type = (array) $this->_schema_type;
+			if (! in_array('null', $this->_schema_type)) {
+				$this->_schema_type[] = 'null';
+			};
+		}
+		return $this->_schema_type;
+	}
+
+
+	/**
+	 * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
+	 * for this property.
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaType($type)
+	{
+		$this->validateSchemaType($type);
+		$this->_schema_type = $type;
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 *
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * By default this returns the scalar default value that was sent in on the class prepped according to the class type
+	 * as the default.  However, when there are schema properties, then the default property is setup to mirror the
+	 * property keys and correctly prepare the default according to that expected property value.
+	 * The getSchema method validates whether the schema for default is setup correctly or not according to the schema type
+	 *
+	 * @return mixed
+	 */
+	public function getSchemaDefault()
+	{
+		$default_value = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
+		$schema_properties = $this->getSchemaProperties();
+
+		//if this schema has properties than shape the default value to match the properties shape.
+		if ($schema_properties) {
+			$value_to_return = array();
+			foreach ($schema_properties as $property_key => $property_schema) {
+				switch ($property_key) {
+					case 'pretty':
+					case 'rendered':
+						$value_to_return[$property_key] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
+						break;
+					default:
+						$value_to_return[$property_key] = $default_value;
+						break;
+				}
+			}
+			$default_value = $value_to_return;
+		}
+		return $default_value;
+	}
+
+
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return $this->_schema_format;
+	}
+
+
+	/**
+	 * Sets the schema format property.
+	 * @throws InvalidArgumentException
+	 * @param string $format
+	 */
+	protected function setSchemaFormat($format)
+	{
+		$this->validateSchemaFormat($format);
+		$this->_schema_format = $format;
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return $this->_schema_readonly;
+	}
+
+
+	/**
+	 * This sets the value for the $_schema_readonly property.
+	 * @param bool $readonly  (only explicit boolean values are accepted)
+	 */
+	protected function setSchemaReadOnly($readonly)
+	{
+		if (! is_bool($readonly)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
+					print_r($readonly, true)
+				)
+			);
+		}
+
+		$this->_schema_readonly = $readonly;
+	}
+
+
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field.
+	 * @uses _get_wpdb_data_type()
+	 *
+	 * @return string
+	 */
+	public function get_wpdb_data_type()
+	{
+		return $this->_get_wpdb_data_type();
+	}
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
+	 * @param string $type  Included if a specific type is requested.
+	 * @uses get_schema_type()
+	 * @return string
+	 */
+	protected function _get_wpdb_data_type($type='')
+	{
+		$type = empty($type) ? $this->getSchemaType() : $type;
+
+		//if type is an array, then different parsing is required.
+		if (is_array($type)) {
+			return $this->_get_wpdb_data_type_for_type_array($type);
+		}
+
+		$wpdb_type = '%s';
+		switch ($type) {
+			case 'number':
+				$wpdb_type = '%f';
+				break;
+			case 'integer':
+			case 'boolean':
+				$wpdb_type = '%d';
+				break;
+			case 'object':
+				$properties = $this->getSchemaProperties();
+				if (isset($properties['raw'], $properties['raw']['type'])) {
+					$wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
+				}
+				break; //leave at default
+		}
+		return $wpdb_type;
+	}
+
+
+
+	protected function _get_wpdb_data_type_for_type_array($type)
+	{
+		$type = (array) $type;
+		//first let's flip because then we can do a faster key check
+		$type = array_flip($type);
+
+		//check for things that mean '%s'
+		if (isset($type['string'],$type['object'],$type['array'])) {
+			return '%s';
+		}
+
+		//if makes it past the above condition and there's float in the array
+		//then the type is %f
+		if (isset($type['number'])) {
+			return '%f';
+		}
+
+		//if it makes it above the above conditions and there is an integer in the array
+		//then the type is %d
+		if (isset($type['integer'])) {
+			return '%d';
+		}
+
+		//anything else is a string
+		return '%s';
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'readonly' => $this->getSchemaReadonly(),
+			'default' => $this->getSchemaDefault()
+		);
+
+		//optional properties of the schema
+		$enum = $this->getSchemaEnum();
+		$properties = $this->getSchemaProperties();
+		$format = $this->getSchemaFormat();
+		if ($enum) {
+			$schema['enum'] = $enum;
+		}
+
+		if ($properties) {
+			$schema['properties'] = $properties;
+		}
+
+		if ($format) {
+			$schema['format'] = $format;
+		}
+		return $schema;
+	}
+
+	/**
+	 * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
+	 * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
+	 * want to see their value, then they shouldn't be db-only fields!)
+	 * Eg, when doing events as custom post types, querying the post_type is essential, but
+	 * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
+	 * By default, all fields aren't db-only.
+	 *
+	 * @return boolean
+	 */
+	public function is_db_only_field()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Validates the incoming string|array to ensure its an allowable type.
+	 * @throws InvalidArgumentException
+	 * @param string|array $type
+	 */
+	private function validateSchemaType($type)
+	{
+		if (! (is_string($type) || is_array($type))) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
+					print_r($type, true)
+				)
+			);
+		}
+
+		//validate allowable types.
+		//@link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+		$allowable_types = array_flip(
+			array(
+				'string',
+				'number',
+				'null',
+				'object',
+				'array',
+				'boolean',
+				'integer'
+			)
+		);
+
+		if (is_array($type)) {
+			foreach ($type as $item_in_type) {
+				$this->validateSchemaType($item_in_type);
+			}
+			return;
+		}
+
+		if (! isset($allowable_types[$type])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
+					$type,
+					implode(',', array_flip($allowable_types))
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Validates that the incoming format is an allowable string to use for the _schema_format property
+	 * @throws InvalidArgumentException
+	 * @param $format
+	 */
+	private function validateSchemaFormat($format)
+	{
+		if (! is_string($format)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
+					print_r($format, true)
+				)
+			);
+		}
+
+		//validate allowable format values
+		//@link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+		$allowable_formats = array_flip(
+			array(
+				'date-time',
+				'email',
+				'hostname',
+				'ipv4',
+				'ipv6',
+				'uri',
+				'uriref'
+			)
+		);
+
+		if (! isset($allowable_formats[$format])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
+					$format,
+					implode(',', array_flip($allowable_formats))
+				)
+			);
+		}
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Simple_HTML_Field.php

Indentation +10 added lines, -10 removed lines

@@ -11,14 +11,14 @@
 
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
+	}
 }

admin_pages/registrations/templates/attendee_details_main_meta_box.template.php

Spacing +5 added lines, -5 removed lines

@@ -20,7 +20,7 @@ 
 						<label for="ATT_fname"><?php _e('First Name', 'event_espresso'); ?><span class="denotes-required-spn">*</span></label>
 					</th>
 					<td>
-						<div class="validation-notice-dv"><?php _e( 'The following is  a required field', 'event_espresso' );?></div>
+						<div class="validation-notice-dv"><?php _e('The following is  a required field', 'event_espresso'); ?></div>
 						<input class="regular-text required" type="text" id="ATT_fname" name="ATT_fname" value="<?php echo $attendee->fname(); ?>"/><br/>
 						<p class="description"><?php _e('The registrant\'s given name. ( required value )', 'event_espresso'); ?></p>
 					</td>
@@ -31,7 +31,7 @@ 
 						<label for="ATT_lname"><?php _e('Last Name', 'event_espresso'); ?><span class="denotes-required-spn">*</span></label>
 					</th>
 					<td>
-						<div class="validation-notice-dv"><?php _e( 'The following is  a required field', 'event_espresso' );?></div>
+						<div class="validation-notice-dv"><?php _e('The following is  a required field', 'event_espresso'); ?></div>
 						<input class="regular-text required" type="text" id="ATT_lname" name="ATT_lname" value="<?php echo $attendee->lname(); ?>"/><br/>
 						<p class="description"><?php _e('The registrant\'s family name. ( required value )', 'event_espresso'); ?></p>
 					</td>
@@ -42,7 +42,7 @@ 
 						<label for="ATT_email"><?php _e('Email Address', 'event_espresso'); ?><span class="denotes-required-spn">*</span></label>
 					</th>
 					<td>
-						<div class="validation-notice-dv"><?php _e( 'The following is  a required field', 'event_espresso' );?></div>
+						<div class="validation-notice-dv"><?php _e('The following is  a required field', 'event_espresso'); ?></div>
 						<input class="regular-text required" type="text" id="ATT_email" name="ATT_email" value="<?php $attendee->f('ATT_email'); ?>"/><br/>
 						<p class="description"><?php _e('( required value )', 'event_espresso'); ?></p>
 					</td>
@@ -109,8 +109,8 @@ 
 				
 				
 				
-				<?php do_action( 'AHEE__attendee_details_main_meta_box__template__table_body_end',$attendee );?>
+				<?php do_action('AHEE__attendee_details_main_meta_box__template__table_body_end', $attendee); ?>
 			</tbody>
 		</table>
-		<?php do_action( 'AHEE__attendee_details_main_meta_box__template__after_table',$attendee );?>
+		<?php do_action('AHEE__attendee_details_main_meta_box__template__after_table', $attendee); ?>
 </div>
\ No newline at end of file

caffeinated/admin/new/pricing/espresso_events_Pricing_Hooks.class.php

Indentation +2108 added lines, -2108 removed lines

@@ -15,2114 +15,2114 @@
 class espresso_events_Pricing_Hooks extends EE_Admin_Hooks
 {
 
-    /**
-     * This property is just used to hold the status of whether an event is currently being
-     * created (true) or edited (false)
-     *
-     * @access protected
-     * @var bool
-     */
-    protected $_is_creating_event;
-
-
-    /**
-     * Used to contain the format strings for date and time that will be used for php date and
-     * time.
-     * Is set in the _set_hooks_properties() method.
-     *
-     * @var array
-     */
-    protected $_date_format_strings;
-
-
-    /**
-     * @var string $_date_time_format
-     */
-    protected $_date_time_format;
-
-
-
-    /**
-     *
-     */
-    protected function _set_hooks_properties()
-    {
-        $this->_name = 'pricing';
-        //capability check
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_default_prices',
-            'advanced_ticket_datetime_metabox'
-        )) {
-            return;
-        }
-        $this->_setup_metaboxes();
-        $this->_set_date_time_formats();
-        $this->_validate_format_strings();
-        $this->_set_scripts_styles();
-        // commented out temporarily until logic is implemented in callback
-        // add_action(
-        //     'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
-        //     array($this, 'autosave_handling')
-        // );
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'caf_updates')
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    protected function _setup_metaboxes()
-    {
-        //if we were going to add our own metaboxes we'd use the below.
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'pricing_metabox',
-                'label'      => esc_html__('Event Tickets & Datetimes', 'event_espresso'),
-                'priority'   => 'high',
-                'context'    => 'normal',
-            ),
-        );
-        $this->_remove_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'id'         => 'espresso_event_editor_tickets',
-                'context'    => 'normal',
-            ),
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    protected function _set_date_time_formats()
-    {
-        /**
-         * Format strings for date and time.  Defaults are existing behaviour from 4.1.
-         * Note, that if you return null as the value for 'date', and 'time' in the array, then
-         * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
-         *
-         * @since 4.6.7
-         * @var array  Expected an array returned with 'date' and 'time' keys.
-         */
-        $this->_date_format_strings = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
-            array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a',
-            )
-        );
-        //validate
-        $this->_date_format_strings['date'] = isset($this->_date_format_strings['date'])
-            ? $this->_date_format_strings['date']
-            : null;
-        $this->_date_format_strings['time'] = isset($this->_date_format_strings['time'])
-            ? $this->_date_format_strings['time']
-            : null;
-        $this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'];
-    }
-
-
-
-    /**
-     * @return void
-     */
-    protected function _validate_format_strings()
-    {
-        //validate format strings
-        $format_validation = EEH_DTT_Helper::validate_format_string(
-            $this->_date_time_format
-        );
-        if (is_array($format_validation)) {
-            $msg = '<p>';
-            $msg .= sprintf(
-                esc_html__(
-                    'The format "%s" was likely added via a filter and is invalid for the following reasons:',
-                    'event_espresso'
-                ),
-                $this->_date_time_format
-            );
-            $msg .= '</p><ul>';
-            foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
-            }
-            $msg .= '</ul><p>';
-            $msg .= sprintf(
-                esc_html__(
-                    '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
-                    'event_espresso'
-                ),
-                '<span style="color:#D54E21;">',
-                '</span>'
-            );
-            $msg .= '</p>';
-            EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_date_format_strings = array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a',
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    protected function _set_scripts_styles()
-    {
-        $this->_scripts_styles = array(
-            'registers'   => array(
-                'ee-tickets-datetimes-css' => array(
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
-                    'type' => 'css',
-                ),
-                'ee-dtt-ticket-metabox'    => array(
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
-                    'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'),
-                ),
-            ),
-            'deregisters' => array(
-                'event-editor-css'       => array('type' => 'css'),
-                'event-datetime-metabox' => array('type' => 'js'),
-            ),
-            'enqueues'    => array(
-                'ee-tickets-datetimes-css' => array('edit', 'create_new'),
-                'ee-dtt-ticket-metabox'    => array('edit', 'create_new'),
-            ),
-            'localize'    => array(
-                'ee-dtt-ticket-metabox' => array(
-                    'DTT_TRASH_BLOCK'       => array(
-                        'main_warning'            => esc_html__(
-                            'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
-                            'event_espresso'
-                        ),
-                        'after_warning'           => esc_html__(
-                            'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
-                            'event_espresso'
-                        ),
-                        'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Cancel', 'event_espresso') . '</button>',
-                        'close_button'            => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Close', 'event_espresso') . '</button>',
-                        'single_warning_from_tkt' => esc_html__(
-                            'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'
-                        ),
-                        'single_warning_from_dtt' => esc_html__(
-                            'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'
-                        ),
-                        'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Dismiss', 'event_espresso') . '</button>',
-                    ),
-                    'DTT_ERROR_MSG'         => array(
-                        'no_ticket_name' => esc_html__('General Admission', 'event_espresso'),
-                        'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">'
-                                            . esc_html__('Dismiss', 'event_espresso') . '</button></div>',
-                    ),
-                    'DTT_OVERSELL_WARNING'  => array(
-                        'datetime_ticket' => esc_html__(
-                            'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
-                            'event_espresso'
-                        ),
-                        'ticket_datetime' => esc_html__(
-                            'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
-                            'event_espresso'
-                        ),
-                    ),
-                    'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats(
-                        $this->_date_format_strings['date'],
-                        $this->_date_format_strings['time']
-                    ),
-                    'DTT_START_OF_WEEK'     => array('dayValue' => (int)get_option('start_of_week')),
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * @param array $update_callbacks
-     * @return array
-     */
-    public function caf_updates(array $update_callbacks)
-    {
-        foreach ($update_callbacks as $key => $callback) {
-            if ($callback[1] === '_default_tickets_update') {
-                unset($update_callbacks[$key]);
-            }
-        }
-        $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update');
-        return $update_callbacks;
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $event The Event object we're attaching data to
-     * @param  array $data The request data from the form
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function datetime_and_tickets_caf_update($event, $data)
-    {
-        //first we need to start with datetimes cause they are the "root" items attached to events.
-        $saved_datetimes = $this->_update_datetimes($event, $data);
-        //next tackle the tickets (and prices?)
-        $this->_update_tickets($event, $saved_datetimes, $data);
-    }
-
-
-    /**
-     * update event_datetimes
-     *
-     * @param  EE_Event $event Event being updated
-     * @param  array $data the request data from the form
-     * @return EE_Datetime[]
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    protected function _update_datetimes($event, $data)
-    {
-        $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_dtt_ids = array();
-        $saved_dtt_objs = array();
-        if (empty($data['edit_event_datetimes']) || !is_array($data['edit_event_datetimes'])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The "edit_event_datetimes" array is invalid therefore the event can not be updated.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            //trim all values to ensure any excess whitespace is removed.
-            $datetime_data = array_map(
-                function ($datetime_data) {
-                    return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
-                },
-                $datetime_data
-            );
-            $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end'])
-                                            && ! empty($datetime_data['DTT_EVT_end'])
-                ? $datetime_data['DTT_EVT_end']
-                : $datetime_data['DTT_EVT_start'];
-            $datetime_values = array(
-                'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
-                    ? $datetime_data['DTT_ID']
-                    : null,
-                'DTT_name'        => ! empty($datetime_data['DTT_name'])
-                    ? $datetime_data['DTT_name']
-                    : '',
-                'DTT_description' => ! empty($datetime_data['DTT_description'])
-                    ? $datetime_data['DTT_description']
-                    : '',
-                'DTT_EVT_start'   => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'     => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit'   => empty($datetime_data['DTT_reg_limit'])
-                    ? EE_INF
-                    : $datetime_data['DTT_reg_limit'],
-                'DTT_order'       => ! isset($datetime_data['DTT_order'])
-                    ? $row
-                    : $datetime_data['DTT_order'],
-            );
-            // if we have an id then let's get existing object first and then set the new values.
-            // Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EE_Registry::instance()
-                                       ->load_model('Datetime', array($timezone))
-                                       ->get_one_by_ID($datetime_data['DTT_ID']);
-                //set date and time format according to what is set in this class.
-                $datetime->set_date_format($this->_date_format_strings['date']);
-                $datetime->set_time_format($this->_date_format_strings['time']);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-                // make sure the $dtt_id here is saved just in case
-                // after the add_relation_to() the autosave replaces it.
-                // We need to do this so we dont' TRASH the parent DTT.
-                // (save the ID for both key and value to avoid duplications)
-                $saved_dtt_ids[$datetime->ID()] = $datetime->ID();
-            } else {
-                $datetime = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array(
-                        $datetime_values,
-                        $timezone,
-                        array($this->_date_format_strings['date'], $this->_date_format_strings['time']),
-                    ),
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            }
-            $datetime->save();
-            $datetime = $event->_add_relation_to($datetime, 'Datetime');
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-                $datetime->save();
-            }
-            //	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
-            // because it is possible there was a new one created for the autosave.
-            // (save the ID for both key and value to avoid duplications)
-            $DTT_ID = $datetime->ID();
-            $saved_dtt_ids[$DTT_ID] = $DTT_ID;
-            $saved_dtt_objs[$row] = $datetime;
-            //todo if ANY of these updates fail then we want the appropriate global error message.
-        }
-        $event->save();
-        // now we need to REMOVE any datetimes that got deleted.
-        // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them.
-        // So its safe to permanently delete at this point.
-        $old_datetimes = explode(',', $data['datetime_IDs']);
-        $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes;
-        if (is_array($old_datetimes)) {
-            $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
-            foreach ($datetimes_to_delete as $id) {
-                $id = absint($id);
-                if (empty($id)) {
-                    continue;
-                }
-                $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
-                //remove tkt relationships.
-                $related_tickets = $dtt_to_remove->get_many_related('Ticket');
-                foreach ($related_tickets as $tkt) {
-                    $dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
-                }
-                $event->_remove_relation_to($id, 'Datetime');
-                $dtt_to_remove->refresh_cache_of_related_objects();
-            }
-        }
-        return $saved_dtt_objs;
-    }
-
-
-    /**
-     * update tickets
-     *
-     * @param  EE_Event $event Event object being updated
-     * @param  EE_Datetime[] $saved_datetimes an array of datetime ids being updated
-     * @param  array $data incoming request data
-     * @return EE_Ticket[]
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    protected function _update_tickets($event, $saved_datetimes, $data)
-    {
-        $new_tkt = null;
-        $new_default = null;
-        //stripslashes because WP filtered the $_POST ($data) array to add slashes
-        $data = stripslashes_deep($data);
-        $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_tickets = $datetimes_on_existing = array();
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        if(empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])){
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The "edit_tickets" array is invalid therefore the event can not be updated.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $update_prices = $create_new_TKT = false;
-            // figure out what datetimes were added to the ticket
-            // and what datetimes were removed from the ticket in the session.
-            $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
-            $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]);
-            $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
-            $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map(
-                function ($ticket_data) {
-                    return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
-                },
-                $tkt
-            );
-            // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle
-            // because we're doing calculations prior to using the models.
-            // note incoming ['TKT_price'] value is already in standard notation (via js).
-            $ticket_price = isset($tkt['TKT_price'])
-                ? round((float)$tkt['TKT_price'], 3)
-                : 0;
-            //note incoming base price needs converted from localized value.
-            $base_price = isset($tkt['TKT_base_price'])
-                ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price'])
-                : 0;
-            //if ticket price == 0 and $base_price != 0 then ticket price == base_price
-            $ticket_price = $ticket_price === 0 && $base_price !== 0
-                ? $base_price
-                : $ticket_price;
-            $base_price_id = isset($tkt['TKT_base_price_ID'])
-                ? $tkt['TKT_base_price_ID']
-                : 0;
-            $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row])
-                ? $data['edit_prices'][$row]
-                : array();
-            $now = null;
-            if (empty($tkt['TKT_start_date'])) {
-                //lets' use now in the set timezone.
-                $now = new DateTime('now', new DateTimeZone($event->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($this->_date_time_format);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                /**
-                 * set the TKT_end_date to the first datetime attached to the ticket.
-                 */
-                $first_dtt = $saved_datetimes[reset($tkt_dtt_rows)];
-                $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format);
-            }
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description'])
-                                     && $tkt['TKT_description'] !== esc_html__(
-                    'You can modify this description',
-                    'event_espresso'
-                )
-                    ? $tkt['TKT_description']
-                    : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === ''
-                    ? EE_INF
-                    : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === ''
-                    ? EE_INF
-                    : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
-                'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
-                'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
-                'TKT_price'       => $ticket_price,
-            );
-            // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly,
-            // which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID'] = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $update_prices = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of doing any add_relations to
-            // because its entirely possible that this ticket wasn't removed or added to any datetime in the session
-            // but DID have it's items modified.
-            // keep in mind that if the TKT has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (absint($TKT_values['TKT_ID'])) {
-                $ticket = EE_Registry::instance()
-                                     ->load_model('Ticket', array($timezone))
-                                     ->get_one_by_ID($tkt['TKT_ID']);
-                if ($ticket instanceof EE_Ticket) {
-                    $ticket = $this->_update_ticket_datetimes(
-                        $ticket,
-                        $saved_datetimes,
-                        $datetimes_added,
-                        $datetimes_removed
-                    );
-                    // are there any registrations using this ticket ?
-                    $tickets_sold = $ticket->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)),
-                            ),
-                        )
-                    );
-                    //set ticket formats
-                    $ticket->set_date_format($this->_date_format_strings['date']);
-                    $ticket->set_time_format($this->_date_format_strings['time']);
-                    // let's just check the total price for the existing ticket
-                    // and determine if it matches the new total price.
-                    // if they are different then we create a new ticket (if tickets sold)
-                    // if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted();
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field === 'TKT_qty') {
-                            $ticket->set_qty($value);
-                        } else {
-                            $ticket->set($field, $value);
-                        }
-                    }
-                    // if $create_new_TKT is false then we can safely update the existing ticket.
-                    // Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        $new_tkt = $this->_duplicate_ticket($ticket, $price_rows, $ticket_price, $base_price,
-                            $base_price_id);
-                    }
-                }
-            } else {
-                // no TKT_id so a new TKT
-                $ticket = EE_Ticket::new_instance(
-                    $TKT_values,
-                    $timezone,
-                    array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
-                );
-                if ($ticket instanceof EE_Ticket) {
-                    // make sure ticket has an ID of setting relations won't work
-                    $ticket->save();
-                    $ticket = $this->_update_ticket_datetimes(
-                        $ticket,
-                        $saved_datetimes,
-                        $datetimes_added,
-                        $datetimes_removed
-                    );
-                    $update_prices = true;
-                }
-            }
-            //make sure any current values have been saved.
-            //$ticket->save();
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-            }
-            //let's make sure the base price is handled
-            $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $ticket, $update_prices, $base_price,
-                $base_price_id) : $ticket;
-            //add/update price_modifiers
-            $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) : $ticket;
-            //need to make sue that the TKT_price is accurate after saving the prices.
-            $ticket->ensure_TKT_Price_correct();
-            //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
-            if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
-                $update_prices = true;
-                $new_default = clone $ticket;
-                $new_default->set('TKT_ID', 0);
-                $new_default->set('TKT_is_default', 1);
-                $new_default->set('TKT_row', 1);
-                $new_default->set('TKT_price', $ticket_price);
-                // remove any dtt relations cause we DON'T want dtt relations attached
-                // (note this is just removing the cached relations in the object)
-                $new_default->_remove_relations('Datetime');
-                //todo we need to add the current attached prices as new prices to the new default ticket.
-                $new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices);
-                //don't forget the base price!
-                $new_default = $this->_add_prices_to_ticket(
-                    array(),
-                    $new_default,
-                    $update_prices,
-                    $base_price,
-                    $base_price_id
-                );
-                $new_default->save();
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket',
-                    $new_default,
-                    $row,
-                    $ticket,
-                    $data
-                );
-            }
-            // DO ALL dtt relationships for both current tickets and any archived tickets
-            // for the given dtt that are related to the current ticket.
-            // TODO... not sure exactly how we're going to do this considering we don't know
-            // what current ticket the archived tickets are related to
-            // (and TKT_parent is used for autosaves so that's not a field we can reliably use).
-            //let's assign any tickets that have been setup to the saved_tickets tracker
-            //save existing TKT
-            $ticket->save();
-            if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
-                //save new TKT
-                $new_tkt->save();
-                //add new ticket to array
-                $saved_tickets[$new_tkt->ID()] = $new_tkt;
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
-                    $new_tkt,
-                    $row,
-                    $tkt,
-                    $data
-                );
-            } else {
-                //add tkt to saved tkts
-                $saved_tickets[$ticket->ID()] = $ticket;
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
-                    $ticket,
-                    $row,
-                    $tkt,
-                    $data
-                );
-            }
-        }
-        // now we need to handle tickets actually "deleted permanently".
-        // There are cases where we'd want this to happen
-        // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
-        // Or a draft event was saved and in the process of editing a ticket is trashed.
-        // No sense in keeping all the related data in the db!
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            //if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
-            if ($tkt_to_remove->get('TKT_is_default')) {
-                continue;
-            }
-            // if this tkt has any registrations attached so then we just ARCHIVE
-            // because we don't actually permanently delete these tickets.
-            if ($tkt_to_remove->count_related('Registration') > 0) {
-                $tkt_to_remove->delete();
-                continue;
-            }
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tkts_sold)
-            $datetimes = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($datetimes as $datetime) {
-                $tkt_to_remove->_remove_relation_to($datetime, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return $saved_tickets;
-    }
-
-
-
-    /**
-     * @access  protected
-     * @param \EE_Ticket     $ticket
-     * @param \EE_Datetime[] $saved_datetimes
-     * @param \EE_Datetime[] $added_datetimes
-     * @param \EE_Datetime[] $removed_datetimes
-     * @return \EE_Ticket
-     * @throws \EE_Error
-     */
-    protected function _update_ticket_datetimes(
-        EE_Ticket $ticket,
-        $saved_datetimes = array(),
-        $added_datetimes = array(),
-        $removed_datetimes = array()
-    ) {
-        // to start we have to add the ticket to all the datetimes its supposed to be with,
-        // and removing the ticket from datetimes it got removed from.
-        // first let's add datetimes
-        if (! empty($added_datetimes) && is_array($added_datetimes)) {
-            foreach ($added_datetimes as $row_id) {
-                $row_id = (int)$row_id;
-                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
-                    $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to add that to the DTT sold because this DTT is getting added.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[$row_id]->increase_sold($ticket->sold());
-                        $saved_datetimes[$row_id]->save();
-                    }
-                }
-            }
-        }
-        // then remove datetimes
-        if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
-            foreach ($removed_datetimes as $row_id) {
-                $row_id = (int)$row_id;
-                // its entirely possible that a datetime got deleted (instead of just removed from relationship.
-                // So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
-                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
-                    $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to remove it's sold from the DTT_sold.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[$row_id]->decrease_sold($ticket->sold());
-                        $saved_datetimes[$row_id]->save();
-                    }
-                }
-            }
-        }
-        // cap ticket qty by datetime reg limits
-        $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-        return $ticket;
-    }
-
-
-
-    /**
-     * @access  protected
-     * @param \EE_Ticket $ticket
-     * @param array      $price_rows
-     * @param int        $ticket_price
-     * @param int        $base_price
-     * @param int        $base_price_id
-     * @return \EE_Ticket
-     * @throws \EE_Error
-     */
-    protected function _duplicate_ticket(
-        EE_Ticket $ticket,
-        $price_rows = array(),
-        $ticket_price = 0,
-        $base_price = 0,
-        $base_price_id = 0
-    ) {
-        // create new ticket that's a copy of the existing
-        // except a new id of course (and not archived)
-        // AND has the new TKT_price associated with it.
-        $new_ticket = clone $ticket;
-        $new_ticket->set('TKT_ID', 0);
-        $new_ticket->set_deleted(0);
-        $new_ticket->set_price($ticket_price);
-        $new_ticket->set_sold(0);
-        // let's get a new ID for this ticket
-        $new_ticket->save();
-        // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
-        $datetimes_on_existing = $ticket->datetimes();
-        $new_ticket = $this->_update_ticket_datetimes(
-            $new_ticket,
-            $datetimes_on_existing,
-            array_keys($datetimes_on_existing)
-        );
-        // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
-        // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
-        // available.
-        if ($ticket->sold() > 0) {
-            $new_qty = $ticket->qty() - $ticket->sold();
-            $new_ticket->set_qty($new_qty);
-        }
-        //now we update the prices just for this ticket
-        $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
-        //and we update the base price
-        $new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id);
-        return $new_ticket;
-    }
-
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices        Array of prices from the form.
-     * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
-     * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
-     * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
-     * @return EE_Ticket
-     * @throws EE_Error
-     */
-    protected function _add_prices_to_ticket(
-        $prices = array(),
-        EE_Ticket $ticket,
-        $new_prices = false,
-        $base_price = false,
-        $base_price_id = false
-    ) {
-        // let's just get any current prices that may exist on the given ticket
-        // so we can remove any prices that got trashed in this session.
-        $current_prices_on_ticket = $base_price !== false
-            ? $ticket->base_price(true)
-            : $ticket->price_modifiers();
-        $updated_prices = array();
-        // if $base_price ! FALSE then updating a base price.
-        if ($base_price !== false) {
-            $prices[1] = array(
-                'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
-                'PRT_ID'     => 1,
-                'PRC_amount' => $base_price,
-                'PRC_name'   => $ticket->get('TKT_name'),
-                'PRC_desc'   => $ticket->get('TKT_description'),
-            );
-        }
-        //possibly need to save tkt
-        if (! $ticket->ID()) {
-            $ticket->save();
-        }
-        foreach ($prices as $row => $prc) {
-            $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
-            if (empty($prt_id)) {
-                continue;
-            } //prices MUST have a price type id.
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => $prt_id,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => false,
-                //make sure we set PRC_is_default to false for all ticket saves from event_editor
-                'PRC_order'      => $row,
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $price = EE_Registry::instance()->load_class(
-                    'Price',
-                    array($PRC_values),
-                    false,
-                    false
-                );
-            } else {
-                $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $value) {
-                    $price->set($field, $value);
-                }
-            }
-            $price->save();
-            $updated_prices[$price->ID()] = $price;
-            $ticket->_add_relation_to($price, 'Price');
-        }
-        //now let's remove any prices that got removed from the ticket
-        if (! empty ($current_prices_on_ticket)) {
-            $current = array_keys($current_prices_on_ticket);
-            $updated = array_keys($updated_prices);
-            $prices_to_remove = array_diff($current, $updated);
-            if (! empty($prices_to_remove)) {
-                foreach ($prices_to_remove as $prc_id) {
-                    $p = $current_prices_on_ticket[$prc_id];
-                    $ticket->_remove_relation_to($p, 'Price');
-                    //delete permanently the price
-                    $p->delete_permanently();
-                }
-            }
-        }
-        return $ticket;
-    }
-
-
-
-    /**
-     * @param Events_Admin_Page $event_admin_obj
-     * @return Events_Admin_Page
-     */
-    public function autosave_handling( Events_Admin_Page $event_admin_obj)
-    {
-        return $event_admin_obj;
-        //doing nothing for the moment.
-        // todo when I get to this remember that I need to set the template args on the $event_admin_obj
-        // (use the set_template_args() method)
-        /**
-         * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
-         * 1. TKT_is_default_selector (visible)
-         * 2. TKT_is_default (hidden)
-         * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket
-         * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want
-         * this ticket to be saved as a default.
-         * The tricky part is, on an initial display on create or edit (or after manually updating),
-         * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true
-         * if this is a create.  However, after an autosave, users will want some sort of indicator that
-         * the TKT HAS been saved as a default..
-         * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
-         * On Autosave:
-         * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements,
-         * then set the TKT_is_default to false.
-         * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).
-         *  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
-         * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
-         */
-    }
-
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function pricing_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
-        $event = $this->_adminpage_obj->get_cpt_model_obj();
-        //set is_creating_event property.
-        $EVT_ID = $event->ID();
-        $this->_is_creating_event = absint($EVT_ID) === 0;
-        //default main template args
-        $main_template_args = array(
-            'event_datetime_help_link' => EEH_Template::get_help_tab_link(
-                'event_editor_event_datetimes_help_tab',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            // todo need to add a filter to the template for the help text
-            // in the Events_Admin_Page core file so we can add further help
-            'existing_datetime_ids'    => '',
-            'total_dtt_rows'           => 1,
-            'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link(
-                'add_new_dtt_info',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'datetime_rows'            => '',
-            'show_tickets_container'   => '',
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'ee_collapsible_status'    => ' ee-collapsible-open'
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
-        );
-        $timezone = $event instanceof EE_Event ? $event->timezone_string() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. For each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        /** @var EEM_Datetime $datetime_model */
-        $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone));
-        $datetimes = $datetime_model->get_all_event_dates($EVT_ID);
-        $main_template_args['total_dtt_rows'] = count($datetimes);
-        /**
-         * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486
-         * for why we are counting $datetime_row and then setting that on the Datetime object
-         */
-        $datetime_row = 1;
-        foreach ($datetimes as $datetime) {
-            $DTT_ID = $datetime->get('DTT_ID');
-            $datetime->set('DTT_order', $datetime_row);
-            $existing_datetime_ids[] = $DTT_ID;
-            //tickets attached
-            $related_tickets = $datetime->ID() > 0
-                ? $datetime->get_many_related(
-                    'Ticket',
-                    array(
-                        array(
-                            'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0),
-                        ),
-                        'default_where_conditions' => 'none',
-                        'order_by'                 => array('TKT_order' => 'ASC'),
-                    )
-                )
-                : array();
-            //if there are no related tickets this is likely a new event OR autodraft
-            // event so we need to generate the default tickets because datetimes
-            // ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
-            // datetime on the event.
-            if (empty ($related_tickets) && count($datetimes) < 2) {
-                /** @var EEM_Ticket $ticket_model */
-                $ticket_model = EE_Registry::instance()->load_model('Ticket');
-                $related_tickets = $ticket_model->get_all_default_tickets();
-                // this should be ordered by TKT_ID, so let's grab the first default ticket
-                // (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
-                $default_prices = EEM_Price::instance()->get_all_default_prices();
-                $main_default_ticket = reset($related_tickets);
-                if ($main_default_ticket instanceof EE_Ticket) {
-                    foreach ($default_prices as $default_price) {
-                        if ($default_price instanceof EE_Price && $default_price->is_base_price()) {
-                            continue;
-                        }
-                        $main_default_ticket->cache('Price', $default_price);
-                    }
-                }
-            }
-            // we can't actually setup rows in this loop yet cause we don't know all
-            // the unique tickets for this event yet (tickets are linked through all datetimes).
-            // So we're going to temporarily cache some of that information.
-            //loop through and setup the ticket rows and make sure the order is set.
-            foreach ($related_tickets as $ticket) {
-                $TKT_ID = $ticket->get('TKT_ID');
-                $ticket_row = $ticket->get('TKT_row');
-                //we only want unique tickets in our final display!!
-                if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
-                    $existing_ticket_ids[] = $TKT_ID;
-                    $all_tickets[] = $ticket;
-                }
-                //temporary cache of this ticket info for this datetime for later processing of datetime rows.
-                $datetime_tickets[$DTT_ID][] = $ticket_row;
-                //temporary cache of this datetime info for this ticket for later processing of ticket rows.
-                if (
-                    ! isset($ticket_datetimes[$TKT_ID])
-                    || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true)
-                ) {
-                    $ticket_datetimes[$TKT_ID][] = $datetime_row;
-                }
-            }
-            $datetime_row++;
-        }
-        $main_template_args['total_ticket_rows'] = count($existing_ticket_ids);
-        $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
-        $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        //sort $all_tickets by order
-        usort(
-            $all_tickets,
-            function (EE_Ticket $a, EE_Ticket $b) {
-                $a_order = (int)$a->get('TKT_order');
-                $b_order = (int)$b->get('TKT_order');
-                if ($a_order === $b_order) {
-                    return 0;
-                }
-                return ($a_order < $b_order) ? -1 : 1;
-            }
-        );
-        // k NOW we have all the data we need for setting up the dtt rows
-        // and ticket rows so we start our dtt loop again.
-        $datetime_row = 1;
-        foreach ($datetimes as $datetime) {
-            $main_template_args['datetime_rows'] .= $this->_get_datetime_row(
-                $datetime_row,
-                $datetime,
-                $datetime_tickets,
-                $all_tickets,
-                false,
-                $datetimes
-            );
-            $datetime_row++;
-        }
-        //then loop through all tickets for the ticket rows.
-        $ticket_row = 1;
-        foreach ($all_tickets as $ticket) {
-            $main_template_args['ticket_rows'] .= $this->_get_ticket_row(
-                $ticket_row,
-                $ticket,
-                $ticket_datetimes,
-                $datetimes,
-                false,
-                $all_tickets
-            );
-            $ticket_row++;
-        }
-        $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets);
-        EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
-            $main_template_args
-        );
-    }
-
-
-
-    /**
-     * @param int         $datetime_row
-     * @param EE_Datetime $datetime
-     * @param array       $datetime_tickets
-     * @param array       $all_tickets
-     * @param bool        $default
-     * @param array       $all_datetimes
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_datetime_row(
-        $datetime_row,
-        EE_Datetime $datetime,
-        $datetime_tickets = array(),
-        $all_tickets = array(),
-        $default = false,
-        $all_datetimes = array()
-    ) {
-        $dtt_display_template_args = array(
-            'dtt_edit_row'             => $this->_get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes),
-            'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row(
-                $datetime_row,
-                $datetime,
-                $datetime_tickets,
-                $all_tickets,
-                $default
-            ),
-            'dtt_row'                  => $default ? 'DTTNUM' : $datetime_row,
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
-            $dtt_display_template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * This method is used to generate a dtt fields  edit row.
-     * The same row is used to generate a row with valid DTT objects
-     * and the default row that is used as the skeleton by the js.
-     *
-     * @param int           $datetime_row  The row number for the row being generated.
-     * @param EE_Datetime   $datetime
-     * @param bool          $default       Whether a default row is being generated or not.
-     * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor.
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes)
-    {
-        // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true.
-        $default = ! $datetime instanceof EE_Datetime ? true : $default;
-        $template_args = array(
-            'dtt_row'              => $default ? 'DTTNUM' : $datetime_row,
-            'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'edit_dtt_expanded'    => '',
-            'DTT_ID'               => $default ? '' : $datetime->ID(),
-            'DTT_name'             => $default ? '' : $datetime->name(),
-            'DTT_description'      => $default ? '' : $datetime->description(),
-            'DTT_EVT_start'        => $default ? '' : $datetime->start_date($this->_date_time_format),
-            'DTT_EVT_end'          => $default ? '' : $datetime->end_date($this->_date_time_format),
-            'DTT_reg_limit'        => $default
-                ? ''
-                : $datetime->get_pretty(
-                    'DTT_reg_limit',
-                    'input'
-                ),
-            'DTT_order'            => $default ? 'DTTNUM' : $datetime_row,
-            'dtt_sold'             => $default ? '0' : $datetime->get('DTT_sold'),
-            'dtt_reserved'         => $default ? '0' : $datetime->reserved(),
-            'clone_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
-                ? ''
-                : 'clone-icon ee-icon ee-icon-clone clickable',
-            'trash_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
-                ? 'ee-lock-icon'
-                : 'trash-icon dashicons dashicons-post-trash clickable',
-            'reg_list_url'         => $default || ! $datetime->event() instanceof \EE_Event
-                ? ''
-                : EE_Admin_Page::add_query_args_and_nonce(
-                    array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()),
-                    REG_ADMIN_URL
-                ),
-        );
-        $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
-            ? ' style="display:none"'
-            : '';
-        //allow filtering of template args at this point.
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
-            $template_args,
-            $datetime_row,
-            $datetime,
-            $default,
-            $all_datetimes,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int         $datetime_row
-     * @param EE_Datetime $datetime
-     * @param array       $datetime_tickets
-     * @param array       $all_tickets
-     * @param bool        $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_dtt_attached_tickets_row(
-        $datetime_row,
-        $datetime,
-        $datetime_tickets = array(),
-        $all_tickets = array(),
-        $default
-    ) {
-        $template_args = array(
-            'dtt_row'                           => $default ? 'DTTNUM' : $datetime_row,
-            'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'DTT_description'                   => $default ? '' : $datetime->description(),
-            'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
-            'show_tickets_row'                  => ' style="display:none;"',
-            'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link(
-                'add_new_ticket_via_datetime',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'DTT_ID'                            => $default ? '' : $datetime->ID(),
-        );
-        //need to setup the list items (but only if this isn't a default skeleton setup)
-        if (! $default) {
-            $ticket_row = 1;
-            foreach ($all_tickets as $ticket) {
-                $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
-                    $datetime_row,
-                    $ticket_row,
-                    $datetime,
-                    $ticket,
-                    $datetime_tickets,
-                    $default
-                );
-                $ticket_row++;
-            }
-        }
-        //filter template args at this point
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
-            $template_args,
-            $datetime_row,
-            $datetime,
-            $datetime_tickets,
-            $all_tickets,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int         $datetime_row
-     * @param int         $ticket_row
-     * @param EE_Datetime $datetime
-     * @param EE_Ticket   $ticket
-     * @param array       $datetime_tickets
-     * @param bool        $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_datetime_tickets_list_item(
-        $datetime_row,
-        $ticket_row,
-        $datetime,
-        $ticket,
-        $datetime_tickets = array(),
-        $default
-    ) {
-        $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()])
-            ? $datetime_tickets[$datetime->ID()]
-            : array();
-        $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
-        $no_ticket = $default && empty($ticket);
-        $template_args = array(
-            'dtt_row'                 => $default
-                ? 'DTTNUM'
-                : $datetime_row,
-            'tkt_row'                 => $no_ticket
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true)
-                ? ' checked="checked"'
-                : '',
-            'ticket_selected'         => in_array($display_row, $dtt_tkts, true)
-                ? ' ticket-selected'
-                : '',
-            'TKT_name'                => $no_ticket
-                ? 'TKTNAME'
-                : $ticket->get('TKT_name'),
-            'tkt_status_class'        => $no_ticket || $this->_is_creating_event
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status(),
-        );
-        //filter template args
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
-            $template_args,
-            $datetime_row,
-            $ticket_row,
-            $datetime,
-            $ticket,
-            $datetime_tickets,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * This generates the ticket row for tickets.
-     * This same method is used to generate both the actual rows and the js skeleton row
-     * (when default === true)
-     *
-     * @param int           $ticket_row       Represents the row number being generated.
-     * @param               $ticket
-     * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket
-     *                                        or empty for default
-     * @param EE_Datetime[] $all_datetimes    All Datetimes on the event or empty for default.
-     * @param bool          $default          Whether default row being generated or not.
-     * @param EE_Ticket[]   $all_tickets      This is an array of all tickets attached to the event
-     *                                        (or empty in the case of defaults)
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_row(
-        $ticket_row,
-        $ticket,
-        $ticket_datetimes,
-        $all_datetimes,
-        $default = false,
-        $all_tickets = array()
-    ) {
-        // if $ticket is not an instance of EE_Ticket then force default to true.
-        $default = ! $ticket instanceof EE_Ticket ? true : $default;
-        $prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
-            array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
-        // if there is only one price (which would be the base price)
-        // or NO prices and this ticket is a default ticket,
-        // let's just make sure there are no cached default prices on the object.
-        // This is done by not including any query_params.
-        if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
-            $prices = $ticket->prices();
-        }
-        // check if we're dealing with a default ticket in which case
-        // we don't want any starting_ticket_datetime_row values set
-        // (otherwise there won't be any new relationships created for tickets based off of the default ticket).
-        // This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
-        $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
-        $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
-            ? $ticket_datetimes[$ticket->ID()]
-            : array();
-        $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal();
-        $base_price = $default ? null : $ticket->base_price();
-        $count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
-        //breaking out complicated condition for ticket_status
-        if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
-        } else {
-            $ticket_status_class = $ticket->is_default()
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status();
-        }
-        //breaking out complicated condition for TKT_taxable
-        if ($default) {
-            $TKT_taxable = '';
-        } else {
-            $TKT_taxable = $ticket->taxable()
-                ? ' checked="checked"'
-                : '';
-        }
-        if ($default) {
-            $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
-        } elseif ($ticket->is_default()) {
-            $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
-        } else {
-            $TKT_status = $ticket->ticket_status(true);
-        }
-        if ($default) {
-            $TKT_min = '';
-        } else {
-            $TKT_min = $ticket->min();
-            if ($TKT_min === -1 || $TKT_min === 0) {
-                $TKT_min = '';
-            }
-        }
-        $template_args = array(
-            'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
-            'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
-            //on initial page load this will always be the correct order.
-            'tkt_status_class'              => $ticket_status_class,
-            'display_edit_tkt_row'          => ' style="display:none;"',
-            'edit_tkt_expanded'             => '',
-            'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_name'                      => $default ? '' : $ticket->name(),
-            'TKT_start_date'                => $default
-                ? ''
-                : $ticket->get_date('TKT_start_date', $this->_date_time_format),
-            'TKT_end_date'                  => $default
-                ? ''
-                : $ticket->get_date('TKT_end_date', $this->_date_time_format),
-            'TKT_status'                    => $TKT_status,
-            'TKT_price'                     => $default
-                ? ''
-                : EEH_Template::format_currency(
-                    $ticket->get_ticket_total_with_taxes(),
-                    false,
-                    false
-                ),
-            'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
-            'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
-            'TKT_qty'                       => $default
-                ? ''
-                : $ticket->get_pretty('TKT_qty', 'symbol'),
-            'TKT_qty_for_input'             => $default
-                ? ''
-                : $ticket->get_pretty('TKT_qty', 'input'),
-            'TKT_uses'                      => $default
-                ? ''
-                : $ticket->get_pretty('TKT_uses', 'input'),
-            'TKT_min'                       => $TKT_min,
-            'TKT_max'                       => $default
-                ? ''
-                : $ticket->get_pretty('TKT_max', 'input'),
-            'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
-            'TKT_reserved'                  => $default ? 0 : $ticket->reserved(),
-            'TKT_registrations'             => $default
-                ? 0
-                : $ticket->count_registrations(
-                    array(
-                        array(
-                            'STS_ID' => array(
-                                '!=',
-                                EEM_Registration::status_id_incomplete,
-                            ),
-                        ),
-                    )
-                ),
-            'TKT_ID'                        => $default ? 0 : $ticket->ID(),
-            'TKT_description'               => $default ? '' : $ticket->get_pretty('TKT_description', 'form_input'),
-            'TKT_is_default'                => $default ? 0 : $ticket->is_default(),
-            'TKT_required'                  => $default ? 0 : $ticket->required(),
-            'TKT_is_default_selector'       => '',
-            'ticket_price_rows'             => '',
-            'TKT_base_price'                => $default || ! $base_price instanceof EE_Price
-                ? ''
-                : $base_price->get_pretty('PRC_amount', 'localized_float'),
-            'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
-            'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0)
-                ? ''
-                : ' style="display:none;"',
-            'show_price_mod_button'         => count($prices) > 1
-                                               || ($default && $count_price_mods > 0)
-                                               || (! $default && $ticket->deleted())
-                ? ' style="display:none;"'
-                : '',
-            'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
-            'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
-            'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes),
-            'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_datetimes),
-            'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
-            'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
-            'TKT_taxable'                   => $TKT_taxable,
-            'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->taxable()
-                ? ''
-                : ' style="display:none"',
-            'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
-            'TKT_subtotal_amount_display'   => EEH_Template::format_currency(
-                $ticket_subtotal,
-                false,
-                false
-            ),
-            'TKT_subtotal_amount'           => $ticket_subtotal,
-            'tax_rows'                      => $this->_get_tax_rows($ticket_row, $ticket),
-            'disabled'                      => $ticket instanceof EE_Ticket && $ticket->deleted(),
-            'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->deleted()
-                ? ' ticket-archived'
-                : '',
-            'trash_icon'                    => $ticket instanceof EE_Ticket
-                                               && $ticket->deleted()
-                                               && ! $ticket->is_permanently_deleteable()
-                ? 'ee-lock-icon '
-                : 'trash-icon dashicons dashicons-post-trash clickable',
-            'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->deleted()
-                ? ''
-                : 'clone-icon ee-icon ee-icon-clone clickable',
-        );
-        $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
-            ? ' style="display:none"'
-            : '';
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date($this->_date_time_format,
-                current_time('timestamp'));
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0
-                ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related(
-                    'Datetime',
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
-                )
-                : null;
-            if (! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime(
-                    'DTT_EVT_start',
-                    $this->_date_time_format
-                );
-            } else {
-                //default so let's just use what's been set for the default date-time which is 30 days from now.
-                $template_args['TKT_end_date'] = date(
-                    $this->_date_time_format,
-                    mktime(24, 0, 0, date('m'), date('d') + 29, date('Y')
-                    )
-                );
-            }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        //generate ticket_datetime items
-        if (! $default) {
-            $datetime_row = 1;
-            foreach ($all_datetimes as $datetime) {
-                $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
-                    $datetime_row,
-                    $ticket_row,
-                    $datetime,
-                    $ticket,
-                    $ticket_datetimes,
-                    $default
-                );
-                $datetime_row++;
-            }
-        }
-        $price_row = 1;
-        foreach ($prices as $price) {
-            if (! $price instanceof EE_Price)  {
-                continue;
-            }
-            if ($price->is_base_price()) {
-                $price_row++;
-                continue;
-            }
-            $show_trash = !((count($prices) > 1 && $price_row === 1) || count($prices) === 1);
-            $show_create = !(count($prices) > 1 && count($prices) !== $price_row);
-            $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row(
-                $ticket_row,
-                $price_row,
-                $price,
-                $default,
-                $ticket,
-                $show_trash,
-                $show_create
-            );
-            $price_row++;
-        }
-        //filter $template_args
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
-            $template_args,
-            $ticket_row,
-            $ticket,
-            $ticket_datetimes,
-            $all_datetimes,
-            $default,
-            $all_tickets,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int            $ticket_row
-     * @param EE_Ticket|null $ticket
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_tax_rows($ticket_row, $ticket)
-    {
-        $tax_rows = '';
-        /** @var EE_Price[] $taxes */
-        $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
-        foreach ($taxes as $tax) {
-            $tax_added = $this->_get_tax_added($tax, $ticket);
-            $template_args = array(
-                'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable')
-                    ? ''
-                    : ' style="display:none;"',
-                'tax_id'            => $tax->ID(),
-                'tkt_row'           => $ticket_row,
-                'tax_label'         => $tax->get('PRC_name'),
-                'tax_added'         => $tax_added,
-                'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
-                'tax_amount'        => $tax->get('PRC_amount'),
-            );
-            $template_args = apply_filters(
-                'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
-                $template_args,
-                $ticket_row,
-                $ticket,
-                $this->_is_creating_event
-            );
-            $tax_rows .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $tax_rows;
-    }
-
-
-
-    /**
-     * @param EE_Price       $tax
-     * @param EE_Ticket|null $ticket
-     * @return float|int
-     * @throws EE_Error
-     */
-    protected function _get_tax_added(EE_Price $tax, $ticket)
-    {
-        $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
-        return $subtotal * $tax->get('PRC_amount') / 100;
-    }
-
-
-
-    /**
-     * @param int            $ticket_row
-     * @param int            $price_row
-     * @param EE_Price|null  $price
-     * @param bool           $default
-     * @param EE_Ticket|null $ticket
-     * @param bool           $show_trash
-     * @param bool           $show_create
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_price_row(
-        $ticket_row,
-        $price_row,
-        $price,
-        $default,
-        $ticket,
-        $show_trash = true,
-        $show_create = true
-    ) {
-        $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted');
-        $template_args = array(
-            'tkt_row'               => $default && empty($ticket)
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'PRC_order'             => $default && empty($price)
-                ? 'PRICENUM'
-                : $price_row,
-            'edit_prices_name'      => $default && empty($price)
-                ? 'PRICENAMEATTR'
-                : 'edit_prices',
-            'price_type_selector'   => $default && empty($price)
-                ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default)
-                : $this->_get_price_type_selector($ticket_row, $price_row, $price, $default, $send_disabled),
-            'PRC_ID'                => $default && empty($price)
-                ? 0
-                : $price->ID(),
-            'PRC_is_default'        => $default && empty($price)
-                ? 0
-                : $price->get('PRC_is_default'),
-            'PRC_name'              => $default && empty($price)
-                ? ''
-                : $price->get('PRC_name'),
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'show_plus_or_minus'    => $default && empty($price)
-                ? ''
-                : ' style="display:none;"',
-            'show_plus'             => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price())
-                ? ' style="display:none;"'
-                : '',
-            'show_minus'            => ($default && empty($price)) || ! $price->is_discount()
-                ? ' style="display:none;"'
-                : '',
-            'show_currency_symbol'  => ($default && empty($price)) || $price->is_percent()
-                ? ' style="display:none"'
-                : '',
-            'PRC_amount'            => $default && empty($price)
-                ? 0
-                : $price->get_pretty('PRC_amount',
-                    'localized_float'),
-            'show_percentage'       => ($default && empty($price)) || ! $price->is_percent()
-                ? ' style="display:none;"'
-                : '',
-            'show_trash_icon'       => $show_trash
-                ? ''
-                : ' style="display:none;"',
-            'show_create_button'    => $show_create
-                ? ''
-                : ' style="display:none;"',
-            'PRC_desc'              => $default && empty($price)
-                ? ''
-                : $price->get('PRC_desc'),
-            'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted'),
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $ticket,
-            $show_trash,
-            $show_create,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @param bool     $disabled
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false)
-    {
-        if ($price->is_base_price()) {
-            return $this->_get_base_price_template($ticket_row, $price_row, $price, $default);
-        }
-        return $this->_get_price_modifier_template($ticket_row, $price_row, $price, $default, $disabled);
-    }
-
-
-
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_base_price_template($ticket_row, $price_row, $price, $default)
-    {
-        $template_args = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
-            'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $price_row,
-            'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
-            'PRT_name'                  => esc_html__('Price', 'event_espresso'),
-            'price_selected_operator'   => '+',
-            'price_selected_is_percent' => 0,
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @param bool     $disabled
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_price_modifier_template(
-        $ticket_row,
-        $price_row,
-        $price,
-        $default,
-        $disabled = false
-    ) {
-        $select_name = $default && ! $price instanceof EE_Price
-            ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
-            : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]';
-        /** @var EEM_Price_Type $price_type_model */
-        $price_type_model = EE_Registry::instance()->load_model('Price_Type');
-        $price_types = $price_type_model->get_all(array(
-            array(
-                'OR' => array(
-                    'PBT_ID'  => '2',
-                    'PBT_ID*' => '3',
-                ),
-            ),
-        ));
-        $all_price_types = $default && ! $price instanceof EE_Price
-            ? array(esc_html__('Select Modifier', 'event_espresso'))
-            : array();
-        $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type();
-        $price_option_spans = '';
-        //setup price types for selector
-        foreach ($price_types as $price_type) {
-            if (! $price_type instanceof EE_Price_Type) {
-                continue;
-            }
-            $all_price_types[$price_type->ID()] = $price_type->get('PRT_name');
-            //while we're in the loop let's setup the option spans used by js
-            $span_args = array(
-                'PRT_ID'         => $price_type->ID(),
-                'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
-                'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
-            );
-            $price_option_spans .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
-                $span_args,
-                true
-            );
-        }
-        $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' : $select_name;
-        $select_input = new EE_Select_Input(
-            $all_price_types,
-            array(
-                'default'               => $selected_price_type_id,
-                'html_name'             => $select_name,
-                'html_class'            => 'edit-price-PRT_ID',
-                'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"',
-            )
-        );
-        $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+';
-        $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator;
-        $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0;
-        $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent;
-        $template_args = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
-            'PRC_order'                 => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row,
-            'price_modifier_selector'   => $select_input->get_html_for_input(),
-            'main_name'                 => $select_name,
-            'selected_price_type_id'    => $selected_price_type_id,
-            'price_option_spans'        => $price_option_spans,
-            'price_selected_operator'   => $price_selected_operator,
-            'price_selected_is_percent' => $price_selected_is_percent,
-            'disabled'                  => $disabled,
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $disabled,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param int              $datetime_row
-     * @param int              $ticket_row
-     * @param EE_Datetime|null $datetime
-     * @param EE_Ticket|null   $ticket
-     * @param array            $ticket_datetimes
-     * @param bool             $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_datetime_list_item(
-        $datetime_row,
-        $ticket_row,
-        $datetime,
-        $ticket,
-        $ticket_datetimes = array(),
-        $default
-    ) {
-        $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
-            ? $ticket_datetimes[$ticket->ID()]
-            : array();
-        $template_args = array(
-            'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
-                ? 'DTTNUM'
-                : $datetime_row,
-            'tkt_row'                  => $default
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true)
-                ? ' ticket-selected'
-                : '',
-            'ticket_datetime_checked'  => in_array($datetime_row, $tkt_datetimes, true)
-                ? ' checked="checked"'
-                : '',
-            'DTT_name'                 => $default && empty($datetime)
-                ? 'DTTNAME'
-                : $datetime->get_dtt_display_name(true),
-            'tkt_status_class'         => '',
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
-            $template_args,
-            $datetime_row,
-            $ticket_row,
-            $datetime,
-            $ticket,
-            $ticket_datetimes,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-
-    /**
-     * @param array $all_datetimes
-     * @param array $all_tickets
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array())
-    {
-        $template_args = array(
-            'default_datetime_edit_row'                => $this->_get_dtt_edit_row(
-                'DTTNUM',
-                null,
-                true,
-                $all_datetimes
-            ),
-            'default_ticket_row'                       => $this->_get_ticket_row(
-                'TICKETNUM',
-                null,
-                array(),
-                array(),
-                true
-            ),
-            'default_price_row'                        => $this->_get_ticket_price_row(
-                'TICKETNUM',
-                'PRICENUM',
-                null,
-                true,
-                null
-            ),
-            'default_price_rows'                       => '',
-            'default_base_price_amount'                => 0,
-            'default_base_price_name'                  => '',
-            'default_base_price_description'           => '',
-            'default_price_modifier_selector_row'      => $this->_get_price_modifier_template(
-                'TICKETNUM',
-                'PRICENUM',
-                null,
-                true
-            ),
-            'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row(
-                'DTTNUM',
-                null,
-                array(),
-                array(),
-                true
-            ),
-            'existing_available_datetime_tickets_list' => '',
-            'existing_available_ticket_datetimes_list' => '',
-            'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item(
-                'DTTNUM',
-                'TICKETNUM',
-                null,
-                null,
-                array(),
-                true
-            ),
-            'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item(
-                'DTTNUM',
-                'TICKETNUM',
-                null,
-                null,
-                array(),
-                true
-            ),
-        );
-        $ticket_row = 1;
-        foreach ($all_tickets as $ticket) {
-            $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
-                'DTTNUM',
-                $ticket_row,
-                null,
-                $ticket,
-                array(),
-                true
-            );
-            $ticket_row++;
-        }
-        $datetime_row = 1;
-        foreach ($all_datetimes as $datetime) {
-            $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
-                $datetime_row,
-                'TICKETNUM',
-                $datetime,
-                null,
-                array(),
-                true
-            );
-            $datetime_row++;
-        }
-        /** @var EEM_Price $price_model */
-        $price_model = EE_Registry::instance()->load_model('Price');
-        $default_prices = $price_model->get_all_default_prices();
-        $price_row = 1;
-        foreach ($default_prices as $price) {
-            if (! $price instanceof EE_Price) {
-                continue;
-            }
-            if ($price->is_base_price()) {
-                $template_args['default_base_price_amount'] = $price->get_pretty(
-                    'PRC_amount',
-                    'localized_float'
-                );
-                $template_args['default_base_price_name'] = $price->get('PRC_name');
-                $template_args['default_base_price_description'] = $price->get('PRC_desc');
-                $price_row++;
-                continue;
-            }
-            $show_trash = !((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1);
-            $show_create = !(count($default_prices) > 1 && count($default_prices) !== $price_row);
-            $template_args['default_price_rows'] .= $this->_get_ticket_price_row(
-                'TICKETNUM',
-                $price_row,
-                $price,
-                true,
-                null,
-                $show_trash,
-                $show_create
-            );
-            $price_row++;
-        }
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
-            $template_args,
-            $all_datetimes,
-            $all_tickets,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * This property is just used to hold the status of whether an event is currently being
+	 * created (true) or edited (false)
+	 *
+	 * @access protected
+	 * @var bool
+	 */
+	protected $_is_creating_event;
+
+
+	/**
+	 * Used to contain the format strings for date and time that will be used for php date and
+	 * time.
+	 * Is set in the _set_hooks_properties() method.
+	 *
+	 * @var array
+	 */
+	protected $_date_format_strings;
+
+
+	/**
+	 * @var string $_date_time_format
+	 */
+	protected $_date_time_format;
+
+
+
+	/**
+	 *
+	 */
+	protected function _set_hooks_properties()
+	{
+		$this->_name = 'pricing';
+		//capability check
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_default_prices',
+			'advanced_ticket_datetime_metabox'
+		)) {
+			return;
+		}
+		$this->_setup_metaboxes();
+		$this->_set_date_time_formats();
+		$this->_validate_format_strings();
+		$this->_set_scripts_styles();
+		// commented out temporarily until logic is implemented in callback
+		// add_action(
+		//     'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
+		//     array($this, 'autosave_handling')
+		// );
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'caf_updates')
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	protected function _setup_metaboxes()
+	{
+		//if we were going to add our own metaboxes we'd use the below.
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'pricing_metabox',
+				'label'      => esc_html__('Event Tickets & Datetimes', 'event_espresso'),
+				'priority'   => 'high',
+				'context'    => 'normal',
+			),
+		);
+		$this->_remove_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'id'         => 'espresso_event_editor_tickets',
+				'context'    => 'normal',
+			),
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	protected function _set_date_time_formats()
+	{
+		/**
+		 * Format strings for date and time.  Defaults are existing behaviour from 4.1.
+		 * Note, that if you return null as the value for 'date', and 'time' in the array, then
+		 * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
+		 *
+		 * @since 4.6.7
+		 * @var array  Expected an array returned with 'date' and 'time' keys.
+		 */
+		$this->_date_format_strings = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
+			array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a',
+			)
+		);
+		//validate
+		$this->_date_format_strings['date'] = isset($this->_date_format_strings['date'])
+			? $this->_date_format_strings['date']
+			: null;
+		$this->_date_format_strings['time'] = isset($this->_date_format_strings['time'])
+			? $this->_date_format_strings['time']
+			: null;
+		$this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'];
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	protected function _validate_format_strings()
+	{
+		//validate format strings
+		$format_validation = EEH_DTT_Helper::validate_format_string(
+			$this->_date_time_format
+		);
+		if (is_array($format_validation)) {
+			$msg = '<p>';
+			$msg .= sprintf(
+				esc_html__(
+					'The format "%s" was likely added via a filter and is invalid for the following reasons:',
+					'event_espresso'
+				),
+				$this->_date_time_format
+			);
+			$msg .= '</p><ul>';
+			foreach ($format_validation as $error) {
+				$msg .= '<li>' . $error . '</li>';
+			}
+			$msg .= '</ul><p>';
+			$msg .= sprintf(
+				esc_html__(
+					'%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
+					'event_espresso'
+				),
+				'<span style="color:#D54E21;">',
+				'</span>'
+			);
+			$msg .= '</p>';
+			EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_date_format_strings = array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a',
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	protected function _set_scripts_styles()
+	{
+		$this->_scripts_styles = array(
+			'registers'   => array(
+				'ee-tickets-datetimes-css' => array(
+					'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+					'type' => 'css',
+				),
+				'ee-dtt-ticket-metabox'    => array(
+					'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+					'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'),
+				),
+			),
+			'deregisters' => array(
+				'event-editor-css'       => array('type' => 'css'),
+				'event-datetime-metabox' => array('type' => 'js'),
+			),
+			'enqueues'    => array(
+				'ee-tickets-datetimes-css' => array('edit', 'create_new'),
+				'ee-dtt-ticket-metabox'    => array('edit', 'create_new'),
+			),
+			'localize'    => array(
+				'ee-dtt-ticket-metabox' => array(
+					'DTT_TRASH_BLOCK'       => array(
+						'main_warning'            => esc_html__(
+							'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
+							'event_espresso'
+						),
+						'after_warning'           => esc_html__(
+							'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
+							'event_espresso'
+						),
+						'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Cancel', 'event_espresso') . '</button>',
+						'close_button'            => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Close', 'event_espresso') . '</button>',
+						'single_warning_from_tkt' => esc_html__(
+							'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'
+						),
+						'single_warning_from_dtt' => esc_html__(
+							'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'
+						),
+						'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Dismiss', 'event_espresso') . '</button>',
+					),
+					'DTT_ERROR_MSG'         => array(
+						'no_ticket_name' => esc_html__('General Admission', 'event_espresso'),
+						'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">'
+											. esc_html__('Dismiss', 'event_espresso') . '</button></div>',
+					),
+					'DTT_OVERSELL_WARNING'  => array(
+						'datetime_ticket' => esc_html__(
+							'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
+							'event_espresso'
+						),
+						'ticket_datetime' => esc_html__(
+							'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
+							'event_espresso'
+						),
+					),
+					'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats(
+						$this->_date_format_strings['date'],
+						$this->_date_format_strings['time']
+					),
+					'DTT_START_OF_WEEK'     => array('dayValue' => (int)get_option('start_of_week')),
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * @param array $update_callbacks
+	 * @return array
+	 */
+	public function caf_updates(array $update_callbacks)
+	{
+		foreach ($update_callbacks as $key => $callback) {
+			if ($callback[1] === '_default_tickets_update') {
+				unset($update_callbacks[$key]);
+			}
+		}
+		$update_callbacks[] = array($this, 'datetime_and_tickets_caf_update');
+		return $update_callbacks;
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $event The Event object we're attaching data to
+	 * @param  array $data The request data from the form
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function datetime_and_tickets_caf_update($event, $data)
+	{
+		//first we need to start with datetimes cause they are the "root" items attached to events.
+		$saved_datetimes = $this->_update_datetimes($event, $data);
+		//next tackle the tickets (and prices?)
+		$this->_update_tickets($event, $saved_datetimes, $data);
+	}
+
+
+	/**
+	 * update event_datetimes
+	 *
+	 * @param  EE_Event $event Event being updated
+	 * @param  array $data the request data from the form
+	 * @return EE_Datetime[]
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	protected function _update_datetimes($event, $data)
+	{
+		$timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_dtt_ids = array();
+		$saved_dtt_objs = array();
+		if (empty($data['edit_event_datetimes']) || !is_array($data['edit_event_datetimes'])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The "edit_event_datetimes" array is invalid therefore the event can not be updated.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			//trim all values to ensure any excess whitespace is removed.
+			$datetime_data = array_map(
+				function ($datetime_data) {
+					return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
+				},
+				$datetime_data
+			);
+			$datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end'])
+											&& ! empty($datetime_data['DTT_EVT_end'])
+				? $datetime_data['DTT_EVT_end']
+				: $datetime_data['DTT_EVT_start'];
+			$datetime_values = array(
+				'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
+					? $datetime_data['DTT_ID']
+					: null,
+				'DTT_name'        => ! empty($datetime_data['DTT_name'])
+					? $datetime_data['DTT_name']
+					: '',
+				'DTT_description' => ! empty($datetime_data['DTT_description'])
+					? $datetime_data['DTT_description']
+					: '',
+				'DTT_EVT_start'   => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'     => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit'   => empty($datetime_data['DTT_reg_limit'])
+					? EE_INF
+					: $datetime_data['DTT_reg_limit'],
+				'DTT_order'       => ! isset($datetime_data['DTT_order'])
+					? $row
+					: $datetime_data['DTT_order'],
+			);
+			// if we have an id then let's get existing object first and then set the new values.
+			// Otherwise we instantiate a new object for save.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EE_Registry::instance()
+									   ->load_model('Datetime', array($timezone))
+									   ->get_one_by_ID($datetime_data['DTT_ID']);
+				//set date and time format according to what is set in this class.
+				$datetime->set_date_format($this->_date_format_strings['date']);
+				$datetime->set_time_format($this->_date_format_strings['time']);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+				// make sure the $dtt_id here is saved just in case
+				// after the add_relation_to() the autosave replaces it.
+				// We need to do this so we dont' TRASH the parent DTT.
+				// (save the ID for both key and value to avoid duplications)
+				$saved_dtt_ids[$datetime->ID()] = $datetime->ID();
+			} else {
+				$datetime = EE_Registry::instance()->load_class(
+					'Datetime',
+					array(
+						$datetime_values,
+						$timezone,
+						array($this->_date_format_strings['date'], $this->_date_format_strings['time']),
+					),
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			}
+			$datetime->save();
+			$datetime = $event->_add_relation_to($datetime, 'Datetime');
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+				$datetime->save();
+			}
+			//	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
+			// because it is possible there was a new one created for the autosave.
+			// (save the ID for both key and value to avoid duplications)
+			$DTT_ID = $datetime->ID();
+			$saved_dtt_ids[$DTT_ID] = $DTT_ID;
+			$saved_dtt_objs[$row] = $datetime;
+			//todo if ANY of these updates fail then we want the appropriate global error message.
+		}
+		$event->save();
+		// now we need to REMOVE any datetimes that got deleted.
+		// Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them.
+		// So its safe to permanently delete at this point.
+		$old_datetimes = explode(',', $data['datetime_IDs']);
+		$old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes;
+		if (is_array($old_datetimes)) {
+			$datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
+			foreach ($datetimes_to_delete as $id) {
+				$id = absint($id);
+				if (empty($id)) {
+					continue;
+				}
+				$dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
+				//remove tkt relationships.
+				$related_tickets = $dtt_to_remove->get_many_related('Ticket');
+				foreach ($related_tickets as $tkt) {
+					$dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
+				}
+				$event->_remove_relation_to($id, 'Datetime');
+				$dtt_to_remove->refresh_cache_of_related_objects();
+			}
+		}
+		return $saved_dtt_objs;
+	}
+
+
+	/**
+	 * update tickets
+	 *
+	 * @param  EE_Event $event Event object being updated
+	 * @param  EE_Datetime[] $saved_datetimes an array of datetime ids being updated
+	 * @param  array $data incoming request data
+	 * @return EE_Ticket[]
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	protected function _update_tickets($event, $saved_datetimes, $data)
+	{
+		$new_tkt = null;
+		$new_default = null;
+		//stripslashes because WP filtered the $_POST ($data) array to add slashes
+		$data = stripslashes_deep($data);
+		$timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_tickets = $datetimes_on_existing = array();
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+		if(empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])){
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The "edit_tickets" array is invalid therefore the event can not be updated.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$update_prices = $create_new_TKT = false;
+			// figure out what datetimes were added to the ticket
+			// and what datetimes were removed from the ticket in the session.
+			$starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
+			$tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]);
+			$datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
+			$datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map(
+				function ($ticket_data) {
+					return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
+				},
+				$tkt
+			);
+			// note we are doing conversions to floats here instead of allowing EE_Money_Field to handle
+			// because we're doing calculations prior to using the models.
+			// note incoming ['TKT_price'] value is already in standard notation (via js).
+			$ticket_price = isset($tkt['TKT_price'])
+				? round((float)$tkt['TKT_price'], 3)
+				: 0;
+			//note incoming base price needs converted from localized value.
+			$base_price = isset($tkt['TKT_base_price'])
+				? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price'])
+				: 0;
+			//if ticket price == 0 and $base_price != 0 then ticket price == base_price
+			$ticket_price = $ticket_price === 0 && $base_price !== 0
+				? $base_price
+				: $ticket_price;
+			$base_price_id = isset($tkt['TKT_base_price_ID'])
+				? $tkt['TKT_base_price_ID']
+				: 0;
+			$price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row])
+				? $data['edit_prices'][$row]
+				: array();
+			$now = null;
+			if (empty($tkt['TKT_start_date'])) {
+				//lets' use now in the set timezone.
+				$now = new DateTime('now', new DateTimeZone($event->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($this->_date_time_format);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				/**
+				 * set the TKT_end_date to the first datetime attached to the ticket.
+				 */
+				$first_dtt = $saved_datetimes[reset($tkt_dtt_rows)];
+				$tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format);
+			}
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description'])
+									 && $tkt['TKT_description'] !== esc_html__(
+					'You can modify this description',
+					'event_espresso'
+				)
+					? $tkt['TKT_description']
+					: '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === ''
+					? EE_INF
+					: $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === ''
+					? EE_INF
+					: $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
+				'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
+				'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
+				'TKT_price'       => $ticket_price,
+			);
+			// if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly,
+			// which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID'] = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$update_prices = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of doing any add_relations to
+			// because its entirely possible that this ticket wasn't removed or added to any datetime in the session
+			// but DID have it's items modified.
+			// keep in mind that if the TKT has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (absint($TKT_values['TKT_ID'])) {
+				$ticket = EE_Registry::instance()
+									 ->load_model('Ticket', array($timezone))
+									 ->get_one_by_ID($tkt['TKT_ID']);
+				if ($ticket instanceof EE_Ticket) {
+					$ticket = $this->_update_ticket_datetimes(
+						$ticket,
+						$saved_datetimes,
+						$datetimes_added,
+						$datetimes_removed
+					);
+					// are there any registrations using this ticket ?
+					$tickets_sold = $ticket->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)),
+							),
+						)
+					);
+					//set ticket formats
+					$ticket->set_date_format($this->_date_format_strings['date']);
+					$ticket->set_time_format($this->_date_format_strings['time']);
+					// let's just check the total price for the existing ticket
+					// and determine if it matches the new total price.
+					// if they are different then we create a new ticket (if tickets sold)
+					// if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted();
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field === 'TKT_qty') {
+							$ticket->set_qty($value);
+						} else {
+							$ticket->set($field, $value);
+						}
+					}
+					// if $create_new_TKT is false then we can safely update the existing ticket.
+					// Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						$new_tkt = $this->_duplicate_ticket($ticket, $price_rows, $ticket_price, $base_price,
+							$base_price_id);
+					}
+				}
+			} else {
+				// no TKT_id so a new TKT
+				$ticket = EE_Ticket::new_instance(
+					$TKT_values,
+					$timezone,
+					array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
+				);
+				if ($ticket instanceof EE_Ticket) {
+					// make sure ticket has an ID of setting relations won't work
+					$ticket->save();
+					$ticket = $this->_update_ticket_datetimes(
+						$ticket,
+						$saved_datetimes,
+						$datetimes_added,
+						$datetimes_removed
+					);
+					$update_prices = true;
+				}
+			}
+			//make sure any current values have been saved.
+			//$ticket->save();
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+			}
+			//let's make sure the base price is handled
+			$ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $ticket, $update_prices, $base_price,
+				$base_price_id) : $ticket;
+			//add/update price_modifiers
+			$ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) : $ticket;
+			//need to make sue that the TKT_price is accurate after saving the prices.
+			$ticket->ensure_TKT_Price_correct();
+			//handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
+			if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
+				$update_prices = true;
+				$new_default = clone $ticket;
+				$new_default->set('TKT_ID', 0);
+				$new_default->set('TKT_is_default', 1);
+				$new_default->set('TKT_row', 1);
+				$new_default->set('TKT_price', $ticket_price);
+				// remove any dtt relations cause we DON'T want dtt relations attached
+				// (note this is just removing the cached relations in the object)
+				$new_default->_remove_relations('Datetime');
+				//todo we need to add the current attached prices as new prices to the new default ticket.
+				$new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices);
+				//don't forget the base price!
+				$new_default = $this->_add_prices_to_ticket(
+					array(),
+					$new_default,
+					$update_prices,
+					$base_price,
+					$base_price_id
+				);
+				$new_default->save();
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket',
+					$new_default,
+					$row,
+					$ticket,
+					$data
+				);
+			}
+			// DO ALL dtt relationships for both current tickets and any archived tickets
+			// for the given dtt that are related to the current ticket.
+			// TODO... not sure exactly how we're going to do this considering we don't know
+			// what current ticket the archived tickets are related to
+			// (and TKT_parent is used for autosaves so that's not a field we can reliably use).
+			//let's assign any tickets that have been setup to the saved_tickets tracker
+			//save existing TKT
+			$ticket->save();
+			if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
+				//save new TKT
+				$new_tkt->save();
+				//add new ticket to array
+				$saved_tickets[$new_tkt->ID()] = $new_tkt;
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
+					$new_tkt,
+					$row,
+					$tkt,
+					$data
+				);
+			} else {
+				//add tkt to saved tkts
+				$saved_tickets[$ticket->ID()] = $ticket;
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
+					$ticket,
+					$row,
+					$tkt,
+					$data
+				);
+			}
+		}
+		// now we need to handle tickets actually "deleted permanently".
+		// There are cases where we'd want this to happen
+		// (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
+		// Or a draft event was saved and in the process of editing a ticket is trashed.
+		// No sense in keeping all the related data in the db!
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
+			if ($tkt_to_remove->get('TKT_is_default')) {
+				continue;
+			}
+			// if this tkt has any registrations attached so then we just ARCHIVE
+			// because we don't actually permanently delete these tickets.
+			if ($tkt_to_remove->count_related('Registration') > 0) {
+				$tkt_to_remove->delete();
+				continue;
+			}
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tkts_sold)
+			$datetimes = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($datetimes as $datetime) {
+				$tkt_to_remove->_remove_relation_to($datetime, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return $saved_tickets;
+	}
+
+
+
+	/**
+	 * @access  protected
+	 * @param \EE_Ticket     $ticket
+	 * @param \EE_Datetime[] $saved_datetimes
+	 * @param \EE_Datetime[] $added_datetimes
+	 * @param \EE_Datetime[] $removed_datetimes
+	 * @return \EE_Ticket
+	 * @throws \EE_Error
+	 */
+	protected function _update_ticket_datetimes(
+		EE_Ticket $ticket,
+		$saved_datetimes = array(),
+		$added_datetimes = array(),
+		$removed_datetimes = array()
+	) {
+		// to start we have to add the ticket to all the datetimes its supposed to be with,
+		// and removing the ticket from datetimes it got removed from.
+		// first let's add datetimes
+		if (! empty($added_datetimes) && is_array($added_datetimes)) {
+			foreach ($added_datetimes as $row_id) {
+				$row_id = (int)$row_id;
+				if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+					$ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to add that to the DTT sold because this DTT is getting added.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[$row_id]->increase_sold($ticket->sold());
+						$saved_datetimes[$row_id]->save();
+					}
+				}
+			}
+		}
+		// then remove datetimes
+		if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
+			foreach ($removed_datetimes as $row_id) {
+				$row_id = (int)$row_id;
+				// its entirely possible that a datetime got deleted (instead of just removed from relationship.
+				// So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
+				if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+					$ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to remove it's sold from the DTT_sold.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[$row_id]->decrease_sold($ticket->sold());
+						$saved_datetimes[$row_id]->save();
+					}
+				}
+			}
+		}
+		// cap ticket qty by datetime reg limits
+		$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+		return $ticket;
+	}
+
+
+
+	/**
+	 * @access  protected
+	 * @param \EE_Ticket $ticket
+	 * @param array      $price_rows
+	 * @param int        $ticket_price
+	 * @param int        $base_price
+	 * @param int        $base_price_id
+	 * @return \EE_Ticket
+	 * @throws \EE_Error
+	 */
+	protected function _duplicate_ticket(
+		EE_Ticket $ticket,
+		$price_rows = array(),
+		$ticket_price = 0,
+		$base_price = 0,
+		$base_price_id = 0
+	) {
+		// create new ticket that's a copy of the existing
+		// except a new id of course (and not archived)
+		// AND has the new TKT_price associated with it.
+		$new_ticket = clone $ticket;
+		$new_ticket->set('TKT_ID', 0);
+		$new_ticket->set_deleted(0);
+		$new_ticket->set_price($ticket_price);
+		$new_ticket->set_sold(0);
+		// let's get a new ID for this ticket
+		$new_ticket->save();
+		// we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
+		$datetimes_on_existing = $ticket->datetimes();
+		$new_ticket = $this->_update_ticket_datetimes(
+			$new_ticket,
+			$datetimes_on_existing,
+			array_keys($datetimes_on_existing)
+		);
+		// $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
+		// if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
+		// available.
+		if ($ticket->sold() > 0) {
+			$new_qty = $ticket->qty() - $ticket->sold();
+			$new_ticket->set_qty($new_qty);
+		}
+		//now we update the prices just for this ticket
+		$new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
+		//and we update the base price
+		$new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id);
+		return $new_ticket;
+	}
+
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices        Array of prices from the form.
+	 * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
+	 * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
+	 * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
+	 * @return EE_Ticket
+	 * @throws EE_Error
+	 */
+	protected function _add_prices_to_ticket(
+		$prices = array(),
+		EE_Ticket $ticket,
+		$new_prices = false,
+		$base_price = false,
+		$base_price_id = false
+	) {
+		// let's just get any current prices that may exist on the given ticket
+		// so we can remove any prices that got trashed in this session.
+		$current_prices_on_ticket = $base_price !== false
+			? $ticket->base_price(true)
+			: $ticket->price_modifiers();
+		$updated_prices = array();
+		// if $base_price ! FALSE then updating a base price.
+		if ($base_price !== false) {
+			$prices[1] = array(
+				'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
+				'PRT_ID'     => 1,
+				'PRC_amount' => $base_price,
+				'PRC_name'   => $ticket->get('TKT_name'),
+				'PRC_desc'   => $ticket->get('TKT_description'),
+			);
+		}
+		//possibly need to save tkt
+		if (! $ticket->ID()) {
+			$ticket->save();
+		}
+		foreach ($prices as $row => $prc) {
+			$prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
+			if (empty($prt_id)) {
+				continue;
+			} //prices MUST have a price type id.
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => $prt_id,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => false,
+				//make sure we set PRC_is_default to false for all ticket saves from event_editor
+				'PRC_order'      => $row,
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$price = EE_Registry::instance()->load_class(
+					'Price',
+					array($PRC_values),
+					false,
+					false
+				);
+			} else {
+				$price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $value) {
+					$price->set($field, $value);
+				}
+			}
+			$price->save();
+			$updated_prices[$price->ID()] = $price;
+			$ticket->_add_relation_to($price, 'Price');
+		}
+		//now let's remove any prices that got removed from the ticket
+		if (! empty ($current_prices_on_ticket)) {
+			$current = array_keys($current_prices_on_ticket);
+			$updated = array_keys($updated_prices);
+			$prices_to_remove = array_diff($current, $updated);
+			if (! empty($prices_to_remove)) {
+				foreach ($prices_to_remove as $prc_id) {
+					$p = $current_prices_on_ticket[$prc_id];
+					$ticket->_remove_relation_to($p, 'Price');
+					//delete permanently the price
+					$p->delete_permanently();
+				}
+			}
+		}
+		return $ticket;
+	}
+
+
+
+	/**
+	 * @param Events_Admin_Page $event_admin_obj
+	 * @return Events_Admin_Page
+	 */
+	public function autosave_handling( Events_Admin_Page $event_admin_obj)
+	{
+		return $event_admin_obj;
+		//doing nothing for the moment.
+		// todo when I get to this remember that I need to set the template args on the $event_admin_obj
+		// (use the set_template_args() method)
+		/**
+		 * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
+		 * 1. TKT_is_default_selector (visible)
+		 * 2. TKT_is_default (hidden)
+		 * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket
+		 * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want
+		 * this ticket to be saved as a default.
+		 * The tricky part is, on an initial display on create or edit (or after manually updating),
+		 * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true
+		 * if this is a create.  However, after an autosave, users will want some sort of indicator that
+		 * the TKT HAS been saved as a default..
+		 * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
+		 * On Autosave:
+		 * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements,
+		 * then set the TKT_is_default to false.
+		 * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).
+		 *  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
+		 * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
+		 */
+	}
+
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function pricing_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
+		$event = $this->_adminpage_obj->get_cpt_model_obj();
+		//set is_creating_event property.
+		$EVT_ID = $event->ID();
+		$this->_is_creating_event = absint($EVT_ID) === 0;
+		//default main template args
+		$main_template_args = array(
+			'event_datetime_help_link' => EEH_Template::get_help_tab_link(
+				'event_editor_event_datetimes_help_tab',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			// todo need to add a filter to the template for the help text
+			// in the Events_Admin_Page core file so we can add further help
+			'existing_datetime_ids'    => '',
+			'total_dtt_rows'           => 1,
+			'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link(
+				'add_new_dtt_info',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'datetime_rows'            => '',
+			'show_tickets_container'   => '',
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'ee_collapsible_status'    => ' ee-collapsible-open'
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
+		);
+		$timezone = $event instanceof EE_Event ? $event->timezone_string() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. For each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		/** @var EEM_Datetime $datetime_model */
+		$datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone));
+		$datetimes = $datetime_model->get_all_event_dates($EVT_ID);
+		$main_template_args['total_dtt_rows'] = count($datetimes);
+		/**
+		 * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486
+		 * for why we are counting $datetime_row and then setting that on the Datetime object
+		 */
+		$datetime_row = 1;
+		foreach ($datetimes as $datetime) {
+			$DTT_ID = $datetime->get('DTT_ID');
+			$datetime->set('DTT_order', $datetime_row);
+			$existing_datetime_ids[] = $DTT_ID;
+			//tickets attached
+			$related_tickets = $datetime->ID() > 0
+				? $datetime->get_many_related(
+					'Ticket',
+					array(
+						array(
+							'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0),
+						),
+						'default_where_conditions' => 'none',
+						'order_by'                 => array('TKT_order' => 'ASC'),
+					)
+				)
+				: array();
+			//if there are no related tickets this is likely a new event OR autodraft
+			// event so we need to generate the default tickets because datetimes
+			// ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
+			// datetime on the event.
+			if (empty ($related_tickets) && count($datetimes) < 2) {
+				/** @var EEM_Ticket $ticket_model */
+				$ticket_model = EE_Registry::instance()->load_model('Ticket');
+				$related_tickets = $ticket_model->get_all_default_tickets();
+				// this should be ordered by TKT_ID, so let's grab the first default ticket
+				// (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
+				$default_prices = EEM_Price::instance()->get_all_default_prices();
+				$main_default_ticket = reset($related_tickets);
+				if ($main_default_ticket instanceof EE_Ticket) {
+					foreach ($default_prices as $default_price) {
+						if ($default_price instanceof EE_Price && $default_price->is_base_price()) {
+							continue;
+						}
+						$main_default_ticket->cache('Price', $default_price);
+					}
+				}
+			}
+			// we can't actually setup rows in this loop yet cause we don't know all
+			// the unique tickets for this event yet (tickets are linked through all datetimes).
+			// So we're going to temporarily cache some of that information.
+			//loop through and setup the ticket rows and make sure the order is set.
+			foreach ($related_tickets as $ticket) {
+				$TKT_ID = $ticket->get('TKT_ID');
+				$ticket_row = $ticket->get('TKT_row');
+				//we only want unique tickets in our final display!!
+				if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
+					$existing_ticket_ids[] = $TKT_ID;
+					$all_tickets[] = $ticket;
+				}
+				//temporary cache of this ticket info for this datetime for later processing of datetime rows.
+				$datetime_tickets[$DTT_ID][] = $ticket_row;
+				//temporary cache of this datetime info for this ticket for later processing of ticket rows.
+				if (
+					! isset($ticket_datetimes[$TKT_ID])
+					|| ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true)
+				) {
+					$ticket_datetimes[$TKT_ID][] = $datetime_row;
+				}
+			}
+			$datetime_row++;
+		}
+		$main_template_args['total_ticket_rows'] = count($existing_ticket_ids);
+		$main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
+		$main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		//sort $all_tickets by order
+		usort(
+			$all_tickets,
+			function (EE_Ticket $a, EE_Ticket $b) {
+				$a_order = (int)$a->get('TKT_order');
+				$b_order = (int)$b->get('TKT_order');
+				if ($a_order === $b_order) {
+					return 0;
+				}
+				return ($a_order < $b_order) ? -1 : 1;
+			}
+		);
+		// k NOW we have all the data we need for setting up the dtt rows
+		// and ticket rows so we start our dtt loop again.
+		$datetime_row = 1;
+		foreach ($datetimes as $datetime) {
+			$main_template_args['datetime_rows'] .= $this->_get_datetime_row(
+				$datetime_row,
+				$datetime,
+				$datetime_tickets,
+				$all_tickets,
+				false,
+				$datetimes
+			);
+			$datetime_row++;
+		}
+		//then loop through all tickets for the ticket rows.
+		$ticket_row = 1;
+		foreach ($all_tickets as $ticket) {
+			$main_template_args['ticket_rows'] .= $this->_get_ticket_row(
+				$ticket_row,
+				$ticket,
+				$ticket_datetimes,
+				$datetimes,
+				false,
+				$all_tickets
+			);
+			$ticket_row++;
+		}
+		$main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets);
+		EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
+			$main_template_args
+		);
+	}
+
+
+
+	/**
+	 * @param int         $datetime_row
+	 * @param EE_Datetime $datetime
+	 * @param array       $datetime_tickets
+	 * @param array       $all_tickets
+	 * @param bool        $default
+	 * @param array       $all_datetimes
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_row(
+		$datetime_row,
+		EE_Datetime $datetime,
+		$datetime_tickets = array(),
+		$all_tickets = array(),
+		$default = false,
+		$all_datetimes = array()
+	) {
+		$dtt_display_template_args = array(
+			'dtt_edit_row'             => $this->_get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes),
+			'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row(
+				$datetime_row,
+				$datetime,
+				$datetime_tickets,
+				$all_tickets,
+				$default
+			),
+			'dtt_row'                  => $default ? 'DTTNUM' : $datetime_row,
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
+			$dtt_display_template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * This method is used to generate a dtt fields  edit row.
+	 * The same row is used to generate a row with valid DTT objects
+	 * and the default row that is used as the skeleton by the js.
+	 *
+	 * @param int           $datetime_row  The row number for the row being generated.
+	 * @param EE_Datetime   $datetime
+	 * @param bool          $default       Whether a default row is being generated or not.
+	 * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor.
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes)
+	{
+		// if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true.
+		$default = ! $datetime instanceof EE_Datetime ? true : $default;
+		$template_args = array(
+			'dtt_row'              => $default ? 'DTTNUM' : $datetime_row,
+			'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'edit_dtt_expanded'    => '',
+			'DTT_ID'               => $default ? '' : $datetime->ID(),
+			'DTT_name'             => $default ? '' : $datetime->name(),
+			'DTT_description'      => $default ? '' : $datetime->description(),
+			'DTT_EVT_start'        => $default ? '' : $datetime->start_date($this->_date_time_format),
+			'DTT_EVT_end'          => $default ? '' : $datetime->end_date($this->_date_time_format),
+			'DTT_reg_limit'        => $default
+				? ''
+				: $datetime->get_pretty(
+					'DTT_reg_limit',
+					'input'
+				),
+			'DTT_order'            => $default ? 'DTTNUM' : $datetime_row,
+			'dtt_sold'             => $default ? '0' : $datetime->get('DTT_sold'),
+			'dtt_reserved'         => $default ? '0' : $datetime->reserved(),
+			'clone_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
+				? ''
+				: 'clone-icon ee-icon ee-icon-clone clickable',
+			'trash_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
+				? 'ee-lock-icon'
+				: 'trash-icon dashicons dashicons-post-trash clickable',
+			'reg_list_url'         => $default || ! $datetime->event() instanceof \EE_Event
+				? ''
+				: EE_Admin_Page::add_query_args_and_nonce(
+					array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()),
+					REG_ADMIN_URL
+				),
+		);
+		$template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
+			? ' style="display:none"'
+			: '';
+		//allow filtering of template args at this point.
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
+			$template_args,
+			$datetime_row,
+			$datetime,
+			$default,
+			$all_datetimes,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int         $datetime_row
+	 * @param EE_Datetime $datetime
+	 * @param array       $datetime_tickets
+	 * @param array       $all_tickets
+	 * @param bool        $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_dtt_attached_tickets_row(
+		$datetime_row,
+		$datetime,
+		$datetime_tickets = array(),
+		$all_tickets = array(),
+		$default
+	) {
+		$template_args = array(
+			'dtt_row'                           => $default ? 'DTTNUM' : $datetime_row,
+			'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'DTT_description'                   => $default ? '' : $datetime->description(),
+			'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
+			'show_tickets_row'                  => ' style="display:none;"',
+			'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link(
+				'add_new_ticket_via_datetime',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'DTT_ID'                            => $default ? '' : $datetime->ID(),
+		);
+		//need to setup the list items (but only if this isn't a default skeleton setup)
+		if (! $default) {
+			$ticket_row = 1;
+			foreach ($all_tickets as $ticket) {
+				$template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
+					$datetime_row,
+					$ticket_row,
+					$datetime,
+					$ticket,
+					$datetime_tickets,
+					$default
+				);
+				$ticket_row++;
+			}
+		}
+		//filter template args at this point
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
+			$template_args,
+			$datetime_row,
+			$datetime,
+			$datetime_tickets,
+			$all_tickets,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int         $datetime_row
+	 * @param int         $ticket_row
+	 * @param EE_Datetime $datetime
+	 * @param EE_Ticket   $ticket
+	 * @param array       $datetime_tickets
+	 * @param bool        $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_tickets_list_item(
+		$datetime_row,
+		$ticket_row,
+		$datetime,
+		$ticket,
+		$datetime_tickets = array(),
+		$default
+	) {
+		$dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()])
+			? $datetime_tickets[$datetime->ID()]
+			: array();
+		$display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
+		$no_ticket = $default && empty($ticket);
+		$template_args = array(
+			'dtt_row'                 => $default
+				? 'DTTNUM'
+				: $datetime_row,
+			'tkt_row'                 => $no_ticket
+				? 'TICKETNUM'
+				: $ticket_row,
+			'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true)
+				? ' checked="checked"'
+				: '',
+			'ticket_selected'         => in_array($display_row, $dtt_tkts, true)
+				? ' ticket-selected'
+				: '',
+			'TKT_name'                => $no_ticket
+				? 'TKTNAME'
+				: $ticket->get('TKT_name'),
+			'tkt_status_class'        => $no_ticket || $this->_is_creating_event
+				? ' tkt-status-' . EE_Ticket::onsale
+				: ' tkt-status-' . $ticket->ticket_status(),
+		);
+		//filter template args
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
+			$template_args,
+			$datetime_row,
+			$ticket_row,
+			$datetime,
+			$ticket,
+			$datetime_tickets,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * This generates the ticket row for tickets.
+	 * This same method is used to generate both the actual rows and the js skeleton row
+	 * (when default === true)
+	 *
+	 * @param int           $ticket_row       Represents the row number being generated.
+	 * @param               $ticket
+	 * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket
+	 *                                        or empty for default
+	 * @param EE_Datetime[] $all_datetimes    All Datetimes on the event or empty for default.
+	 * @param bool          $default          Whether default row being generated or not.
+	 * @param EE_Ticket[]   $all_tickets      This is an array of all tickets attached to the event
+	 *                                        (or empty in the case of defaults)
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_row(
+		$ticket_row,
+		$ticket,
+		$ticket_datetimes,
+		$all_datetimes,
+		$default = false,
+		$all_tickets = array()
+	) {
+		// if $ticket is not an instance of EE_Ticket then force default to true.
+		$default = ! $ticket instanceof EE_Ticket ? true : $default;
+		$prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
+			array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
+		// if there is only one price (which would be the base price)
+		// or NO prices and this ticket is a default ticket,
+		// let's just make sure there are no cached default prices on the object.
+		// This is done by not including any query_params.
+		if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
+			$prices = $ticket->prices();
+		}
+		// check if we're dealing with a default ticket in which case
+		// we don't want any starting_ticket_datetime_row values set
+		// (otherwise there won't be any new relationships created for tickets based off of the default ticket).
+		// This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
+		$default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
+		$tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+			? $ticket_datetimes[$ticket->ID()]
+			: array();
+		$ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal();
+		$base_price = $default ? null : $ticket->base_price();
+		$count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
+		//breaking out complicated condition for ticket_status
+		if ($default) {
+			$ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+		} else {
+			$ticket_status_class = $ticket->is_default()
+				? ' tkt-status-' . EE_Ticket::onsale
+				: ' tkt-status-' . $ticket->ticket_status();
+		}
+		//breaking out complicated condition for TKT_taxable
+		if ($default) {
+			$TKT_taxable = '';
+		} else {
+			$TKT_taxable = $ticket->taxable()
+				? ' checked="checked"'
+				: '';
+		}
+		if ($default) {
+			$TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
+		} elseif ($ticket->is_default()) {
+			$TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
+		} else {
+			$TKT_status = $ticket->ticket_status(true);
+		}
+		if ($default) {
+			$TKT_min = '';
+		} else {
+			$TKT_min = $ticket->min();
+			if ($TKT_min === -1 || $TKT_min === 0) {
+				$TKT_min = '';
+			}
+		}
+		$template_args = array(
+			'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
+			'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
+			//on initial page load this will always be the correct order.
+			'tkt_status_class'              => $ticket_status_class,
+			'display_edit_tkt_row'          => ' style="display:none;"',
+			'edit_tkt_expanded'             => '',
+			'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_name'                      => $default ? '' : $ticket->name(),
+			'TKT_start_date'                => $default
+				? ''
+				: $ticket->get_date('TKT_start_date', $this->_date_time_format),
+			'TKT_end_date'                  => $default
+				? ''
+				: $ticket->get_date('TKT_end_date', $this->_date_time_format),
+			'TKT_status'                    => $TKT_status,
+			'TKT_price'                     => $default
+				? ''
+				: EEH_Template::format_currency(
+					$ticket->get_ticket_total_with_taxes(),
+					false,
+					false
+				),
+			'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
+			'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
+			'TKT_qty'                       => $default
+				? ''
+				: $ticket->get_pretty('TKT_qty', 'symbol'),
+			'TKT_qty_for_input'             => $default
+				? ''
+				: $ticket->get_pretty('TKT_qty', 'input'),
+			'TKT_uses'                      => $default
+				? ''
+				: $ticket->get_pretty('TKT_uses', 'input'),
+			'TKT_min'                       => $TKT_min,
+			'TKT_max'                       => $default
+				? ''
+				: $ticket->get_pretty('TKT_max', 'input'),
+			'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
+			'TKT_reserved'                  => $default ? 0 : $ticket->reserved(),
+			'TKT_registrations'             => $default
+				? 0
+				: $ticket->count_registrations(
+					array(
+						array(
+							'STS_ID' => array(
+								'!=',
+								EEM_Registration::status_id_incomplete,
+							),
+						),
+					)
+				),
+			'TKT_ID'                        => $default ? 0 : $ticket->ID(),
+			'TKT_description'               => $default ? '' : $ticket->get_pretty('TKT_description', 'form_input'),
+			'TKT_is_default'                => $default ? 0 : $ticket->is_default(),
+			'TKT_required'                  => $default ? 0 : $ticket->required(),
+			'TKT_is_default_selector'       => '',
+			'ticket_price_rows'             => '',
+			'TKT_base_price'                => $default || ! $base_price instanceof EE_Price
+				? ''
+				: $base_price->get_pretty('PRC_amount', 'localized_float'),
+			'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
+			'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0)
+				? ''
+				: ' style="display:none;"',
+			'show_price_mod_button'         => count($prices) > 1
+											   || ($default && $count_price_mods > 0)
+											   || (! $default && $ticket->deleted())
+				? ' style="display:none;"'
+				: '',
+			'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
+			'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
+			'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes),
+			'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_datetimes),
+			'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
+			'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
+			'TKT_taxable'                   => $TKT_taxable,
+			'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->taxable()
+				? ''
+				: ' style="display:none"',
+			'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
+			'TKT_subtotal_amount_display'   => EEH_Template::format_currency(
+				$ticket_subtotal,
+				false,
+				false
+			),
+			'TKT_subtotal_amount'           => $ticket_subtotal,
+			'tax_rows'                      => $this->_get_tax_rows($ticket_row, $ticket),
+			'disabled'                      => $ticket instanceof EE_Ticket && $ticket->deleted(),
+			'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->deleted()
+				? ' ticket-archived'
+				: '',
+			'trash_icon'                    => $ticket instanceof EE_Ticket
+											   && $ticket->deleted()
+											   && ! $ticket->is_permanently_deleteable()
+				? 'ee-lock-icon '
+				: 'trash-icon dashicons dashicons-post-trash clickable',
+			'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->deleted()
+				? ''
+				: 'clone-icon ee-icon ee-icon-clone clickable',
+		);
+		$template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
+			? ' style="display:none"'
+			: '';
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date($this->_date_time_format,
+				current_time('timestamp'));
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0
+				? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related(
+					'Datetime',
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
+				)
+				: null;
+			if (! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime(
+					'DTT_EVT_start',
+					$this->_date_time_format
+				);
+			} else {
+				//default so let's just use what's been set for the default date-time which is 30 days from now.
+				$template_args['TKT_end_date'] = date(
+					$this->_date_time_format,
+					mktime(24, 0, 0, date('m'), date('d') + 29, date('Y')
+					)
+				);
+			}
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+		//generate ticket_datetime items
+		if (! $default) {
+			$datetime_row = 1;
+			foreach ($all_datetimes as $datetime) {
+				$template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
+					$datetime_row,
+					$ticket_row,
+					$datetime,
+					$ticket,
+					$ticket_datetimes,
+					$default
+				);
+				$datetime_row++;
+			}
+		}
+		$price_row = 1;
+		foreach ($prices as $price) {
+			if (! $price instanceof EE_Price)  {
+				continue;
+			}
+			if ($price->is_base_price()) {
+				$price_row++;
+				continue;
+			}
+			$show_trash = !((count($prices) > 1 && $price_row === 1) || count($prices) === 1);
+			$show_create = !(count($prices) > 1 && count($prices) !== $price_row);
+			$template_args['ticket_price_rows'] .= $this->_get_ticket_price_row(
+				$ticket_row,
+				$price_row,
+				$price,
+				$default,
+				$ticket,
+				$show_trash,
+				$show_create
+			);
+			$price_row++;
+		}
+		//filter $template_args
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
+			$template_args,
+			$ticket_row,
+			$ticket,
+			$ticket_datetimes,
+			$all_datetimes,
+			$default,
+			$all_tickets,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int            $ticket_row
+	 * @param EE_Ticket|null $ticket
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_tax_rows($ticket_row, $ticket)
+	{
+		$tax_rows = '';
+		/** @var EE_Price[] $taxes */
+		$taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
+		foreach ($taxes as $tax) {
+			$tax_added = $this->_get_tax_added($tax, $ticket);
+			$template_args = array(
+				'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable')
+					? ''
+					: ' style="display:none;"',
+				'tax_id'            => $tax->ID(),
+				'tkt_row'           => $ticket_row,
+				'tax_label'         => $tax->get('PRC_name'),
+				'tax_added'         => $tax_added,
+				'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
+				'tax_amount'        => $tax->get('PRC_amount'),
+			);
+			$template_args = apply_filters(
+				'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
+				$template_args,
+				$ticket_row,
+				$ticket,
+				$this->_is_creating_event
+			);
+			$tax_rows .= EEH_Template::display_template(
+				PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $tax_rows;
+	}
+
+
+
+	/**
+	 * @param EE_Price       $tax
+	 * @param EE_Ticket|null $ticket
+	 * @return float|int
+	 * @throws EE_Error
+	 */
+	protected function _get_tax_added(EE_Price $tax, $ticket)
+	{
+		$subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
+		return $subtotal * $tax->get('PRC_amount') / 100;
+	}
+
+
+
+	/**
+	 * @param int            $ticket_row
+	 * @param int            $price_row
+	 * @param EE_Price|null  $price
+	 * @param bool           $default
+	 * @param EE_Ticket|null $ticket
+	 * @param bool           $show_trash
+	 * @param bool           $show_create
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_price_row(
+		$ticket_row,
+		$price_row,
+		$price,
+		$default,
+		$ticket,
+		$show_trash = true,
+		$show_create = true
+	) {
+		$send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted');
+		$template_args = array(
+			'tkt_row'               => $default && empty($ticket)
+				? 'TICKETNUM'
+				: $ticket_row,
+			'PRC_order'             => $default && empty($price)
+				? 'PRICENUM'
+				: $price_row,
+			'edit_prices_name'      => $default && empty($price)
+				? 'PRICENAMEATTR'
+				: 'edit_prices',
+			'price_type_selector'   => $default && empty($price)
+				? $this->_get_base_price_template($ticket_row, $price_row, $price, $default)
+				: $this->_get_price_type_selector($ticket_row, $price_row, $price, $default, $send_disabled),
+			'PRC_ID'                => $default && empty($price)
+				? 0
+				: $price->ID(),
+			'PRC_is_default'        => $default && empty($price)
+				? 0
+				: $price->get('PRC_is_default'),
+			'PRC_name'              => $default && empty($price)
+				? ''
+				: $price->get('PRC_name'),
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'show_plus_or_minus'    => $default && empty($price)
+				? ''
+				: ' style="display:none;"',
+			'show_plus'             => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price())
+				? ' style="display:none;"'
+				: '',
+			'show_minus'            => ($default && empty($price)) || ! $price->is_discount()
+				? ' style="display:none;"'
+				: '',
+			'show_currency_symbol'  => ($default && empty($price)) || $price->is_percent()
+				? ' style="display:none"'
+				: '',
+			'PRC_amount'            => $default && empty($price)
+				? 0
+				: $price->get_pretty('PRC_amount',
+					'localized_float'),
+			'show_percentage'       => ($default && empty($price)) || ! $price->is_percent()
+				? ' style="display:none;"'
+				: '',
+			'show_trash_icon'       => $show_trash
+				? ''
+				: ' style="display:none;"',
+			'show_create_button'    => $show_create
+				? ''
+				: ' style="display:none;"',
+			'PRC_desc'              => $default && empty($price)
+				? ''
+				: $price->get('PRC_desc'),
+			'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted'),
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$ticket,
+			$show_trash,
+			$show_create,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @param bool     $disabled
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false)
+	{
+		if ($price->is_base_price()) {
+			return $this->_get_base_price_template($ticket_row, $price_row, $price, $default);
+		}
+		return $this->_get_price_modifier_template($ticket_row, $price_row, $price, $default, $disabled);
+	}
+
+
+
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_base_price_template($ticket_row, $price_row, $price, $default)
+	{
+		$template_args = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
+			'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $price_row,
+			'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
+			'PRT_name'                  => esc_html__('Price', 'event_espresso'),
+			'price_selected_operator'   => '+',
+			'price_selected_is_percent' => 0,
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @param bool     $disabled
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_price_modifier_template(
+		$ticket_row,
+		$price_row,
+		$price,
+		$default,
+		$disabled = false
+	) {
+		$select_name = $default && ! $price instanceof EE_Price
+			? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
+			: 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]';
+		/** @var EEM_Price_Type $price_type_model */
+		$price_type_model = EE_Registry::instance()->load_model('Price_Type');
+		$price_types = $price_type_model->get_all(array(
+			array(
+				'OR' => array(
+					'PBT_ID'  => '2',
+					'PBT_ID*' => '3',
+				),
+			),
+		));
+		$all_price_types = $default && ! $price instanceof EE_Price
+			? array(esc_html__('Select Modifier', 'event_espresso'))
+			: array();
+		$selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type();
+		$price_option_spans = '';
+		//setup price types for selector
+		foreach ($price_types as $price_type) {
+			if (! $price_type instanceof EE_Price_Type) {
+				continue;
+			}
+			$all_price_types[$price_type->ID()] = $price_type->get('PRT_name');
+			//while we're in the loop let's setup the option spans used by js
+			$span_args = array(
+				'PRT_ID'         => $price_type->ID(),
+				'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
+				'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
+			);
+			$price_option_spans .= EEH_Template::display_template(
+				PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
+				$span_args,
+				true
+			);
+		}
+		$select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' : $select_name;
+		$select_input = new EE_Select_Input(
+			$all_price_types,
+			array(
+				'default'               => $selected_price_type_id,
+				'html_name'             => $select_name,
+				'html_class'            => 'edit-price-PRT_ID',
+				'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"',
+			)
+		);
+		$price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+';
+		$price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator;
+		$price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0;
+		$price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent;
+		$template_args = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
+			'PRC_order'                 => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row,
+			'price_modifier_selector'   => $select_input->get_html_for_input(),
+			'main_name'                 => $select_name,
+			'selected_price_type_id'    => $selected_price_type_id,
+			'price_option_spans'        => $price_option_spans,
+			'price_selected_operator'   => $price_selected_operator,
+			'price_selected_is_percent' => $price_selected_is_percent,
+			'disabled'                  => $disabled,
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$disabled,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param int              $datetime_row
+	 * @param int              $ticket_row
+	 * @param EE_Datetime|null $datetime
+	 * @param EE_Ticket|null   $ticket
+	 * @param array            $ticket_datetimes
+	 * @param bool             $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_datetime_list_item(
+		$datetime_row,
+		$ticket_row,
+		$datetime,
+		$ticket,
+		$ticket_datetimes = array(),
+		$default
+	) {
+		$tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+			? $ticket_datetimes[$ticket->ID()]
+			: array();
+		$template_args = array(
+			'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
+				? 'DTTNUM'
+				: $datetime_row,
+			'tkt_row'                  => $default
+				? 'TICKETNUM'
+				: $ticket_row,
+			'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true)
+				? ' ticket-selected'
+				: '',
+			'ticket_datetime_checked'  => in_array($datetime_row, $tkt_datetimes, true)
+				? ' checked="checked"'
+				: '',
+			'DTT_name'                 => $default && empty($datetime)
+				? 'DTTNAME'
+				: $datetime->get_dtt_display_name(true),
+			'tkt_status_class'         => '',
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
+			$template_args,
+			$datetime_row,
+			$ticket_row,
+			$datetime,
+			$ticket,
+			$ticket_datetimes,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+
+	/**
+	 * @param array $all_datetimes
+	 * @param array $all_tickets
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array())
+	{
+		$template_args = array(
+			'default_datetime_edit_row'                => $this->_get_dtt_edit_row(
+				'DTTNUM',
+				null,
+				true,
+				$all_datetimes
+			),
+			'default_ticket_row'                       => $this->_get_ticket_row(
+				'TICKETNUM',
+				null,
+				array(),
+				array(),
+				true
+			),
+			'default_price_row'                        => $this->_get_ticket_price_row(
+				'TICKETNUM',
+				'PRICENUM',
+				null,
+				true,
+				null
+			),
+			'default_price_rows'                       => '',
+			'default_base_price_amount'                => 0,
+			'default_base_price_name'                  => '',
+			'default_base_price_description'           => '',
+			'default_price_modifier_selector_row'      => $this->_get_price_modifier_template(
+				'TICKETNUM',
+				'PRICENUM',
+				null,
+				true
+			),
+			'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row(
+				'DTTNUM',
+				null,
+				array(),
+				array(),
+				true
+			),
+			'existing_available_datetime_tickets_list' => '',
+			'existing_available_ticket_datetimes_list' => '',
+			'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item(
+				'DTTNUM',
+				'TICKETNUM',
+				null,
+				null,
+				array(),
+				true
+			),
+			'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item(
+				'DTTNUM',
+				'TICKETNUM',
+				null,
+				null,
+				array(),
+				true
+			),
+		);
+		$ticket_row = 1;
+		foreach ($all_tickets as $ticket) {
+			$template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
+				'DTTNUM',
+				$ticket_row,
+				null,
+				$ticket,
+				array(),
+				true
+			);
+			$ticket_row++;
+		}
+		$datetime_row = 1;
+		foreach ($all_datetimes as $datetime) {
+			$template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
+				$datetime_row,
+				'TICKETNUM',
+				$datetime,
+				null,
+				array(),
+				true
+			);
+			$datetime_row++;
+		}
+		/** @var EEM_Price $price_model */
+		$price_model = EE_Registry::instance()->load_model('Price');
+		$default_prices = $price_model->get_all_default_prices();
+		$price_row = 1;
+		foreach ($default_prices as $price) {
+			if (! $price instanceof EE_Price) {
+				continue;
+			}
+			if ($price->is_base_price()) {
+				$template_args['default_base_price_amount'] = $price->get_pretty(
+					'PRC_amount',
+					'localized_float'
+				);
+				$template_args['default_base_price_name'] = $price->get('PRC_name');
+				$template_args['default_base_price_description'] = $price->get('PRC_desc');
+				$price_row++;
+				continue;
+			}
+			$show_trash = !((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1);
+			$show_create = !(count($default_prices) > 1 && count($default_prices) !== $price_row);
+			$template_args['default_price_rows'] .= $this->_get_ticket_price_row(
+				'TICKETNUM',
+				$price_row,
+				$price,
+				true,
+				null,
+				$show_trash,
+				$show_create
+			);
+			$price_row++;
+		}
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
+			$template_args,
+			$all_datetimes,
+			$all_tickets,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
 } //end class espresso_events_Pricing_Hooks

core/db_models/fields/EE_Text_Field_Base.php

Indentation +44 added lines, -44 removed lines

@@ -7,50 +7,50 @@
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
 
-    /**
-     * Gets the value in the format expected when being set.
-     * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed|string
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return is_string($value_of_field_on_model_object)
-            ? stripslashes($value_of_field_on_model_object)
-            : $value_of_field_on_model_object;
-    }
+	/**
+	 * Gets the value in the format expected when being set.
+	 * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed|string
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return is_string($value_of_field_on_model_object)
+			? stripslashes($value_of_field_on_model_object)
+			: $value_of_field_on_model_object;
+	}
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema === 'form_input') {
-            $value_on_field_to_be_outputted = (string)htmlentities(
-                $value_on_field_to_be_outputted,
-                ENT_QUOTES,
-                'UTF-8'
-            );
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema === 'form_input') {
+			$value_on_field_to_be_outputted = (string)htmlentities(
+				$value_on_field_to_be_outputted,
+				ENT_QUOTES,
+				'UTF-8'
+			);
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	}
 
-    /**
-     * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
-     * quotes need to have slashes added to it. (We used to call html_entity_decode on the value here,
-     * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
-     * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
-     * So if we do it again here, we'll be removing HTML entities the user intended to have.)
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
+	 * quotes need to have slashes added to it. (We used to call html_entity_decode on the value here,
+	 * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
+	 * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
+	 * So if we do it again here, we'll be removing HTML entities the user intended to have.)
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
     public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
     {
         if ($schema === 'form_input') {
-            $value_on_field_to_be_outputted = (string)htmlentities(
+            $value_on_field_to_be_outputted = (string) htmlentities(
                 $value_on_field_to_be_outputted,
                 ENT_QUOTES,
                 'UTF-8'

core/admin/EE_Admin_Page_Loader.core.php

Indentation +742 added lines, -742 removed lines

@@ -28,748 +28,748 @@
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-
-
-    /**
-     * _caf_autoloader
-     * This property is used for holding an array of folder names of any NEW EE_Admin_Pages found in the
-     * caffeinated/new directory.  This array is then used to setup a corresponding dynamic autoloader for these pages
-     * classes.
-     *
-     * @var array
-     */
-    //	private $_caf_autoloader = array();
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        //load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        //define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-        //let's set default autoloaders.  Note that this just sets autoloaders for root admin files.
-        //		spl_autoload_register( array( $this, 'init_autoloaders') );
-        //let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        //set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        //set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        //first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[$group->menu_slug] = $group;
-        }
-        return $groups;
-    }
-
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude        = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[basename($admin_screen)] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n" . sprintf(
-                    __(
-                        'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                        'event_espresso'
-                    ),
-                    EE_ADMIN_PAGES
-                );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        //this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        //allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs             = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        //loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                //skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-                ) {
-                    unset($installed_refs[$page]);
-                    continue;
-                }
-                $menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[$menu_slug] = $page;
-                //flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                //now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[$page])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function($path_to_file) use ($caf_path) {
-                            return $caf_path;
-                        }
-                    );
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page)
-                        {
-                            return $caf_admin_page;
-                        }
-                    );
-                    $extend = true;
-                }
-                //let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
-                $hooks_ref      = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        //the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        //first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        //now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        //make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        //we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[$page]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[$page_slug])) {
-            return $this->_installed_pages[$page_slug]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />' . sprintf(
-                    esc_html__(
-                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $class_name . '</strong>'
-                );
-            $error_msg[]     = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[]     = $error_msg[0]
-                               . "\r\n"
-                               . sprintf(
-                                   esc_html__(
-                                       'There is no Init class in place for the %s admin page.',
-                                       'event_espresso'
-                                   ),
-                                   $page
-                               )
-                               . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        //prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        //rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                //if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                      new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                //if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                //use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                //assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[$page_map->menu_group][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        //let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            //valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            //sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            //prepend header
-            array_unshift($menu_maps, $menu_groups[$group]);
-            //reset $pages_array with prepped data
-            $pages_array[$group] = $menu_maps;
-        }
-        //now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[$group])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
-            }
-        }/**/
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        //first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        //okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[basename($admin_screen)] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                    //					$this->_caf_autoloader[] = array(
-                    //						'dir' => 'new',
-                    //						'folder' => basename( $admin_screen )
-                    //					);
-                }
-            }
-        }
-        //let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    //now let's make sure there is a file that matches the expected format
-                    $filename                                              = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename                                              = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
-                        array('\\', '/'),
-                        DS,
-                        EE_CORE_CAF_ADMIN
-                        . 'extend'
-                        . DS
-                        . $extend_ref
-                        . DS
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                    //					$this->_caf_autoloader[] = array(
-                    //						'dir' => 'extend',
-                    //						'folder' => $extend_ref
-                    //					);
-                }
-            }
-        }
-        //let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a                = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-
-
-
-    /**
-     * Initial autoloader registration
-     * This just sets up the autoloader for the root admin files
-     *
-     * @param  string $className incoming classname to check for autoload
-     * @return void
-     */
-    //	public function init_autoloaders( $className ) {
-    //		$dir_ref = array(
-    //			EE_ADMIN => array('core', 'class')
-    //		);
-    //		EEH_Autoloader::try_autoload($dir_ref, $className );
-    //	}
-    /**
-     * This method takes care of setting up the autoloader dynamically for any NEW EE_Admin pages found in the
-     * caffeinated folders.
-     *
-     * @access public
-     * @param  string $className in coming classname being called
-     * @return void
-     */
-    //	public function caffeinated_autoloaders( $className ) {
-    //		//let's setup an array of paths to check (for each subsystem)
-    //		$dir_ref = array();
-    //		foreach ( $this->_caf_autoloader as $pathinfo) {
-    //			$dir_ref[ EE_CORE_CAF_ADMIN . $pathinfo['dir'] . DS . $pathinfo['folder'] . DS] = array('core', 'class');
-    //		}
-    //
-    //		EEH_Autoloader::try_autoload($dir_ref, $className );
-    //	}
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+
+
+	/**
+	 * _caf_autoloader
+	 * This property is used for holding an array of folder names of any NEW EE_Admin_Pages found in the
+	 * caffeinated/new directory.  This array is then used to setup a corresponding dynamic autoloader for these pages
+	 * classes.
+	 *
+	 * @var array
+	 */
+	//	private $_caf_autoloader = array();
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		//load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		//define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+		//let's set default autoloaders.  Note that this just sets autoloaders for root admin files.
+		//		spl_autoload_register( array( $this, 'init_autoloaders') );
+		//let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		//set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		//set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		//first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[$group->menu_slug] = $group;
+		}
+		return $groups;
+	}
+
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude        = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[basename($admin_screen)] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n" . sprintf(
+					__(
+						'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+						'event_espresso'
+					),
+					EE_ADMIN_PAGES
+				);
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		//this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		//allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs             = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		//loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				//skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+				) {
+					unset($installed_refs[$page]);
+					continue;
+				}
+				$menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
+				$this->_menu_slugs[$menu_slug] = $page;
+				//flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				//now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[$page])) {
+					$this->_current_caf_extend_slug = $page;
+					$admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
+					$caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
+					$caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
+						function($path_to_file) use ($caf_path) {
+							return $caf_path;
+						}
+					);
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
+						function ($admin_page) use ($caf_admin_page)
+						{
+							return $caf_admin_page;
+						}
+					);
+					$extend = true;
+				}
+				//let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
+				$hooks_ref      = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		//the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		//first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		//now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		//make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		//we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[$page]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[$page_slug])) {
+			return $this->_installed_pages[$page_slug]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />' . sprintf(
+					esc_html__(
+						'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+						'event_espresso'
+					),
+					'<strong>' . $class_name . '</strong>'
+				);
+			$error_msg[]     = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[]     = $error_msg[0]
+							   . "\r\n"
+							   . sprintf(
+								   esc_html__(
+									   'There is no Init class in place for the %s admin page.',
+									   'event_espresso'
+								   ),
+								   $page
+							   )
+							   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		//prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		//rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				//if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					  new PersistentAdminNotice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				//if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				//use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				//assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[$page_map->menu_group][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		//let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			//valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			//sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			//prepend header
+			array_unshift($menu_maps, $menu_groups[$group]);
+			//reset $pages_array with prepped data
+			$pages_array[$group] = $menu_maps;
+		}
+		//now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[$group])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
+			}
+		}/**/
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		//first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		//okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[basename($admin_screen)] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+					//					$this->_caf_autoloader[] = array(
+					//						'dir' => 'new',
+					//						'folder' => basename( $admin_screen )
+					//					);
+				}
+			}
+		}
+		//let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					//now let's make sure there is a file that matches the expected format
+					$filename                                              = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename                                              = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
+						array('\\', '/'),
+						DS,
+						EE_CORE_CAF_ADMIN
+						. 'extend'
+						. DS
+						. $extend_ref
+						. DS
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+					//					$this->_caf_autoloader[] = array(
+					//						'dir' => 'extend',
+					//						'folder' => $extend_ref
+					//					);
+				}
+			}
+		}
+		//let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a                = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+
+
+
+	/**
+	 * Initial autoloader registration
+	 * This just sets up the autoloader for the root admin files
+	 *
+	 * @param  string $className incoming classname to check for autoload
+	 * @return void
+	 */
+	//	public function init_autoloaders( $className ) {
+	//		$dir_ref = array(
+	//			EE_ADMIN => array('core', 'class')
+	//		);
+	//		EEH_Autoloader::try_autoload($dir_ref, $className );
+	//	}
+	/**
+	 * This method takes care of setting up the autoloader dynamically for any NEW EE_Admin pages found in the
+	 * caffeinated folders.
+	 *
+	 * @access public
+	 * @param  string $className in coming classname being called
+	 * @return void
+	 */
+	//	public function caffeinated_autoloaders( $className ) {
+	//		//let's setup an array of paths to check (for each subsystem)
+	//		$dir_ref = array();
+	//		foreach ( $this->_caf_autoloader as $pathinfo) {
+	//			$dir_ref[ EE_CORE_CAF_ADMIN . $pathinfo['dir'] . DS . $pathinfo['folder'] . DS] = array('core', 'class');
+	//		}
+	//
+	//		EEH_Autoloader::try_autoload($dir_ref, $className );
+	//	}
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 
 
 }

Spacing +31 added lines, -31 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice;
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 
@@ -142,13 +142,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -261,7 +261,7 @@ 
         //first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -292,7 +292,7 @@ 
         $installed_refs = array();
         $exclude        = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
@@ -307,7 +307,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n" . sprintf(
+            $error_msg[] = $error_msg[0]."\r\n".sprintf(
                     __(
                         'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
                         'event_espresso'
@@ -319,7 +319,7 @@ 
         //this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
         $installed_refs = $this->_set_caffeinated($installed_refs);
         //allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs             = apply_filters(
+        $installed_refs = apply_filters(
             'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
             $installed_refs
         );
@@ -336,7 +336,7 @@ 
             $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
             if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 //skip if in full maintenance mode and maintenance_mode_parent is set
@@ -365,7 +365,7 @@ 
                     );
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page)
+                        function($admin_page) use ($caf_admin_page)
                         {
                             return $caf_admin_page;
                         }
@@ -424,7 +424,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -439,7 +439,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -457,19 +457,19 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />' . sprintf(
+        if ( ! class_exists($class_name)) {
+            $inner_error_msg = '<br />'.sprintf(
                     esc_html__(
                         'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                         'event_espresso'
                     ),
-                    '<strong>' . $class_name . '</strong>'
+                    '<strong>'.$class_name.'</strong>'
                 );
-            $error_msg[]     = sprintf(
+            $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
                 $page
             );
-            $error_msg[]     = $error_msg[0]
+            $error_msg[] = $error_msg[0]
                                . "\r\n"
                                . sprintf(
                                    esc_html__(
@@ -545,7 +545,7 @@ 
                 //if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                       new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -557,7 +557,7 @@ 
                     continue;
                 }
                 //if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -585,7 +585,7 @@ 
         //let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             //valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             //sort pages.
@@ -626,13 +626,13 @@ 
     {
 
         //first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated'.DS.'admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         //okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
@@ -649,13 +649,13 @@ 
             }
         }
         //let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
                     $extend_ref = basename($extend);
                     //now let's make sure there is a file that matches the expected format
-                    $filename                                              = str_replace(
+                    $filename = str_replace(
                         ' ',
                         '_',
                         ucwords(
@@ -666,7 +666,7 @@ 
                             )
                         )
                     );
-                    $filename                                              = 'Extend_' . $filename . '_Admin_Page';
+                    $filename                                              = 'Extend_'.$filename.'_Admin_Page';
                     $this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
                         array('\\', '/'),
                         DS,
@@ -690,12 +690,12 @@ 
         }
         //let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks          = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a                = new ReflectionClass($classname);

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Braces +2 added lines, -1 removed lines

@@ -6,8 +6,9 @@
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
+}
 
 /**
  *

Indentation +339 added lines, -339 removed lines

@@ -7,7 +7,7 @@ 
  * @subpackage messages
  */
 if (!defined('EVENT_ESPRESSO_VERSION'))
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 
 /**
  *
@@ -24,343 +24,343 @@ 
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for generating pdf
-     */
-
-    /**
-     * This is the pdf body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * @return EE_Pdf_messenger
-     */
-    public function __construct()
-    {
-        //set properties
-        $this->name = 'pdf';
-        $this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('PDF', 'event_espresso'),
-            'plural' => __('PDFs', 'event_espresso')
-        );
-        $this->activate_on_install = TRUE;
-
-        parent::__construct();
-    }
-
-
-    /**
-     * PDF Messenger desires execution immediately.
-     * @see  parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     * @see parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => false);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'content' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required' => array('[ATTENDEE_LIST]')
-            ),
-            'event_list' => array(
-                'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
-                'required' => array('[EVENT_LIST]')
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
-                'required' => array('[TICKET_LIST]')
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]')
-            ),
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => __('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => TRUE,
-                'validation' => TRUE,
-                'css_class' => 'large-text',
-                'format' => '%s'
-            ),
-            'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => __('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'rows' => '15'
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]')
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]')
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]')
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]')
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     *
-     */
-    protected function _set_default_message_types()
-    {
-        //note currently PDF is only a secondary messenger so it never has any associated message types.
-        $this->_default_message_types = array();
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array();
-    }
-
-
-    /**
-     * Generates html version of the message content and then sends it to the pdf generator.
-     *
-     *
-     * @since 4.5.0
-     *
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
-            'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
-            'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
-            'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-            'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        $content = $this->_get_main_template();
+	/**
+	 * The following are the properties that this messenger requires for generating pdf
+	 */
+
+	/**
+	 * This is the pdf body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * @return EE_Pdf_messenger
+	 */
+	public function __construct()
+	{
+		//set properties
+		$this->name = 'pdf';
+		$this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('PDF', 'event_espresso'),
+			'plural' => __('PDFs', 'event_espresso')
+		);
+		$this->activate_on_install = TRUE;
+
+		parent::__construct();
+	}
+
+
+	/**
+	 * PDF Messenger desires execution immediately.
+	 * @see  parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 * @see parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => false);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'content' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required' => array('[ATTENDEE_LIST]')
+			),
+			'event_list' => array(
+				'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
+				'required' => array('[EVENT_LIST]')
+			),
+			'ticket_list' => array(
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
+				'required' => array('[TICKET_LIST]')
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]')
+			),
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => __('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => TRUE,
+				'validation' => TRUE,
+				'css_class' => 'large-text',
+				'format' => '%s'
+			),
+			'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => __('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'rows' => '15'
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]')
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]')
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]')
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]')
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _set_default_message_types()
+	{
+		//note currently PDF is only a secondary messenger so it never has any associated message types.
+		$this->_default_message_types = array();
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array();
+	}
+
+
+	/**
+	 * Generates html version of the message content and then sends it to the pdf generator.
+	 *
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		$content = $this->_get_main_template();
 //		die( $content );
-        $this->_do_pdf($content);
-        exit(0);
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-
-        //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_head', 'wp_enqueue_scripts');
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for pdf purposes.
-     *
-     * @since  4.5.0
-     *
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = FALSE)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
-        //add message type to template_args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
-    }
-
-
-    /**
-     * This takes care of loading the dompdf library and generating the actual pdf
-     *
-     * @param string $content This is the generated html content being converted into a pdf.
-     *
-     * @return void
-     */
-    protected function _do_pdf($content = '')
-    {
-        $invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
-
-        //only load dompdf if nobody else has yet...
-        if (!defined('DOMPDF_DIR')) {
-            define('DOMPDF_ENABLE_REMOTE', TRUE);
-            define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
-            define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-            require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
-        }
-        $dompdf = new DOMPDF();
-        if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
-            $dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE);
-        }
-        //Remove all spaces between HTML tags
-        $content = preg_replace('/>\s+</', '><', $content);
-        $dompdf->load_html($content);
-        $dompdf->render();
-        //forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
+		$this->_do_pdf($content);
+		exit(0);
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+
+		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_head', 'wp_enqueue_scripts');
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for pdf purposes.
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = FALSE)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
+		//add message type to template_args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
+	}
+
+
+	/**
+	 * This takes care of loading the dompdf library and generating the actual pdf
+	 *
+	 * @param string $content This is the generated html content being converted into a pdf.
+	 *
+	 * @return void
+	 */
+	protected function _do_pdf($content = '')
+	{
+		$invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
+
+		//only load dompdf if nobody else has yet...
+		if (!defined('DOMPDF_DIR')) {
+			define('DOMPDF_ENABLE_REMOTE', TRUE);
+			define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
+			define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
+			require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+		}
+		$dompdf = new DOMPDF();
+		if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
+			$dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE);
+		}
+		//Remove all spaces between HTML tags
+		$content = preg_replace('/>\s+</', '><', $content);
+		$dompdf->load_html($content);
+		$dompdf->render();
+		//forcing the browser to open a download dialog.
+		$dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -6,7 +6,7 @@ 
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
     exit('NO direct script access allowed');
 
 /**
@@ -268,7 +268,7 @@ 
             'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
             'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
             'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+            'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
             'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
         );
         $this->_deregister_wp_hooks();
@@ -332,11 +332,11 @@ 
         $invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
 
         //only load dompdf if nobody else has yet...
-        if (!defined('DOMPDF_DIR')) {
+        if ( ! defined('DOMPDF_DIR')) {
             define('DOMPDF_ENABLE_REMOTE', TRUE);
             define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
             define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-            require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+            require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
         }
         $dompdf = new DOMPDF();
         if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
@@ -347,7 +347,7 @@ 
         $dompdf->load_html($content);
         $dompdf->render();
         //forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
+        $dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE));
     }
 
 

core/libraries/messages/messenger/EE_Html_messenger.class.php

Spacing +3 added lines, -3 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -318,7 +318,7 @@ 
                     ),
                     'ticket_line_item_no_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                                 'Ticket Line Item List with no Price Modifiers',
                                 'event_espresso'
                             ),
@@ -332,7 +332,7 @@ 
                     ),
                     'ticket_line_item_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                                 'Ticket Line Item List with Price Modifiers',
                                 'event_espresso'
                             ),

Indentation +554 added lines, -554 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (!defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -16,558 +16,558 @@ 
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        //set properties
-        $this->name = 'html';
-        $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('html', 'event_espresso'),
-            'plural' => __('html', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @see    parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @see    parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => true);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
-            ),
-            'content' => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ),
-            ),
-            'event_list' => array(
-                'shortcodes' => array(
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ),
-                'required' => array('[EVENT_LIST]'),
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array(
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ),
-                'required' => array('[TICKET_LIST]'),
-            ),
-            'ticket_line_item_no_pms' => array(
-                'shortcodes' => array('line_item', 'ticket'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'ticket_line_item_pms' => array(
-                'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'price_modifier_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]'),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee'),
-                'required' => array('[ATTENDEE_LIST]'),
-            ),
-            'tax_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[TAX_LINE_ITEM_LIST]'),
-            ),
-            'additional_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-            ),
-            'payment_list' => array(
-                'shortcodes' => array('payment'),
-                'required' => array('[PAYMENT_LIST_*]'),
-            ),
-        );
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @since 4.5.0
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param \EE_Messages_Template_Pack $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    )
-    {
-        $variation = $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-        return $variation;
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => __('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => true,
-                'validation' => true,
-                'css_class' => 'large-text',
-                'format' => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => __('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'ticket_line_item_no_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                                'Ticket Line Item List with no Price Modifiers',
-                                'event_espresso'
-                            ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'ticket_line_item_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                                'Ticket Line Item List with Price Modifiers',
-                                'event_espresso'
-                            ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'price_modifier_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'tax_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TAX_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
-                    ),
-                    'additional_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-                    ),
-                    'payment_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PAYMENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PAYMENT_LIST_*]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @since 4.5.0
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
-            'base_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body' => wpautop(
-                stripslashes_deep(
-                    html_entity_decode(
-                        apply_filters(
-                            'FHEE__EE_Html_messenger___send_message__main_body',
-                            $this->_content,
-                            $this->_content,
-                            $this->_incoming_message_type
-                        ),
-                        ENT_QUOTES,
-                        "UTF-8"
-                    )
-                )
-            ),
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        echo $this->_get_main_template();
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-        //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @since  4.5.0
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
-        //include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string $content
-     * @param string $content_again
-     * @param \EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        $content = '',
-        $content_again = '',
-        EE_message_type $incoming_message_type
-    )
-    {
-        if (
-            ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= \EEH_Template::powered_by_event_espresso(
-                    'aln-cntr',
-                    '',
-                    array('utm_content' => 'messages_system')
-                )
-                . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		//set properties
+		$this->name = 'html';
+		$this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('html', 'event_espresso'),
+			'plural' => __('html', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @see    parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @see    parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => true);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
+			),
+			'content' => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				),
+			),
+			'event_list' => array(
+				'shortcodes' => array(
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				),
+				'required' => array('[EVENT_LIST]'),
+			),
+			'ticket_list' => array(
+				'shortcodes' => array(
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				),
+				'required' => array('[TICKET_LIST]'),
+			),
+			'ticket_line_item_no_pms' => array(
+				'shortcodes' => array('line_item', 'ticket'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'ticket_line_item_pms' => array(
+				'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'price_modifier_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]'),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee'),
+				'required' => array('[ATTENDEE_LIST]'),
+			),
+			'tax_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[TAX_LINE_ITEM_LIST]'),
+			),
+			'additional_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+			),
+			'payment_list' => array(
+				'shortcodes' => array('payment'),
+				'required' => array('[PAYMENT_LIST_*]'),
+			),
+		);
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @since 4.5.0
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param \EE_Messages_Template_Pack $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	)
+	{
+		$variation = $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+		return $variation;
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => __('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => true,
+				'validation' => true,
+				'css_class' => 'large-text',
+				'format' => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => __('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'ticket_line_item_no_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+								'Ticket Line Item List with no Price Modifiers',
+								'event_espresso'
+							),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'ticket_line_item_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+								'Ticket Line Item List with Price Modifiers',
+								'event_espresso'
+							),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'price_modifier_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'tax_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[TAX_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
+					),
+					'additional_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+					),
+					'payment_list' => array(
+						'input' => 'textarea',
+						'label' => '[PAYMENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PAYMENT_LIST_*]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @since 4.5.0
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body' => wpautop(
+				stripslashes_deep(
+					html_entity_decode(
+						apply_filters(
+							'FHEE__EE_Html_messenger___send_message__main_body',
+							$this->_content,
+							$this->_content,
+							$this->_incoming_message_type
+						),
+						ENT_QUOTES,
+						"UTF-8"
+					)
+				)
+			),
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		echo $this->_get_main_template();
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @since  4.5.0
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
+		//include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string $content
+	 * @param string $content_again
+	 * @param \EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		$content = '',
+		$content_again = '',
+		EE_message_type $incoming_message_type
+	)
+	{
+		if (
+			($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= \EEH_Template::powered_by_event_espresso(
+					'aln-cntr',
+					'',
+					array('utm_content' => 'messages_system')
+				)
+				. EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 
 }