eventespresso / event-espresso-core

core/db_classes/EE_Message.class.php

Indentation +867 added lines, -867 removed lines

@@ -10,875 +10,875 @@
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid = $message_resource_manager->is_message_type_active_for_messenger(
-                $this->messenger(),
-                $this->message_type()
-            );
-            if (! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'
-                        ),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
-            : str_replace(
-                '_',
-                ' ',
-                $this->message_type()
-            );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
-            : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed:
-            case EEM_Message::status_debug_only:
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent:
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default:
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the
-     * status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID(EEM_Message::status_messenger_executing);
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		// if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if (! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid = $message_resource_manager->is_message_type_active_for_messenger(
+				$this->messenger(),
+				$this->message_type()
+			);
+			if (! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'
+						),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type
+			? $message_type->label[ $label_type ]
+			: str_replace(
+				'_',
+				' ',
+				$this->message_type()
+			);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts = $message_resource_manager->get_all_contexts();
+		return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if (! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
+			: $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed:
+			case EEM_Message::status_debug_only:
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent:
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default:
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the
+	 * status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID(EEM_Message::status_messenger_executing);
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -51,7 +51,7 @@ 
     {
         $has_object = parent::_check_for_object($props_n_values, __CLASS__);
         // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
+        if ( ! $has_object) {
             EE_Registry::instance()->load_helper('URL');
             $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
         }
@@ -219,7 +219,7 @@ 
     {
         $label_type = $plural ? 'plural' : 'singular';
         $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
     }
 
 
@@ -336,7 +336,7 @@ 
                 $this->messenger(),
                 $this->message_type()
             );
-            if (! $valid && $throw_exceptions) {
+            if ( ! $valid && $throw_exceptions) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -366,7 +366,7 @@ 
         $label_type = $plural ? 'plural' : 'singular';
         $message_type = $this->message_type_object();
         return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
+            ? $message_type->label[$label_type]
             : str_replace(
                 '_',
                 ' ',
@@ -397,7 +397,7 @@ 
         /** @type EE_Message_Resource_Manager $message_resource_manager */
         $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
     }
 
 
@@ -452,7 +452,7 @@ 
      */
     public function recipient_object()
     {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
+        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
             return null;
         }
 
@@ -736,13 +736,13 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_pack)) {
+        if ( ! empty($this->template_pack)) {
             return $this->template_pack;
         }
         /** @type EE_Message_Template_Group $grp */
         $grp = $this->get_first_related('Message_Template_Group');
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -768,7 +768,7 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_variation)) {
+        if ( ! empty($this->template_variation)) {
             return $this->template_variation;
         }
 
@@ -776,7 +776,7 @@ 
         $grp = $this->get_first_related('Message_Template_Group');
 
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(

core/db_classes/EE_CSV.class.php

Indentation +669 added lines, -669 removed lines

@@ -16,673 +16,673 @@
 class EE_CSV
 {
 
-    // instance of the EE_CSV object
-    private static $_instance = null;
-
-
-    // multidimensional array to store update & error messages
-    // var $_notices = array( 'updates' => array(), 'errors' => array() );
-
-
-    private $_primary_keys;
-
-    /**
-     *
-     * @var EE_Registry
-     */
-    private $EE;
-    /**
-     * 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';
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        global $wpdb;
-
-        $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('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 === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
-     * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
-     *
-     * @param string $file_path
-     * @return string
-     * @throws EE_Error
-     */
-    private function read_unicode_file($file_path)
-    {
-        $fc = "";
-        $fh = fopen($file_path, "rb");
-        if (! $fh) {
-            throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
-        }
-        $flen = filesize($file_path);
-        $bc = fread($fh, $flen);
-        for ($i = 0; $i < $flen; $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);
-    }
-
-
-    /**
-     * 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
-     */
-    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) {
-            # Set the parent multidimensional array key to 0.
-            $nn = 0;
-            $csvarray = 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, 0, ',', '"')) !== false) {
-                    $csvarray[] = $data;
-                }
-            } else {
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
-                    $csvarray[] = $data;
-                }
-            }
-            # Close the File.
-            fclose($file_handle);
-            return $csvarray;
-        } else {
-            EE_Error::add_error(
-                sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * @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',...),
-     *                                      ...
-     *                                      )
-     *                                      ...
-     *                                      )
-     */
-    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 (! $multi_dimensional_array) {
-            return false;
-        }
-        // gotta start somewhere
-        $row = 1;
-        // array to store csv data in
-        $ee_formatted_data = array();
-        // array to store headers (column names)
-        $headers = array();
-        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 = array();
-                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 = array();
-            // 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 editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
-                            continue;
-                        }
-                        $matches = array();
-                        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(
-                                        __(
-                                            "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 || ($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);
-        // echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
-        // die();
-
-        // it's good to give back
-        return $ee_formatted_data;
-    }
-
-
-    public function save_csv_to_db($csv_data_array, $model_name = false)
-    {
-        EE_Error::doing_it_wrong(
-            'save_csv_to_db',
-            __(
-                '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);
-    }
-
-    /**
-     * 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 $new_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
-        $fh = fopen('php://output', 'w');
-        return $fh;
-    }
-
-    /**
-     * Writes some meta data to the CSV as a bunch of columns. Initially we're only
-     * mentioning the version and timezone
-     *
-     * @param resource $filehandle
-     */
-    public function write_metadata_to_csv($filehandle)
-    {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
-        $this->fputcsv2($filehandle, $data_row);
-        $meta_data = array(
-            0 => array(
-                '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($filehandle, $meta_data);
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
-     *                                      by string
-     * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
-     *                                      headers in the CSV. Eg, if $data looked like
-     *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
-     *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
-     * @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)
-     */
-    public function write_data_array_to_csv($filehandle, $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(
-                        __(
-                            "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);
-                echo $this->fputcsv2($filehandle, $keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                echo $this->fputcsv2($filehandle, $data_row);
-            }
-            return true;
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-        // //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
-        //
-        //
-        // $no_table = TRUE;
-        //
-        // // loop through data and add each row to the file/stream as csv
-        // foreach ( $data as $model_name => $model_data ) {
-        // // test first row to see if it is data or a model name
-        // $model = EE_Registry::instance();->load_model($model_name);
-        // //if the model really exists,
-        // if ( $model ) {
-        //
-        // // we have a table name
-        // $no_table = FALSE;
-        //
-        // // put the tablename into an array cuz that's how fputcsv rolls
-        // $model_name_row = array( 'MODEL', $model_name );
-        //
-        // // add table name to csv output
-        // echo self::fputcsv2($filehandle, $model_name_row);
-        //
-        // // now get the rest of the data
-        // foreach ( $model_data as $row ) {
-        // // output the row
-        // echo self::fputcsv2($filehandle, $row);
-        // }
-        //
-        // }
-        //
-        // if ( $no_table ) {
-        // // no table so just put the data
-        // echo self::fputcsv2($filehandle, $model_data);
-        // }
-        //
-        // } // END OF foreach ( $data )
-    }
-
-    /**
-     * 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 filehandle where we're writing the CSV to
-     */
-    public function end_sending_csv($fh)
-    {
-        fclose($fh);
-        exit(0);
-    }
-
-    /**
-     * 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($filehandle).
-     *
-     * @param resource $filehandle
-     * @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 o fthat model
-     *                                   object (eg, the event's id, name, etc)
-     * @return boolean success
-     */
-    public function write_model_data_to_csv($filehandle, $model_data_array)
-    {
-        $this->write_metadata_to_csv($filehandle);
-        foreach ($model_data_array as $model_name => $model_instance_arrays) {
-            // first: output a special row stating the model
-            echo $this->fputcsv2($filehandle, array('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($filehandle, $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 = array();
-                foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
-                }
-                $this->write_data_array_to_csv($filehandle, array($column_names));
-            }
-        }
-    }
-
-    /**
-     * 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
-     */
-    public function export_multiple_model_data_to_csv($filename, $model_data_array)
-    {
-        $filehandle = $this->begin_sending_csv($filename);
-        $this->write_model_data_to_csv($filehandle, $model_data_array);
-        $this->end_sending_csv($filehandle);
-    }
-
-    /**
-     * @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 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;
-        }
-
-
-        // somebody told me i might need this ???
-        global $wpdb;
-        $prefix = $wpdb->prefix;
-
-
-        $fh = $this->begin_sending_csv($filename);
-
-
-        $this->end_sending_csv($fh);
-    }
-
-
-    /**
-     * @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 uplaod size
-        if ($percent_of_max) {
-            // is percent_of_max like this -> 50 or like this -> 0.50 ?
-            if ($percent_of_max > 1) {
-                // chnages 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;
-    }
-
-
-    /**
-     * @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 = array();
-        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);
-    }
-
-
-    // /**
-    //  * @CSV    Import / Export messages
-    //  * @access public
-    //  * @return void
-    //  */
-    // public function csv_admin_notices()
-    // {
-    //
-    //     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
-    //     foreach (array('updates', 'errors') as $type) {
-    //
-    //         // if particular notice type is not empty, then "You've got Mail"
-    //         if (! empty($this->_notices[ $type ])) {
-    //
-    //             // is it an update or an error ?
-    //             $msg_class = $type == 'updates' ? 'updated' : 'error';
-    //             echo '<div id="message" class="' . $msg_class . '">';
-    //             // display each notice, however many that may be
-    //             foreach ($this->_notices[ $type ] as $message) {
-    //                 echo '<p>' . $message . '</p>';
-    //             }
-    //             // wrap it up
-    //             echo '</div>';
-    //         }
-    //     }
-    // }
-
-    /**
-     * 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);
-    }
+	// instance of the EE_CSV object
+	private static $_instance = null;
+
+
+	// multidimensional array to store update & error messages
+	// var $_notices = array( 'updates' => array(), 'errors' => array() );
+
+
+	private $_primary_keys;
+
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	private $EE;
+	/**
+	 * 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';
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		global $wpdb;
+
+		$this->_primary_keys = array(
+			$wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
+			$wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
+			$wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
+			$wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
+			$wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
+			$wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
+			$wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
+			$wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
+			$wpdb->prefix . 'esp_question'                => array('QST_ID'),
+			$wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
+			$wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
+			$wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
+			$wpdb->prefix . 'esp_registration'            => array('REG_ID'),
+			$wpdb->prefix . 'esp_status'                  => array('STS_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'events_detail'               => array('id'),
+			$wpdb->prefix . 'events_category_detail'      => array('id'),
+			$wpdb->prefix . 'events_category_rel'         => array('id'),
+			$wpdb->prefix . 'events_venue'                => array('id'),
+			$wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
+			$wpdb->prefix . 'events_locale'               => array('id'),
+			$wpdb->prefix . 'events_locale_rel'           => array('id'),
+			$wpdb->prefix . 'events_personnel'            => array('id'),
+			$wpdb->prefix . 'events_personnel_rel'        => array('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 === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
+	 * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
+	 *
+	 * @param string $file_path
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function read_unicode_file($file_path)
+	{
+		$fc = "";
+		$fh = fopen($file_path, "rb");
+		if (! $fh) {
+			throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
+		}
+		$flen = filesize($file_path);
+		$bc = fread($fh, $flen);
+		for ($i = 0; $i < $flen; $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);
+	}
+
+
+	/**
+	 * 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
+	 */
+	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) {
+			# Set the parent multidimensional array key to 0.
+			$nn = 0;
+			$csvarray = 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, 0, ',', '"')) !== false) {
+					$csvarray[] = $data;
+				}
+			} else {
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
+					$csvarray[] = $data;
+				}
+			}
+			# Close the File.
+			fclose($file_handle);
+			return $csvarray;
+		} else {
+			EE_Error::add_error(
+				sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * @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',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      ...
+	 *                                      )
+	 */
+	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 (! $multi_dimensional_array) {
+			return false;
+		}
+		// gotta start somewhere
+		$row = 1;
+		// array to store csv data in
+		$ee_formatted_data = array();
+		// array to store headers (column names)
+		$headers = array();
+		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 = array();
+				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 = array();
+			// 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 editign programs adda bunch of empty columns onto the end...
+						if (! $column_name) {
+							continue;
+						}
+						$matches = array();
+						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(
+										__(
+											"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 || ($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);
+		// echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
+		// die();
+
+		// it's good to give back
+		return $ee_formatted_data;
+	}
+
+
+	public function save_csv_to_db($csv_data_array, $model_name = false)
+	{
+		EE_Error::doing_it_wrong(
+			'save_csv_to_db',
+			__(
+				'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);
+	}
+
+	/**
+	 * 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 $new_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
+		$fh = fopen('php://output', 'w');
+		return $fh;
+	}
+
+	/**
+	 * Writes some meta data to the CSV as a bunch of columns. Initially we're only
+	 * mentioning the version and timezone
+	 *
+	 * @param resource $filehandle
+	 */
+	public function write_metadata_to_csv($filehandle)
+	{
+		$data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+		$this->fputcsv2($filehandle, $data_row);
+		$meta_data = array(
+			0 => array(
+				'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($filehandle, $meta_data);
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
+	 *                                      by string
+	 * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
+	 *                                      headers in the CSV. Eg, if $data looked like
+	 *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
+	 *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
+	 * @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)
+	 */
+	public function write_data_array_to_csv($filehandle, $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(
+						__(
+							"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);
+				echo $this->fputcsv2($filehandle, $keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				echo $this->fputcsv2($filehandle, $data_row);
+			}
+			return true;
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+		// //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
+		//
+		//
+		// $no_table = TRUE;
+		//
+		// // loop through data and add each row to the file/stream as csv
+		// foreach ( $data as $model_name => $model_data ) {
+		// // test first row to see if it is data or a model name
+		// $model = EE_Registry::instance();->load_model($model_name);
+		// //if the model really exists,
+		// if ( $model ) {
+		//
+		// // we have a table name
+		// $no_table = FALSE;
+		//
+		// // put the tablename into an array cuz that's how fputcsv rolls
+		// $model_name_row = array( 'MODEL', $model_name );
+		//
+		// // add table name to csv output
+		// echo self::fputcsv2($filehandle, $model_name_row);
+		//
+		// // now get the rest of the data
+		// foreach ( $model_data as $row ) {
+		// // output the row
+		// echo self::fputcsv2($filehandle, $row);
+		// }
+		//
+		// }
+		//
+		// if ( $no_table ) {
+		// // no table so just put the data
+		// echo self::fputcsv2($filehandle, $model_data);
+		// }
+		//
+		// } // END OF foreach ( $data )
+	}
+
+	/**
+	 * 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 filehandle where we're writing the CSV to
+	 */
+	public function end_sending_csv($fh)
+	{
+		fclose($fh);
+		exit(0);
+	}
+
+	/**
+	 * 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($filehandle).
+	 *
+	 * @param resource $filehandle
+	 * @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 o fthat model
+	 *                                   object (eg, the event's id, name, etc)
+	 * @return boolean success
+	 */
+	public function write_model_data_to_csv($filehandle, $model_data_array)
+	{
+		$this->write_metadata_to_csv($filehandle);
+		foreach ($model_data_array as $model_name => $model_instance_arrays) {
+			// first: output a special row stating the model
+			echo $this->fputcsv2($filehandle, array('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($filehandle, $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 = array();
+				foreach ($model->field_settings() as $field) {
+					$column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+				}
+				$this->write_data_array_to_csv($filehandle, array($column_names));
+			}
+		}
+	}
+
+	/**
+	 * 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
+	 */
+	public function export_multiple_model_data_to_csv($filename, $model_data_array)
+	{
+		$filehandle = $this->begin_sending_csv($filename);
+		$this->write_model_data_to_csv($filehandle, $model_data_array);
+		$this->end_sending_csv($filehandle);
+	}
+
+	/**
+	 * @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 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;
+		}
+
+
+		// somebody told me i might need this ???
+		global $wpdb;
+		$prefix = $wpdb->prefix;
+
+
+		$fh = $this->begin_sending_csv($filename);
+
+
+		$this->end_sending_csv($fh);
+	}
+
+
+	/**
+	 * @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 uplaod size
+		if ($percent_of_max) {
+			// is percent_of_max like this -> 50 or like this -> 0.50 ?
+			if ($percent_of_max > 1) {
+				// chnages 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;
+	}
+
+
+	/**
+	 * @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 = array();
+		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);
+	}
+
+
+	// /**
+	//  * @CSV    Import / Export messages
+	//  * @access public
+	//  * @return void
+	//  */
+	// public function csv_admin_notices()
+	// {
+	//
+	//     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
+	//     foreach (array('updates', 'errors') as $type) {
+	//
+	//         // if particular notice type is not empty, then "You've got Mail"
+	//         if (! empty($this->_notices[ $type ])) {
+	//
+	//             // is it an update or an error ?
+	//             $msg_class = $type == 'updates' ? 'updated' : 'error';
+	//             echo '<div id="message" class="' . $msg_class . '">';
+	//             // display each notice, however many that may be
+	//             foreach ($this->_notices[ $type ] as $message) {
+	//                 echo '<p>' . $message . '</p>';
+	//             }
+	//             // wrap it up
+	//             echo '</div>';
+	//         }
+	//     }
+	// }
+
+	/**
+	 * 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

@@ -48,31 +48,31 @@ 
         global $wpdb;
 
         $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
+            $wpdb->prefix.'esp_answer'                  => array('ANS_ID'),
+            $wpdb->prefix.'esp_attendee'                => array('ATT_ID'),
+            $wpdb->prefix.'esp_datetime'                => array('DTT_ID'),
+            $wpdb->prefix.'esp_event_question_group'    => array('EQG_ID'),
+            $wpdb->prefix.'esp_message_template'        => array('MTP_ID'),
+            $wpdb->prefix.'esp_payment'                 => array('PAY_ID'),
+            $wpdb->prefix.'esp_price'                   => array('PRC_ID'),
+            $wpdb->prefix.'esp_price_type'              => array('PRT_ID'),
+            $wpdb->prefix.'esp_question'                => array('QST_ID'),
+            $wpdb->prefix.'esp_question_group'          => array('QSG_ID'),
+            $wpdb->prefix.'esp_question_group_question' => array('QGQ_ID'),
+            $wpdb->prefix.'esp_question_option'         => array('QSO_ID'),
+            $wpdb->prefix.'esp_registration'            => array('REG_ID'),
+            $wpdb->prefix.'esp_status'                  => array('STS_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'events_detail'               => array('id'),
+            $wpdb->prefix.'events_category_detail'      => array('id'),
+            $wpdb->prefix.'events_category_rel'         => array('id'),
+            $wpdb->prefix.'events_venue'                => array('id'),
+            $wpdb->prefix.'events_venue_rel'            => array('emeta_id'),
+            $wpdb->prefix.'events_locale'               => array('id'),
+            $wpdb->prefix.'events_locale_rel'           => array('id'),
+            $wpdb->prefix.'events_personnel'            => array('id'),
+            $wpdb->prefix.'events_personnel_rel'        => array('id'),
         );
     }
 
@@ -104,7 +104,7 @@ 
     {
         $fc = "";
         $fh = fopen($file_path, "rb");
-        if (! $fh) {
+        if ( ! $fh) {
             throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
         }
         $flen = filesize($file_path);
@@ -112,7 +112,7 @@ 
         for ($i = 0; $i < $flen; $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)) {
@@ -207,7 +207,7 @@ 
     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 (! $multi_dimensional_array) {
+        if ( ! $multi_dimensional_array) {
             return false;
         }
         // gotta start somewhere
@@ -243,23 +243,23 @@ 
             // 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 editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
+                        if ( ! $column_name) {
                             continue;
                         }
                         $matches = array();
                         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(
                                         __(
@@ -275,24 +275,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 || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
+            if ( ! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+                $ee_formatted_data[$model_name][] = $model_entry;
             }
             // advance to next row
             $row++;
@@ -353,7 +353,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(
@@ -372,7 +372,7 @@ 
      */
     public function write_metadata_to_csv($filehandle)
     {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+        $data_row = array(EE_CSV::metadata_header); // do NOT translate because this exact string is used when importing
         $this->fputcsv2($filehandle, $data_row);
         $meta_data = array(
             0 => array(
@@ -501,7 +501,7 @@ 
             echo $this->fputcsv2($filehandle, array('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($filehandle, $model_instance_arrays);
             } else {
                 // echo "no data to write... so just write the headers";
@@ -510,7 +510,7 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 $column_names = array();
                 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($filehandle, array($column_names));
             }
@@ -543,12 +543,12 @@ 
     {
 
         // 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;
         }
 
@@ -629,11 +629,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);
     }
 
 

core/db_classes/EE_Extra_Join.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Extra_Join extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @param null  $timezone
-     * @return EE_Extra_Join|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null)
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @param null  $timezone
+	 * @return EE_Extra_Join|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null)
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @param null  $timezone
-     * @return EE_Extra_Join
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @param null  $timezone
+	 * @return EE_Extra_Join
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Currency_Payment_Method.class.php

Indentation +32 added lines, -32 removed lines

@@ -14,40 +14,40 @@
 class EE_Currency_Payment_Method extends EE_Base_Class
 {
 
-    /** Currency to Payment Method Link ID @var CPM_ID */
-    protected $_CPM_ID = null;
-    /** Currency Code @var CUR_code */
-    protected $_CUR_code = null;
-    /** Payment Method ID @var PMD_ID */
-    protected $_PMD_ID = null;
-    protected $_Payment_Method;
-    protected $_Currency;
+	/** Currency to Payment Method Link ID @var CPM_ID */
+	protected $_CPM_ID = null;
+	/** Currency Code @var CUR_code */
+	protected $_CUR_code = null;
+	/** Payment Method ID @var PMD_ID */
+	protected $_PMD_ID = null;
+	protected $_Payment_Method;
+	protected $_Currency;
 
 
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Question_Group.class.php

Indentation +276 added lines, -276 removed lines

@@ -12,280 +12,280 @@
 class EE_Question_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * gets the question group's name
-     *
-     * @access public
-     * @param bool $pretty
-     * @return string
-     */
-    public function name($pretty = false)
-    {
-        return $pretty ? $this->get_pretty('QSG_name') : $this->get('QSG_name');
-    }
-
-
-    /**
-     * Gets the question group's internal name
-     *
-     * @access public
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->get('QSG_identifier');
-    }
-
-
-    /**
-     * Gets the question group's description
-     *
-     * @access public
-     * @param bool $pretty
-     * @return string
-     */
-    public function desc($pretty = false)
-    {
-        return $pretty ? $this->get_pretty('QSG_desc') : $this->get('QSG_desc');
-    }
-
-
-    /**
-     * Gets the question group's order number in a sequence
-     * of other question groups
-     *
-     * @access public
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('QSG_order');
-    }
-
-
-    /**
-     * Returns whether to show the group's name on the frontend
-     *
-     * @access public
-     * @return boolean
-     */
-    public function show_group_name()
-    {
-        return $this->get('QSG_show_group_name');
-    }
-
-
-    /**
-     * Returns whether to show the group's description
-     * on the frontend
-     *
-     * @access public
-     * @return boolean
-     */
-    public function show_group_desc()
-    {
-        return $this->get('QSG_show_group_desc');
-    }
-
-
-    /**
-     * Returns whether this is a 'system group' (meaning
-     * a question group integral to the system, whose questions
-     * relate to the attendee table)
-     *
-     * @access public
-     * @return int
-     */
-    public function system_group()
-    {
-        return $this->get('QSG_system');
-    }
-
-
-    /**
-     * get the author of the question group.
-     *
-     * @since 4.5.0
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('QSG_wp_user');
-    }
-
-
-    /**
-     * Returns whether this question group has
-     * been deleted
-     *
-     * @access public
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of questions with questions IN the group at the start of the array and questions NOT in the group
-     * at the end of the array.  Questions in the group are ordered by Question_Group_Question.QGQ_order and questions
-     * NOT in the group are ordered by Question.QGQ_order
-     *
-     * @return EE_Question[]
-     */
-    public function questions_in_and_not_in_group()
-    {
-        $questions_in_group = $this->questions();
-        $exclude_question_ids = ! empty($questions_in_group) ? array_keys($questions_in_group) : array();
-        $questions_not_in_group = $this->questions_not_in_group($exclude_question_ids);
-        return $questions_in_group + $questions_not_in_group;
-    }
-
-
-    /**
-     * Gets all the questions which are part of this question group (ordered Question_Group_Question.QGQ_order)
-     *
-     * @param array $query_params
-     * @return EE_Question[]
-     */
-    public function questions($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params
-            : array('order_by' => array('Question_Group_Question.QGQ_order' => 'ASC'));
-        return $this->ID() ? $this->get_many_related('Question', $query_params) : array();
-    }
-
-
-    /**
-     * Gets all the questions which are NOT part of this question group.
-     *
-     * @param  mixed $question_IDS_in_group if empty array then all questions returned.  if FALSE then we first get
-     *                                      questions in this group and exclude them from questions get all. IF empty
-     *                                      array then we just return all questions.
-     * @return EE_Question[]
-     */
-    public function questions_not_in_group($question_IDS_in_group = false)
-    {
-        if ($question_IDS_in_group === false) {
-            $questions = $this->questions();
-            $question_IDS_in_group = ! empty($questions) ? array_keys($questions) : array();
-        }
-        $_where = ! empty($question_IDS_in_group) ? array('QST_ID' => array('not_in', $question_IDS_in_group))
-            : array();
-
-        return EEM_Question::instance()->get_all(array($_where, 'order_by' => array('QST_ID' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all events which are related to this question group
-     *
-     * @return EE_Event[]
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Adds the question to this question group
-     *
-     * @param EE_Question || int $question object or ID
-     * @return boolean if successful
-     */
-    public function add_question($questionObjectOrID)
-    {
-        return $this->_add_relation_to($questionObjectOrID, 'Question');
-    }
-
-
-    /**
-     * Removes the question from this question group
-     *
-     * @param EE_Question || int $question object or ID
-     * @return boolean of success
-     */
-    public function remove_question($questionObjectOrID)
-    {
-        return $this->_remove_relation_to($questionObjectOrID, 'Question');
-    }
-
-
-    /**
-     * @param $questionObjectOrID
-     * @param $qst_order
-     * @return int
-     */
-    public function update_question_order($questionObjectOrID, $qst_order)
-    {
-        $qst_ID = $questionObjectOrID instanceof EE_Question ? $questionObjectOrID->ID() : (int) $questionObjectOrID;
-        return EEM_Question_Group_Question::instance()->update(
-            array('QGQ_order' => $qst_order),
-            array(
-                array(
-                    'QST_ID' => $qst_ID,
-                    'QSG_ID' => $this->ID(),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * Basically this is method just returns whether the question group has any questions with answers.  This is used
-     * by the admin currently to determine whether we should display the ui for deleting permanently or not b/c
-     * question groups with questions that have answers should not be possible to delete permanently
-     *
-     * @return boolean true if has questions with answers, false if not.
-     */
-    public function has_questions_with_answers()
-    {
-        $has_answers = false;
-        $questions = $this->get_many_related('Question');
-        foreach ($questions as $question) {
-            if ($question->count_related('Answer') > 0) {
-                $has_answers = true;
-            }
-        }
-        return $has_answers;
-    }
-
-
-    /**
-     * The purpose of this method is set the question group order for this question group to be the max out of all
-     * question groups
-     *
-     * @access public
-     * @return void
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->get_model()->get_latest_question_group_order();
-        $latest_order++;
-        $this->set('QSG_order', $latest_order);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * gets the question group's name
+	 *
+	 * @access public
+	 * @param bool $pretty
+	 * @return string
+	 */
+	public function name($pretty = false)
+	{
+		return $pretty ? $this->get_pretty('QSG_name') : $this->get('QSG_name');
+	}
+
+
+	/**
+	 * Gets the question group's internal name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->get('QSG_identifier');
+	}
+
+
+	/**
+	 * Gets the question group's description
+	 *
+	 * @access public
+	 * @param bool $pretty
+	 * @return string
+	 */
+	public function desc($pretty = false)
+	{
+		return $pretty ? $this->get_pretty('QSG_desc') : $this->get('QSG_desc');
+	}
+
+
+	/**
+	 * Gets the question group's order number in a sequence
+	 * of other question groups
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('QSG_order');
+	}
+
+
+	/**
+	 * Returns whether to show the group's name on the frontend
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function show_group_name()
+	{
+		return $this->get('QSG_show_group_name');
+	}
+
+
+	/**
+	 * Returns whether to show the group's description
+	 * on the frontend
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function show_group_desc()
+	{
+		return $this->get('QSG_show_group_desc');
+	}
+
+
+	/**
+	 * Returns whether this is a 'system group' (meaning
+	 * a question group integral to the system, whose questions
+	 * relate to the attendee table)
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function system_group()
+	{
+		return $this->get('QSG_system');
+	}
+
+
+	/**
+	 * get the author of the question group.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('QSG_wp_user');
+	}
+
+
+	/**
+	 * Returns whether this question group has
+	 * been deleted
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of questions with questions IN the group at the start of the array and questions NOT in the group
+	 * at the end of the array.  Questions in the group are ordered by Question_Group_Question.QGQ_order and questions
+	 * NOT in the group are ordered by Question.QGQ_order
+	 *
+	 * @return EE_Question[]
+	 */
+	public function questions_in_and_not_in_group()
+	{
+		$questions_in_group = $this->questions();
+		$exclude_question_ids = ! empty($questions_in_group) ? array_keys($questions_in_group) : array();
+		$questions_not_in_group = $this->questions_not_in_group($exclude_question_ids);
+		return $questions_in_group + $questions_not_in_group;
+	}
+
+
+	/**
+	 * Gets all the questions which are part of this question group (ordered Question_Group_Question.QGQ_order)
+	 *
+	 * @param array $query_params
+	 * @return EE_Question[]
+	 */
+	public function questions($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params
+			: array('order_by' => array('Question_Group_Question.QGQ_order' => 'ASC'));
+		return $this->ID() ? $this->get_many_related('Question', $query_params) : array();
+	}
+
+
+	/**
+	 * Gets all the questions which are NOT part of this question group.
+	 *
+	 * @param  mixed $question_IDS_in_group if empty array then all questions returned.  if FALSE then we first get
+	 *                                      questions in this group and exclude them from questions get all. IF empty
+	 *                                      array then we just return all questions.
+	 * @return EE_Question[]
+	 */
+	public function questions_not_in_group($question_IDS_in_group = false)
+	{
+		if ($question_IDS_in_group === false) {
+			$questions = $this->questions();
+			$question_IDS_in_group = ! empty($questions) ? array_keys($questions) : array();
+		}
+		$_where = ! empty($question_IDS_in_group) ? array('QST_ID' => array('not_in', $question_IDS_in_group))
+			: array();
+
+		return EEM_Question::instance()->get_all(array($_where, 'order_by' => array('QST_ID' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all events which are related to this question group
+	 *
+	 * @return EE_Event[]
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Adds the question to this question group
+	 *
+	 * @param EE_Question || int $question object or ID
+	 * @return boolean if successful
+	 */
+	public function add_question($questionObjectOrID)
+	{
+		return $this->_add_relation_to($questionObjectOrID, 'Question');
+	}
+
+
+	/**
+	 * Removes the question from this question group
+	 *
+	 * @param EE_Question || int $question object or ID
+	 * @return boolean of success
+	 */
+	public function remove_question($questionObjectOrID)
+	{
+		return $this->_remove_relation_to($questionObjectOrID, 'Question');
+	}
+
+
+	/**
+	 * @param $questionObjectOrID
+	 * @param $qst_order
+	 * @return int
+	 */
+	public function update_question_order($questionObjectOrID, $qst_order)
+	{
+		$qst_ID = $questionObjectOrID instanceof EE_Question ? $questionObjectOrID->ID() : (int) $questionObjectOrID;
+		return EEM_Question_Group_Question::instance()->update(
+			array('QGQ_order' => $qst_order),
+			array(
+				array(
+					'QST_ID' => $qst_ID,
+					'QSG_ID' => $this->ID(),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * Basically this is method just returns whether the question group has any questions with answers.  This is used
+	 * by the admin currently to determine whether we should display the ui for deleting permanently or not b/c
+	 * question groups with questions that have answers should not be possible to delete permanently
+	 *
+	 * @return boolean true if has questions with answers, false if not.
+	 */
+	public function has_questions_with_answers()
+	{
+		$has_answers = false;
+		$questions = $this->get_many_related('Question');
+		foreach ($questions as $question) {
+			if ($question->count_related('Answer') > 0) {
+				$has_answers = true;
+			}
+		}
+		return $has_answers;
+	}
+
+
+	/**
+	 * The purpose of this method is set the question group order for this question group to be the max out of all
+	 * question groups
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->get_model()->get_latest_question_group_order();
+		$latest_order++;
+		$this->set('QSG_order', $latest_order);
+	}
 }

core/db_classes/EE_Checkin.class.php

Indentation +82 added lines, -82 removed lines

@@ -11,86 +11,86 @@
 {
 
 
-    /**
-     * 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
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Checkin
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    public function ID()
-    {
-        return $this->get('CHK_ID');
-    }
-
-
-    public function registration_id()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    public function datetime_id()
-    {
-        return $this->get('DTT_ID');
-    }
-
-
-    public function status()
-    {
-        return $this->get('CHK_in');
-    }
-
-
-    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
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Checkin
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	public function ID()
+	{
+		return $this->get('CHK_ID');
+	}
+
+
+	public function registration_id()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	public function datetime_id()
+	{
+		return $this->get('DTT_ID');
+	}
+
+
+	public function status()
+	{
+		return $this->get('CHK_in');
+	}
+
+
+	public function timestamp()
+	{
+		return $this->get('CHK_timestamp');
+	}
 }

core/db_classes/EE_Currency.class.php

Indentation +176 added lines, -176 removed lines

@@ -12,180 +12,180 @@
 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_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-    /**
-     * Gets code
-     *
-     * @return string
-     */
-    public function code()
-    {
-        return $this->get('CUR_code');
-    }
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @return boolean
-     */
-    public function set_code($code)
-    {
-        return $this->set('CUR_code', $code);
-    }
-
-    /**
-     * Gets active
-     *
-     * @return boolean
-     */
-    public function active()
-    {
-        return $this->get('CUR_active');
-    }
-
-    /**
-     * Sets active
-     *
-     * @param boolean $active
-     * @return boolean
-     */
-    public function set_active($active)
-    {
-        return $this->set('CUR_active', $active);
-    }
-
-    /**
-     * Gets dec_plc
-     *
-     * @return int
-     */
-    public function dec_plc()
-    {
-        return $this->get('CUR_dec_plc');
-    }
-
-    /**
-     * Sets dec_plc
-     *
-     * @param int $dec_plc
-     * @return boolean
-     */
-    public function set_dec_plc($dec_plc)
-    {
-        return $this->set('CUR_dec_plc', $dec_plc);
-    }
-
-    /**
-     * Gets plural
-     *
-     * @return string
-     */
-    public function plural_name()
-    {
-        return $this->get('CUR_plural');
-    }
-
-    /**
-     * Sets plural
-     *
-     * @param string $plural
-     * @return boolean
-     */
-    public function set_plural_name($plural)
-    {
-        return $this->set('CUR_plural', $plural);
-    }
-
-    /**
-     * Gets sign
-     *
-     * @return string
-     */
-    public function sign()
-    {
-        return $this->get('CUR_sign');
-    }
-
-    /**
-     * Sets sign
-     *
-     * @param string $sign
-     * @return boolean
-     */
-    public function set_sign($sign)
-    {
-        return $this->set('CUR_sign', $sign);
-    }
-
-    /**
-     * Gets single
-     *
-     * @return string
-     */
-    public function singular_name()
-    {
-        return $this->get('CUR_single');
-    }
-
-    /**
-     * Sets single
-     *
-     * @param string $single
-     * @return boolean
-     */
-    public function set_singular_name($single)
-    {
-        return $this->set('CUR_single', $single);
-    }
-
-    /**
-     * Gets a prettier name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return sprintf(__("%s (%s)", "event_espresso"), $this->code(), $this->plural_name());
-    }
+	/** 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_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 */
+	public function code()
+	{
+		return $this->get('CUR_code');
+	}
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @return boolean
+	 */
+	public function set_code($code)
+	{
+		return $this->set('CUR_code', $code);
+	}
+
+	/**
+	 * Gets active
+	 *
+	 * @return boolean
+	 */
+	public function active()
+	{
+		return $this->get('CUR_active');
+	}
+
+	/**
+	 * Sets active
+	 *
+	 * @param boolean $active
+	 * @return boolean
+	 */
+	public function set_active($active)
+	{
+		return $this->set('CUR_active', $active);
+	}
+
+	/**
+	 * Gets dec_plc
+	 *
+	 * @return int
+	 */
+	public function dec_plc()
+	{
+		return $this->get('CUR_dec_plc');
+	}
+
+	/**
+	 * Sets dec_plc
+	 *
+	 * @param int $dec_plc
+	 * @return boolean
+	 */
+	public function set_dec_plc($dec_plc)
+	{
+		return $this->set('CUR_dec_plc', $dec_plc);
+	}
+
+	/**
+	 * Gets plural
+	 *
+	 * @return string
+	 */
+	public function plural_name()
+	{
+		return $this->get('CUR_plural');
+	}
+
+	/**
+	 * Sets plural
+	 *
+	 * @param string $plural
+	 * @return boolean
+	 */
+	public function set_plural_name($plural)
+	{
+		return $this->set('CUR_plural', $plural);
+	}
+
+	/**
+	 * Gets sign
+	 *
+	 * @return string
+	 */
+	public function sign()
+	{
+		return $this->get('CUR_sign');
+	}
+
+	/**
+	 * Sets sign
+	 *
+	 * @param string $sign
+	 * @return boolean
+	 */
+	public function set_sign($sign)
+	{
+		return $this->set('CUR_sign', $sign);
+	}
+
+	/**
+	 * Gets single
+	 *
+	 * @return string
+	 */
+	public function singular_name()
+	{
+		return $this->get('CUR_single');
+	}
+
+	/**
+	 * Sets single
+	 *
+	 * @param string $single
+	 * @return boolean
+	 */
+	public function set_singular_name($single)
+	{
+		return $this->set('CUR_single', $single);
+	}
+
+	/**
+	 * Gets a prettier name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return sprintf(__("%s (%s)", "event_espresso"), $this->code(), $this->plural_name());
+	}
 }

core/db_classes/EE_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -389,11 +389,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -402,7 +402,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -441,7 +441,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -464,14 +464,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +570 added lines, -570 removed lines

@@ -11,580 +11,580 @@
 class EE_Payment_Method extends EE_Base_Class
 {
 
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_type_obj;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return boolean
-     */
-    public function active()
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws \EE_Error
-     */
-    public function set_active()
-    {
-        $default_scopes = array(EEM_Payment_Method::scope_cart);
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     */
-    public function deactivate()
-    {
-        $this->set_scope(array());
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     */
-    public function debug_mode()
-    {
-        return $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string $field_name
-     * @param mixed $field_value
-     * @param boolean $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     */
-    public function scope()
-    {
-        return $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs(array($this));
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     */
-    public function settings_array()
-    {
-        $fields = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = array();
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws \EE_Error
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_type_obj;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return boolean
+	 */
+	public function active()
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws \EE_Error
+	 */
+	public function set_active()
+	{
+		$default_scopes = array(EEM_Payment_Method::scope_cart);
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 */
+	public function deactivate()
+	{
+		$this->set_scope(array());
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 */
+	public function debug_mode()
+	{
+		return $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string $field_name
+	 * @param mixed $field_value
+	 * @param boolean $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 */
+	public function scope()
+	{
+		return $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs(array($this));
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 */
+	public function settings_array()
+	{
+		$fields = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = array();
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws \EE_Error
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws \EE_Error
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return int @see EE_Base_Class::save()
-     * @throws \EE_Error
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    __('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    EE_Registry::instance()->REQ->get_current_page_permalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return int @see EE_Base_Class::save()
+	 * @throws \EE_Error
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					EE_Registry::instance()->REQ->get_current_page_permalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/db_classes/EE_Event_Venue.class.php

Indentation +17 added lines, -17 removed lines

@@ -6,23 +6,23 @@
 class EE_Event_Venue extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Event_Venue|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Event_Venue|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Event_Venue
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Event_Venue
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 }