eventespresso / event-espresso-core

core/db_classes/EE_Answer.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
     /**
      * Set Answer value
      *
-     * @param mixed $ANS_value
+     * @param string $ANS_value
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +149 added lines, -149 removed lines

@@ -10,153 +10,153 @@
 class EE_Answer extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Answer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Answer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [])
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Set Question ID
-     *
-     * @param int $QST_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question($QST_ID = 0)
-    {
-        $this->set('QST_ID', $QST_ID);
-    }
-
-
-    /**
-     * Set Registration ID
-     *
-     * @param int $REG_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_registration($REG_ID = 0)
-    {
-        $this->set('REG_ID', $REG_ID);
-    }
-
-
-    /**
-     * Set Answer value
-     *
-     * @param mixed $ANS_value
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_value($ANS_value = '')
-    {
-        $this->set('ANS_value', $ANS_value);
-    }
-
-
-    /**
-     * get Attendee First Name
-     *
-     * @return        int
-     * @throws EE_Error
-     */
-    public function registration_ID()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     * get Attendee Last Name
-     *
-     * @return        int
-     * @throws EE_Error
-     */
-    public function question_ID()
-    {
-        return $this->get('QST_ID');
-    }
-
-
-    /**
-     * get Attendee Address
-     *
-     * @return        string
-     * @throws EE_Error
-     */
-    public function value()
-    {
-        return $this->get('ANS_value');
-    }
-
-
-    /**
-     * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
-     *
-     * @param null $schema
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_value($schema = null)
-    {
-        return $this->get_pretty('ANS_value', $schema);
-    }
-
-
-    /**
-     * Echoes out a pretty value (even for multi-choice options)
-     *
-     * @param string $schema
-     * @throws EE_Error
-     */
-    public function e_value($schema = null)
-    {
-        $this->e('ANS_value', $schema);
-    }
-
-
-    /**
-     * Gets the related EE_Question to this EE_Answer
-     *
-     * @return EE_Base_Class|EE_Question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question()
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the related EE_Registration to this EE_Answer
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration()
-    {
-        return $this->get_first_related('Registration');
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Answer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Answer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [])
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Set Question ID
+	 *
+	 * @param int $QST_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question($QST_ID = 0)
+	{
+		$this->set('QST_ID', $QST_ID);
+	}
+
+
+	/**
+	 * Set Registration ID
+	 *
+	 * @param int $REG_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_registration($REG_ID = 0)
+	{
+		$this->set('REG_ID', $REG_ID);
+	}
+
+
+	/**
+	 * Set Answer value
+	 *
+	 * @param mixed $ANS_value
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_value($ANS_value = '')
+	{
+		$this->set('ANS_value', $ANS_value);
+	}
+
+
+	/**
+	 * get Attendee First Name
+	 *
+	 * @return        int
+	 * @throws EE_Error
+	 */
+	public function registration_ID()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 * get Attendee Last Name
+	 *
+	 * @return        int
+	 * @throws EE_Error
+	 */
+	public function question_ID()
+	{
+		return $this->get('QST_ID');
+	}
+
+
+	/**
+	 * get Attendee Address
+	 *
+	 * @return        string
+	 * @throws EE_Error
+	 */
+	public function value()
+	{
+		return $this->get('ANS_value');
+	}
+
+
+	/**
+	 * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
+	 *
+	 * @param null $schema
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_value($schema = null)
+	{
+		return $this->get_pretty('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Echoes out a pretty value (even for multi-choice options)
+	 *
+	 * @param string $schema
+	 * @throws EE_Error
+	 */
+	public function e_value($schema = null)
+	{
+		$this->e('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Gets the related EE_Question to this EE_Answer
+	 *
+	 * @return EE_Base_Class|EE_Question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question()
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the related EE_Registration to this EE_Answer
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration()
+	{
+		return $this->get_first_related('Registration');
+	}
 }

core/db_classes/EE_Attendee.class.php

Doc Comments +3 added lines, -3 removed lines

@@ -451,7 +451,7 @@ 
      * Gets registrations of this attendee
      *
      * @param array $query_params
-     * @return array[]|EE_Base_Class[]|EE_Registration[]
+     * @return EE_Base_Class[]
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -497,7 +497,7 @@ 
     /**
      * returns any events attached to this attendee ($_Event property);
      *
-     * @return array
+     * @return EE_Base_Class[]
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -523,7 +523,7 @@ 
      * and keys are their cleaned values.
      *
      * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
+     * @return null|EE_Billing_Info_Form
      * @throws EE_Error
      * @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
      *                                          used to save the billing info

Indentation +803 added lines, -803 removed lines

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

Spacing +13 added lines, -13 removed lines

@@ -25,16 +25,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = [])
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -372,10 +372,10 @@ 
     public function full_address_as_array()
     {
         $full_address_array     = [];
-        $initial_address_fields = ['ATT_address', 'ATT_address2', 'ATT_city',];
+        $initial_address_fields = ['ATT_address', 'ATT_address2', 'ATT_city', ];
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
@@ -390,7 +390,7 @@ 
         }
         // lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -531,18 +531,18 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
         // double-check the form isn't totally hidden, in which case pretend there is no form
         $form_totally_hidden = true;
         foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+            if ( ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
                 $form_totally_hidden = false;
                 break;
             }
@@ -569,7 +569,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         }
         return null;
     }
@@ -586,7 +586,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(
                 __('Cannot save billing info because there is none.', 'event_espresso'),
                 __FILE__,

core/db_classes/EE_CPT_Base.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -167,7 +167,7 @@ 
      *
      * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
      * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+     * @param string $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
      *                           representing width and height in pixels (i.e. array(32,32) ).
      * @param string|array $attr Optional. Query string or array of attributes.
      * @return string HTML image element
@@ -211,7 +211,7 @@ 
      * This is a method for restoring this_obj using details from the given $revision_id
      *
      * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
+     * @param string[] $related_obj_names if included this will be used to restore for related obj
      *                                 if not included then we just do restore on the meta.
      *                                 We will accept an array of related_obj_names for restoration here.
      * @param array $where_query       You can optionally include an array of key=>value pairs
@@ -277,7 +277,7 @@ 
      *
      * @param string  $meta_key
      * @param boolean $single
-     * @return mixed
+     * @return string|null
      * @throws EE_Error
      */
     public function get_post_meta($meta_key = null, $single = false)
@@ -312,8 +312,8 @@ 
     /**
      * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
      *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
+     * @param string $meta_key
+     * @param string $meta_value
      * @param bool  $unique     If postmeta for this $meta_key already exists,
      *                          whether to add an additional item or not
      * @return boolean          Boolean true, except if the $unique argument was set to true
@@ -334,7 +334,7 @@ 
     /**
      * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
      *
-     * @param mixed $meta_key
+     * @param string $meta_key
      * @param mixed $meta_value
      * @return boolean False for failure. True for success.
      * @throws EE_Error

Indentation +483 added lines, -483 removed lines

@@ -12,487 +12,487 @@
 abstract class EE_CPT_Base extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * This is a property for holding cached feature images on CPT objects.
-     * Cache's are set on the first "feature_image()" method call.
-     * Each key in the array corresponds to the requested size.
-     *
-     * @var array
-     */
-    protected $_feature_image = [];
-
-    /**
-     * @var WP_Post the WP_Post that corresponds with this CPT model object
-     */
-    protected $_wp_post;
-
-
-    abstract public function wp_user();
-
-
-    /**
-     * Adds to the specified event category. If it category doesn't exist, creates it.
-     *
-     * @param string $category_name
-     * @param string $category_description    optional
-     * @param int    $parent_term_taxonomy_id optional
-     * @return EE_Term_Taxonomy
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
-    {
-        return $this->get_model()->add_event_category(
-            $this,
-            $category_name,
-            $category_description,
-            $parent_term_taxonomy_id
-        );
-    }
-
-
-    /**
-     * Removes the event category by specified name from being related ot this event
-     *
-     * @param string $category_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_event_category($category_name)
-    {
-        return $this->get_model()->remove_event_category($this, $category_name);
-    }
-
-
-    /**
-     * Removes the relation to the specified term taxonomy, and maintains the
-     * data integrity of the term taxonomy provided
-     *
-     * @param EE_Term_Taxonomy $term_taxonomy
-     * @return EE_Base_Class the relation was removed from
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_relation_to_term_taxonomy($term_taxonomy)
-    {
-        if (! $term_taxonomy) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        "No Term_Taxonomy provided which to remove from model object of type %s and id %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $term_taxonomy->set_count($term_taxonomy->count() - 1);
-        $term_taxonomy->save();
-        return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * The main purpose of this method is to return the post type for the model object
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function post_type()
-    {
-        return $this->get_model()->post_type();
-    }
-
-
-    /**
-     * The main purpose of this method is to return the parent for the model object
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function parent()
-    {
-        return $this->get('parent');
-    }
-
-
-    /**
-     * return the _status property
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function status()
-    {
-        return $this->get('status');
-    }
-
-
-    /**
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_status($status)
-    {
-        $this->set('status', $status);
-    }
-
-
-    /**
-     * See _get_feature_image. Returns the HTML to display a featured image
-     *
-     * @param string       $size
-     * @param string|array $attr
-     * @return string of html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function feature_image($size = 'thumbnail', $attr = '')
-    {
-        return $this->_get_feature_image($size, $attr);
-    }
-
-
-    /**
-     * This calls the equivalent model method for retrieving the feature image
-     * which in turn is a wrapper for WordPress' get_the_post_thumbnail() function.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_feature_image($size, $attr)
-    {
-        // first let's see if we already have the _feature_image property set
-        // AND if it has a cached element on it FOR the given size
-        $attr_key                           = is_array($attr)
-            ? implode('_', $attr)
-            : $attr;
-        $cache_key                          = is_array($size)
-            ? implode('_', $size) . $attr_key
-            : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ]
-            : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
-    }
-
-
-    /**
-     * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
-     * using the given size params.
-     *
-     * @param string|array $size  can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
-     *                            representing width and height in pixels eg. array(32,32).
-     * @return string|boolean          the url of the image or false if not found
-     * @throws EE_Error
-     */
-    public function feature_image_url($size = 'thumbnail')
-    {
-        $attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
-        return ! empty($attachment) ? $attachment[0] : false;
-    }
-
-
-    /**
-     * This is a method for restoring this_obj using details from the given $revision_id
-     *
-     * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
-     *                                 if not included then we just do restore on the meta.
-     *                                 We will accept an array of related_obj_names for restoration here.
-     * @param array $where_query       You can optionally include an array of key=>value pairs
-     *                                 that allow you to further constrict the relation to being added.
-     *                                 However, keep in mind that the columns (keys) given
-     *                                 must match a column on the JOIN table and currently
-     *                                 only the HABTM models accept these additional conditions.
-     *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
-     *                                 then a NEW row is created in the join table.
-     *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
-     *                                 sent);
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_revision($revision_id, $related_obj_names = [], $where_query = [])
-    {
-        // get revision object
-        $revision_obj = $this->get_model()->get_one_by_ID($revision_id);
-        if ($revision_obj instanceof EE_CPT_Base) {
-            // no related_obj_name so we assume we're saving a revision on this object.
-            if (empty($related_obj_names)) {
-                $fields = $this->get_model()->get_meta_table_fields();
-                foreach ($fields as $field) {
-                    $this->set($field, $revision_obj->get($field));
-                }
-                $this->save();
-            }
-            $related_obj_names = (array) $related_obj_names;
-            foreach ($related_obj_names as $related_name) {
-                // related_obj_name so we're saving a revision on an object related to this object
-                // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values         = isset($where_query[ $related_name ])
-                    ? $where_query[ $related_name ]
-                    : [];
-                $where_params          = ! empty($cols_n_values) ? [$cols_n_values] : [];
-                $related_objs          = $this->get_many_related($related_name, $where_params);
-                $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
-                // load helper
-                // remove related objs from this object that are not in revision
-                // array_diff *should* work cause I think objects are indexed by ID?
-                $related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
-                foreach ($related_to_remove as $rr) {
-                    $this->_remove_relation_to($rr, $related_name, $cols_n_values);
-                }
-                // add all related objs attached to revision to this object
-                foreach ($revision_related_objs as $r_obj) {
-                    $this->_add_relation_to($r_obj, $related_name, $cols_n_values);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
-     * If only $id is set:
-     *  it will return all meta values in an associative array.
-     * If $single is set to false, or left blank:
-     *  the function returns an array containing all values of the specified key.
-     * If $single is set to true:
-     *  the function returns the first value of the specified key (not in an array)
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function get_post_meta($meta_key = null, $single = false)
-    {
-        return get_post_meta($this->ID(), $meta_key, $single);
-    }
-
-
-    /**
-     * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
-     * Returns meta_id if the meta doesn't exist,
-     * otherwise returns true on success and false on failure.
-     * NOTE: If the meta_value passed to this function is the same
-     * as the value that is already in the database, this function returns false.
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $prev_value
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_post_meta($meta_key, $meta_value, $prev_value = null)
-    {
-        if (! $this->ID()) {
-            $this->save();
-        }
-        return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
-    }
-
-
-    /**
-     * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @param bool  $unique     If postmeta for this $meta_key already exists,
-     *                          whether to add an additional item or not
-     * @return boolean          Boolean true, except if the $unique argument was set to true
-     *                          and a custom field with the given key already exists,
-     *                          in which case false is returned.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_post_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($this->ID()) {
-            $this->save();
-        }
-        return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
-    }
-
-
-    /**
-     * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @return boolean False for failure. True for success.
-     * @throws EE_Error
-     */
-    public function delete_post_meta($meta_key, $meta_value = '')
-    {
-        if (! $this->ID()) {
-            // there is obviously no postmeta for this if it's not saved
-            // so let's just report this as a success
-            return true;
-        }
-        return delete_post_meta($this->ID(), $meta_key, $meta_value);
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        return get_permalink($this->ID());
-    }
-
-
-    /**
-     * Gets all the term-taxonomies for this CPT
-     *
-     * @param array $query_params
-     * @return array[]|EE_Base_Class[]|EE_Term_Taxonomy
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function term_taxonomies($query_params = [])
-    {
-        return $this->get_many_related('Term_Taxonomy', $query_params);
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_custom_post_statuses()
-    {
-        return $this->get_model()->get_custom_post_statuses();
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_post_statuses()
-    {
-        return $this->get_model()->get_status_array();
-    }
-
-
-    /**
-     * When fetching a new value for a post field that uses the global $post for rendering,
-     * set the global $post temporarily to be this model object; and afterwards restore it
-     *
-     * @param string $field_name
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_fresh_property($field_name, $pretty = false, $extra_cache_ref = null)
-    {
-        global $post;
-
-        if (
-            $pretty
-            && (
-                ! (
-                    $post instanceof WP_Post
-                    && $post->ID
-                )
-                || (int) $post->ID !== $this->ID()
-            )
-            && $this->get_model()->field_settings_for($field_name) instanceof EE_Post_Content_Field
-        ) {
-            $old_post     = $post;
-            $post         = $this->wp_post();
-            $return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
-            $post         = $old_post;
-        } else {
-            $return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
-        }
-        return $return_value;
-    }
-
-
-    /**
-     * Returns the WP post associated with this CPT model object.
-     * If this CPT is saved, fetches it from the DB.
-     * Otherwise, create an unsaved WP_POst object. Caches the post internally.
-     *
-     * @return WP_Post
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_post()
-    {
-        global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
-            if ($this->ID()) {
-                $this->_wp_post = get_post($this->ID());
-            } else {
-                $simulated_db_result = new stdClass();
-                $field_settings      = $this->get_model()->field_settings(true);
-                foreach ($field_settings as $field_name => $field_obj) {
-                    if (
-                        $this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())
-                             ->get_table_name() === $wpdb->posts
-                    ) {
-                        $column = $field_obj->get_table_column();
-
-                        if ($field_obj instanceof EE_Datetime_Field) {
-                            $value_on_model_obj = $this->get_DateTime_object($field_name);
-                        } elseif ($field_obj->is_db_only_field()) {
-                            $value_on_model_obj = $field_obj->get_default_value();
-                        } else {
-                            $value_on_model_obj = $this->get_raw($field_name);
-                        }
-                        $simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
-                    }
-                }
-                $this->_wp_post = new WP_Post($simulated_db_result);
-            }
-            // and let's make retrieving the EE CPT object easy too
-            $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
-                $this->_wp_post->{$classname} = $this;
-            }
-        }
-        return $this->_wp_post;
-    }
-
-
-    /**
-     * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __sleep()
-    {
-        $properties_to_serialize = parent::__sleep();
-        $properties_to_serialize = array_diff($properties_to_serialize, ['_wp_post']);
-        return $properties_to_serialize;
-    }
+	/**
+	 * This is a property for holding cached feature images on CPT objects.
+	 * Cache's are set on the first "feature_image()" method call.
+	 * Each key in the array corresponds to the requested size.
+	 *
+	 * @var array
+	 */
+	protected $_feature_image = [];
+
+	/**
+	 * @var WP_Post the WP_Post that corresponds with this CPT model object
+	 */
+	protected $_wp_post;
+
+
+	abstract public function wp_user();
+
+
+	/**
+	 * Adds to the specified event category. If it category doesn't exist, creates it.
+	 *
+	 * @param string $category_name
+	 * @param string $category_description    optional
+	 * @param int    $parent_term_taxonomy_id optional
+	 * @return EE_Term_Taxonomy
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
+	{
+		return $this->get_model()->add_event_category(
+			$this,
+			$category_name,
+			$category_description,
+			$parent_term_taxonomy_id
+		);
+	}
+
+
+	/**
+	 * Removes the event category by specified name from being related ot this event
+	 *
+	 * @param string $category_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_event_category($category_name)
+	{
+		return $this->get_model()->remove_event_category($this, $category_name);
+	}
+
+
+	/**
+	 * Removes the relation to the specified term taxonomy, and maintains the
+	 * data integrity of the term taxonomy provided
+	 *
+	 * @param EE_Term_Taxonomy $term_taxonomy
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_relation_to_term_taxonomy($term_taxonomy)
+	{
+		if (! $term_taxonomy) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						"No Term_Taxonomy provided which to remove from model object of type %s and id %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
+		$term_taxonomy->save();
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the post type for the model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function post_type()
+	{
+		return $this->get_model()->post_type();
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the parent for the model object
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function parent()
+	{
+		return $this->get('parent');
+	}
+
+
+	/**
+	 * return the _status property
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('status');
+	}
+
+
+	/**
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_status($status)
+	{
+		$this->set('status', $status);
+	}
+
+
+	/**
+	 * See _get_feature_image. Returns the HTML to display a featured image
+	 *
+	 * @param string       $size
+	 * @param string|array $attr
+	 * @return string of html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function feature_image($size = 'thumbnail', $attr = '')
+	{
+		return $this->_get_feature_image($size, $attr);
+	}
+
+
+	/**
+	 * This calls the equivalent model method for retrieving the feature image
+	 * which in turn is a wrapper for WordPress' get_the_post_thumbnail() function.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access protected
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_feature_image($size, $attr)
+	{
+		// first let's see if we already have the _feature_image property set
+		// AND if it has a cached element on it FOR the given size
+		$attr_key                           = is_array($attr)
+			? implode('_', $attr)
+			: $attr;
+		$cache_key                          = is_array($size)
+			? implode('_', $size) . $attr_key
+			: $size . $attr_key;
+		$this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
+			? $this->_feature_image[ $cache_key ]
+			: $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[ $cache_key ];
+	}
+
+
+	/**
+	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
+	 * using the given size params.
+	 *
+	 * @param string|array $size  can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
+	 *                            representing width and height in pixels eg. array(32,32).
+	 * @return string|boolean          the url of the image or false if not found
+	 * @throws EE_Error
+	 */
+	public function feature_image_url($size = 'thumbnail')
+	{
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment) ? $attachment[0] : false;
+	}
+
+
+	/**
+	 * This is a method for restoring this_obj using details from the given $revision_id
+	 *
+	 * @param int   $revision_id       ID of the revision we're getting data from
+	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 *                                 if not included then we just do restore on the meta.
+	 *                                 We will accept an array of related_obj_names for restoration here.
+	 * @param array $where_query       You can optionally include an array of key=>value pairs
+	 *                                 that allow you to further constrict the relation to being added.
+	 *                                 However, keep in mind that the columns (keys) given
+	 *                                 must match a column on the JOIN table and currently
+	 *                                 only the HABTM models accept these additional conditions.
+	 *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
+	 *                                 then a NEW row is created in the join table.
+	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
+	 *                                 sent);
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_revision($revision_id, $related_obj_names = [], $where_query = [])
+	{
+		// get revision object
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
+			// no related_obj_name so we assume we're saving a revision on this object.
+			if (empty($related_obj_names)) {
+				$fields = $this->get_model()->get_meta_table_fields();
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
+				}
+				$this->save();
+			}
+			$related_obj_names = (array) $related_obj_names;
+			foreach ($related_obj_names as $related_name) {
+				// related_obj_name so we're saving a revision on an object related to this object
+				// do we have $where_query params for this related object?  If we do then we include that.
+				$cols_n_values         = isset($where_query[ $related_name ])
+					? $where_query[ $related_name ]
+					: [];
+				$where_params          = ! empty($cols_n_values) ? [$cols_n_values] : [];
+				$related_objs          = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
+				// load helper
+				// remove related objs from this object that are not in revision
+				// array_diff *should* work cause I think objects are indexed by ID?
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
+				}
+				// add all related objs attached to revision to this object
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
+	 * If only $id is set:
+	 *  it will return all meta values in an associative array.
+	 * If $single is set to false, or left blank:
+	 *  the function returns an array containing all values of the specified key.
+	 * If $single is set to true:
+	 *  the function returns the first value of the specified key (not in an array)
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function get_post_meta($meta_key = null, $single = false)
+	{
+		return get_post_meta($this->ID(), $meta_key, $single);
+	}
+
+
+	/**
+	 * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
+	 * Returns meta_id if the meta doesn't exist,
+	 * otherwise returns true on success and false on failure.
+	 * NOTE: If the meta_value passed to this function is the same
+	 * as the value that is already in the database, this function returns false.
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $prev_value
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_post_meta($meta_key, $meta_value, $prev_value = null)
+	{
+		if (! $this->ID()) {
+			$this->save();
+		}
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
+	}
+
+
+	/**
+	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @param bool  $unique     If postmeta for this $meta_key already exists,
+	 *                          whether to add an additional item or not
+	 * @return boolean          Boolean true, except if the $unique argument was set to true
+	 *                          and a custom field with the given key already exists,
+	 *                          in which case false is returned.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_post_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($this->ID()) {
+			$this->save();
+		}
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
+	}
+
+
+	/**
+	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @return boolean False for failure. True for success.
+	 * @throws EE_Error
+	 */
+	public function delete_post_meta($meta_key, $meta_value = '')
+	{
+		if (! $this->ID()) {
+			// there is obviously no postmeta for this if it's not saved
+			// so let's just report this as a success
+			return true;
+		}
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		return get_permalink($this->ID());
+	}
+
+
+	/**
+	 * Gets all the term-taxonomies for this CPT
+	 *
+	 * @param array $query_params
+	 * @return array[]|EE_Base_Class[]|EE_Term_Taxonomy
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function term_taxonomies($query_params = [])
+	{
+		return $this->get_many_related('Term_Taxonomy', $query_params);
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_custom_post_statuses()
+	{
+		return $this->get_model()->get_custom_post_statuses();
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_post_statuses()
+	{
+		return $this->get_model()->get_status_array();
+	}
+
+
+	/**
+	 * When fetching a new value for a post field that uses the global $post for rendering,
+	 * set the global $post temporarily to be this model object; and afterwards restore it
+	 *
+	 * @param string $field_name
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_fresh_property($field_name, $pretty = false, $extra_cache_ref = null)
+	{
+		global $post;
+
+		if (
+			$pretty
+			&& (
+				! (
+					$post instanceof WP_Post
+					&& $post->ID
+				)
+				|| (int) $post->ID !== $this->ID()
+			)
+			&& $this->get_model()->field_settings_for($field_name) instanceof EE_Post_Content_Field
+		) {
+			$old_post     = $post;
+			$post         = $this->wp_post();
+			$return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
+			$post         = $old_post;
+		} else {
+			$return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
+		}
+		return $return_value;
+	}
+
+
+	/**
+	 * Returns the WP post associated with this CPT model object.
+	 * If this CPT is saved, fetches it from the DB.
+	 * Otherwise, create an unsaved WP_POst object. Caches the post internally.
+	 *
+	 * @return WP_Post
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_post()
+	{
+		global $wpdb;
+		if (! $this->_wp_post instanceof WP_Post) {
+			if ($this->ID()) {
+				$this->_wp_post = get_post($this->ID());
+			} else {
+				$simulated_db_result = new stdClass();
+				$field_settings      = $this->get_model()->field_settings(true);
+				foreach ($field_settings as $field_name => $field_obj) {
+					if (
+						$this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())
+							 ->get_table_name() === $wpdb->posts
+					) {
+						$column = $field_obj->get_table_column();
+
+						if ($field_obj instanceof EE_Datetime_Field) {
+							$value_on_model_obj = $this->get_DateTime_object($field_name);
+						} elseif ($field_obj->is_db_only_field()) {
+							$value_on_model_obj = $field_obj->get_default_value();
+						} else {
+							$value_on_model_obj = $this->get_raw($field_name);
+						}
+						$simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
+					}
+				}
+				$this->_wp_post = new WP_Post($simulated_db_result);
+			}
+			// and let's make retrieving the EE CPT object easy too
+			$classname = get_class($this);
+			if (! isset($this->_wp_post->{$classname})) {
+				$this->_wp_post->{$classname} = $this;
+			}
+		}
+		return $this->_wp_post;
+	}
+
+
+	/**
+	 * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __sleep()
+	{
+		$properties_to_serialize = parent::__sleep();
+		$properties_to_serialize = array_diff($properties_to_serialize, ['_wp_post']);
+		return $properties_to_serialize;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -76,7 +76,7 @@ 
      */
     public function remove_relation_to_term_taxonomy($term_taxonomy)
     {
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -182,12 +182,12 @@ 
             ? implode('_', $attr)
             : $attr;
         $cache_key                          = is_array($size)
-            ? implode('_', $size) . $attr_key
-            : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ]
+            ? implode('_', $size).$attr_key
+            : $size.$attr_key;
+        $this->_feature_image[$cache_key] = isset($this->_feature_image[$cache_key])
+            ? $this->_feature_image[$cache_key]
             : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
+        return $this->_feature_image[$cache_key];
     }
 
 
@@ -244,8 +244,8 @@ 
             foreach ($related_obj_names as $related_name) {
                 // related_obj_name so we're saving a revision on an object related to this object
                 // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values         = isset($where_query[ $related_name ])
-                    ? $where_query[ $related_name ]
+                $cols_n_values         = isset($where_query[$related_name])
+                    ? $where_query[$related_name]
                     : [];
                 $where_params          = ! empty($cols_n_values) ? [$cols_n_values] : [];
                 $related_objs          = $this->get_many_related($related_name, $where_params);
@@ -302,7 +302,7 @@ 
      */
     public function update_post_meta($meta_key, $meta_value, $prev_value = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
@@ -341,7 +341,7 @@ 
      */
     public function delete_post_meta($meta_key, $meta_value = '')
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             // there is obviously no postmeta for this if it's not saved
             // so let's just report this as a success
             return true;
@@ -447,7 +447,7 @@ 
     public function wp_post()
     {
         global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
+        if ( ! $this->_wp_post instanceof WP_Post) {
             if ($this->ID()) {
                 $this->_wp_post = get_post($this->ID());
             } else {
@@ -474,7 +474,7 @@ 
             }
             // and let's make retrieving the EE CPT object easy too
             $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
+            if ( ! isset($this->_wp_post->{$classname})) {
                 $this->_wp_post->{$classname} = $this;
             }
         }

core/db_classes/EE_CSV.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -339,8 +339,8 @@
      * and dies (in order to avoid other plugins from messing up the csv output)
      *
      * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
+     * @param boolean  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+     * @return boolean|null | void writes CSV file to output and dies
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +621 added lines, -621 removed lines

@@ -13,625 +13,625 @@
 class EE_CSV
 {
 
-    /**
-     * string used for 1st cell in exports,
-     * which indicates that the following 2 rows will be metadata keys and values
-     */
-    const metadata_header = 'Event Espresso Export Meta Data';
-
-
-    /**
-     * instance of the EE_CSV object
-     *
-     * @var EE_CSV
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    private $_primary_keys;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @return void
-     */
-    private function __construct()
-    {
-        global $wpdb;
-
-        $this->_primary_keys = [
-            $wpdb->prefix . 'esp_answer'                  => ['ANS_ID'],
-            $wpdb->prefix . 'esp_attendee'                => ['ATT_ID'],
-            $wpdb->prefix . 'esp_datetime'                => ['DTT_ID'],
-            $wpdb->prefix . 'esp_event_question_group'    => ['EQG_ID'],
-            $wpdb->prefix . 'esp_message_template'        => ['MTP_ID'],
-            $wpdb->prefix . 'esp_payment'                 => ['PAY_ID'],
-            $wpdb->prefix . 'esp_price'                   => ['PRC_ID'],
-            $wpdb->prefix . 'esp_price_type'              => ['PRT_ID'],
-            $wpdb->prefix . 'esp_question'                => ['QST_ID'],
-            $wpdb->prefix . 'esp_question_group'          => ['QSG_ID'],
-            $wpdb->prefix . 'esp_question_group_question' => ['QGQ_ID'],
-            $wpdb->prefix . 'esp_question_option'         => ['QSO_ID'],
-            $wpdb->prefix . 'esp_registration'            => ['REG_ID'],
-            $wpdb->prefix . 'esp_status'                  => ['STS_ID'],
-            $wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
-            $wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
-            $wpdb->prefix . 'events_detail'               => ['id'],
-            $wpdb->prefix . 'events_category_detail'      => ['id'],
-            $wpdb->prefix . 'events_category_rel'         => ['id'],
-            $wpdb->prefix . 'events_venue'                => ['id'],
-            $wpdb->prefix . 'events_venue_rel'            => ['emeta_id'],
-            $wpdb->prefix . 'events_locale'               => ['id'],
-            $wpdb->prefix . 'events_locale_rel'           => ['id'],
-            $wpdb->prefix . 'events_personnel'            => ['id'],
-            $wpdb->prefix . 'events_personnel_rel'        => ['id'],
-        ];
-    }
-
-
-    /**
-     *        @ singleton method used to instantiate class object
-     *        @ access public
-     *
-     * @return EE_CSV
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CSV) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @Import contents of csv file and store values in an array to be manipulated by other functions
-     * @access public
-     * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
-     *                                      If $model_name is provided, assumes that each row in the CSV represents a
-     *                                      model object for that model If $model_name ISN'T provided, assumes that
-     *                                      before model object data, there is a row where the first entry is simply
-     *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
-     *                                      then maybe a row of headers, and then the model data. Eg.
-     *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
-     *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
-     *                                      Forest
-     * @param string  $model_name           model name if we know what model we're importing
-     * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
-     *                                      data
-     * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
-     *                                      error message like the following array('Event'=>array(
-     *                                      array('EVT_ID'=>1,'EVT_name'=>'bob party',...),
-     *                                      array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
-     *                                      ...
-     *                                      )
-     *                                      'Venue'=>array(
-     *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
-     *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
-     *                                      ...
-     *                                      )
-     *                                      ...
-     *                                      )
-     * @throws EE_Error
-     */
-    public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
-    {
-        $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (empty($multi_dimensional_array)) {
-            return false;
-        }
-        // gotta start somewhere
-        $row = 1;
-        // array to store csv data in
-        $ee_formatted_data = [];
-        // array to store headers (column names)
-        $headers = [];
-        foreach ($multi_dimensional_array as $data) {
-            // if first cell is MODEL, then second cell is the MODEL name
-            if ($data[0] == 'MODEL') {
-                $model_name = $data[1];
-                // don't bother looking for model data in this row.
-                // The rest of this row should be blank
-                // AND pretend this is the first row again
-                $row = 1;
-                // reset headers
-                $headers = [];
-                continue;
-            }
-            if (strpos($data[0], EE_CSV::metadata_header) !== false) {
-                $model_name = EE_CSV::metadata_header;
-                // store like model data, we just won't try importing it etc.
-                $row = 1;
-                continue;
-            }
-
-
-            // how many columns are there?
-            $columns = count($data);
-
-            $model_entry = [];
-            // loop through each column
-            for ($i = 0; $i < $columns; $i++) {
-                // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
-                // do we need to grab the column names?
-                if ($row === 1) {
-                    if ($first_row_is_headers) {
-                        // store the column names to use for keys
-                        $column_name = $data[ $i ];
-                        // check it's not blank... sometimes CSV editing programs
-                        // add a bunch of empty columns onto the end...
-                        if (! $column_name) {
-                            continue;
-                        }
-                        $matches = [];
-                        if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
-                        } else {
-                            // now get the db table name from it (the part between square brackets)
-                            $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        esc_html__(
-                                            "The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
-                                            "event_espresso"
-                                        ),
-                                        $column_name,
-                                        implode(",", $data)
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                            $headers[ $i ] = $matches[2];
-                        }
-                    } else {
-                        // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ]                 = $i;
-                    }
-                    // and we need to store csv data
-                } else {
-                    // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                    }
-                }
-            }
-            // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || $row > 1) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
-            }
-            // advance to next row
-            $row++;
-        }
-
-        // delete the uploaded file
-        unlink($path_to_file);
-
-        // it's good to give back
-        return $ee_formatted_data;
-    }
-
-
-    /**
-     * Generic CSV-functionality to turn an entire CSV file into a single array that's
-     * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
-     * representing each row in the CSV file, and the second-level arrays being each column in that row
-     *
-     * @param string $path_to_file
-     * @return array of arrays. Top-level array has rows, second-level array has each item
-     * @throws EE_Error
-     */
-    public function import_csv_to_multi_dimensional_array($path_to_file)
-    {
-        // needed to deal with Mac line endings
-        ini_set('auto_detect_line_endings', true);
-        // because fgetcsv does not correctly deal with backslashed quotes such as \"
-        // we'll read the file into a string
-        $file_contents = $this->read_unicode_file($path_to_file);
-        // replace backslashed quotes with CSV enclosures
-        $file_contents = str_replace('\\"', '"""', $file_contents);
-        // HEY YOU! PUT THAT FILE BACK!!!
-        file_put_contents($path_to_file, $file_contents);
-
-        if (($file_handle = fopen($path_to_file, "r")) !== false) {
-            $csv_array = [];
-            // in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions
-            // of fgetcsv choke if passed more than 4 - is that crazy or what?
-            if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-                //  PHP 5.2- version
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle)) !== false) {
-                    $csv_array[] = $data;
-                }
-            } else {
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle)) !== false) {
-                    $csv_array[] = $data;
-                }
-            }
-            # Close the File.
-            fclose($file_handle);
-            return $csv_array;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    "An error occurred - the file: %s could not opened.",
-                    "event_espresso"
-                ),
-                $path_to_file
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return [];
-    }
-
-
-    /**
-     * Opens a unicode or utf file
-     * (normal file_get_contents has difficulty reading a unicode file)
-     *
-     * @param string $file_path
-     * @return string
-     * @throws EE_Error
-     * @see http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
-     */
-    private function read_unicode_file($file_path)
-    {
-        $fc = "";
-        $fh = fopen($file_path, "rb");
-        if (! $fh) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Cannot open file for read: %s<br>\n", 'event_espresso'),
-                    $file_path
-                )
-            );
-        }
-        $file_length = filesize($file_path);
-        $bc          = fread($fh, $file_length);
-        for ($i = 0; $i < $file_length; $i++) {
-            $c = substr($bc, $i, 1);
-            if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
-            }
-        }
-        if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
-            $fc = substr($fc, 2);
-        }
-        return ($fc);
-    }
-
-
-    /**
-     * @param       $csv_data_array
-     * @param false $model_name
-     * @return bool
-     * @throws EE_Error
-     */
-    public function save_csv_to_db($csv_data_array, $model_name = false)
-    {
-        EE_Error::doing_it_wrong(
-            'save_csv_to_db',
-            esc_html__(
-                'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
-    }
-
-
-    /**
-     * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
-     * and dies (in order to avoid other plugins from messing up the csv output)
-     *
-     * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function export_multiple_model_data_to_csv($filename, $model_data_array)
-    {
-        $file_handle = $this->begin_sending_csv($filename);
-        $this->write_model_data_to_csv($file_handle, $model_data_array);
-        $this->end_sending_csv($file_handle);
-    }
-
-
-    /**
-     * Sends HTTP headers to indicate that the browser should download a file,
-     * and starts writing the file to PHP's output. Returns the file handle so other functions can
-     * also write to it
-     *
-     * @param string $filename the name of the file that the user will download
-     * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
-     */
-    public function begin_sending_csv($filename)
-    {
-        // grab file extension
-        $ext = substr(strrchr($filename, '.'), 1);
-        if ($ext == '.csv' or $ext == '.xls') {
-            str_replace($ext, '', $filename);
-        }
-        $filename .= '.csv';
-
-        // if somebody's been naughty and already started outputting stuff, trash it
-        // and start writing our stuff.
-        if (ob_get_length()) {
-            @ob_flush();
-            @flush();
-            @ob_end_flush();
-        }
-        @ob_start();
-        header("Pragma: public");
-        header("Expires: 0");
-        header("Pragma: no-cache");
-        header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
-        // header("Content-Type: application/force-download");
-        // header("Content-Type: application/octet-stream");
-        // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
-        header("Content-Type: text/csv; charset=utf-8");
-        do_action('AHEE__EE_CSV__begin_sending_csv__headers');
-        echo apply_filters(
-            'FHEE__EE_CSV__begin_sending_csv__start_writing',
-            "\xEF\xBB\xBF"
-        ); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
-        return fopen('php://output', 'w');
-    }
-
-
-    /**
-     * Given an open file, writes all the model data to it in the format the importer expects.
-     * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($file_handle).
-     *
-     * @param resource $file_handle
-     * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
-     *                                   next layer is numerically indexed to represent each model object (eg, each
-     *                                   individual event), and the last layer has all the attributes of that model
-     *                                   object (eg, the event's id, name, etc)
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function write_model_data_to_csv($file_handle, $model_data_array)
-    {
-        $this->write_metadata_to_csv($file_handle);
-        foreach ($model_data_array as $model_name => $model_instance_arrays) {
-            // first: output a special row stating the model
-            $this->fputcsv2($file_handle, ['MODEL', $model_name]);
-            // if we have items to put in the CSV, do it normally
-
-            if (! empty($model_instance_arrays)) {
-                $this->write_data_array_to_csv($file_handle, $model_instance_arrays);
-            } else {
-                // echo "no data to write... so just write the headers";
-                // so there's actually NO model objects for that model.
-                // probably still want to show the columns
-                $model        = EE_Registry::instance()->load_model($model_name);
-                $column_names = [];
-                foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
-                }
-                $this->write_data_array_to_csv($file_handle, [$column_names]);
-            }
-        }
-    }
-
-
-    /**
-     * Writes some meta data to the CSV as a bunch of columns. Initially we're only
-     * mentioning the version and timezone
-     *
-     * @param resource $file_handle
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function write_metadata_to_csv($file_handle)
-    {
-        $data_row = [EE_CSV::metadata_header];// do NOT translate because this exact string is used when importing
-        $this->fputcsv2($file_handle, $data_row);
-        $meta_data = [
-            0 => [
-                'version'        => espresso_version(),
-                'timezone'       => EEH_DTT_Helper::get_timezone(),
-                'time_of_export' => current_time('mysql'),
-                'site_url'       => site_url(),
-            ],
-        ];
-        $this->write_data_array_to_csv($file_handle, $meta_data);
-    }
-
-
-    /**
-     * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
-     * @access private
-     * @param resource $fh         - file handle - what we are writing to
-     * @param array    $row        - individual row of csv data
-     * @param string   $delimiter  - csv delimiter
-     * @param string   $enclosure  - csv enclosure
-     * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     * @return void
-     */
-    private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = [];
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value)
-                ? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
-                : $field_value;
-        }
-
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $file_handle. uses the array indices of $data for column headers
-     *
-     * @param resource $file_handle
-     * @param array    $data        2D array, first numerically-indexed,
-     *                              and next-level-down preferably indexed by string
-     * @return boolean              if we successfully wrote to the CSV or not.
-     *                              If there's no $data, we consider that a success
-     *                              (because we wrote everything there was...nothing)
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function write_data_array_to_csv($file_handle, $data)
-    {
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "top-level array must be numerically indexed. Does these look like numbers to you? %s",
-                            "event_espresso"
-                        ),
-                        implode(",", array_keys($data))
-                    )
-                );
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                $this->fputcsv2($file_handle, $keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $this->fputcsv2($file_handle, $data_row);
-            }
-            return true;
-        }
-        // no data TO write... so we can assume that's a success
-        return true;
-    }
-
-
-    /**
-     * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
-     * Calls exit to prevent polluting the CSV file with other junk
-     *
-     * @param resource $fh file_handle where we're writing the CSV to
-     */
-    public function end_sending_csv($fh)
-    {
-        fclose($fh);
-        exit(0);
-    }
-
-
-    /**
-     * @Export contents of an array to csv file
-     * @access public
-     * @param array  $data     - the array of data to be converted to csv and exported
-     * @param string $filename - name for newly created csv file
-     * @return bool TRUE on success, FALSE on fail
-     */
-    public function export_array_to_csv($data = false, $filename = false)
-    {
-        // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
-            return false;
-        }
-
-        // no filename?? get outta here
-        if (! $filename) {
-            return false;
-        }
-        $fh = $this->begin_sending_csv($filename);
-        $this->end_sending_csv($fh);
-        return true;
-    }
-
-
-    /**
-     * @Determine the maximum upload file size based on php.ini settings
-     * @access    public
-     * @param int $percent_of_max - desired percentage of the max upload_mb
-     * @return int KB
-     */
-    public function get_max_upload_size($percent_of_max = false)
-    {
-        $max_upload   = (int) (ini_get('upload_max_filesize'));
-        $max_post     = (int) (ini_get('post_max_size'));
-        $memory_limit = (int) (ini_get('memory_limit'));
-
-        // determine the smallest of the three values from above
-        $upload_mb = min($max_upload, $max_post, $memory_limit);
-
-        // convert MB to KB
-        $upload_mb = $upload_mb * 1024;
-
-        // don't want the full monty? then reduce the max upload size
-        if ($percent_of_max) {
-            // is percent_of_max like this -> 50 or like this -> 0.50 ?
-            if ($percent_of_max > 1) {
-                // changes 50 to 0.50
-                $percent_of_max = $percent_of_max / 100;
-            }
-            // make upload_mb a percentage of the max upload_mb
-            $upload_mb = $upload_mb * $percent_of_max;
-        }
-
-        return $upload_mb;
-    }
-
-
-    /**
-     * Gets the date format to use in teh csv. filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_date_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-
-    /**
-     * Gets the time format we want to use in CSV reports. Filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_time_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	/**
+	 * string used for 1st cell in exports,
+	 * which indicates that the following 2 rows will be metadata keys and values
+	 */
+	const metadata_header = 'Event Espresso Export Meta Data';
+
+
+	/**
+	 * instance of the EE_CSV object
+	 *
+	 * @var EE_CSV
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	private $_primary_keys;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @return void
+	 */
+	private function __construct()
+	{
+		global $wpdb;
+
+		$this->_primary_keys = [
+			$wpdb->prefix . 'esp_answer'                  => ['ANS_ID'],
+			$wpdb->prefix . 'esp_attendee'                => ['ATT_ID'],
+			$wpdb->prefix . 'esp_datetime'                => ['DTT_ID'],
+			$wpdb->prefix . 'esp_event_question_group'    => ['EQG_ID'],
+			$wpdb->prefix . 'esp_message_template'        => ['MTP_ID'],
+			$wpdb->prefix . 'esp_payment'                 => ['PAY_ID'],
+			$wpdb->prefix . 'esp_price'                   => ['PRC_ID'],
+			$wpdb->prefix . 'esp_price_type'              => ['PRT_ID'],
+			$wpdb->prefix . 'esp_question'                => ['QST_ID'],
+			$wpdb->prefix . 'esp_question_group'          => ['QSG_ID'],
+			$wpdb->prefix . 'esp_question_group_question' => ['QGQ_ID'],
+			$wpdb->prefix . 'esp_question_option'         => ['QSO_ID'],
+			$wpdb->prefix . 'esp_registration'            => ['REG_ID'],
+			$wpdb->prefix . 'esp_status'                  => ['STS_ID'],
+			$wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
+			$wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
+			$wpdb->prefix . 'events_detail'               => ['id'],
+			$wpdb->prefix . 'events_category_detail'      => ['id'],
+			$wpdb->prefix . 'events_category_rel'         => ['id'],
+			$wpdb->prefix . 'events_venue'                => ['id'],
+			$wpdb->prefix . 'events_venue_rel'            => ['emeta_id'],
+			$wpdb->prefix . 'events_locale'               => ['id'],
+			$wpdb->prefix . 'events_locale_rel'           => ['id'],
+			$wpdb->prefix . 'events_personnel'            => ['id'],
+			$wpdb->prefix . 'events_personnel_rel'        => ['id'],
+		];
+	}
+
+
+	/**
+	 *        @ singleton method used to instantiate class object
+	 *        @ access public
+	 *
+	 * @return EE_CSV
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_CSV) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @Import contents of csv file and store values in an array to be manipulated by other functions
+	 * @access public
+	 * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
+	 *                                      If $model_name is provided, assumes that each row in the CSV represents a
+	 *                                      model object for that model If $model_name ISN'T provided, assumes that
+	 *                                      before model object data, there is a row where the first entry is simply
+	 *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
+	 *                                      then maybe a row of headers, and then the model data. Eg.
+	 *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
+	 *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
+	 *                                      Forest
+	 * @param string  $model_name           model name if we know what model we're importing
+	 * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
+	 *                                      data
+	 * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
+	 *                                      error message like the following array('Event'=>array(
+	 *                                      array('EVT_ID'=>1,'EVT_name'=>'bob party',...),
+	 *                                      array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      'Venue'=>array(
+	 *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
+	 *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      ...
+	 *                                      )
+	 * @throws EE_Error
+	 */
+	public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
+	{
+		$multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
+		if (empty($multi_dimensional_array)) {
+			return false;
+		}
+		// gotta start somewhere
+		$row = 1;
+		// array to store csv data in
+		$ee_formatted_data = [];
+		// array to store headers (column names)
+		$headers = [];
+		foreach ($multi_dimensional_array as $data) {
+			// if first cell is MODEL, then second cell is the MODEL name
+			if ($data[0] == 'MODEL') {
+				$model_name = $data[1];
+				// don't bother looking for model data in this row.
+				// The rest of this row should be blank
+				// AND pretend this is the first row again
+				$row = 1;
+				// reset headers
+				$headers = [];
+				continue;
+			}
+			if (strpos($data[0], EE_CSV::metadata_header) !== false) {
+				$model_name = EE_CSV::metadata_header;
+				// store like model data, we just won't try importing it etc.
+				$row = 1;
+				continue;
+			}
+
+
+			// how many columns are there?
+			$columns = count($data);
+
+			$model_entry = [];
+			// loop through each column
+			for ($i = 0; $i < $columns; $i++) {
+				// replace csv_enclosures with backslashed quotes
+				$data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+				// do we need to grab the column names?
+				if ($row === 1) {
+					if ($first_row_is_headers) {
+						// store the column names to use for keys
+						$column_name = $data[ $i ];
+						// check it's not blank... sometimes CSV editing programs
+						// add a bunch of empty columns onto the end...
+						if (! $column_name) {
+							continue;
+						}
+						$matches = [];
+						if ($model_name == EE_CSV::metadata_header) {
+							$headers[ $i ] = $column_name;
+						} else {
+							// now get the db table name from it (the part between square brackets)
+							$success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
+							if (! $success) {
+								EE_Error::add_error(
+									sprintf(
+										esc_html__(
+											"The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
+											"event_espresso"
+										),
+										$column_name,
+										implode(",", $data)
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+							$headers[ $i ] = $matches[2];
+						}
+					} else {
+						// no column names means our final array will just use counters for keys
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+						$headers[ $i ]                 = $i;
+					}
+					// and we need to store csv data
+				} else {
+					// this column isn' ta header, store it if there is a header for it
+					if (isset($headers[ $i ])) {
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+					}
+				}
+			}
+			// save the row's data IF it's a non-header-row
+			if (! $first_row_is_headers || $row > 1) {
+				$ee_formatted_data[ $model_name ][] = $model_entry;
+			}
+			// advance to next row
+			$row++;
+		}
+
+		// delete the uploaded file
+		unlink($path_to_file);
+
+		// it's good to give back
+		return $ee_formatted_data;
+	}
+
+
+	/**
+	 * Generic CSV-functionality to turn an entire CSV file into a single array that's
+	 * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
+	 * representing each row in the CSV file, and the second-level arrays being each column in that row
+	 *
+	 * @param string $path_to_file
+	 * @return array of arrays. Top-level array has rows, second-level array has each item
+	 * @throws EE_Error
+	 */
+	public function import_csv_to_multi_dimensional_array($path_to_file)
+	{
+		// needed to deal with Mac line endings
+		ini_set('auto_detect_line_endings', true);
+		// because fgetcsv does not correctly deal with backslashed quotes such as \"
+		// we'll read the file into a string
+		$file_contents = $this->read_unicode_file($path_to_file);
+		// replace backslashed quotes with CSV enclosures
+		$file_contents = str_replace('\\"', '"""', $file_contents);
+		// HEY YOU! PUT THAT FILE BACK!!!
+		file_put_contents($path_to_file, $file_contents);
+
+		if (($file_handle = fopen($path_to_file, "r")) !== false) {
+			$csv_array = [];
+			// in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions
+			// of fgetcsv choke if passed more than 4 - is that crazy or what?
+			if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+				//  PHP 5.2- version
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle)) !== false) {
+					$csv_array[] = $data;
+				}
+			} else {
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle)) !== false) {
+					$csv_array[] = $data;
+				}
+			}
+			# Close the File.
+			fclose($file_handle);
+			return $csv_array;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					"An error occurred - the file: %s could not opened.",
+					"event_espresso"
+				),
+				$path_to_file
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return [];
+	}
+
+
+	/**
+	 * Opens a unicode or utf file
+	 * (normal file_get_contents has difficulty reading a unicode file)
+	 *
+	 * @param string $file_path
+	 * @return string
+	 * @throws EE_Error
+	 * @see http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
+	 */
+	private function read_unicode_file($file_path)
+	{
+		$fc = "";
+		$fh = fopen($file_path, "rb");
+		if (! $fh) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Cannot open file for read: %s<br>\n", 'event_espresso'),
+					$file_path
+				)
+			);
+		}
+		$file_length = filesize($file_path);
+		$bc          = fread($fh, $file_length);
+		for ($i = 0; $i < $file_length; $i++) {
+			$c = substr($bc, $i, 1);
+			if ((ord($c) != 0) && (ord($c) != 13)) {
+				$fc = $fc . $c;
+			}
+		}
+		if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
+			$fc = substr($fc, 2);
+		}
+		return ($fc);
+	}
+
+
+	/**
+	 * @param       $csv_data_array
+	 * @param false $model_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function save_csv_to_db($csv_data_array, $model_name = false)
+	{
+		EE_Error::doing_it_wrong(
+			'save_csv_to_db',
+			esc_html__(
+				'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
+	}
+
+
+	/**
+	 * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
+	 * and dies (in order to avoid other plugins from messing up the csv output)
+	 *
+	 * @param string $filename         the filename you want to give the file
+	 * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+	 * @return bool | void writes CSV file to output and dies
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function export_multiple_model_data_to_csv($filename, $model_data_array)
+	{
+		$file_handle = $this->begin_sending_csv($filename);
+		$this->write_model_data_to_csv($file_handle, $model_data_array);
+		$this->end_sending_csv($file_handle);
+	}
+
+
+	/**
+	 * Sends HTTP headers to indicate that the browser should download a file,
+	 * and starts writing the file to PHP's output. Returns the file handle so other functions can
+	 * also write to it
+	 *
+	 * @param string $filename the name of the file that the user will download
+	 * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
+	 */
+	public function begin_sending_csv($filename)
+	{
+		// grab file extension
+		$ext = substr(strrchr($filename, '.'), 1);
+		if ($ext == '.csv' or $ext == '.xls') {
+			str_replace($ext, '', $filename);
+		}
+		$filename .= '.csv';
+
+		// if somebody's been naughty and already started outputting stuff, trash it
+		// and start writing our stuff.
+		if (ob_get_length()) {
+			@ob_flush();
+			@flush();
+			@ob_end_flush();
+		}
+		@ob_start();
+		header("Pragma: public");
+		header("Expires: 0");
+		header("Pragma: no-cache");
+		header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
+		// header("Content-Type: application/force-download");
+		// header("Content-Type: application/octet-stream");
+		// header("Content-Type: application/download");
+		header('Content-disposition: attachment; filename=' . $filename);
+		header("Content-Type: text/csv; charset=utf-8");
+		do_action('AHEE__EE_CSV__begin_sending_csv__headers');
+		echo apply_filters(
+			'FHEE__EE_CSV__begin_sending_csv__start_writing',
+			"\xEF\xBB\xBF"
+		); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
+		return fopen('php://output', 'w');
+	}
+
+
+	/**
+	 * Given an open file, writes all the model data to it in the format the importer expects.
+	 * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($file_handle).
+	 *
+	 * @param resource $file_handle
+	 * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
+	 *                                   next layer is numerically indexed to represent each model object (eg, each
+	 *                                   individual event), and the last layer has all the attributes of that model
+	 *                                   object (eg, the event's id, name, etc)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function write_model_data_to_csv($file_handle, $model_data_array)
+	{
+		$this->write_metadata_to_csv($file_handle);
+		foreach ($model_data_array as $model_name => $model_instance_arrays) {
+			// first: output a special row stating the model
+			$this->fputcsv2($file_handle, ['MODEL', $model_name]);
+			// if we have items to put in the CSV, do it normally
+
+			if (! empty($model_instance_arrays)) {
+				$this->write_data_array_to_csv($file_handle, $model_instance_arrays);
+			} else {
+				// echo "no data to write... so just write the headers";
+				// so there's actually NO model objects for that model.
+				// probably still want to show the columns
+				$model        = EE_Registry::instance()->load_model($model_name);
+				$column_names = [];
+				foreach ($model->field_settings() as $field) {
+					$column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+				}
+				$this->write_data_array_to_csv($file_handle, [$column_names]);
+			}
+		}
+	}
+
+
+	/**
+	 * Writes some meta data to the CSV as a bunch of columns. Initially we're only
+	 * mentioning the version and timezone
+	 *
+	 * @param resource $file_handle
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function write_metadata_to_csv($file_handle)
+	{
+		$data_row = [EE_CSV::metadata_header];// do NOT translate because this exact string is used when importing
+		$this->fputcsv2($file_handle, $data_row);
+		$meta_data = [
+			0 => [
+				'version'        => espresso_version(),
+				'timezone'       => EEH_DTT_Helper::get_timezone(),
+				'time_of_export' => current_time('mysql'),
+				'site_url'       => site_url(),
+			],
+		];
+		$this->write_data_array_to_csv($file_handle, $meta_data);
+	}
+
+
+	/**
+	 * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
+	 * @access private
+	 * @param resource $fh         - file handle - what we are writing to
+	 * @param array    $row        - individual row of csv data
+	 * @param string   $delimiter  - csv delimiter
+	 * @param string   $enclosure  - csv enclosure
+	 * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	 * @return void
+	 */
+	private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = [];
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value)
+				? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+				: $field_value;
+		}
+
+		fwrite($fh, join($delimiter, $output) . PHP_EOL);
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $file_handle. uses the array indices of $data for column headers
+	 *
+	 * @param resource $file_handle
+	 * @param array    $data        2D array, first numerically-indexed,
+	 *                              and next-level-down preferably indexed by string
+	 * @return boolean              if we successfully wrote to the CSV or not.
+	 *                              If there's no $data, we consider that a success
+	 *                              (because we wrote everything there was...nothing)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function write_data_array_to_csv($file_handle, $data)
+	{
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"top-level array must be numerically indexed. Does these look like numbers to you? %s",
+							"event_espresso"
+						),
+						implode(",", array_keys($data))
+					)
+				);
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				$this->fputcsv2($file_handle, $keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$this->fputcsv2($file_handle, $data_row);
+			}
+			return true;
+		}
+		// no data TO write... so we can assume that's a success
+		return true;
+	}
+
+
+	/**
+	 * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
+	 * Calls exit to prevent polluting the CSV file with other junk
+	 *
+	 * @param resource $fh file_handle where we're writing the CSV to
+	 */
+	public function end_sending_csv($fh)
+	{
+		fclose($fh);
+		exit(0);
+	}
+
+
+	/**
+	 * @Export contents of an array to csv file
+	 * @access public
+	 * @param array  $data     - the array of data to be converted to csv and exported
+	 * @param string $filename - name for newly created csv file
+	 * @return bool TRUE on success, FALSE on fail
+	 */
+	public function export_array_to_csv($data = false, $filename = false)
+	{
+		// no data file?? get outta here
+		if (! $data or ! is_array($data) or empty($data)) {
+			return false;
+		}
+
+		// no filename?? get outta here
+		if (! $filename) {
+			return false;
+		}
+		$fh = $this->begin_sending_csv($filename);
+		$this->end_sending_csv($fh);
+		return true;
+	}
+
+
+	/**
+	 * @Determine the maximum upload file size based on php.ini settings
+	 * @access    public
+	 * @param int $percent_of_max - desired percentage of the max upload_mb
+	 * @return int KB
+	 */
+	public function get_max_upload_size($percent_of_max = false)
+	{
+		$max_upload   = (int) (ini_get('upload_max_filesize'));
+		$max_post     = (int) (ini_get('post_max_size'));
+		$memory_limit = (int) (ini_get('memory_limit'));
+
+		// determine the smallest of the three values from above
+		$upload_mb = min($max_upload, $max_post, $memory_limit);
+
+		// convert MB to KB
+		$upload_mb = $upload_mb * 1024;
+
+		// don't want the full monty? then reduce the max upload size
+		if ($percent_of_max) {
+			// is percent_of_max like this -> 50 or like this -> 0.50 ?
+			if ($percent_of_max > 1) {
+				// changes 50 to 0.50
+				$percent_of_max = $percent_of_max / 100;
+			}
+			// make upload_mb a percentage of the max upload_mb
+			$upload_mb = $upload_mb * $percent_of_max;
+		}
+
+		return $upload_mb;
+	}
+
+
+	/**
+	 * Gets the date format to use in teh csv. filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_date_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+
+	/**
+	 * Gets the time format we want to use in CSV reports. Filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_time_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -43,31 +43,31 @@ 
         global $wpdb;
 
         $this->_primary_keys = [
-            $wpdb->prefix . 'esp_answer'                  => ['ANS_ID'],
-            $wpdb->prefix . 'esp_attendee'                => ['ATT_ID'],
-            $wpdb->prefix . 'esp_datetime'                => ['DTT_ID'],
-            $wpdb->prefix . 'esp_event_question_group'    => ['EQG_ID'],
-            $wpdb->prefix . 'esp_message_template'        => ['MTP_ID'],
-            $wpdb->prefix . 'esp_payment'                 => ['PAY_ID'],
-            $wpdb->prefix . 'esp_price'                   => ['PRC_ID'],
-            $wpdb->prefix . 'esp_price_type'              => ['PRT_ID'],
-            $wpdb->prefix . 'esp_question'                => ['QST_ID'],
-            $wpdb->prefix . 'esp_question_group'          => ['QSG_ID'],
-            $wpdb->prefix . 'esp_question_group_question' => ['QGQ_ID'],
-            $wpdb->prefix . 'esp_question_option'         => ['QSO_ID'],
-            $wpdb->prefix . 'esp_registration'            => ['REG_ID'],
-            $wpdb->prefix . 'esp_status'                  => ['STS_ID'],
-            $wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
-            $wpdb->prefix . 'esp_transaction'             => ['TXN_ID'],
-            $wpdb->prefix . 'events_detail'               => ['id'],
-            $wpdb->prefix . 'events_category_detail'      => ['id'],
-            $wpdb->prefix . 'events_category_rel'         => ['id'],
-            $wpdb->prefix . 'events_venue'                => ['id'],
-            $wpdb->prefix . 'events_venue_rel'            => ['emeta_id'],
-            $wpdb->prefix . 'events_locale'               => ['id'],
-            $wpdb->prefix . 'events_locale_rel'           => ['id'],
-            $wpdb->prefix . 'events_personnel'            => ['id'],
-            $wpdb->prefix . 'events_personnel_rel'        => ['id'],
+            $wpdb->prefix.'esp_answer'                  => ['ANS_ID'],
+            $wpdb->prefix.'esp_attendee'                => ['ATT_ID'],
+            $wpdb->prefix.'esp_datetime'                => ['DTT_ID'],
+            $wpdb->prefix.'esp_event_question_group'    => ['EQG_ID'],
+            $wpdb->prefix.'esp_message_template'        => ['MTP_ID'],
+            $wpdb->prefix.'esp_payment'                 => ['PAY_ID'],
+            $wpdb->prefix.'esp_price'                   => ['PRC_ID'],
+            $wpdb->prefix.'esp_price_type'              => ['PRT_ID'],
+            $wpdb->prefix.'esp_question'                => ['QST_ID'],
+            $wpdb->prefix.'esp_question_group'          => ['QSG_ID'],
+            $wpdb->prefix.'esp_question_group_question' => ['QGQ_ID'],
+            $wpdb->prefix.'esp_question_option'         => ['QSO_ID'],
+            $wpdb->prefix.'esp_registration'            => ['REG_ID'],
+            $wpdb->prefix.'esp_status'                  => ['STS_ID'],
+            $wpdb->prefix.'esp_transaction'             => ['TXN_ID'],
+            $wpdb->prefix.'esp_transaction'             => ['TXN_ID'],
+            $wpdb->prefix.'events_detail'               => ['id'],
+            $wpdb->prefix.'events_category_detail'      => ['id'],
+            $wpdb->prefix.'events_category_rel'         => ['id'],
+            $wpdb->prefix.'events_venue'                => ['id'],
+            $wpdb->prefix.'events_venue_rel'            => ['emeta_id'],
+            $wpdb->prefix.'events_locale'               => ['id'],
+            $wpdb->prefix.'events_locale_rel'           => ['id'],
+            $wpdb->prefix.'events_personnel'            => ['id'],
+            $wpdb->prefix.'events_personnel_rel'        => ['id'],
         ];
     }
 
@@ -81,7 +81,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CSV) {
+        if ( ! self::$_instance instanceof EE_CSV) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -157,24 +157,24 @@ 
             // loop through each column
             for ($i = 0; $i < $columns; $i++) {
                 // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+                $data[$i] = str_replace('"""', '\\"', $data[$i]);
                 // do we need to grab the column names?
                 if ($row === 1) {
                     if ($first_row_is_headers) {
                         // store the column names to use for keys
-                        $column_name = $data[ $i ];
+                        $column_name = $data[$i];
                         // check it's not blank... sometimes CSV editing programs
                         // add a bunch of empty columns onto the end...
-                        if (! $column_name) {
+                        if ( ! $column_name) {
                             continue;
                         }
                         $matches = [];
                         if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
+                            $headers[$i] = $column_name;
                         } else {
                             // now get the db table name from it (the part between square brackets)
                             $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
+                            if ( ! $success) {
                                 EE_Error::add_error(
                                     sprintf(
                                         esc_html__(
@@ -190,24 +190,24 @@ 
                                 );
                                 return false;
                             }
-                            $headers[ $i ] = $matches[2];
+                            $headers[$i] = $matches[2];
                         }
                     } else {
                         // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ]                 = $i;
+                        $model_entry[$headers[$i]] = $data[$i];
+                        $headers[$i]                 = $i;
                     }
                     // and we need to store csv data
                 } else {
                     // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
+                    if (isset($headers[$i])) {
+                        $model_entry[$headers[$i]] = $data[$i];
                     }
                 }
             }
             // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || $row > 1) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
+            if ( ! $first_row_is_headers || $row > 1) {
+                $ee_formatted_data[$model_name][] = $model_entry;
             }
             // advance to next row
             $row++;
@@ -291,7 +291,7 @@ 
     {
         $fc = "";
         $fh = fopen($file_path, "rb");
-        if (! $fh) {
+        if ( ! $fh) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("Cannot open file for read: %s<br>\n", 'event_espresso'),
@@ -304,7 +304,7 @@ 
         for ($i = 0; $i < $file_length; $i++) {
             $c = substr($bc, $i, 1);
             if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
+                $fc = $fc.$c;
             }
         }
         if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
@@ -384,7 +384,7 @@ 
         // header("Content-Type: application/force-download");
         // header("Content-Type: application/octet-stream");
         // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
+        header('Content-disposition: attachment; filename='.$filename);
         header("Content-Type: text/csv; charset=utf-8");
         do_action('AHEE__EE_CSV__begin_sending_csv__headers');
         echo apply_filters(
@@ -416,7 +416,7 @@ 
             $this->fputcsv2($file_handle, ['MODEL', $model_name]);
             // if we have items to put in the CSV, do it normally
 
-            if (! empty($model_instance_arrays)) {
+            if ( ! empty($model_instance_arrays)) {
                 $this->write_data_array_to_csv($file_handle, $model_instance_arrays);
             } else {
                 // echo "no data to write... so just write the headers";
@@ -425,7 +425,7 @@ 
                 $model        = EE_Registry::instance()->load_model($model_name);
                 $column_names = [];
                 foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+                    $column_names[$field->get_nicename()."[".$field->get_name()."]"] = null;
                 }
                 $this->write_data_array_to_csv($file_handle, [$column_names]);
             }
@@ -443,7 +443,7 @@ 
      */
     public function write_metadata_to_csv($file_handle)
     {
-        $data_row = [EE_CSV::metadata_header];// do NOT translate because this exact string is used when importing
+        $data_row = [EE_CSV::metadata_header]; // do NOT translate because this exact string is used when importing
         $this->fputcsv2($file_handle, $data_row);
         $meta_data = [
             0 => [
@@ -487,11 +487,11 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value)
-                ? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+                ? ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure)
                 : $field_value;
         }
 
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
+        fwrite($fh, join($delimiter, $output).PHP_EOL);
     }
 
 
@@ -565,12 +565,12 @@ 
     public function export_array_to_csv($data = false, $filename = false)
     {
         // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
+        if ( ! $data or ! is_array($data) or empty($data)) {
             return false;
         }
 
         // no filename?? get outta here
-        if (! $filename) {
+        if ( ! $filename) {
             return false;
         }
         $fh = $this->begin_sending_csv($filename);

core/db_classes/EE_Currency.class.php

Indentation +234 added lines, -234 removed lines

@@ -10,238 +10,238 @@
 class EE_Currency extends EE_Base_Class
 {
 
-    /** Currency COde
-     *
-     * @var CUR_code
-     */
-    protected $_CUR_code = null;
-
-    /** Currency Name Singular
-     *
-     * @var CUR_single
-     */
-    protected $_CUR_single = null;
-
-    /** Currency Name Plural
-     *
-     * @var CUR_plural
-     */
-    protected $_CUR_plural = null;
-
-    /** Currency Sign
-     *
-     * @var CUR_sign
-     */
-    protected $_CUR_sign = null;
-
-    /** Currency Decimal Places
-     *
-     * @var CUR_dec_plc
-     */
-    protected $_CUR_dec_plc = null;
-
-    /** Active?
-     *
-     * @var CUR_active
-     */
-    protected $_CUR_active = null;
-
-    protected $_Payment_Method;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone
-     *                                        (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Currency
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.
-     *                                If not set the timezone for the website will be used.
-     * @return EE_Currency
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_code($code)
-    {
-        $this->set('CUR_code', $code);
-    }
-
-
-    /**
-     * Gets active
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function active()
-    {
-        return $this->get('CUR_active');
-    }
-
-
-    /**
-     * Sets active
-     *
-     * @param boolean $active
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_active($active)
-    {
-        $this->set('CUR_active', $active);
-    }
-
-
-    /**
-     * Gets dec_plc
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function dec_plc()
-    {
-        return $this->get('CUR_dec_plc');
-    }
-
-
-    /**
-     * Sets dec_plc
-     *
-     * @param int $dec_plc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_dec_plc($dec_plc)
-    {
-        $this->set('CUR_dec_plc', $dec_plc);
-    }
-
-
-    /**
-     * Sets plural
-     *
-     * @param string $plural
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_plural_name($plural)
-    {
-        $this->set('CUR_plural', $plural);
-    }
-
-
-    /**
-     * Gets sign
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function sign()
-    {
-        return $this->get('CUR_sign');
-    }
-
-
-    /**
-     * Sets sign
-     *
-     * @param string $sign
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_sign($sign)
-    {
-        $this->set('CUR_sign', $sign);
-    }
-
-
-    /**
-     * Gets single
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function singular_name()
-    {
-        return $this->get('CUR_single');
-    }
-
-
-    /**
-     * Sets single
-     *
-     * @param string $single
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_singular_name($single)
-    {
-        $this->set('CUR_single', $single);
-    }
-
-
-    /**
-     * Gets a prettier name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return sprintf(
-            esc_html__("%s (%s)", "event_espresso"),
-            $this->code(),
-            $this->plural_name()
-        );
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function code()
-    {
-        return $this->get('CUR_code');
-    }
-
-
-    /**
-     * Gets plural
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function plural_name()
-    {
-        return $this->get('CUR_plural');
-    }
+	/** Currency COde
+	 *
+	 * @var CUR_code
+	 */
+	protected $_CUR_code = null;
+
+	/** Currency Name Singular
+	 *
+	 * @var CUR_single
+	 */
+	protected $_CUR_single = null;
+
+	/** Currency Name Plural
+	 *
+	 * @var CUR_plural
+	 */
+	protected $_CUR_plural = null;
+
+	/** Currency Sign
+	 *
+	 * @var CUR_sign
+	 */
+	protected $_CUR_sign = null;
+
+	/** Currency Decimal Places
+	 *
+	 * @var CUR_dec_plc
+	 */
+	protected $_CUR_dec_plc = null;
+
+	/** Active?
+	 *
+	 * @var CUR_active
+	 */
+	protected $_CUR_active = null;
+
+	protected $_Payment_Method;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone
+	 *                                        (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Currency
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.
+	 *                                If not set the timezone for the website will be used.
+	 * @return EE_Currency
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_code($code)
+	{
+		$this->set('CUR_code', $code);
+	}
+
+
+	/**
+	 * Gets active
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function active()
+	{
+		return $this->get('CUR_active');
+	}
+
+
+	/**
+	 * Sets active
+	 *
+	 * @param boolean $active
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_active($active)
+	{
+		$this->set('CUR_active', $active);
+	}
+
+
+	/**
+	 * Gets dec_plc
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function dec_plc()
+	{
+		return $this->get('CUR_dec_plc');
+	}
+
+
+	/**
+	 * Sets dec_plc
+	 *
+	 * @param int $dec_plc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_dec_plc($dec_plc)
+	{
+		$this->set('CUR_dec_plc', $dec_plc);
+	}
+
+
+	/**
+	 * Sets plural
+	 *
+	 * @param string $plural
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_plural_name($plural)
+	{
+		$this->set('CUR_plural', $plural);
+	}
+
+
+	/**
+	 * Gets sign
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function sign()
+	{
+		return $this->get('CUR_sign');
+	}
+
+
+	/**
+	 * Sets sign
+	 *
+	 * @param string $sign
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_sign($sign)
+	{
+		$this->set('CUR_sign', $sign);
+	}
+
+
+	/**
+	 * Gets single
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function singular_name()
+	{
+		return $this->get('CUR_single');
+	}
+
+
+	/**
+	 * Sets single
+	 *
+	 * @param string $single
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_singular_name($single)
+	{
+		$this->set('CUR_single', $single);
+	}
+
+
+	/**
+	 * Gets a prettier name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return sprintf(
+			esc_html__("%s (%s)", "event_espresso"),
+			$this->code(),
+			$this->plural_name()
+		);
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function code()
+	{
+		return $this->get('CUR_code');
+	}
+
+
+	/**
+	 * Gets plural
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function plural_name()
+	{
+		return $this->get('CUR_plural');
+	}
 }

core/db_classes/EE_Country.class.php

Indentation +132 added lines, -132 removed lines

@@ -10,136 +10,136 @@
 class EE_Country extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Country|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Country
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [])
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets the country name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('CNT_name');
-    }
-
-
-    /**
-     * gets the country's currency code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_code()
-    {
-        return $this->get('CNT_cur_code');
-    }
-
-
-    /**
-     * gets the country's currency sign/symbol
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_sign()
-    {
-        $CNT_cur_sign = $this->get('CNT_cur_sign');
-        return $CNT_cur_sign ? $CNT_cur_sign : '';
-    }
-
-
-    /**
-     * Currency name singular
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_name_single()
-    {
-        return $this->get('CNT_cur_single');
-    }
-
-
-    /**
-     * Currency name plural
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_name_plural()
-    {
-        return $this->get('CNT_cur_plural');
-    }
-
-
-    /**
-     * currency_sign_before - ie: $TRUE  or  FALSE$
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function currency_sign_before()
-    {
-        return $this->get('CNT_cur_sign_b4');
-    }
-
-
-    /**
-     * currency_decimal_places : 2 = 0.00   3 = 0.000
-     *
-     * @return integer
-     * @throws EE_Error
-     */
-    public function currency_decimal_places()
-    {
-        return $this->get('CNT_cur_dec_plc');
-    }
-
-
-    /**
-     * currency_decimal_mark :   (comma) ',' = 0,01   or   (decimal) '.' = 0.01
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_decimal_mark()
-    {
-        return $this->get('CNT_cur_dec_mrk');
-    }
-
-
-    /**
-     * currency thousands separator:   (comma) ',' = 1,000   or   (decimal) '.' = 1.000
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function currency_thousands_separator()
-    {
-        return $this->get('CNT_cur_thsnds');
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Country|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Country
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [])
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets the country name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('CNT_name');
+	}
+
+
+	/**
+	 * gets the country's currency code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_code()
+	{
+		return $this->get('CNT_cur_code');
+	}
+
+
+	/**
+	 * gets the country's currency sign/symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_sign()
+	{
+		$CNT_cur_sign = $this->get('CNT_cur_sign');
+		return $CNT_cur_sign ? $CNT_cur_sign : '';
+	}
+
+
+	/**
+	 * Currency name singular
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_name_single()
+	{
+		return $this->get('CNT_cur_single');
+	}
+
+
+	/**
+	 * Currency name plural
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_name_plural()
+	{
+		return $this->get('CNT_cur_plural');
+	}
+
+
+	/**
+	 * currency_sign_before - ie: $TRUE  or  FALSE$
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function currency_sign_before()
+	{
+		return $this->get('CNT_cur_sign_b4');
+	}
+
+
+	/**
+	 * currency_decimal_places : 2 = 0.00   3 = 0.000
+	 *
+	 * @return integer
+	 * @throws EE_Error
+	 */
+	public function currency_decimal_places()
+	{
+		return $this->get('CNT_cur_dec_plc');
+	}
+
+
+	/**
+	 * currency_decimal_mark :   (comma) ',' = 0,01   or   (decimal) '.' = 0.01
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_decimal_mark()
+	{
+		return $this->get('CNT_cur_dec_mrk');
+	}
+
+
+	/**
+	 * currency thousands separator:   (comma) ',' = 1,000   or   (decimal) '.' = 1.000
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function currency_thousands_separator()
+	{
+		return $this->get('CNT_cur_thsnds');
+	}
 }

core/db_classes/EE_Change_Log.class.php

Indentation +236 added lines, -236 removed lines

@@ -10,240 +10,240 @@
 class EE_Change_Log extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone
-     *                                  If not set the timezone for the website will be used.
-     * @param array  $date_formats      incoming date_formats in an array where the first value is the
-     *                                  date_format and the second value is the time format
-     * @return EE_Change_Log
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.
-     *                                If not set the timezone for the website will be used.
-     * @return EE_Change_Log
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets message
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function message()
-    {
-        return $this->get('LOG_message');
-    }
-
-
-    /**
-     * Sets message
-     *
-     * @param mixed $message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_message($message)
-    {
-        $this->set('LOG_message', $message);
-    }
-
-
-    /**
-     * Gets time
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function time()
-    {
-        return $this->get('LOG_time');
-    }
-
-
-    /**
-     * Sets time
-     *
-     * @param string $time
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_time($time)
-    {
-        $this->set('LOG_time', $time);
-    }
-
-
-    /**
-     * Return the localized log type label.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type_label()
-    {
-        return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
-    }
-
-
-    /**
-     * Gets log_type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type()
-    {
-        return $this->get('LOG_type');
-    }
-
-
-    /**
-     * Sets log_type
-     *
-     * @param string $log_type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_log_type($log_type)
-    {
-        $this->set('LOG_type', $log_type);
-    }
-
-
-    /**
-     * Gets OBJ_ID (the ID of the item related to this log)
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('LOG_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('LOG_wp_user', $wp_user_id);
-    }
-
-
-    /**
-     * Gets the model object attached to this log
-     *
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        $is_model_name             = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
-            return null;
-        }
-        return $this->get_first_related($model_name_of_related_obj);
-    }
-
-
-    /**
-     * Gets type of the model object related to this log
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-
-    /**
-     * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
-     * _add_relation_to because you don't have to specify what type of model you're
-     * associating it with
-     *
-     * @param EE_Base_Class $object
-     * @param boolean       $save
-     * @return bool if $save=true, NULL is $save=false
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_object($object, $save = true)
-    {
-        if ($object instanceof EE_Base_Class) {
-            $this->set_OBJ_type($object->get_model()->get_this_model_name());
-            $this->set_OBJ_ID($object->ID());
-        } else {
-            $this->set_OBJ_type(null);
-            $this->set_OBJ_ID(null);
-        }
-        if ($save) {
-            return $this->save();
-        }
-        return null;
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_OBJ_type($type)
-    {
-        $this->set('OBJ_type', $type);
-    }
-
-
-    /**
-     * Sets OBJ_ID
-     *
-     * @param mixed $OBJ_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_OBJ_ID($OBJ_ID)
-    {
-        $this->set('OBJ_ID', $OBJ_ID);
-    }
+	/**
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone
+	 *                                  If not set the timezone for the website will be used.
+	 * @param array  $date_formats      incoming date_formats in an array where the first value is the
+	 *                                  date_format and the second value is the time format
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.
+	 *                                If not set the timezone for the website will be used.
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets message
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function message()
+	{
+		return $this->get('LOG_message');
+	}
+
+
+	/**
+	 * Sets message
+	 *
+	 * @param mixed $message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_message($message)
+	{
+		$this->set('LOG_message', $message);
+	}
+
+
+	/**
+	 * Gets time
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function time()
+	{
+		return $this->get('LOG_time');
+	}
+
+
+	/**
+	 * Sets time
+	 *
+	 * @param string $time
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_time($time)
+	{
+		$this->set('LOG_time', $time);
+	}
+
+
+	/**
+	 * Return the localized log type label.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type_label()
+	{
+		return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
+	}
+
+
+	/**
+	 * Gets log_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type()
+	{
+		return $this->get('LOG_type');
+	}
+
+
+	/**
+	 * Sets log_type
+	 *
+	 * @param string $log_type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_log_type($log_type)
+	{
+		$this->set('LOG_type', $log_type);
+	}
+
+
+	/**
+	 * Gets OBJ_ID (the ID of the item related to this log)
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('LOG_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('LOG_wp_user', $wp_user_id);
+	}
+
+
+	/**
+	 * Gets the model object attached to this log
+	 *
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		$is_model_name             = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
+		if (! $is_model_name) {
+			return null;
+		}
+		return $this->get_first_related($model_name_of_related_obj);
+	}
+
+
+	/**
+	 * Gets type of the model object related to this log
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+
+	/**
+	 * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
+	 * _add_relation_to because you don't have to specify what type of model you're
+	 * associating it with
+	 *
+	 * @param EE_Base_Class $object
+	 * @param boolean       $save
+	 * @return bool if $save=true, NULL is $save=false
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_object($object, $save = true)
+	{
+		if ($object instanceof EE_Base_Class) {
+			$this->set_OBJ_type($object->get_model()->get_this_model_name());
+			$this->set_OBJ_ID($object->ID());
+		} else {
+			$this->set_OBJ_type(null);
+			$this->set_OBJ_ID(null);
+		}
+		if ($save) {
+			return $this->save();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_type($type)
+	{
+		$this->set('OBJ_type', $type);
+	}
+
+
+	/**
+	 * Sets OBJ_ID
+	 *
+	 * @param mixed $OBJ_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_ID($OBJ_ID)
+	{
+		$this->set('OBJ_ID', $OBJ_ID);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
     {
         $model_name_of_related_obj = $this->OBJ_type();
         $is_model_name             = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
+        if ( ! $is_model_name) {
             return null;
         }
         return $this->get_first_related($model_name_of_related_obj);

core/db_classes/EE_Checkin.class.php

Indentation +103 added lines, -103 removed lines

@@ -11,107 +11,107 @@
 {
 
 
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @type int
-     */
-    const status_checked_out = 0;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const status_checked_in = 1;
-
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const status_checked_never = 2;
-
-
-    /**
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats      incoming date_formats in an array
-     *                                  where the first value is the date_format
-     *                                  and the second value is the time format
-     * @return EE_Checkin
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Checkin
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function ID()
-    {
-        return $this->get('CHK_ID');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function registration_id()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function datetime_id()
-    {
-        return $this->get('DTT_ID');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function status()
-    {
-        return $this->get('CHK_in');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function timestamp()
-    {
-        return $this->get('CHK_timestamp');
-    }
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @type int
+	 */
+	const status_checked_out = 0;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const status_checked_in = 1;
+
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @type int
+	 */
+	const status_checked_never = 2;
+
+
+	/**
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats      incoming date_formats in an array
+	 *                                  where the first value is the date_format
+	 *                                  and the second value is the time format
+	 * @return EE_Checkin
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Checkin
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function ID()
+	{
+		return $this->get('CHK_ID');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function registration_id()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function datetime_id()
+	{
+		return $this->get('DTT_ID');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('CHK_in');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function timestamp()
+	{
+		return $this->get('CHK_timestamp');
+	}
 }