eventespresso / event-espresso-core

core/db_models/fields/EE_Post_Content_Field.php

Indentation +112 added lines, -112 removed lines

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

Spacing +8 added lines, -8 removed lines

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

core/db_models/fields/EE_Model_Field_Base.php

Indentation +638 added lines, -639 removed lines

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

core/db_models/fields/EE_Simple_HTML_Field.php

Indentation +10 added lines, -10 removed lines

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

admin_pages/registrations/templates/attendee_details_main_meta_box.template.php

Spacing +5 added lines, -5 removed lines

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

core/libraries/rest_api/controllers/config/Read.php

Indentation +77 added lines, -77 removed lines

@@ -9,7 +9,7 @@ 
 use EEH_DTT_Helper;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,85 +25,85 @@ 
 class Read
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return EE_Config|WP_Error
-     */
-    public static function handleRequest(WP_REST_Request $request, $version)
-    {
-        $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
-            return EE_Config::instance();
-        } else {
-            return new WP_Error(
-                'cannot_read_config',
-                sprintf(
-                    __(
-                        'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
-                        'event_espresso'
-                    ),
-                    $cap
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return EE_Config|WP_Error
+	 */
+	public static function handleRequest(WP_REST_Request $request, $version)
+	{
+		$cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
+			return EE_Config::instance();
+		} else {
+			return new WP_Error(
+				'cannot_read_config',
+				sprintf(
+					__(
+						'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
+						'event_espresso'
+					),
+					$cap
+				),
+				array('status' => 403)
+			);
+		}
+	}
 
 
 
-    /**
-     * Handles the request for public site info
-     *
-     * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
-     *                         current user could be authenticated using basic auth data
-     * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
-     *                         basic auth data was somehow received
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return array|WP_Error
-     */
-    public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-            // @codingStandardsIgnoreStart
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            // @codingStandardsIgnoreEnd
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
-            array(
-                'default_timezone' => array(
-                    'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                    'string' => get_option('timezone_string'),
-                    'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-                ),
-                'default_currency' => EE_Config::instance()->currency,
-                'authentication'   => array(
-                    'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
-                    'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
-                    'warning'                      => $warning
-                )
-            )
-        );
-    }
+	/**
+	 * Handles the request for public site info
+	 *
+	 * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
+	 *                         current user could be authenticated using basic auth data
+	 * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
+	 *                         basic auth data was somehow received
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return array|WP_Error
+	 */
+	public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+			// @codingStandardsIgnoreStart
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			// @codingStandardsIgnoreEnd
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
+			array(
+				'default_timezone' => array(
+					'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+					'string' => get_option('timezone_string'),
+					'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+				),
+				'default_currency' => EE_Config::instance()->currency,
+				'authentication'   => array(
+					'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
+					'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
+					'warning'                      => $warning
+				)
+			)
+		);
+	}
 }
 
 // End of file Read.php

Spacing +3 added lines, -3 removed lines

@@ -8,7 +8,7 @@ 
 use EE_Restriction_Generator_Base;
 use EEH_DTT_Helper;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -97,8 +97,8 @@ 
                 ),
                 'default_currency' => EE_Config::instance()->currency,
                 'authentication'   => array(
-                    'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
-                    'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
+                    'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+                    'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
                     'warning'                      => $warning
                 )
             )

core/db_classes/EE_Attendee.class.php

Indentation +665 added lines, -665 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -23,670 +23,670 @@ 
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, EEI_Address, EEI_Admin_Links, EEI_Attendee
 {
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            //			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     */
-    public function e_full_name()
-    {
-        echo $this->full_name();
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname(),
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array     = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        //now handle state and country
-        $state_obj = $this->state_obj();
-        if (! empty($state_obj)) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if (! empty($country_obj)) {
-            $full_address_array[] = $country_obj->name();
-        }
-        //lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     */
-    public function address()
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     */
-    public function city()
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     *        get Attendee State ID
-     *
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     */
-    public function state_name()
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     */
-    public function country_name()
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related('Registration',
-            array('order_by' => array('REG_date' => 'DESC'))); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related('Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC')));//, '=', 'OBJECT_K' );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta($this->ID(), $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true));
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			//			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 */
+	public function e_full_name()
+	{
+		echo $this->full_name();
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname(),
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array     = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		//now handle state and country
+		$state_obj = $this->state_obj();
+		if (! empty($state_obj)) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if (! empty($country_obj)) {
+			$full_address_array[] = $country_obj->name();
+		}
+		//lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 *        get Attendee State ID
+	 *
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 */
+	public function state_name()
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 */
+	public function country_name()
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related('Registration',
+			array('order_by' => array('REG_date' => 'DESC'))); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related('Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC')));//, '=', 'OBJECT_K' );
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta($this->ID(), $this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true));
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 
 
 }

core/db_classes/EE_WP_User.class.php

Indentation +80 added lines, -80 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -13,93 +13,93 @@ 
 class EE_WP_User extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @var WP_User
-     */
-    protected $_wp_user_obj;
+	/**
+	 * @var WP_User
+	 */
+	protected $_wp_user_obj;
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
-    /**
-     * Return a normal WP_User object (caches the object for future calls)
-     *
-     * @return WP_User
-     */
-    public function wp_user_obj()
-    {
-        if (! $this->_wp_user_obj) {
-            $this->_wp_user_obj = get_user_by('ID', $this->ID());
-        }
-        return $this->_wp_user_obj;
-    }
+	/**
+	 * Return a normal WP_User object (caches the object for future calls)
+	 *
+	 * @return WP_User
+	 */
+	public function wp_user_obj()
+	{
+		if (! $this->_wp_user_obj) {
+			$this->_wp_user_obj = get_user_by('ID', $this->ID());
+		}
+		return $this->_wp_user_obj;
+	}
 
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return esc_url(
-            add_query_arg(
-                'wp_http_referer',
-                urlencode(
-                    wp_unslash(
-                        $_SERVER['REQUEST_URI']
-                    )
-                ),
-                get_edit_user_link($this->ID())
-            )
-        );
-    }
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return esc_url(
+			add_query_arg(
+				'wp_http_referer',
+				urlencode(
+					wp_unslash(
+						$_SERVER['REQUEST_URI']
+					)
+				),
+				get_edit_user_link($this->ID())
+			)
+		);
+	}
 
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return admin_url('users.php');
-    }
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return admin_url('users.php');
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -45,7 +45,7 @@ 
      */
     public function wp_user_obj()
     {
-        if (! $this->_wp_user_obj) {
+        if ( ! $this->_wp_user_obj) {
             $this->_wp_user_obj = get_user_by('ID', $this->ID());
         }
         return $this->_wp_user_obj;

core/services/currency/CurrencyFactory.php

Spacing +7 added lines, -7 removed lines

@@ -67,7 +67,7 @@ 
     {
         if ($this->country_currency_data === null) {
             $country_currency_data = json_decode(
-                EEH_File::get_file_contents(__DIR__ . DS . 'country-currencies.json'),
+                EEH_File::get_file_contents(__DIR__.DS.'country-currencies.json'),
                 true
             );
             $this->parseCountryCurrencyData($country_currency_data);
@@ -83,8 +83,8 @@ 
     private function parseCountryCurrencyData($country_currency_data)
     {
         foreach ($country_currency_data as $country_currency) {
-            $this->country_currencies_by_iso_code[ $country_currency['CountryISO'] ] = $country_currency;
-            $this->country_currencies_by_currency[ $country_currency['CurrencyCode'] ] = $country_currency;
+            $this->country_currencies_by_iso_code[$country_currency['CountryISO']] = $country_currency;
+            $this->country_currencies_by_currency[$country_currency['CurrencyCode']] = $country_currency;
         }
         $this->country_currency_data = $country_currency_data;
     }
@@ -128,7 +128,7 @@ 
     {
         $this->getCountryCurrencyData();
         $CNT_ISO = $CNT_ISO !== null ? $CNT_ISO : $this->site_country_iso;
-        if(! isset($this->country_currencies_by_iso_code[ $CNT_ISO ])) {
+        if ( ! isset($this->country_currencies_by_iso_code[$CNT_ISO])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -140,7 +140,7 @@ 
             );
         }
         return $this->createCurrencyFromCountryCurrency(
-            $this->country_currencies_by_iso_code[ $CNT_ISO ]
+            $this->country_currencies_by_iso_code[$CNT_ISO]
         );
     }
 
@@ -162,7 +162,7 @@ 
     public function createFromCode($code)
     {
         $this->getCountryCurrencyData();
-        if (! isset($this->country_currencies_by_currency[ $code ])) {
+        if ( ! isset($this->country_currencies_by_currency[$code])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -174,7 +174,7 @@ 
             );
         }
         return $this->createCurrencyFromCountryCurrency(
-            $this->country_currencies_by_currency[ $code ]
+            $this->country_currencies_by_currency[$code]
         );
     }
 }

Indentation +142 added lines, -142 removed lines

@@ -24,147 +24,147 @@
 class CurrencyFactory
 {
 
-    /**
-     * @var array[] $country_currency_data
-     */
-    private $country_currency_data;
-
-    /**
-     * @var array[] $country_currencies_by_iso_code
-     */
-    private $country_currencies_by_iso_code;
-
-    /**
-     * @var array[] $country_currencies_by_currency
-     */
-    private $country_currencies_by_currency;
-
-    /**
-     * @var string $site_country_iso
-     */
-    private $site_country_iso;
-
-
-    /**
-     * CurrencyFactory constructor.
-     *
-     * @param EE_Organization_Config $organization_config
-     */
-    public function __construct(EE_Organization_Config  $organization_config) {
-        $this->site_country_iso = $organization_config->CNT_ISO;
-    }
-
-
-    /**
-     * @return array[]
-     * @throws EE_Error
-     */
-    private function getCountryCurrencyData()
-    {
-        if ($this->country_currency_data === null) {
-            $country_currency_data = json_decode(
-                EEH_File::get_file_contents(__DIR__ . DS . 'country-currencies.json'),
-                true
-            );
-            $this->parseCountryCurrencyData($country_currency_data);
-        }
-        return $this->country_currency_data;
-    }
-
-
-    /**
-     * @param array[] $country_currency_data
-     */
-    private function parseCountryCurrencyData($country_currency_data)
-    {
-        foreach ($country_currency_data as $country_currency) {
-            $this->country_currencies_by_iso_code[ $country_currency['CountryISO'] ] = $country_currency;
-            $this->country_currencies_by_currency[ $country_currency['CurrencyCode'] ] = $country_currency;
-        }
-        $this->country_currency_data = $country_currency_data;
-    }
-
-
-    /**
-     * @param array $country_currency
-     * @return Currency
-     */
-    private function createCurrencyFromCountryCurrency(array $country_currency)
-    {
-        return new Currency(
-            $country_currency['CurrencyCode'],
-            new Label(
-                $country_currency['CurrencyNameSingle'],
-                $country_currency['CurrencyNamePlural']
-            ),
-            $country_currency['CurrencySign'],
-            $country_currency['CurrencySignB4'],
-            $country_currency['CurrencyDecimalPlaces'],
-            $country_currency['CurrencyDecimalMark'],
-            $country_currency['CurrencyThousands'],
-            $country_currency['CurrencySubunits']
-        );
-    }
-
-
-
-    /**
-     * returns a Currency object for the supplied country code
-     *
-     * @param string $CNT_ISO
-     * @return Currency
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function createFromCountryCode($CNT_ISO = null)
-    {
-        $this->getCountryCurrencyData();
-        $CNT_ISO = $CNT_ISO !== null ? $CNT_ISO : $this->site_country_iso;
-        if(! isset($this->country_currencies_by_iso_code[ $CNT_ISO ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Valid country currency data could not be found for the "%1$s" country code;',
-                        'event_espresso'
-                    ),
-                    $CNT_ISO
-                )
-            );
-        }
-        return $this->createCurrencyFromCountryCurrency(
-            $this->country_currencies_by_iso_code[ $CNT_ISO ]
-        );
-    }
-
-
-
-    /**
-     * returns a Currency object for the supplied currency code
-     * PLZ NOTE: variations may exist between how different countries display the same currency,
-     * so it may be necessary to use CreateCurrency::fromCountryCode() to achieve the desired results
-     *
-     * @param string $code
-     * @return Currency
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    public function createFromCode($code)
-    {
-        $this->getCountryCurrencyData();
-        if (! isset($this->country_currencies_by_currency[ $code ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'A valid currency could not be found for the "%1$s" currency code;',
-                        'event_espresso'
-                    ),
-                    $code
-                )
-            );
-        }
-        return $this->createCurrencyFromCountryCurrency(
-            $this->country_currencies_by_currency[ $code ]
-        );
-    }
+	/**
+	 * @var array[] $country_currency_data
+	 */
+	private $country_currency_data;
+
+	/**
+	 * @var array[] $country_currencies_by_iso_code
+	 */
+	private $country_currencies_by_iso_code;
+
+	/**
+	 * @var array[] $country_currencies_by_currency
+	 */
+	private $country_currencies_by_currency;
+
+	/**
+	 * @var string $site_country_iso
+	 */
+	private $site_country_iso;
+
+
+	/**
+	 * CurrencyFactory constructor.
+	 *
+	 * @param EE_Organization_Config $organization_config
+	 */
+	public function __construct(EE_Organization_Config  $organization_config) {
+		$this->site_country_iso = $organization_config->CNT_ISO;
+	}
+
+
+	/**
+	 * @return array[]
+	 * @throws EE_Error
+	 */
+	private function getCountryCurrencyData()
+	{
+		if ($this->country_currency_data === null) {
+			$country_currency_data = json_decode(
+				EEH_File::get_file_contents(__DIR__ . DS . 'country-currencies.json'),
+				true
+			);
+			$this->parseCountryCurrencyData($country_currency_data);
+		}
+		return $this->country_currency_data;
+	}
+
+
+	/**
+	 * @param array[] $country_currency_data
+	 */
+	private function parseCountryCurrencyData($country_currency_data)
+	{
+		foreach ($country_currency_data as $country_currency) {
+			$this->country_currencies_by_iso_code[ $country_currency['CountryISO'] ] = $country_currency;
+			$this->country_currencies_by_currency[ $country_currency['CurrencyCode'] ] = $country_currency;
+		}
+		$this->country_currency_data = $country_currency_data;
+	}
+
+
+	/**
+	 * @param array $country_currency
+	 * @return Currency
+	 */
+	private function createCurrencyFromCountryCurrency(array $country_currency)
+	{
+		return new Currency(
+			$country_currency['CurrencyCode'],
+			new Label(
+				$country_currency['CurrencyNameSingle'],
+				$country_currency['CurrencyNamePlural']
+			),
+			$country_currency['CurrencySign'],
+			$country_currency['CurrencySignB4'],
+			$country_currency['CurrencyDecimalPlaces'],
+			$country_currency['CurrencyDecimalMark'],
+			$country_currency['CurrencyThousands'],
+			$country_currency['CurrencySubunits']
+		);
+	}
+
+
+
+	/**
+	 * returns a Currency object for the supplied country code
+	 *
+	 * @param string $CNT_ISO
+	 * @return Currency
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function createFromCountryCode($CNT_ISO = null)
+	{
+		$this->getCountryCurrencyData();
+		$CNT_ISO = $CNT_ISO !== null ? $CNT_ISO : $this->site_country_iso;
+		if(! isset($this->country_currencies_by_iso_code[ $CNT_ISO ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Valid country currency data could not be found for the "%1$s" country code;',
+						'event_espresso'
+					),
+					$CNT_ISO
+				)
+			);
+		}
+		return $this->createCurrencyFromCountryCurrency(
+			$this->country_currencies_by_iso_code[ $CNT_ISO ]
+		);
+	}
+
+
+
+	/**
+	 * returns a Currency object for the supplied currency code
+	 * PLZ NOTE: variations may exist between how different countries display the same currency,
+	 * so it may be necessary to use CreateCurrency::fromCountryCode() to achieve the desired results
+	 *
+	 * @param string $code
+	 * @return Currency
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	public function createFromCode($code)
+	{
+		$this->getCountryCurrencyData();
+		if (! isset($this->country_currencies_by_currency[ $code ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'A valid currency could not be found for the "%1$s" currency code;',
+						'event_espresso'
+					),
+					$code
+				)
+			);
+		}
+		return $this->createCurrencyFromCountryCurrency(
+			$this->country_currencies_by_currency[ $code ]
+		);
+	}
 }
 // Location: CreateCurrency.php

core/db_models/fields/EE_Text_Field_Base.php

Spacing +1 added lines, -1 removed lines

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

Indentation +43 added lines, -43 removed lines

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