eventespresso / event-espresso-core

core/db_models/EEM_Question_Group.model.php

Spacing +5 added lines, -5 removed lines

@@ -45,10 +45,10 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QSG_system');
         parent::__construct($timezone);
     }
     /**
@@ -59,7 +59,7 @@ 
     public function get_latest_question_group_order()
     {
         $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
+            'max_order' => array("MAX(QSG_order)", "%d")
             );
         $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
         return $max[0]['max_order'];

Indentation +51 added lines, -51 removed lines

@@ -11,58 +11,58 @@
  */
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
-    const system_personal = 1;
-    const system_address = 2;
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	const system_personal = 1;
+	const system_address = 2;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Question Group', 'event_espresso');
-        $this->plural_item = esc_html__('Question Groups', 'event_espresso');
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Question Group', 'event_espresso');
+		$this->plural_item = esc_html__('Question Groups', 'event_espresso');
 
-        $this->_tables = array(
-            'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID')
-        );
-        $this->_fields = array(
-            'Question_Group' => array(
-                'QSG_ID' => new EE_Primary_Key_Int_Field('QSG_ID', esc_html__('Question Group ID', 'event_espresso')),
-                'QSG_name' => new EE_Plain_Text_Field('QSG_name', esc_html__('Question Group Name', 'event_espresso'), false, ''),
-                'QSG_identifier' => new EE_Plain_Text_Field('QSG_identifier', esc_html__('Text ID for question Group', 'event_espresso'), false, ''),
-                'QSG_desc' => new EE_Post_Content_Field('QSG_desc', esc_html__('Description of Question Group', 'event_espresso'), true, ''),
-                'QSG_order' => new EE_Integer_Field('QSG_order', esc_html__('Order in which to show the question group', 'event_espresso'), true, 0),
-                'QSG_show_group_name' => new EE_Boolean_Field('QSG_show_group_name', esc_html__('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
-                'QSG_show_group_desc' => new EE_Boolean_Field('QSG_show_group_desc', esc_html__('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
-                'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', esc_html__('Question Group Creator ID', 'event_espresso'), false),
-                'QSG_system' => new EE_Integer_Field('QSG_system', esc_html__('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
-                'QSG_deleted' => new EE_Trashed_Flag_Field('QSG_deleted', esc_html__('Flag indicating this question group was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question' => new EE_HABTM_Relation('Question_Group_Question'),
-            'Event' => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        parent::__construct($timezone);
-    }
-    /**
-     * searches the db for the question group with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_group_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
-            );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return $max[0]['max_order'];
-    }
+		$this->_tables = array(
+			'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID')
+		);
+		$this->_fields = array(
+			'Question_Group' => array(
+				'QSG_ID' => new EE_Primary_Key_Int_Field('QSG_ID', esc_html__('Question Group ID', 'event_espresso')),
+				'QSG_name' => new EE_Plain_Text_Field('QSG_name', esc_html__('Question Group Name', 'event_espresso'), false, ''),
+				'QSG_identifier' => new EE_Plain_Text_Field('QSG_identifier', esc_html__('Text ID for question Group', 'event_espresso'), false, ''),
+				'QSG_desc' => new EE_Post_Content_Field('QSG_desc', esc_html__('Description of Question Group', 'event_espresso'), true, ''),
+				'QSG_order' => new EE_Integer_Field('QSG_order', esc_html__('Order in which to show the question group', 'event_espresso'), true, 0),
+				'QSG_show_group_name' => new EE_Boolean_Field('QSG_show_group_name', esc_html__('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
+				'QSG_show_group_desc' => new EE_Boolean_Field('QSG_show_group_desc', esc_html__('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
+				'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', esc_html__('Question Group Creator ID', 'event_espresso'), false),
+				'QSG_system' => new EE_Integer_Field('QSG_system', esc_html__('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
+				'QSG_deleted' => new EE_Trashed_Flag_Field('QSG_deleted', esc_html__('Flag indicating this question group was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question' => new EE_HABTM_Relation('Question_Group_Question'),
+			'Event' => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		parent::__construct($timezone);
+	}
+	/**
+	 * searches the db for the question group with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_group_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QSG_order)","%d")
+			);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return $max[0]['max_order'];
+	}
 }

core/db_models/EEM_Attendee.model.php

Spacing +3 added lines, -3 removed lines

@@ -284,8 +284,8 @@ 
      */
     public function get_attendee_field_for_system_question($system_question_string)
     {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+        return isset($this->_system_question_to_attendee_field_name[$system_question_string])
+            ? $this->_system_question_to_attendee_field_name[$system_question_string]
             : null;
     }
 
@@ -353,7 +353,7 @@ 
             return false;
         }
         $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
+        if ( ! empty($attendee)) {
             return array_shift($attendee);
         }
         return false;

Indentation +419 added lines, -419 removed lines

@@ -13,432 +13,432 @@
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    /**
-     * QST_system for questions are strings not integers now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not integers now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
 
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname = 'fname';
-
-    const system_question_lname = 'lname';
-
-    const system_question_email = 'email';
-
-    const system_question_email_confirm = 'email_confirm';
-
-    const system_question_address = 'address';
-
-    const system_question_address2 = 'address2';
-
-    const system_question_city = 'city';
-
-    const system_question_state = 'state';
-
-    const system_question_country = 'country';
-
-    const system_question_zip = 'zip';
-
-    const system_question_phone = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name = array(
-        EEM_Attendee::system_question_fname    => 'ATT_fname',
-        EEM_Attendee::system_question_lname    => 'ATT_lname',
-        EEM_Attendee::system_question_email    => 'ATT_email',
-        EEM_Attendee::system_question_address  => 'ATT_address',
-        EEM_Attendee::system_question_address2 => 'ATT_address2',
-        EEM_Attendee::system_question_city     => 'ATT_city',
-        EEM_Attendee::system_question_state    => 'STA_ID',
-        EEM_Attendee::system_question_country  => 'CNT_ISO',
-        EEM_Attendee::system_question_zip      => 'ATT_zip',
-        EEM_Attendee::system_question_phone    => 'ATT_phone',
-    );
-
-
-
-    /**
-     * EEM_Attendee constructor.
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('Attendee', 'event_espresso');
-        $this->plural_item = esc_html__('Attendees', 'event_espresso');
-        $this->_tables = array(
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table(
-                'esp_attendee_meta',
-                'ATTM_ID',
-                'ATT_ID'
-            ),
-        );
-        $this->_fields = array(
-            'Attendee_CPT'  => array(
-                'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('Attendee ID', 'event_espresso')
-                ),
-                'ATT_full_name' => $model_field_factory->createPlainTextField(
-                    'post_title',
-                    esc_html__('Attendee Full Name', 'event_espresso'),
-                    false,
-                    esc_html__('Unknown', 'event_espresso')
-                ),
-                'ATT_bio'       => $model_field_factory->createPostContentField(
-                    'post_content',
-                    esc_html__('Attendee Biography', 'event_espresso'),
-                    false,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_slug'      => $model_field_factory->createSlugField(
-                    'post_name',
-                    esc_html__('Attendee URL Slug', 'event_espresso')
-                ),
-                'ATT_created'   => $model_field_factory->createDatetimeField(
-                    'post_date',
-                    esc_html__('Time Attendee Created', 'event_espresso')
-                ),
-                'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
-                    'post_excerpt',
-                    esc_html__('Attendee Short Biography', 'event_espresso'),
-                    true,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_modified'  => $model_field_factory->createDatetimeField(
-                    'post_modified',
-                    esc_html__('Time Attendee Last Modified', 'event_espresso')
-                ),
-                'ATT_author'    => $model_field_factory->createWpUserField(
-                    'post_author',
-                    esc_html__('Creator ID of the first Event attended', 'event_espresso'),
-                    false
-                ),
-                'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
-                    'post_parent',
-                    esc_html__('Parent Attendee (unused)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
-                'status'        => $model_field_factory->createWpPostStatusField(
-                    'post_status',
-                    esc_html__('Attendee Status', 'event_espresso'),
-                    false,
-                    'publish'
-                ),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'ATT_bio',
-                        'ATT_short_bio',
-                        'ATT_address',
-                        'ATT_address2',
-                        'ATT_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'ATT_zip',
-                        'ATT_email',
-                        'ATT_phone'
-                    )
-                )
-            ),
-            'Attendee_Meta' => array(
-                'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
-                    'ATTM_ID',
-                    esc_html__('Attendee Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
-                    'ATT_ID',
-                    esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
-                    false
-                ),
-                'ATT_fname'    => $model_field_factory->createPlainTextField(
-                    'ATT_fname',
-                    esc_html__('First Name', 'event_espresso')
-                ),
-                'ATT_lname'    => $model_field_factory->createPlainTextField(
-                    'ATT_lname',
-                    esc_html__('Last Name', 'event_espresso')
-                ),
-                'ATT_address'  => $model_field_factory->createPlainTextField(
-                    'ATT_address',
-                    esc_html__('Address Part 1', 'event_espresso')
-                ),
-                'ATT_address2' => $model_field_factory->createPlainTextField(
-                    'ATT_address2',
-                    esc_html__('Address Part 2', 'event_espresso')
-                ),
-                'ATT_city'     => $model_field_factory->createPlainTextField(
-                    'ATT_city',
-                    esc_html__('City', 'event_espresso')
-                ),
-                'STA_ID'       => $model_field_factory->createForeignKeyIntField(
-                    'STA_ID',
-                    esc_html__('State', 'event_espresso'),
-                    true,
-                    0,
-                    'State'
-                ),
-                'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
-                    'CNT_ISO',
-                    esc_html__('Country', 'event_espresso'),
-                    true,
-                    '',
-                    'Country'
-                ),
-                'ATT_zip'      => $model_field_factory->createPlainTextField(
-                    'ATT_zip',
-                    esc_html__('ZIP/Postal Code', 'event_espresso')
-                ),
-                'ATT_email'    => $model_field_factory->createEmailField(
-                    'ATT_email',
-                    esc_html__('Email Address', 'event_espresso')
-                ),
-                'ATT_phone'    => $model_field_factory->createPlainTextField(
-                    'ATT_phone',
-                    esc_html__('Phone', 'event_espresso')
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            // allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        $this->_caps_slug = 'contacts';
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question($system_question_string)
-    {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
-            : null;
-    }
-
-
-
-    /**
-     * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
-     *
-     * @return array
-     */
-    public function system_question_to_attendee_field_mapping()
-    {
-        return $this->_system_question_to_attendee_field_name;
-    }
-
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj)
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                        ? $transaction_id_or_obj->ID()
-                        : $transaction_id_or_obj,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param $ATT_ID
-     * @return mixed array on success, FALSE on fail
-     * @deprecated
-     */
-    public function get_attendee_by_ID($ATT_ID = false)
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param array $where_cols_n_values
-     * @return mixed array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_attendee($where_cols_n_values = array())
-    {
-        if (empty($where_cols_n_values)) {
-            return false;
-        }
-        $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
-            return array_shift($attendee);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Search for an existing Attendee record in the DB
-     *
-     * @param array $where_cols_n_values
-     * @return bool|mixed
-     * @throws EE_Error
-     */
-    public function find_existing_attendee($where_cols_n_values = null)
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = array(
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        );
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
-            ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
-            ? $valid_data
-            : false;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids
-     * and sends back a list of corresponding non duplicate EE_Attendee objects.
-     *
-     * @since  4.3.0
-     * @param  array $ids array of EE_Registration ids
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_array_of_contacts_from_reg_ids($ids)
-    {
-        $ids = (array) $ids;
-        $_where = array(
-            'Registration.REG_ID' => array('in', $ids),
-        );
-        return $this->get_all(array($_where));
-    }
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname = 'fname';
+
+	const system_question_lname = 'lname';
+
+	const system_question_email = 'email';
+
+	const system_question_email_confirm = 'email_confirm';
+
+	const system_question_address = 'address';
+
+	const system_question_address2 = 'address2';
+
+	const system_question_city = 'city';
+
+	const system_question_state = 'state';
+
+	const system_question_country = 'country';
+
+	const system_question_zip = 'zip';
+
+	const system_question_phone = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name = array(
+		EEM_Attendee::system_question_fname    => 'ATT_fname',
+		EEM_Attendee::system_question_lname    => 'ATT_lname',
+		EEM_Attendee::system_question_email    => 'ATT_email',
+		EEM_Attendee::system_question_address  => 'ATT_address',
+		EEM_Attendee::system_question_address2 => 'ATT_address2',
+		EEM_Attendee::system_question_city     => 'ATT_city',
+		EEM_Attendee::system_question_state    => 'STA_ID',
+		EEM_Attendee::system_question_country  => 'CNT_ISO',
+		EEM_Attendee::system_question_zip      => 'ATT_zip',
+		EEM_Attendee::system_question_phone    => 'ATT_phone',
+	);
+
+
+
+	/**
+	 * EEM_Attendee constructor.
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('Attendee', 'event_espresso');
+		$this->plural_item = esc_html__('Attendees', 'event_espresso');
+		$this->_tables = array(
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table(
+				'esp_attendee_meta',
+				'ATTM_ID',
+				'ATT_ID'
+			),
+		);
+		$this->_fields = array(
+			'Attendee_CPT'  => array(
+				'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('Attendee ID', 'event_espresso')
+				),
+				'ATT_full_name' => $model_field_factory->createPlainTextField(
+					'post_title',
+					esc_html__('Attendee Full Name', 'event_espresso'),
+					false,
+					esc_html__('Unknown', 'event_espresso')
+				),
+				'ATT_bio'       => $model_field_factory->createPostContentField(
+					'post_content',
+					esc_html__('Attendee Biography', 'event_espresso'),
+					false,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_slug'      => $model_field_factory->createSlugField(
+					'post_name',
+					esc_html__('Attendee URL Slug', 'event_espresso')
+				),
+				'ATT_created'   => $model_field_factory->createDatetimeField(
+					'post_date',
+					esc_html__('Time Attendee Created', 'event_espresso')
+				),
+				'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
+					'post_excerpt',
+					esc_html__('Attendee Short Biography', 'event_espresso'),
+					true,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_modified'  => $model_field_factory->createDatetimeField(
+					'post_modified',
+					esc_html__('Time Attendee Last Modified', 'event_espresso')
+				),
+				'ATT_author'    => $model_field_factory->createWpUserField(
+					'post_author',
+					esc_html__('Creator ID of the first Event attended', 'event_espresso'),
+					false
+				),
+				'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
+					'post_parent',
+					esc_html__('Parent Attendee (unused)', 'event_espresso'),
+					false,
+					0
+				),
+				'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
+				'status'        => $model_field_factory->createWpPostStatusField(
+					'post_status',
+					esc_html__('Attendee Status', 'event_espresso'),
+					false,
+					'publish'
+				),
+				'password' => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'ATT_bio',
+						'ATT_short_bio',
+						'ATT_address',
+						'ATT_address2',
+						'ATT_city',
+						'STA_ID',
+						'CNT_ISO',
+						'ATT_zip',
+						'ATT_email',
+						'ATT_phone'
+					)
+				)
+			),
+			'Attendee_Meta' => array(
+				'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
+					'ATTM_ID',
+					esc_html__('Attendee Meta Row ID', 'event_espresso'),
+					false
+				),
+				'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
+					'ATT_ID',
+					esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
+					false
+				),
+				'ATT_fname'    => $model_field_factory->createPlainTextField(
+					'ATT_fname',
+					esc_html__('First Name', 'event_espresso')
+				),
+				'ATT_lname'    => $model_field_factory->createPlainTextField(
+					'ATT_lname',
+					esc_html__('Last Name', 'event_espresso')
+				),
+				'ATT_address'  => $model_field_factory->createPlainTextField(
+					'ATT_address',
+					esc_html__('Address Part 1', 'event_espresso')
+				),
+				'ATT_address2' => $model_field_factory->createPlainTextField(
+					'ATT_address2',
+					esc_html__('Address Part 2', 'event_espresso')
+				),
+				'ATT_city'     => $model_field_factory->createPlainTextField(
+					'ATT_city',
+					esc_html__('City', 'event_espresso')
+				),
+				'STA_ID'       => $model_field_factory->createForeignKeyIntField(
+					'STA_ID',
+					esc_html__('State', 'event_espresso'),
+					true,
+					0,
+					'State'
+				),
+				'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
+					'CNT_ISO',
+					esc_html__('Country', 'event_espresso'),
+					true,
+					'',
+					'Country'
+				),
+				'ATT_zip'      => $model_field_factory->createPlainTextField(
+					'ATT_zip',
+					esc_html__('ZIP/Postal Code', 'event_espresso')
+				),
+				'ATT_email'    => $model_field_factory->createEmailField(
+					'ATT_email',
+					esc_html__('Email Address', 'event_espresso')
+				),
+				'ATT_phone'    => $model_field_factory->createPlainTextField(
+					'ATT_phone',
+					esc_html__('Phone', 'event_espresso')
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			// allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		$this->_caps_slug = 'contacts';
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question($system_question_string)
+	{
+		return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
+			? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+			: null;
+	}
+
+
+
+	/**
+	 * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
+	 *
+	 * @return array
+	 */
+	public function system_question_to_attendee_field_mapping()
+	{
+		return $this->_system_question_to_attendee_field_name;
+	}
+
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj)
+	{
+		return $this->get_all(
+			array(
+				array(
+					'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+						? $transaction_id_or_obj->ID()
+						: $transaction_id_or_obj,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param $ATT_ID
+	 * @return mixed array on success, FALSE on fail
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID($ATT_ID = false)
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param array $where_cols_n_values
+	 * @return mixed array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_attendee($where_cols_n_values = array())
+	{
+		if (empty($where_cols_n_values)) {
+			return false;
+		}
+		$attendee = $this->get_all(array($where_cols_n_values));
+		if (! empty($attendee)) {
+			return array_shift($attendee);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Search for an existing Attendee record in the DB
+	 *
+	 * @param array $where_cols_n_values
+	 * @return bool|mixed
+	 * @throws EE_Error
+	 */
+	public function find_existing_attendee($where_cols_n_values = null)
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = array(
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		);
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
+			? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
+			? $valid_data
+			: false;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids
+	 * and sends back a list of corresponding non duplicate EE_Attendee objects.
+	 *
+	 * @since  4.3.0
+	 * @param  array $ids array of EE_Registration ids
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_array_of_contacts_from_reg_ids($ids)
+	{
+		$ids = (array) $ids;
+		$_where = array(
+			'Registration.REG_ID' => array('in', $ids),
+		);
+		return $this->get_all(array($_where));
+	}
 }

core/db_models/EEM_Post_Meta.model.php

Spacing +2 added lines, -2 removed lines

@@ -59,11 +59,11 @@
         );
         $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+            $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta(
                 'meta_key',
                 'meta_value'
             );

Indentation +49 added lines, -49 removed lines

@@ -19,56 +19,56 @@
 class EEM_Post_Meta extends EEM_Base
 {
 
-    // private instance of the EE_Post_Meta object
-    protected static $_instance = null;
+	// private instance of the EE_Post_Meta object
+	protected static $_instance = null;
 
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Post Meta', 'event_espresso');
-        $this->plural_item = esc_html__('Post Metas', 'event_espresso');
-        $this->_tables = array(
-            'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Post_Meta' => array(
-                'meta_id'    => new EE_Primary_Key_Int_Field(
-                    'meta_id',
-                    esc_html__("Meta ID", "event_espresso")
-                ),
-                'post_id'    => new EE_Foreign_Key_Int_Field(
-                    'post_id',
-                    esc_html__("Primary Key of Post", "event_espresso"),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'meta_key'   => new EE_Plain_Text_Field(
-                    'meta_key',
-                    esc_html__("Meta Key", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'meta_value' => new EE_Maybe_Serialized_Text_Field(
-                    'meta_value',
-                    esc_html__("Meta Value", "event_espresso"),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations = array();
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model = true;
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
-                'meta_key',
-                'meta_value'
-            );
-        }
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Post Meta', 'event_espresso');
+		$this->plural_item = esc_html__('Post Metas', 'event_espresso');
+		$this->_tables = array(
+			'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Post_Meta' => array(
+				'meta_id'    => new EE_Primary_Key_Int_Field(
+					'meta_id',
+					esc_html__("Meta ID", "event_espresso")
+				),
+				'post_id'    => new EE_Foreign_Key_Int_Field(
+					'post_id',
+					esc_html__("Primary Key of Post", "event_espresso"),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'meta_key'   => new EE_Plain_Text_Field(
+					'meta_key',
+					esc_html__("Meta Key", "event_espresso"),
+					false,
+					''
+				),
+				'meta_value' => new EE_Maybe_Serialized_Text_Field(
+					'meta_value',
+					esc_html__("Meta Value", "event_espresso"),
+					true
+				),
+			),
+		);
+		$this->_model_relations = array();
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model = true;
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+				'meta_key',
+				'meta_value'
+			);
+		}
+		parent::__construct($timezone);
+	}
 }

core/db_models/fields/EE_Float_Field.php

Indentation +62 added lines, -62 removed lines

@@ -7,77 +7,77 @@
 class EE_Float_Field extends EE_Model_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('number');
-    }
+	/**
+	 * @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('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param type $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param type $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        // remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(
-                array(" ", EE_Config::instance()->currency->thsnds),
-                "",
-                $value_inputted_for_field_on_model_object
-            );
+		// remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(
+				array(" ", EE_Config::instance()->currency->thsnds),
+				"",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(
-                EE_Config::instance()->currency->dec_mrk,
-                ".",
-                $value_inputted_for_field_on_model_object
-            );
+			$value_inputted_for_field_on_model_object = str_replace(
+				EE_Config::instance()->currency->dec_mrk,
+				".",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace(
-                "/[^0-9,.]/",
-                "",
-                $value_inputted_for_field_on_model_object
-            );
-        }
+			$value_inputted_for_field_on_model_object = preg_replace(
+				"/[^0-9,.]/",
+				"",
+				$value_inputted_for_field_on_model_object
+			);
+		}
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format(
-            $value_on_field_to_be_outputted,
-            $EE->CFG->currency->dec_plc,
-            $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds
-        );
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format(
+			$value_on_field_to_be_outputted,
+			$EE->CFG->currency->dec_plc,
+			$EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds
+		);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //      echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_All_Caps_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
  */
 class EE_All_Caps_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * makes it all upper case, and key-like
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * makes it all upper case, and key-like
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_Text_Field_Base.php

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

core/db_models/fields/EE_Slug_Field.php

Indentation +11 added lines, -11 removed lines

@@ -2,15 +2,15 @@
 
 class EE_Slug_Field extends EE_Text_Field_Base
 {
-    /**
-     * ensures string is usable in URLs
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        // reminder: function prepares for use in URLs, not making human-readable.
-        return sanitize_title($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * ensures string is usable in URLs
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		// reminder: function prepares for use in URLs, not making human-readable.
+		return sanitize_title($value_inputted_for_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Primary_Key_Int_Field.php

Indentation +20 added lines, -20 removed lines

@@ -3,27 +3,27 @@
 class EE_Primary_Key_Int_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, 0);
-        $this->setSchemaType('integer');
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, 0);
+		$this->setSchemaType('integer');
+	}
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 
-    public function is_auto_increment()
-    {
-        return true;
-    }
+	public function is_auto_increment()
+	{
+		return true;
+	}
 }

core/db_models/fields/EE_Model_Field_Base.php

Spacing +10 added lines, -10 removed lines

@@ -127,7 +127,7 @@ 
         /**
          * allow for changing the defaults
          */
-        $this->_nicename      = apply_filters(
+        $this->_nicename = apply_filters(
             'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
             $this->_nicename,
             $this
@@ -217,7 +217,7 @@ 
      */
     public function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
     /**
@@ -312,7 +312,7 @@ 
     {
         if ($this->is_nullable()) {
             $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
+            if ( ! in_array('null', $this->_schema_type)) {
                 $this->_schema_type[] = 'null';
             };
         }
@@ -369,10 +369,10 @@ 
                 switch ($property_key) {
                     case 'pretty':
                     case 'rendered':
-                        $value_to_return[ $property_key ] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
+                        $value_to_return[$property_key] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
                         break;
                     default:
-                        $value_to_return[ $property_key ] = $default_value;
+                        $value_to_return[$property_key] = $default_value;
                         break;
                 }
             }
@@ -437,7 +437,7 @@ 
      */
     protected function setSchemaReadOnly($readonly)
     {
-        if (! is_bool($readonly)) {
+        if ( ! is_bool($readonly)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
@@ -584,7 +584,7 @@ 
      */
     private function validateSchemaType($type)
     {
-        if (! (is_string($type) || is_array($type))) {
+        if ( ! (is_string($type) || is_array($type))) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
@@ -614,7 +614,7 @@ 
             return;
         }
 
-        if (! isset($allowable_types[ $type ])) {
+        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'),
@@ -633,7 +633,7 @@ 
      */
     private function validateSchemaFormat($format)
     {
-        if (! is_string($format)) {
+        if ( ! is_string($format)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
@@ -656,7 +656,7 @@ 
             )
         );
 
-        if (! isset($allowable_formats[ $format ])) {
+        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'),

Indentation +646 added lines, -647 removed lines

@@ -20,651 +20,650 @@
  */
 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(esc_html__(
-                "Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                "event_espresso"
-            ), get_class($this)));
-        }
-    }
-
-    public function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-    public function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    public function is_auto_increment()
-    {
-        return false;
-    }
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    public function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        return $this->get_nicename();
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        if ($this->is_nullable()) {
-            $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
-                $this->_schema_type[] = 'null';
-            };
-        }
-        return $this->_schema_type;
-    }
-
-
-    /**
-     * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
-     * for this property.
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaType($type)
-    {
-        $this->validateSchemaType($type);
-        $this->_schema_type = $type;
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     *
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return 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(esc_html__(
+				"Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+				"event_espresso"
+			), get_class($this)));
+		}
+	}
+
+	public function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+	public function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	public function is_auto_increment()
+	{
+		return false;
+	}
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	public function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		return $this->get_nicename();
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		if ($this->is_nullable()) {
+			$this->_schema_type = (array) $this->_schema_type;
+			if (! in_array('null', $this->_schema_type)) {
+				$this->_schema_type[] = 'null';
+			};
+		}
+		return $this->_schema_type;
+	}
+
+
+	/**
+	 * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
+	 * for this property.
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaType($type)
+	{
+		$this->validateSchemaType($type);
+		$this->_schema_type = $type;
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 *
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return 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))
+				)
+			);
+		}
+	}
 }