eventespresso / event-espresso-core

core/db_models/fields/EE_Model_Field_Base.php

Indentation +688 added lines, -688 removed lines

@@ -20,692 +20,692 @@
  */
 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;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "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 [];
-    }
-
-
-    /**
-     * 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 = [];
-            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 [];
-    }
-
-
-    /**
-     * 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.
-     *
-     * @param string $format
-     * @throws InvalidArgumentException
-     */
-    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.
-     *
-     * @return string
-     * @uses _get_wpdb_data_type()
-     *
-     */
-    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.
-     * @return string
-     * @uses get_schema_type()
-     */
-    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 = [
-            '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.
-     *
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    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(
-            [
-                '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
-     *
-     * @param $format
-     * @throws InvalidArgumentException
-     */
-    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(
-            [
-                '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;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"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 [];
+	}
+
+
+	/**
+	 * 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 = [];
+			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 [];
+	}
+
+
+	/**
+	 * 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.
+	 *
+	 * @param string $format
+	 * @throws InvalidArgumentException
+	 */
+	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.
+	 *
+	 * @return string
+	 * @uses _get_wpdb_data_type()
+	 *
+	 */
+	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.
+	 * @return string
+	 * @uses get_schema_type()
+	 */
+	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 = [
+			'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.
+	 *
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	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(
+			[
+				'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
+	 *
+	 * @param $format
+	 * @throws InvalidArgumentException
+	 */
+	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(
+			[
+				'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))
+				)
+			);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -139,7 +139,7 @@ 
         /**
          * allow for changing the defaults
          */
-        $this->_nicename      = apply_filters(
+        $this->_nicename = apply_filters(
             'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
             $this->_nicename,
             $this
@@ -243,7 +243,7 @@ 
      */
     public function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
 
@@ -344,7 +344,7 @@ 
     {
         if ($this->is_nullable()) {
             $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
+            if ( ! in_array('null', $this->_schema_type)) {
                 $this->_schema_type[] = 'null';
             }
         }
@@ -401,11 +401,11 @@ 
                 switch ($property_key) {
                     case 'pretty':
                     case 'rendered':
-                        $value_to_return[ $property_key ] =
+                        $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;
+                        $value_to_return[$property_key] = $default_value;
                         break;
                 }
             }
@@ -471,7 +471,7 @@ 
      */
     protected function setSchemaReadOnly($readonly)
     {
-        if (! is_bool($readonly)) {
+        if ( ! is_bool($readonly)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
@@ -619,7 +619,7 @@ 
      */
     private function validateSchemaType($type)
     {
-        if (! (is_string($type) || is_array($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'),
@@ -649,7 +649,7 @@ 
             return;
         }
 
-        if (! isset($allowable_types[ $type ])) {
+        if ( ! isset($allowable_types[$type])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -672,7 +672,7 @@ 
      */
     private function validateSchemaFormat($format)
     {
-        if (! is_string($format)) {
+        if ( ! is_string($format)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
@@ -695,7 +695,7 @@ 
             ]
         );
 
-        if (! isset($allowable_formats[ $format ])) {
+        if ( ! isset($allowable_formats[$format])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(

core/EE_Cart.core.php

Spacing +9 added lines, -9 removed lines

@@ -69,14 +69,14 @@ 
             self::$_instance = new self($grand_total, $session);
         }
         // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
+        if ( ! self::$_instance instanceof EE_Cart) {
             // try getting the cart out of the session
             $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
             self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
             unset($saved_cart);
         }
         // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
             self::$_instance = new self($grand_total, $session);
         }
         self::$_instance->get_grand_total();
@@ -132,7 +132,7 @@ 
      */
     public function session()
     {
-        if (! $this->_session instanceof EE_Session) {
+        if ( ! $this->_session instanceof EE_Session) {
             $this->set_session();
         }
         return $this->_session;
@@ -277,7 +277,7 @@ 
      */
     public function hasTickets()
     {
-        if (! $this->has_tickets) {
+        if ( ! $this->has_tickets) {
             $tickets           = EEH_Line_Item::get_ticket_line_items($this->get_grand_total());
             $this->has_tickets = is_array($tickets) && count($tickets) > 0;
         }
@@ -293,7 +293,7 @@ 
      */
     public function get_cart_total_before_tax()
     {
-        if (! $this->hasTickets()) {
+        if ( ! $this->hasTickets()) {
             return 0.00;
         }
         return $this->get_grand_total()->recalculate_pre_tax_total();
@@ -308,7 +308,7 @@ 
      */
     public function get_applied_taxes()
     {
-        if (! $this->hasTickets()) {
+        if ( ! $this->hasTickets()) {
             return 0.00;
         }
         return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
@@ -323,7 +323,7 @@ 
      */
     public function get_cart_grand_total()
     {
-        if (! $this->hasTickets()) {
+        if ( ! $this->hasTickets()) {
             return 0.00;
         }
         EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
@@ -339,7 +339,7 @@ 
      */
     public function recalculate_all_cart_totals()
     {
-        if (! $this->hasTickets()) {
+        if ( ! $this->hasTickets()) {
             return 0.00;
         }
         $pre_tax_total = $this->get_cart_total_before_tax();
@@ -427,7 +427,7 @@ 
      */
     public function __wakeup()
     {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+        if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
             // $this->_grand_total is actually just an ID, so use it to get the object from the db
             $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
         }

Indentation +430 added lines, -430 removed lines

@@ -16,434 +16,434 @@
  */
 class EE_Cart implements ResettableInterface
 {
-    /**
-     * TRUE if tickets have been added to cart
-     *
-     * @var bool
-     */
-    private $has_tickets;
-
-    /**
-     * instance of the EE_Cart object
-     *
-     * @var EE_Cart $_instance
-     */
-    private static $_instance;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session $_session
-     */
-    protected $_session;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * @var EE_Line_Item
-     */
-    private $_grand_total;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws EE_Error|ReflectionException
-     */
-    public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws EE_Error|ReflectionException
-     */
-    public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-    /**
-     * @return EE_Session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function session()
-    {
-        if (! $this->_session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->_session;
-    }
-
-
-    /**
-     * @param EE_Session $session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_session(EE_Session $session = null)
-    {
-        $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->_grand_total = $line_item;
-    }
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Session     $session
-     * @return EE_Cart
-     * @throws EE_Error|ReflectionException
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error|ReflectionException
-     */
-    private function _create_grand_total()
-    {
-        $this->_grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->_grand_total;
-    }
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets()
-    {
-        if ($this->_grand_total === null) {
-            return array();
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
-    }
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @return int
-     * @throws EE_Error|ReflectionException
-     */
-    public function all_ticket_quantity_count()
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->get('LIN_quantity');
-        }
-        $this->has_tickets = $count > 0;
-        return $count;
-    }
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_taxes()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_grand_total()
-    {
-        return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
-    }
-
-
-    /**
-     * @process items for adding to cart
-     * @access  public
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error|ReflectionException
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
-        $this->has_tickets = true;
-        return $this->save_cart();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function hasTickets()
-    {
-        if (! $this->has_tickets) {
-            $tickets           = EEH_Line_Item::get_ticket_line_items($this->get_grand_total());
-            $this->has_tickets = is_array($tickets) && count($tickets) > 0;
-        }
-        return $this->has_tickets;
-    }
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @return float
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_cart_total_before_tax()
-    {
-        if (! $this->hasTickets()) {
-            return 0.00;
-        }
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @return float
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_applied_taxes()
-    {
-        if (! $this->hasTickets()) {
-            return 0.00;
-        }
-        return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @return float
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_cart_grand_total()
-    {
-        if (! $this->hasTickets()) {
-            return 0.00;
-        }
-        EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @return float
-     * @throws EE_Error|ReflectionException
-     */
-    public function recalculate_all_cart_totals()
-    {
-        if (! $this->hasTickets()) {
-            return 0.00;
-        }
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        $this->_grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->_grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws EE_Error|ReflectionException
-     */
-    public function delete_items($line_item_codes = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @return bool
-     * @throws EE_Error|ReflectionException
-     */
-    public function empty_cart()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_grand_total = $this->_create_grand_total();
-        $this->has_tickets = false;
-        return $this->save_cart();
-    }
-
-
-    /**
-     * @remove ALL items from cart and delete total as well
-     * @return bool
-     * @throws EE_Error|ReflectionException
-     */
-    public function delete_cart()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-            if ($deleted) {
-                $deleted += $this->_grand_total->delete();
-                $this->_grand_total = null;
-                $this->has_tickets = null;
-                return $deleted > 0;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @save   cart to session
-     * @param bool $apply_taxes
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error|ReflectionException
-     */
-    public function save_cart($apply_taxes = true)
-    {
-        if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-            // make sure we don't cache the transaction because it can get stale
-            if (
-                $this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->_grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->_grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        }
-        return false;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function __wakeup()
-    {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
-        }
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    public function __sleep()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
-            $this->_grand_total = $this->_grand_total->ID();
-        }
-        return array('_grand_total');
-    }
+	/**
+	 * TRUE if tickets have been added to cart
+	 *
+	 * @var bool
+	 */
+	private $has_tickets;
+
+	/**
+	 * instance of the EE_Cart object
+	 *
+	 * @var EE_Cart $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session $_session
+	 */
+	protected $_session;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * @var EE_Line_Item
+	 */
+	private $_grand_total;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if (! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * @return EE_Session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function session()
+	{
+		if (! $this->_session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->_session;
+	}
+
+
+	/**
+	 * @param EE_Session $session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_session(EE_Session $session = null)
+	{
+		$this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->_grand_total = $line_item;
+	}
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Session     $session
+	 * @return EE_Cart
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error|ReflectionException
+	 */
+	private function _create_grand_total()
+	{
+		$this->_grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->_grand_total;
+	}
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets()
+	{
+		if ($this->_grand_total === null) {
+			return array();
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
+	}
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @return int
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function all_ticket_quantity_count()
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->get('LIN_quantity');
+		}
+		$this->has_tickets = $count > 0;
+		return $count;
+	}
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_taxes()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_grand_total()
+	{
+		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
+	}
+
+
+	/**
+	 * @process items for adding to cart
+	 * @access  public
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
+		$this->has_tickets = true;
+		return $this->save_cart();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function hasTickets()
+	{
+		if (! $this->has_tickets) {
+			$tickets           = EEH_Line_Item::get_ticket_line_items($this->get_grand_total());
+			$this->has_tickets = is_array($tickets) && count($tickets) > 0;
+		}
+		return $this->has_tickets;
+	}
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @return float
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_cart_total_before_tax()
+	{
+		if (! $this->hasTickets()) {
+			return 0.00;
+		}
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @return float
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_applied_taxes()
+	{
+		if (! $this->hasTickets()) {
+			return 0.00;
+		}
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @return float
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_cart_grand_total()
+	{
+		if (! $this->hasTickets()) {
+			return 0.00;
+		}
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @return float
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function recalculate_all_cart_totals()
+	{
+		if (! $this->hasTickets()) {
+			return 0.00;
+		}
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->_grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function delete_items($line_item_codes = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @return bool
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function empty_cart()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_grand_total = $this->_create_grand_total();
+		$this->has_tickets = false;
+		return $this->save_cart();
+	}
+
+
+	/**
+	 * @remove ALL items from cart and delete total as well
+	 * @return bool
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function delete_cart()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+			if ($deleted) {
+				$deleted += $this->_grand_total->delete();
+				$this->_grand_total = null;
+				$this->has_tickets = null;
+				return $deleted > 0;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @save   cart to session
+	 * @param bool $apply_taxes
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function save_cart($apply_taxes = true)
+	{
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+			// make sure we don't cache the transaction because it can get stale
+			if (
+				$this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->_grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		}
+		return false;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function __wakeup()
+	{
+		if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function __sleep()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
+			$this->_grand_total = $this->_grand_total->ID();
+		}
+		return array('_grand_total');
+	}
 }

core/services/formatters/LocaleFloatFormatter.php

Spacing +1 added lines, -1 removed lines

@@ -93,7 +93,7 @@
         // now add any extra zeros to the correct precision
         $decimal = str_pad($decimal, $precision, '0');
         // the final fully formatted result is as simple as stringing it all together
-        return $formatted_number . $decimal_point . $decimal;
+        return $formatted_number.$decimal_point.$decimal;
     }
 
 

Indentation +151 added lines, -151 removed lines

@@ -15,159 +15,159 @@
  */
 abstract class LocaleFloatFormatter implements LocaleFloatFormatterInterface, InterminableInterface
 {
-    /**
-     * number of decimal places used for high precision internal calculations and storage
-     */
-    const DECIMAL_PRECISION = 6;
+	/**
+	 * number of decimal places used for high precision internal calculations and storage
+	 */
+	const DECIMAL_PRECISION = 6;
 
-    /*
+	/*
      * the following constants represent the values returned for 'n_sign_posn' && 'p_sign_posn'
      */
 
-    /**
-     * 0 - Parentheses surround the quantity and currency_symbol
-     */
-    const PARENTHESES = 0;
-
-    /**
-     * 1 - The sign string precedes the quantity and currency_symbol
-     */
-    const SIGN_BEFORE_ALL = 1;
-
-    /**
-     * 2 - The sign string follows the quantity and currency_symbol
-     */
-    const SIGN_AFTER_ALL = 2;
-
-    /**
-     * 3 - The sign string immediately precedes the currency_symbol
-     */
-    const SIGN_BEFORE_CURRENCY = 3;
-
-    /**
-     * 4 - The sign string immediately follows the currency_symbol
-     */
-    const SIGN_AFTER_CURRENCY = 4;
-
-    /**
-     * @var Locales
-     */
-    protected $locales;
-
-
-    /**
-     * LocaleFloatFormatter constructor.
-     *
-     * @param Locales $locales
-     */
-    public function __construct(Locales $locales)
-    {
-        $this->locales = $locales;
-    }
-
-
-    /**
-     * inserts symbols for the locale's decimal and thousands separator at the appropriate places
-     *
-     * @param float  $number
-     * @param int    $precision
-     * @param string $decimal_point
-     * @param int    $grouping
-     * @param string $thousands_separator
-     * @return string
-     */
-    protected function formatGroupings(
-        float $number,
-        int $precision,
-        string $decimal_point,
-        int $grouping,
-        string $thousands_separator
-    ): string {
-        // remove sign (+-), cast to string, then break apart at the decimal place
-        $parts = explode('.', (string) abs($number));
-        // separate the integer and decimal portions of the number into separate variables
-        [$integer, $decimal] = $parts + [0, 0];
-        // ok this gets a bit crazy, but we need to insert the locale's thousand separator
-        // at the correct intervals for the locale, so 123456789 can be something like "123,456,879" or "1.23.45.67.89"
-        // so we're first going to reverse the string, then use chunk_split() to give us something like "987,654,321"
-        // why reverse the number first? cuz otherwise something like "1234" would become "123,4" not "1,234"
-        $formatted_number = chunk_split(strrev($integer), $grouping, $thousands_separator);
-        // so THEN we reverse the string again and remove any extra separators
-        $formatted_number = ltrim(strrev($formatted_number), $thousands_separator);
-        if ($precision === 0) {
-            return $formatted_number;
-        }
-        // now let's deal with the decimal places, by first adding a decimal to an otherwise non-decimal number
-        $decimal = "0.$decimal";
-        // then type cast the string to a float and round to the appropriate precision for the locale
-        $decimal = round((float) $decimal, $precision);
-        // now type cast back to a string, and remove the first two characters ( the "0." added earlier )
-        $decimal = substr((string) $decimal, 2, $precision);
-        // now add any extra zeros to the correct precision
-        $decimal = str_pad($decimal, $precision, '0');
-        // the final fully formatted result is as simple as stringing it all together
-        return $formatted_number . $decimal_point . $decimal;
-    }
-
-
-    /**
-     * Removes all characters except digits, +- and .
-     *
-     * @param float|int|string $number
-     * @return float
-     */
-    public function filterNumericValue($number): float
-    {
-        return (float) filter_var($number, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
-    }
-
-
-    /**
-     * formats the provided number to 6 decimal places using the site locale and returns a string
-     *
-     * @param float|int|string $number unformatted float, ex: 1.23456789
-     * @return string                  formatted number value, ex: '1.234568'
-     */
-    public function precisionFormat($number): string
-    {
-        $locale = $this->locales->getLocale($this->locales->getSiteLocaleName());
-        return $this->format($locale, $number, LocaleFloatFormatter::DECIMAL_PRECISION);
-    }
-
-
-    /**
-     * strips formatting using the site locale, then rounds the provided number to 6 decimal places and returns a float
-     *
-     * @param float|int|string $number    unformatted number value, ex: 1234.5678956789
-     * @param int|null         $precision the number of decimal places to round to
-     * @param int              $mode      one of the PHP_ROUND_* constants for round up, round down, etc
-     * @return float                      rounded value, ex: 1,234.567896
-     */
-    public function precisionRound(
-        $number,
-        ?int $precision = LocaleFloatFormatter::DECIMAL_PRECISION,
-        int $mode = PHP_ROUND_HALF_UP
-    ): float {
-        return round(
-            $this->filterNumericValue($number),
-            $precision,
-            $mode
-        );
-    }
-
-
-    /**
-     * strips formatting for the provided locale (defaults to site locale),
-     * then rounds the provided number and returns a float
-     *
-     * @param float|int|string $number unformatted number value, ex: 1234.56789
-     * @param string|Locale    $locale ex: 'en_US' or Locale object
-     * @param int              $mode   one of the PHP_ROUND_* constants for round up, round down, etc
-     * @return float                   rounded value, ex: 1,234.57
-     */
-    public function roundForLocale($number, $locale = '', int $mode = PHP_ROUND_HALF_UP): float
-    {
-        $locale = $this->locales->getLocale($locale);
-        return round($this->filterNumericValue($number), $locale->decimalPrecision(), $mode);
-    }
+	/**
+	 * 0 - Parentheses surround the quantity and currency_symbol
+	 */
+	const PARENTHESES = 0;
+
+	/**
+	 * 1 - The sign string precedes the quantity and currency_symbol
+	 */
+	const SIGN_BEFORE_ALL = 1;
+
+	/**
+	 * 2 - The sign string follows the quantity and currency_symbol
+	 */
+	const SIGN_AFTER_ALL = 2;
+
+	/**
+	 * 3 - The sign string immediately precedes the currency_symbol
+	 */
+	const SIGN_BEFORE_CURRENCY = 3;
+
+	/**
+	 * 4 - The sign string immediately follows the currency_symbol
+	 */
+	const SIGN_AFTER_CURRENCY = 4;
+
+	/**
+	 * @var Locales
+	 */
+	protected $locales;
+
+
+	/**
+	 * LocaleFloatFormatter constructor.
+	 *
+	 * @param Locales $locales
+	 */
+	public function __construct(Locales $locales)
+	{
+		$this->locales = $locales;
+	}
+
+
+	/**
+	 * inserts symbols for the locale's decimal and thousands separator at the appropriate places
+	 *
+	 * @param float  $number
+	 * @param int    $precision
+	 * @param string $decimal_point
+	 * @param int    $grouping
+	 * @param string $thousands_separator
+	 * @return string
+	 */
+	protected function formatGroupings(
+		float $number,
+		int $precision,
+		string $decimal_point,
+		int $grouping,
+		string $thousands_separator
+	): string {
+		// remove sign (+-), cast to string, then break apart at the decimal place
+		$parts = explode('.', (string) abs($number));
+		// separate the integer and decimal portions of the number into separate variables
+		[$integer, $decimal] = $parts + [0, 0];
+		// ok this gets a bit crazy, but we need to insert the locale's thousand separator
+		// at the correct intervals for the locale, so 123456789 can be something like "123,456,879" or "1.23.45.67.89"
+		// so we're first going to reverse the string, then use chunk_split() to give us something like "987,654,321"
+		// why reverse the number first? cuz otherwise something like "1234" would become "123,4" not "1,234"
+		$formatted_number = chunk_split(strrev($integer), $grouping, $thousands_separator);
+		// so THEN we reverse the string again and remove any extra separators
+		$formatted_number = ltrim(strrev($formatted_number), $thousands_separator);
+		if ($precision === 0) {
+			return $formatted_number;
+		}
+		// now let's deal with the decimal places, by first adding a decimal to an otherwise non-decimal number
+		$decimal = "0.$decimal";
+		// then type cast the string to a float and round to the appropriate precision for the locale
+		$decimal = round((float) $decimal, $precision);
+		// now type cast back to a string, and remove the first two characters ( the "0." added earlier )
+		$decimal = substr((string) $decimal, 2, $precision);
+		// now add any extra zeros to the correct precision
+		$decimal = str_pad($decimal, $precision, '0');
+		// the final fully formatted result is as simple as stringing it all together
+		return $formatted_number . $decimal_point . $decimal;
+	}
+
+
+	/**
+	 * Removes all characters except digits, +- and .
+	 *
+	 * @param float|int|string $number
+	 * @return float
+	 */
+	public function filterNumericValue($number): float
+	{
+		return (float) filter_var($number, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
+	}
+
+
+	/**
+	 * formats the provided number to 6 decimal places using the site locale and returns a string
+	 *
+	 * @param float|int|string $number unformatted float, ex: 1.23456789
+	 * @return string                  formatted number value, ex: '1.234568'
+	 */
+	public function precisionFormat($number): string
+	{
+		$locale = $this->locales->getLocale($this->locales->getSiteLocaleName());
+		return $this->format($locale, $number, LocaleFloatFormatter::DECIMAL_PRECISION);
+	}
+
+
+	/**
+	 * strips formatting using the site locale, then rounds the provided number to 6 decimal places and returns a float
+	 *
+	 * @param float|int|string $number    unformatted number value, ex: 1234.5678956789
+	 * @param int|null         $precision the number of decimal places to round to
+	 * @param int              $mode      one of the PHP_ROUND_* constants for round up, round down, etc
+	 * @return float                      rounded value, ex: 1,234.567896
+	 */
+	public function precisionRound(
+		$number,
+		?int $precision = LocaleFloatFormatter::DECIMAL_PRECISION,
+		int $mode = PHP_ROUND_HALF_UP
+	): float {
+		return round(
+			$this->filterNumericValue($number),
+			$precision,
+			$mode
+		);
+	}
+
+
+	/**
+	 * strips formatting for the provided locale (defaults to site locale),
+	 * then rounds the provided number and returns a float
+	 *
+	 * @param float|int|string $number unformatted number value, ex: 1234.56789
+	 * @param string|Locale    $locale ex: 'en_US' or Locale object
+	 * @param int              $mode   one of the PHP_ROUND_* constants for round up, round down, etc
+	 * @return float                   rounded value, ex: 1,234.57
+	 */
+	public function roundForLocale($number, $locale = '', int $mode = PHP_ROUND_HALF_UP): float
+	{
+		$locale = $this->locales->getLocale($locale);
+		return round($this->filterNumericValue($number), $locale->decimalPrecision(), $mode);
+	}
 }

core/services/locale/Locales.php

Spacing +5 added lines, -5 removed lines

@@ -85,13 +85,13 @@
         if ($locale instanceof Locale) {
             return $locale;
         }
-        if (isset($this->locales[ $locale ])) {
-            return $this->locales[ $locale ];
+        if (isset($this->locales[$locale])) {
+            return $this->locales[$locale];
         }
         $locale_info = $this->locale_switcher->getLocale($locale);
-        if (! empty($locale_info)) {
-            $this->locales[ $locale ] = new Locale($locale, $locale_info, $this->default_data->getDefaults());
-            return $this->locales[ $locale ];
+        if ( ! empty($locale_info)) {
+            $this->locales[$locale] = new Locale($locale, $locale_info, $this->default_data->getDefaults());
+            return $this->locales[$locale];
         }
         throw new DomainException(
             sprintf(

Indentation +171 added lines, -171 removed lines

@@ -15,175 +15,175 @@
  */
 class Locales implements InterminableInterface
 {
-    /**
-     * Locale string for the site as set in the WP Settings admin
-     */
-    const SITE = 'site';
-
-    /**
-     * Locale string for the current user
-     */
-    const USER = 'user';
-
-    /**
-     * @var DefaultLocaleData
-     */
-    protected $default_data;
-
-    /**
-     * @var Locale[]
-     */
-    protected $locales;
-
-    /**
-     * @var LocaleSwitcher
-     */
-    protected $locale_switcher;
-
-    /**
-     * @var string
-     */
-    protected $site_locale;
-
-    /**
-     * @var string
-     */
-    protected $user_locale;
-
-
-    /**
-     * LocaleFloatFormatter constructor.
-     *
-     * @param DefaultLocaleData $default_data
-     * @param LocaleSwitcher $locale_switcher
-     */
-    public function __construct(DefaultLocaleData $default_data, LocaleSwitcher $locale_switcher)
-    {
-        $this->default_data = $default_data;
-        $this->locale_switcher = $locale_switcher;
-        $this->site_locale = $this->default_data->getDefaultLocale();
-        // give site owners a chance to change the locale for the site
-        // ex: some of the WordPress language locales, like "ja" (Japan) do not specify a country
-        // but the locale data on teh server might require it, like "ja_JP"
-        $this->site_locale = sanitize_text_field(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_locale_Locales__construct__site_locale',
-                ! empty($this->site_locale) ? $this->site_locale : get_locale()
-            )
-        );
-        $this->user_locale = get_user_locale();
-    }
-
-
-    /**
-     * @param string|Locale $locale locale name ex: en_US or Locale object
-     * @return Locale
-     */
-    public function getLocale($locale): Locale
-    {
-        $locale = ! empty($locale) ? $locale : $this->site_locale;
-        if ($locale instanceof Locale) {
-            return $locale;
-        }
-        if (isset($this->locales[ $locale ])) {
-            return $this->locales[ $locale ];
-        }
-        $locale_info = $this->locale_switcher->getLocale($locale);
-        if (! empty($locale_info)) {
-            $this->locales[ $locale ] = new Locale($locale, $locale_info, $this->default_data->getDefaults());
-            return $this->locales[ $locale ];
-        }
-        throw new DomainException(
-            sprintf(
-                esc_html__(
-                    'The "%1$s" locale is either missing or invalid. Please contact your hosting provider about having it enabled on the server',
-                    'event_espresso'
-                ),
-                $locale
-            )
-        );
-    }
-
-
-    /**
-     * @param string $currency_ISO              ex: "USD"
-     * @param bool   $fallback_to_site_locale   [optional] if true, will return the site locale
-     *                                          if a locale can not be identified for the supplied currency ISO
-     * @return Locale
-     */
-    public function getLocaleForCurrencyISO(string $currency_ISO, bool $fallback_to_site_locale = false): Locale
-    {
-        $locale_name = '';
-        // first try to find a matching currency in the current list of locales
-        foreach ($this->locales as $locale) {
-            if ($locale instanceof Locale) {
-                if ($locale->currencyIsoCode() === $currency_ISO) {
-                    $locale_name = $locale->name();
-                    break;
-                }
-            }
-        }
-        // give site owners a chance to specify the appropriate locale for the provided currency ISO code
-        // ex: the Canadian Dollar "CAD" could be for the locale "en_CA" or "fr_CA"
-        // and the Euro (EUR) could be one of ~20 or so countries that use it, many of which have multiple locales
-        $locale_name = sanitize_text_field(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_locale_Locales__getLocaleForCurrencyISO__locale_name',
-                $locale_name,
-                $currency_ISO
-            )
-        );
-        if ($locale_name) {
-            return $this->getLocale($locale_name);
-        }
-        if ($fallback_to_site_locale) {
-            return $this->getSiteLocale();
-        }
-        throw new DomainException(
-            sprintf(
-                esc_html__(
-                    'The "%1$s" locale corresponding to the "%2$s" currency is either missing or invalid. Please contact your hosting provider about having it enabled on the server',
-                    'event_espresso'
-                ),
-                $locale_name,
-                $currency_ISO
-            )
-        );
-    }
-
-
-    /**
-     * @return Locale
-     */
-    public function getSiteLocale(): Locale
-    {
-        return $this->getLocale($this->site_locale);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getSiteLocaleName(): string
-    {
-        return $this->site_locale;
-    }
-
-
-    /**
-     * @return Locale
-     */
-    public function getUserLocale(): Locale
-    {
-        return $this->getLocale($this->user_locale);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getUserLocaleName(): string
-    {
-        return $this->user_locale;
-    }
+	/**
+	 * Locale string for the site as set in the WP Settings admin
+	 */
+	const SITE = 'site';
+
+	/**
+	 * Locale string for the current user
+	 */
+	const USER = 'user';
+
+	/**
+	 * @var DefaultLocaleData
+	 */
+	protected $default_data;
+
+	/**
+	 * @var Locale[]
+	 */
+	protected $locales;
+
+	/**
+	 * @var LocaleSwitcher
+	 */
+	protected $locale_switcher;
+
+	/**
+	 * @var string
+	 */
+	protected $site_locale;
+
+	/**
+	 * @var string
+	 */
+	protected $user_locale;
+
+
+	/**
+	 * LocaleFloatFormatter constructor.
+	 *
+	 * @param DefaultLocaleData $default_data
+	 * @param LocaleSwitcher $locale_switcher
+	 */
+	public function __construct(DefaultLocaleData $default_data, LocaleSwitcher $locale_switcher)
+	{
+		$this->default_data = $default_data;
+		$this->locale_switcher = $locale_switcher;
+		$this->site_locale = $this->default_data->getDefaultLocale();
+		// give site owners a chance to change the locale for the site
+		// ex: some of the WordPress language locales, like "ja" (Japan) do not specify a country
+		// but the locale data on teh server might require it, like "ja_JP"
+		$this->site_locale = sanitize_text_field(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_locale_Locales__construct__site_locale',
+				! empty($this->site_locale) ? $this->site_locale : get_locale()
+			)
+		);
+		$this->user_locale = get_user_locale();
+	}
+
+
+	/**
+	 * @param string|Locale $locale locale name ex: en_US or Locale object
+	 * @return Locale
+	 */
+	public function getLocale($locale): Locale
+	{
+		$locale = ! empty($locale) ? $locale : $this->site_locale;
+		if ($locale instanceof Locale) {
+			return $locale;
+		}
+		if (isset($this->locales[ $locale ])) {
+			return $this->locales[ $locale ];
+		}
+		$locale_info = $this->locale_switcher->getLocale($locale);
+		if (! empty($locale_info)) {
+			$this->locales[ $locale ] = new Locale($locale, $locale_info, $this->default_data->getDefaults());
+			return $this->locales[ $locale ];
+		}
+		throw new DomainException(
+			sprintf(
+				esc_html__(
+					'The "%1$s" locale is either missing or invalid. Please contact your hosting provider about having it enabled on the server',
+					'event_espresso'
+				),
+				$locale
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $currency_ISO              ex: "USD"
+	 * @param bool   $fallback_to_site_locale   [optional] if true, will return the site locale
+	 *                                          if a locale can not be identified for the supplied currency ISO
+	 * @return Locale
+	 */
+	public function getLocaleForCurrencyISO(string $currency_ISO, bool $fallback_to_site_locale = false): Locale
+	{
+		$locale_name = '';
+		// first try to find a matching currency in the current list of locales
+		foreach ($this->locales as $locale) {
+			if ($locale instanceof Locale) {
+				if ($locale->currencyIsoCode() === $currency_ISO) {
+					$locale_name = $locale->name();
+					break;
+				}
+			}
+		}
+		// give site owners a chance to specify the appropriate locale for the provided currency ISO code
+		// ex: the Canadian Dollar "CAD" could be for the locale "en_CA" or "fr_CA"
+		// and the Euro (EUR) could be one of ~20 or so countries that use it, many of which have multiple locales
+		$locale_name = sanitize_text_field(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_locale_Locales__getLocaleForCurrencyISO__locale_name',
+				$locale_name,
+				$currency_ISO
+			)
+		);
+		if ($locale_name) {
+			return $this->getLocale($locale_name);
+		}
+		if ($fallback_to_site_locale) {
+			return $this->getSiteLocale();
+		}
+		throw new DomainException(
+			sprintf(
+				esc_html__(
+					'The "%1$s" locale corresponding to the "%2$s" currency is either missing or invalid. Please contact your hosting provider about having it enabled on the server',
+					'event_espresso'
+				),
+				$locale_name,
+				$currency_ISO
+			)
+		);
+	}
+
+
+	/**
+	 * @return Locale
+	 */
+	public function getSiteLocale(): Locale
+	{
+		return $this->getLocale($this->site_locale);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getSiteLocaleName(): string
+	{
+		return $this->site_locale;
+	}
+
+
+	/**
+	 * @return Locale
+	 */
+	public function getUserLocale(): Locale
+	{
+		return $this->getLocale($this->user_locale);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getUserLocaleName(): string
+	{
+		return $this->user_locale;
+	}
 }

core/libraries/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

Spacing +2 added lines, -2 removed lines

@@ -112,7 +112,7 @@ 
         // price td
         $html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_r');
         // total td
-        $total = $line_item->is_taxable() ? $line_item->prettyTotal() . '*' : $line_item->prettyTotal();
+        $total = $line_item->is_taxable() ? $line_item->prettyTotal().'*' : $line_item->prettyTotal();
         $html .= EEH_HTML::td($total, '', 'item_r');
         // end of row
         $html .= EEH_HTML::trx();
@@ -137,7 +137,7 @@ 
         $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
+        $html .= EEH_HTML::td().EEH_HTML::tdx();
         // discount/surcharge td
         if ($line_item->is_percent()) {
             $html .= EEH_HTML::td($line_item->prettyPercent(), '', 'item_r');

Indentation +213 added lines, -213 removed lines

@@ -14,221 +14,221 @@
  */
 class EE_Invoice_Line_Item_Display_Strategy extends LineItemDisplayStrategy
 {
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_separator_row($options);
-                $html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, esc_html__('Sub-Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, esc_html__('Tax Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax:
-                $html .= $this->_tax_row($line_item, $options);
-                break;
-        }
-
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', $row_class);
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_r');
-        // price td
-        $html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_r');
-        // total td
-        $total = $line_item->is_taxable() ? $line_item->prettyTotal() . '*' : $line_item->prettyTotal();
-        $html .= EEH_HTML::td($total, '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->prettyPercent(), '', 'item_r');
-        } else {
-            $html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_r');
-        }
-        // total td
-        $html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // percent td
-        $html .= EEH_HTML::td(
-            $line_item->prettyPercent(),
-            '',
-            'item_r',
-            '',
-            ' colspan="2"'
-        );
-        // total td
-        $html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="2"' : '';
-        // start of row
-        $html = EEH_HTML::tr('', '', 'total_tr odd');
-        // empty td
-        $html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($line_item->prettyTotal(), '', 'total');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _separator_row
-     *
-     * @param array        $options
-     * @return mixed
-     */
-    private function _separator_row($options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
-        // start of row
-        $html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_separator_row($options);
+				$html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, esc_html__('Sub-Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, esc_html__('Tax Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax:
+				$html .= $this->_tax_row($line_item, $options);
+				break;
+		}
+
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', $row_class);
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_r');
+		// price td
+		$html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_r');
+		// total td
+		$total = $line_item->is_taxable() ? $line_item->prettyTotal() . '*' : $line_item->prettyTotal();
+		$html .= EEH_HTML::td($total, '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		$html .= EEH_HTML::td() . EEH_HTML::tdx();
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->prettyPercent(), '', 'item_r');
+		} else {
+			$html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_r');
+		}
+		// total td
+		$html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// percent td
+		$html .= EEH_HTML::td(
+			$line_item->prettyPercent(),
+			'',
+			'item_r',
+			'',
+			' colspan="2"'
+		);
+		// total td
+		$html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="2"' : '';
+		// start of row
+		$html = EEH_HTML::tr('', '', 'total_tr odd');
+		// empty td
+		$html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($line_item->prettyTotal(), '', 'total');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _separator_row
+	 *
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _separator_row($options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
+		// start of row
+		$html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
 //      // separator td
 //      $html .= EEH_HTML::td( '<hr>', '',  '',  '',  $colspan );
 //      // end of row
 //      $html .= EEH_HTML::trx();
-        return $html;
-    }
+		return $html;
+	}
 }

core/libraries/line_item_display/LineItemDisplayStrategy.php

Indentation +21 added lines, -21 removed lines

@@ -10,28 +10,28 @@
 abstract class LineItemDisplayStrategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @var CurrencyFormatter
-     * @since $VID:$
-     */
-    protected $currency_formatter;
+	/**
+	 * @var CurrencyFormatter
+	 * @since $VID:$
+	 */
+	protected $currency_formatter;
 
-    /**
-     * @var NumberFormatter
-     */
-    protected $decimal_formatter;
+	/**
+	 * @var NumberFormatter
+	 */
+	protected $decimal_formatter;
 
 
-    /**
-     * LineItemDisplayStrategy constructor.
-     *
-     * @param CurrencyFormatter $currency_formatter
-     */
-    public function __construct(CurrencyFormatter $currency_formatter = null)
-    {
-        if (! $currency_formatter instanceof CurrencyFormatter) {
-            $currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
-        }
-        $this->currency_formatter = $currency_formatter;
-    }
+	/**
+	 * LineItemDisplayStrategy constructor.
+	 *
+	 * @param CurrencyFormatter $currency_formatter
+	 */
+	public function __construct(CurrencyFormatter $currency_formatter = null)
+	{
+		if (! $currency_formatter instanceof CurrencyFormatter) {
+			$currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
+		}
+		$this->currency_formatter = $currency_formatter;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
      */
     public function __construct(CurrencyFormatter $currency_formatter = null)
     {
-        if (! $currency_formatter instanceof CurrencyFormatter) {
+        if ( ! $currency_formatter instanceof CurrencyFormatter) {
             $currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
         }
         $this->currency_formatter = $currency_formatter;

core/libraries/line_item_display/EE_Default_Line_Item_Display_Strategy.strategy.php

Indentation +215 added lines, -215 removed lines

@@ -13,219 +13,219 @@
 class EE_Default_Line_Item_Display_Strategy extends LineItemDisplayStrategy
 {
 
-    /**
-     * total amount of tax to apply
-     *
-     * @type float $_tax_rate
-     */
-    private $_tax_rate = 0;
-
-    /**
-     * total amount including tax we can bill for at this time
-     *
-     * @type float $_grand_total
-     */
-    private $_grand_total = 0.00;
-
-    /**
-     * total number of items being billed for
-     *
-     * @type int $_total_items
-     */
-    private $_total_items = 0;
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function total_items()
-    {
-        return $this->_total_items;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = [])
-    {
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = [
-            'show_desc' => true,  //    TRUE        FALSE
-            'odd'       => false,
-        ];
-        $options         = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_sub_total:
-                break;
-
-            case EEM_Line_Item::type_tax:
-                $this->_tax_rate += $line_item->percent();
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-                foreach ($line_item->children() as $child_line_item) {
-                    if ($child_line_item->type() == EEM_Line_Item::type_tax) {
-                        // recursively feed children back into this method
-                        $this->display_line_item($child_line_item, $options);
-                    }
-                }
-                break;
-
-            case EEM_Line_Item::type_total:
-                // get all child line items
-                $children = $line_item->children();
-                if ($options['set_tax_rate'] === true) {
-                    // loop thru tax child line items just to determine tax rate
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                } else {
-                    // now loop thru all non-tax child line items
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $html .= $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                }
-                break;
-        }
-
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = [])
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html      = EEH_HTML::tr('', '', $row_class);
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
-            $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
-            ($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
-                : ''),
-            $line_item,
-            $options
-        );
-        if ($line_item->is_taxable()) {
-            $ticket_price_includes_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
-                ? esc_html__('* price includes taxes', 'event_espresso')
-                : esc_html__('* price does not include taxes', 'event_espresso');
-            $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                              . $ticket_price_includes_taxes
-                              . '</span>';
-        }
-
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
-        // quantity td
-        $html     .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        $tax_rate = $line_item->is_taxable()
-                    && EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
-            ? 1 + ($this->_tax_rate / 100)
-            : 1;
-        // price td
-        // FIRST get the correctly rounded price per ticket including taxes
-        $raw_unit_price = $this->currency_formatter->roundForLocale($line_item->unit_price() * $tax_rate);
-        $unit_price     = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
-            $this->currency_formatter->formatForLocale($raw_unit_price),
-            $line_item,
-            $tax_rate
-        );
-        $html           .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
-        // total td
-        $total = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
-            $this->currency_formatter->formatForLocale($raw_unit_price * $line_item->quantity()),
-            $line_item,
-            $tax_rate
-        );
-        $html  .= EEH_HTML::td($total, '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-
-        return $html;
-    }
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = [])
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name && desc
-        $name_and_desc = $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
-                                                  . $line_item->desc()
-                                                  . '</span>' : '';
-        // name td
-        $html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->prettyPercent(), '', 'item_c');
-        } else {
-            $html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_c jst-rght');
-        }
-        // total td
-        $html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * total amount of tax to apply
+	 *
+	 * @type float $_tax_rate
+	 */
+	private $_tax_rate = 0;
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 *
+	 * @type float $_grand_total
+	 */
+	private $_grand_total = 0.00;
+
+	/**
+	 * total number of items being billed for
+	 *
+	 * @type int $_total_items
+	 */
+	private $_total_items = 0;
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function total_items()
+	{
+		return $this->_total_items;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = [])
+	{
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = [
+			'show_desc' => true,  //    TRUE        FALSE
+			'odd'       => false,
+		];
+		$options         = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_sub_total:
+				break;
+
+			case EEM_Line_Item::type_tax:
+				$this->_tax_rate += $line_item->percent();
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+				foreach ($line_item->children() as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax) {
+						// recursively feed children back into this method
+						$this->display_line_item($child_line_item, $options);
+					}
+				}
+				break;
+
+			case EEM_Line_Item::type_total:
+				// get all child line items
+				$children = $line_item->children();
+				if ($options['set_tax_rate'] === true) {
+					// loop thru tax child line items just to determine tax rate
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$this->display_line_item($child_line_item, $options);
+						}
+					}
+				} else {
+					// now loop thru all non-tax child line items
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$html .= $this->display_line_item($child_line_item, $options);
+						}
+					}
+				}
+				break;
+		}
+
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = [])
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html      = EEH_HTML::tr('', '', $row_class);
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
+			$line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+				: ''),
+			$line_item,
+			$options
+		);
+		if ($line_item->is_taxable()) {
+			$ticket_price_includes_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
+				? esc_html__('* price includes taxes', 'event_espresso')
+				: esc_html__('* price does not include taxes', 'event_espresso');
+			$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
+							  . $ticket_price_includes_taxes
+							  . '</span>';
+		}
+
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
+		// quantity td
+		$html     .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$tax_rate = $line_item->is_taxable()
+					&& EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
+			? 1 + ($this->_tax_rate / 100)
+			: 1;
+		// price td
+		// FIRST get the correctly rounded price per ticket including taxes
+		$raw_unit_price = $this->currency_formatter->roundForLocale($line_item->unit_price() * $tax_rate);
+		$unit_price     = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
+			$this->currency_formatter->formatForLocale($raw_unit_price),
+			$line_item,
+			$tax_rate
+		);
+		$html           .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
+		// total td
+		$total = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
+			$this->currency_formatter->formatForLocale($raw_unit_price * $line_item->quantity()),
+			$line_item,
+			$tax_rate
+		);
+		$html  .= EEH_HTML::td($total, '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+
+		return $html;
+	}
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = [])
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name && desc
+		$name_and_desc = $line_item->name();
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
+												  . $line_item->desc()
+												  . '</span>' : '';
+		// name td
+		$html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->prettyPercent(), '', 'item_c');
+		} else {
+			$html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'item_c jst-rght');
+		}
+		// total td
+		$html .= EEH_HTML::td($line_item->prettyTotal(), '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -65,10 +65,10 @@ 
         $html = '';
         // set some default options and merge with incoming
         $default_options = [
-            'show_desc' => true,  //    TRUE        FALSE
+            'show_desc' => true, //    TRUE        FALSE
             'odd'       => false,
         ];
-        $options         = array_merge($default_options, (array) $options);
+        $options = array_merge($default_options, (array) $options);
 
         switch ($line_item->type()) {
             case EEM_Line_Item::type_line_item:
@@ -149,7 +149,7 @@ 
         );
         $name_and_desc .= apply_filters(
             'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
-            ($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+            ($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>'
                 : ''),
             $line_item,
             $options
@@ -166,7 +166,7 @@ 
         // name td
         $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
         // quantity td
-        $html     .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
         $tax_rate = $line_item->is_taxable()
                     && EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
             ? 1 + ($this->_tax_rate / 100)
@@ -180,7 +180,7 @@ 
             $line_item,
             $tax_rate
         );
-        $html           .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
+        $html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
         // total td
         $total = apply_filters(
             'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
@@ -188,7 +188,7 @@ 
             $line_item,
             $tax_rate
         );
-        $html  .= EEH_HTML::td($total, '', 'item_r jst-rght');
+        $html .= EEH_HTML::td($total, '', 'item_r jst-rght');
         // end of row
         $html .= EEH_HTML::trx();
 

core/libraries/line_item_display/EE_Admin_Table_Registration_Line_Item_Display_Strategy.strategy.php

Spacing +9 added lines, -9 removed lines

@@ -75,15 +75,15 @@ 
             : $line_item->name();
 
         $name_html = $name_link
-            ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+            ? '<a href="'.$name_link.'">'.$name_html.'</a>'
             : $name_html;
 
         $name_html .= $line_item->is_taxable() ? ' *' : '';
         // maybe preface with icon?
         $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
+            ? $line_item_related_object->get_icon().$name_html
             : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+        $name_html = '<span class="ee-line-item-name linked">'.$name_html.'</span><br>';
         $name_html .= sprintf(
             _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
             '<span class="ee-line-item-related-parent-object">',
@@ -91,7 +91,7 @@ 
                 ? $line_item->parent()->OBJ_type_i18n()
                 : esc_html__('Item:', 'event_espresso'),
             $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+                ? '<a href="'.$parent_related_object_link.'">'.$parent_related_object_name.'</a>'
                 : $parent_related_object_name,
             '</span>'
         );
@@ -110,7 +110,7 @@ 
         $type_html .= $line_item->OBJ_type() ? '<br />' : '';
         $code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
         $type_html .= ! empty($code)
-            ? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
+            ? '<span class="ee-line-item-id">'.sprintf(esc_html__('Code: %s', 'event_espresso'), $code).'</span>'
             : '';
         $html      .= EEH_HTML::td($type_html, '', 'jst-left');
 
@@ -120,7 +120,7 @@ 
             $datetimes = $line_item_related_object->datetimes();
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+                    $datetime_content .= $datetime->get_dtt_display_name().'<br>';
                 }
             }
         }
@@ -154,7 +154,7 @@ 
         $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
         // name th
         $html .= EEH_HTML::th(
-            $line_item->name() . '(' . $line_item->prettyPercent() . ')',
+            $line_item->name().'('.$line_item->prettyPercent().')',
             '',
             'jst-rght',
             '',
@@ -193,12 +193,12 @@ 
         if ($total_match) {
             $total_label = sprintf(
                 esc_html__('This registration\'s total %s:', 'event_espresso'),
-                '(' . $currency_code . ')'
+                '('.$currency_code.')'
             );
         } else {
             $total_label = sprintf(
                 esc_html__('This registration\'s approximate total %s', 'event_espresso'),
-                '(' . $currency_code . ')'
+                '('.$currency_code.')'
             );
             $total_label .= '<br>';
             $total_label .= '<p class="ee-footnote-text">'

Indentation +208 added lines, -208 removed lines

@@ -14,212 +14,212 @@
 class EE_Admin_Table_Registration_Line_Item_Display_Strategy extends EE_Admin_Table_Line_Item_Display_Strategy
 {
 
-    /**
-     * Table header for display.
-     *
-     * @param array $options
-     * @return string
-     * @since   4.8
-     */
-    protected function _table_header($options)
-    {
-        $html = EEH_HTML::table('', '', $options['table_css_class']);
-        $html .= EEH_HTML::thead();
-        $html .= EEH_HTML::tr();
-        $html .= EEH_HTML::th(esc_html__('Name', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Type', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Date(s)', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Amount', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::tbody();
-        return $html;
-    }
-
-
-    /**
-     *    _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _item_row(EE_Line_Item $line_item, $options = [])
-    {
-        $line_item_related_object        = $line_item->get_object();
-        $parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->get_object()
-            : null;
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html      = EEH_HTML::tr('', '', $row_class);
-
-
-        // Name Column
-        $name_link = $line_item_related_object instanceof EEI_Admin_Links
-            ? $line_item_related_object->get_admin_details_link()
-            : '';
-
-        // related object scope.
-        $parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
-            ? $parent_line_item_related_object->name()
-            : '';
-        $parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->name()
-            : $parent_related_object_name;
-        $parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
-            ? $parent_line_item_related_object->get_admin_details_link()
-            : '';
-
-        $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
-            ? $line_item_related_object->name()
-            : $line_item->name();
-
-        $name_html = $name_link
-            ? '<a href="' . $name_link . '">' . $name_html . '</a>'
-            : $name_html;
-
-        $name_html .= $line_item->is_taxable() ? ' *' : '';
-        // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
-            : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .= sprintf(
-            _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
-            '<span class="ee-line-item-related-parent-object">',
-            $line_item->parent() instanceof EE_Line_Item
-                ? $line_item->parent()->OBJ_type_i18n()
-                : esc_html__('Item:', 'event_espresso'),
-            $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
-                : $parent_related_object_name,
-            '</span>'
-        );
-
-        $name_html = apply_filters(
-            'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
-            $name_html,
-            $line_item,
-            $options
-        );
-
-        $html .= EEH_HTML::td($name_html, '', 'jst-left');
-        // Type Column
-        $type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
-        $type_html .= $this->_get_cancellations($line_item);
-        $type_html .= $line_item->OBJ_type() ? '<br />' : '';
-        $code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code)
-            ? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
-            : '';
-        $html      .= EEH_HTML::td($type_html, '', 'jst-left');
-
-        // Date column
-        $datetime_content = '';
-        if ($line_item_related_object instanceof EE_Ticket) {
-            $datetimes = $line_item_related_object->datetimes();
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
-                }
-            }
-        }
-        $html .= EEH_HTML::td($datetime_content, '', 'jst-left');
-
-        // Amount Column
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->prettyPercent(), '', 'jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'jst-rght');
-        }
-
-        // finish things off and return
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _tax_row(EE_Line_Item $line_item, $options = [])
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
-        // name th
-        $html .= EEH_HTML::th(
-            $line_item->name() . '(' . $line_item->prettyPercent() . ')',
-            '',
-            'jst-rght',
-            '',
-            ' colspan="3"'
-        );
-        // total th
-        $html .= EEH_HTML::th($line_item->prettyTotal(), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _total_row(EE_Line_Item $line_item, $options = [])
-    {
-        $currency_code      = $this->currency_formatter->getCurrencyIsoCodeForLocale();
-        $registration       = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
-        $registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
-        // if no valid registration object then we're not going to show the approximate text.
-        $total_match = $registration instanceof EE_Registration
-            ? $registration->final_price() === $line_item->total()
-            : true;
-
-        // start of row
-        $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
-        // Total th label
-        if ($total_match) {
-            $total_label = sprintf(
-                esc_html__('This registration\'s total %s:', 'event_espresso'),
-                '(' . $currency_code . ')'
-            );
-        } else {
-            $total_label = sprintf(
-                esc_html__('This registration\'s approximate total %s', 'event_espresso'),
-                '(' . $currency_code . ')'
-            );
-            $total_label .= '<br>';
-            $total_label .= '<p class="ee-footnote-text">'
-                            . sprintf(
-                                esc_html__(
-                                    'The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.',
-                                    'event_espresso'
-                                ),
-                                '<strong>',
-                                $registration_total,
-                                '</strong>'
-                            )
-                            . '</p>';
-        }
-        $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
-        // total th
-
-        $html .= EEH_HTML::th($line_item->prettyTotal(), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * Table header for display.
+	 *
+	 * @param array $options
+	 * @return string
+	 * @since   4.8
+	 */
+	protected function _table_header($options)
+	{
+		$html = EEH_HTML::table('', '', $options['table_css_class']);
+		$html .= EEH_HTML::thead();
+		$html .= EEH_HTML::tr();
+		$html .= EEH_HTML::th(esc_html__('Name', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Type', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Date(s)', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Amount', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::tbody();
+		return $html;
+	}
+
+
+	/**
+	 *    _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _item_row(EE_Line_Item $line_item, $options = [])
+	{
+		$line_item_related_object        = $line_item->get_object();
+		$parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->get_object()
+			: null;
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html      = EEH_HTML::tr('', '', $row_class);
+
+
+		// Name Column
+		$name_link = $line_item_related_object instanceof EEI_Admin_Links
+			? $line_item_related_object->get_admin_details_link()
+			: '';
+
+		// related object scope.
+		$parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
+			? $parent_line_item_related_object->name()
+			: '';
+		$parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->name()
+			: $parent_related_object_name;
+		$parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
+			? $parent_line_item_related_object->get_admin_details_link()
+			: '';
+
+		$name_html = $line_item_related_object instanceof EEI_Line_Item_Object
+			? $line_item_related_object->name()
+			: $line_item->name();
+
+		$name_html = $name_link
+			? '<a href="' . $name_link . '">' . $name_html . '</a>'
+			: $name_html;
+
+		$name_html .= $line_item->is_taxable() ? ' *' : '';
+		// maybe preface with icon?
+		$name_html = $line_item_related_object instanceof EEI_Has_Icon
+			? $line_item_related_object->get_icon() . $name_html
+			: $name_html;
+		$name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+		$name_html .= sprintf(
+			_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
+			'<span class="ee-line-item-related-parent-object">',
+			$line_item->parent() instanceof EE_Line_Item
+				? $line_item->parent()->OBJ_type_i18n()
+				: esc_html__('Item:', 'event_espresso'),
+			$parent_related_object_link
+				? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+				: $parent_related_object_name,
+			'</span>'
+		);
+
+		$name_html = apply_filters(
+			'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
+			$name_html,
+			$line_item,
+			$options
+		);
+
+		$html .= EEH_HTML::td($name_html, '', 'jst-left');
+		// Type Column
+		$type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
+		$type_html .= $this->_get_cancellations($line_item);
+		$type_html .= $line_item->OBJ_type() ? '<br />' : '';
+		$code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
+		$type_html .= ! empty($code)
+			? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
+			: '';
+		$html      .= EEH_HTML::td($type_html, '', 'jst-left');
+
+		// Date column
+		$datetime_content = '';
+		if ($line_item_related_object instanceof EE_Ticket) {
+			$datetimes = $line_item_related_object->datetimes();
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+				}
+			}
+		}
+		$html .= EEH_HTML::td($datetime_content, '', 'jst-left');
+
+		// Amount Column
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->prettyPercent(), '', 'jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->prettyUnitPrice(), '', 'jst-rght');
+		}
+
+		// finish things off and return
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _tax_row(EE_Line_Item $line_item, $options = [])
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
+		// name th
+		$html .= EEH_HTML::th(
+			$line_item->name() . '(' . $line_item->prettyPercent() . ')',
+			'',
+			'jst-rght',
+			'',
+			' colspan="3"'
+		);
+		// total th
+		$html .= EEH_HTML::th($line_item->prettyTotal(), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _total_row(EE_Line_Item $line_item, $options = [])
+	{
+		$currency_code      = $this->currency_formatter->getCurrencyIsoCodeForLocale();
+		$registration       = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
+		$registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
+		// if no valid registration object then we're not going to show the approximate text.
+		$total_match = $registration instanceof EE_Registration
+			? $registration->final_price() === $line_item->total()
+			: true;
+
+		// start of row
+		$html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
+		// Total th label
+		if ($total_match) {
+			$total_label = sprintf(
+				esc_html__('This registration\'s total %s:', 'event_espresso'),
+				'(' . $currency_code . ')'
+			);
+		} else {
+			$total_label = sprintf(
+				esc_html__('This registration\'s approximate total %s', 'event_espresso'),
+				'(' . $currency_code . ')'
+			);
+			$total_label .= '<br>';
+			$total_label .= '<p class="ee-footnote-text">'
+							. sprintf(
+								esc_html__(
+									'The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.',
+									'event_espresso'
+								),
+								'<strong>',
+								$registration_total,
+								'</strong>'
+							)
+							. '</p>';
+		}
+		$html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
+		// total th
+
+		$html .= EEH_HTML::th($line_item->prettyTotal(), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

Indentation +640 added lines, -640 removed lines

@@ -12,649 +12,649 @@
  */
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
-    // private instance of the Message object
-    protected static $_instance = null;
-
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	// private instance of the Message object
+	protected static $_instance = null;
+
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }