eventespresso / event-espresso-core

core/db_classes/EE_Question.class.php

Indentation +661 added lines, -661 removed lines

@@ -14,665 +14,665 @@
 class EE_Question extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
 
-    /**
-     *
-     * @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_Question
-     */
-    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_Question
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param string $QST_display_text
-     */
-    public function set_display_text($QST_display_text = '')
-    {
-        $this->set('QST_display_text', $QST_display_text);
-    }
-
-
-    /**
-     *        Set    Question admin text
-     *
-     * @access        public
-     * @param        string $QST_admin_label
-     */
-    public function set_admin_label($QST_admin_label = '')
-    {
-        $this->set('QST_admin_label', $QST_admin_label);
-    }
-
-
-    /**
-     *        Set    system name
-     *
-     * @access        public
-     * @param        mixed $QST_system
-     */
-    public function set_system_ID($QST_system = '')
-    {
-        $this->set('QST_system', $QST_system);
-    }
-
-
-    /**
-     *        Set    question's type
-     *
-     * @access        public
-     * @param        string $QST_type
-     */
-    public function set_question_type($QST_type = '')
-    {
-        $this->set('QST_type', $QST_type);
-    }
-
-
-    /**
-     *        Sets whether this question must be answered when presented in a form
-     *
-     * @access        public
-     * @param        bool $QST_required
-     */
-    public function set_required($QST_required = false)
-    {
-        $this->set('QST_required', $QST_required);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param        string $QST_required_text
-     */
-    public function set_required_text($QST_required_text = '')
-    {
-        $this->set('QST_required_text', $QST_required_text);
-    }
-
-
-    /**
-     *        Sets the order of this question when placed in a sequence of questions
-     *
-     * @access        public
-     * @param        int $QST_order
-     */
-    public function set_order($QST_order = 0)
-    {
-        $this->set('QST_order', $QST_order);
-    }
-
-
-    /**
-     *        Sets whether the question is admin-only
-     *
-     * @access        public
-     * @param        bool $QST_admin_only
-     */
-    public function set_admin_only($QST_admin_only = false)
-    {
-        $this->set('QST_admin_only', $QST_admin_only);
-    }
-
-
-    /**
-     *        Sets the wordpress user ID on the question
-     *
-     * @access        public
-     * @param        int $QST_wp_user
-     */
-    public function set_wp_user($QST_wp_user = 1)
-    {
-        $this->set('QST_wp_user', $QST_wp_user);
-    }
-
-
-    /**
-     *        Sets whether the question has been deleted
-     *        (we use this boolean instead of actually
-     *        deleting it because when users delete this question
-     *        they really want to remove the question from future
-     *        forms, BUT keep their old answers which depend
-     *        on this record actually existing.
-     *
-     * @access        public
-     * @param    bool $QST_deleted
-     */
-    public function set_deleted($QST_deleted = false)
-    {
-        $this->set('QST_deleted', $QST_deleted);
-    }
-
-
-    /**
-     * returns the text for displaying the question to users
-     *
-     * @access public
-     * @return string
-     */
-    public function display_text()
-    {
-        return $this->get('QST_display_text');
-    }
-
-
-    /**
-     * returns the text for the administrative label
-     *
-     * @access public
-     * @return string
-     */
-    public function admin_label()
-    {
-        return $this->get('QST_admin_label');
-    }
-
-
-    /**
-     * returns the attendee column name for this question
-     *
-     * @access public
-     * @return string
-     */
-    public function system_ID()
-    {
-        return $this->get('QST_system');
-    }
-
-
-    /**
-     * returns either a string of 'text', 'textfield', etc.
-     *
-     * @access public
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->get('QST_required');
-    }
-
-
-    /**
-     * returns the text which should be displayed when a user
-     * doesn't answer this question in a form
-     *
-     * @access public
-     * @return string
-     */
-    public function required_text()
-    {
-        return $this->get('QST_required_text');
-    }
-
-
-    /**
-     * returns the type of this question
-     *
-     * @access public
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('QST_type');
-    }
-
-
-    /**
-     * returns an integer showing where this question should
-     * be placed in a sequence of questions
-     *
-     * @access public
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('QST_order');
-    }
-
-
-    /**
-     * returns whether this question should only appears to admins,
-     * or to everyone
-     *
-     * @access public
-     * @return boolean
-     */
-    public function admin_only()
-    {
-        return $this->get('QST_admin_only');
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @access public
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('QST_wp_user');
-    }
-
-
-    /**
-     * returns whether this question has been marked as 'deleted'
-     *
-     * @access public
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of related EE_Answer  to this EE_Question
-     *
-     * @return EE_Answer[]
-     */
-    public function answers()
-    {
-        return $this->get_many_related('Answer');
-    }
-
-
-    /**
-     * Boolean check for if there are answers on this question in th db
-     *
-     * @return boolean true = has answers, false = no answers.
-     */
-    public function has_answers()
-    {
-        return $this->count_related('Answer') > 0 ? true : false;
-    }
-
-
-    /**
-     * gets an array of EE_Question_Group which relate to this question
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        return $this->get_many_related('Question_Group');
-    }
-
-
-    /**
-     * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
-     *
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option[]
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        if (! $this->ID()) {
-            return array();
-        }
-        $query_params = array();
-        if ($selected_value_to_always_include) {
-            if (is_array($selected_value_to_always_include)) {
-                $query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
-            } else {
-                $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
-            }
-        }
-        if ($notDeletedOptionsOnly) {
-            $query_params[0]['OR*options-query']['QSO_deleted'] = false;
-        }
-        // order by QSO_order
-        $query_params['order_by'] = array('QSO_order' => 'ASC');
-        return $this->get_many_related('Question_Option', $query_params);
-    }
-
-
-    /**
-     * returns an array of EE_Question_Options which relate to this question
-     *
-     * @return \EE_Question_Option[]
-     */
-    public function temp_options()
-    {
-        return $this->_model_relations['Question_Option'];
-    }
-
-
-    /**
-     * Adds an option for this question. Note: if the option were previously associated with a different
-     * Question, that relationship will be overwritten.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_option(EE_Question_Option $option)
-    {
-        return $this->_add_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * Adds an option directly to this question without saving to the db
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_temp_option(EE_Question_Option $option)
-    {
-        $this->_model_relations['Question_Option'][] = $option;
-        return true;
-    }
-
-
-    /**
-     * Marks the option as deleted.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function remove_option(EE_Question_Option $option)
-    {
-        return $this->_remove_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function is_system_question()
-    {
-        $system_ID = $this->get('QST_system');
-        return ! empty($system_ID) ? true : false;
-    }
-
-
-    /**
-     * The purpose of this method is set the question order this question order to be the max out of all questions
-     *
-     * @access public
-     * @return void
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->get_model()->get_latest_question_order();
-        $latest_order++;
-        $this->set('QST_order', $latest_order);
-    }
-
-
-    /**
-     * Retrieves the list of allowed question types from the model.
-     *
-     * @return string[]
-     */
-    private function _allowed_question_types()
-    {
-        $questionModel = $this->get_model();
-        /* @var $questionModel EEM_Question */
-        return $questionModel->allowed_question_types();
-    }
-
-    /**
-     * Duplicates this question and its question options
-     *
-     * @return \EE_Question
-     */
-    public function duplicate($options = array())
-    {
-        $new_question = clone $this;
-        $new_question->set('QST_ID', null);
-        $new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
-        $new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
-        $new_question->set_system_ID(null);
-        $new_question->set_wp_user(get_current_user_id());
-        // if we're duplicating a trashed question, assume we don't want the new one to be trashed
-        $new_question->set_deleted(false);
-        $success = $new_question->save();
-        if ($success) {
-            // we don't totally want to duplicate the question options, because we want them to be for the NEW question
-            foreach ($this->options() as $question_option) {
-                $question_option->duplicate(array('QST_ID' => $new_question->ID()));
-            }
-            return $new_question;
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Returns the question's maximum allowed response size
-     *
-     * @return int|float
-     */
-    public function max()
-    {
-        return $this->get('QST_max');
-    }
-
-    /**
-     * Sets the question's maximum allowed response size
-     *
-     * @param int|float $new_max
-     * @return void
-     */
-    public function set_max($new_max)
-    {
-        $this->set('QST_max', $new_max);
-    }
-
-
-    /**
-     * Creates a form input from this question which can be used in HTML forms
-     *
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @param array           $input_constructor_args
-     * @return EE_Form_Input_Base
-     */
-    public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
-    {
-        $identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
-
-        $input_constructor_args = array_merge(
-            array(
-                'required'                          => $this->required() ? true : false,
-                'html_label_text'                   => $this->display_text(),
-                'required_validation_error_message' => $this->required_text(),
-            ),
-            $input_constructor_args
-        );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
-        }
-        // has this question been answered ?
-        if ($answer instanceof EE_Answer
-            && $answer->value() !== ''
-        ) {
-            // answer gets htmlspecialchars called on it, undo that please
-            // because the form input's display strategy may call esc_attr too
-            // which also does html special characters
-            $values_with_html_special_chars = $answer->value();
-            if (is_array($values_with_html_special_chars)) {
-                $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
-            } else {
-                $default_value = htmlspecialchars_decode($values_with_html_special_chars);
-            }
-            $input_constructor_args['default'] = $default_value;
-        }
-        $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
-        if (in_array(
-            $this->type(),
-            EEM_Question::instance()->questionTypesWithMaxLength(),
-            true
-        )) {
-            $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
-                null,
-                min($max_max_for_question, $this->max())
-            );
-        }
-        $input_constructor_args = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
-            $input_constructor_args,
-            $registration,
-            $this,
-            $answer
-        );
-
-        $result = null;
-        switch ($this->type()) {
-            // Text
-            case EEM_Question::QST_type_text:
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            // Textarea
-            case EEM_Question::QST_type_textarea:
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                break;
-            // Radio Buttons
-            case EEM_Question::QST_type_radio:
-                $result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
-                break;
-            // Dropdown
-            case EEM_Question::QST_type_dropdown:
-                $result = new EE_Select_Input($this->options(), $input_constructor_args);
-                break;
-            // State Dropdown
-            case EEM_Question::QST_type_state:
-                $state_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__state_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_State_Select_Input($state_options, $input_constructor_args);
-                break;
-            // Country Dropdown
-            case EEM_Question::QST_type_country:
-                $country_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__country_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_Country_Select_Input($country_options, $input_constructor_args);
-                break;
-            // Checkboxes
-            case EEM_Question::QST_type_checkbox:
-                $result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
-                break;
-            // Date
-            case EEM_Question::QST_type_date:
-                $result = new EE_Datepicker_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_html_textarea:
-                $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
-                break;
-            case EEM_Question::QST_type_email:
-                    $result = new EE_Email_Input($input_constructor_args);
-                break;
-            // Email confirm
-            case EEM_Question::QST_type_email_confirm:
-                $result = new EE_Email_Confirm_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_us_phone:
-                $result = new EE_Phone_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_int:
-                $result = new EE_Integer_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_decimal:
-                $result = new EE_Float_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_url:
-                $input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_year:
-                $result = new EE_Year_Input(
-                    $input_constructor_args,
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
-                        true,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
-                        100,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
-                        100,
-                        $this
-                    )
-                );
-                break;
-            case EEM_Question::QST_type_multi_select:
-                $result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
-                break;
-            // fallback
-            default:
-                $default_input = apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
-                    null,
-                    $this->type(),
-                    $this,
-                    $input_constructor_args
-                );
-                if (! $default_input) {
-                    $default_input = new EE_Text_Input($input_constructor_args);
-                }
-                $result = $default_input;
-        }
-        return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
-    }
-
-
-    /**
-     * Returns whether or not this question type should have question option entries
-     *
-     * @return bool
-     */
-    public function should_have_question_options()
-    {
-        return in_array(
-            $this->type(),
-            $this->_model->question_types_with_options(),
-            true
-        );
-    }
+	/**
+	 *
+	 * @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_Question
+	 */
+	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_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param string $QST_display_text
+	 */
+	public function set_display_text($QST_display_text = '')
+	{
+		$this->set('QST_display_text', $QST_display_text);
+	}
+
+
+	/**
+	 *        Set    Question admin text
+	 *
+	 * @access        public
+	 * @param        string $QST_admin_label
+	 */
+	public function set_admin_label($QST_admin_label = '')
+	{
+		$this->set('QST_admin_label', $QST_admin_label);
+	}
+
+
+	/**
+	 *        Set    system name
+	 *
+	 * @access        public
+	 * @param        mixed $QST_system
+	 */
+	public function set_system_ID($QST_system = '')
+	{
+		$this->set('QST_system', $QST_system);
+	}
+
+
+	/**
+	 *        Set    question's type
+	 *
+	 * @access        public
+	 * @param        string $QST_type
+	 */
+	public function set_question_type($QST_type = '')
+	{
+		$this->set('QST_type', $QST_type);
+	}
+
+
+	/**
+	 *        Sets whether this question must be answered when presented in a form
+	 *
+	 * @access        public
+	 * @param        bool $QST_required
+	 */
+	public function set_required($QST_required = false)
+	{
+		$this->set('QST_required', $QST_required);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param        string $QST_required_text
+	 */
+	public function set_required_text($QST_required_text = '')
+	{
+		$this->set('QST_required_text', $QST_required_text);
+	}
+
+
+	/**
+	 *        Sets the order of this question when placed in a sequence of questions
+	 *
+	 * @access        public
+	 * @param        int $QST_order
+	 */
+	public function set_order($QST_order = 0)
+	{
+		$this->set('QST_order', $QST_order);
+	}
+
+
+	/**
+	 *        Sets whether the question is admin-only
+	 *
+	 * @access        public
+	 * @param        bool $QST_admin_only
+	 */
+	public function set_admin_only($QST_admin_only = false)
+	{
+		$this->set('QST_admin_only', $QST_admin_only);
+	}
+
+
+	/**
+	 *        Sets the wordpress user ID on the question
+	 *
+	 * @access        public
+	 * @param        int $QST_wp_user
+	 */
+	public function set_wp_user($QST_wp_user = 1)
+	{
+		$this->set('QST_wp_user', $QST_wp_user);
+	}
+
+
+	/**
+	 *        Sets whether the question has been deleted
+	 *        (we use this boolean instead of actually
+	 *        deleting it because when users delete this question
+	 *        they really want to remove the question from future
+	 *        forms, BUT keep their old answers which depend
+	 *        on this record actually existing.
+	 *
+	 * @access        public
+	 * @param    bool $QST_deleted
+	 */
+	public function set_deleted($QST_deleted = false)
+	{
+		$this->set('QST_deleted', $QST_deleted);
+	}
+
+
+	/**
+	 * returns the text for displaying the question to users
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function display_text()
+	{
+		return $this->get('QST_display_text');
+	}
+
+
+	/**
+	 * returns the text for the administrative label
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function admin_label()
+	{
+		return $this->get('QST_admin_label');
+	}
+
+
+	/**
+	 * returns the attendee column name for this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function system_ID()
+	{
+		return $this->get('QST_system');
+	}
+
+
+	/**
+	 * returns either a string of 'text', 'textfield', etc.
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->get('QST_required');
+	}
+
+
+	/**
+	 * returns the text which should be displayed when a user
+	 * doesn't answer this question in a form
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function required_text()
+	{
+		return $this->get('QST_required_text');
+	}
+
+
+	/**
+	 * returns the type of this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('QST_type');
+	}
+
+
+	/**
+	 * returns an integer showing where this question should
+	 * be placed in a sequence of questions
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('QST_order');
+	}
+
+
+	/**
+	 * returns whether this question should only appears to admins,
+	 * or to everyone
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function admin_only()
+	{
+		return $this->get('QST_admin_only');
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('QST_wp_user');
+	}
+
+
+	/**
+	 * returns whether this question has been marked as 'deleted'
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of related EE_Answer  to this EE_Question
+	 *
+	 * @return EE_Answer[]
+	 */
+	public function answers()
+	{
+		return $this->get_many_related('Answer');
+	}
+
+
+	/**
+	 * Boolean check for if there are answers on this question in th db
+	 *
+	 * @return boolean true = has answers, false = no answers.
+	 */
+	public function has_answers()
+	{
+		return $this->count_related('Answer') > 0 ? true : false;
+	}
+
+
+	/**
+	 * gets an array of EE_Question_Group which relate to this question
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		return $this->get_many_related('Question_Group');
+	}
+
+
+	/**
+	 * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
+	 *
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option[]
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		if (! $this->ID()) {
+			return array();
+		}
+		$query_params = array();
+		if ($selected_value_to_always_include) {
+			if (is_array($selected_value_to_always_include)) {
+				$query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
+			} else {
+				$query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
+			}
+		}
+		if ($notDeletedOptionsOnly) {
+			$query_params[0]['OR*options-query']['QSO_deleted'] = false;
+		}
+		// order by QSO_order
+		$query_params['order_by'] = array('QSO_order' => 'ASC');
+		return $this->get_many_related('Question_Option', $query_params);
+	}
+
+
+	/**
+	 * returns an array of EE_Question_Options which relate to this question
+	 *
+	 * @return \EE_Question_Option[]
+	 */
+	public function temp_options()
+	{
+		return $this->_model_relations['Question_Option'];
+	}
+
+
+	/**
+	 * Adds an option for this question. Note: if the option were previously associated with a different
+	 * Question, that relationship will be overwritten.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_option(EE_Question_Option $option)
+	{
+		return $this->_add_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * Adds an option directly to this question without saving to the db
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_temp_option(EE_Question_Option $option)
+	{
+		$this->_model_relations['Question_Option'][] = $option;
+		return true;
+	}
+
+
+	/**
+	 * Marks the option as deleted.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function remove_option(EE_Question_Option $option)
+	{
+		return $this->_remove_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function is_system_question()
+	{
+		$system_ID = $this->get('QST_system');
+		return ! empty($system_ID) ? true : false;
+	}
+
+
+	/**
+	 * The purpose of this method is set the question order this question order to be the max out of all questions
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->get_model()->get_latest_question_order();
+		$latest_order++;
+		$this->set('QST_order', $latest_order);
+	}
+
+
+	/**
+	 * Retrieves the list of allowed question types from the model.
+	 *
+	 * @return string[]
+	 */
+	private function _allowed_question_types()
+	{
+		$questionModel = $this->get_model();
+		/* @var $questionModel EEM_Question */
+		return $questionModel->allowed_question_types();
+	}
+
+	/**
+	 * Duplicates this question and its question options
+	 *
+	 * @return \EE_Question
+	 */
+	public function duplicate($options = array())
+	{
+		$new_question = clone $this;
+		$new_question->set('QST_ID', null);
+		$new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
+		$new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
+		$new_question->set_system_ID(null);
+		$new_question->set_wp_user(get_current_user_id());
+		// if we're duplicating a trashed question, assume we don't want the new one to be trashed
+		$new_question->set_deleted(false);
+		$success = $new_question->save();
+		if ($success) {
+			// we don't totally want to duplicate the question options, because we want them to be for the NEW question
+			foreach ($this->options() as $question_option) {
+				$question_option->duplicate(array('QST_ID' => $new_question->ID()));
+			}
+			return $new_question;
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns the question's maximum allowed response size
+	 *
+	 * @return int|float
+	 */
+	public function max()
+	{
+		return $this->get('QST_max');
+	}
+
+	/**
+	 * Sets the question's maximum allowed response size
+	 *
+	 * @param int|float $new_max
+	 * @return void
+	 */
+	public function set_max($new_max)
+	{
+		$this->set('QST_max', $new_max);
+	}
+
+
+	/**
+	 * Creates a form input from this question which can be used in HTML forms
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @param array           $input_constructor_args
+	 * @return EE_Form_Input_Base
+	 */
+	public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
+	{
+		$identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
+
+		$input_constructor_args = array_merge(
+			array(
+				'required'                          => $this->required() ? true : false,
+				'html_label_text'                   => $this->display_text(),
+				'required_validation_error_message' => $this->required_text(),
+			),
+			$input_constructor_args
+		);
+		if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
+		}
+		// has this question been answered ?
+		if ($answer instanceof EE_Answer
+			&& $answer->value() !== ''
+		) {
+			// answer gets htmlspecialchars called on it, undo that please
+			// because the form input's display strategy may call esc_attr too
+			// which also does html special characters
+			$values_with_html_special_chars = $answer->value();
+			if (is_array($values_with_html_special_chars)) {
+				$default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
+			} else {
+				$default_value = htmlspecialchars_decode($values_with_html_special_chars);
+			}
+			$input_constructor_args['default'] = $default_value;
+		}
+		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
+		if (in_array(
+			$this->type(),
+			EEM_Question::instance()->questionTypesWithMaxLength(),
+			true
+		)) {
+			$input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
+				null,
+				min($max_max_for_question, $this->max())
+			);
+		}
+		$input_constructor_args = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
+			$input_constructor_args,
+			$registration,
+			$this,
+			$answer
+		);
+
+		$result = null;
+		switch ($this->type()) {
+			// Text
+			case EEM_Question::QST_type_text:
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			// Textarea
+			case EEM_Question::QST_type_textarea:
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				break;
+			// Radio Buttons
+			case EEM_Question::QST_type_radio:
+				$result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
+				break;
+			// Dropdown
+			case EEM_Question::QST_type_dropdown:
+				$result = new EE_Select_Input($this->options(), $input_constructor_args);
+				break;
+			// State Dropdown
+			case EEM_Question::QST_type_state:
+				$state_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__state_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_State_Select_Input($state_options, $input_constructor_args);
+				break;
+			// Country Dropdown
+			case EEM_Question::QST_type_country:
+				$country_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__country_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_Country_Select_Input($country_options, $input_constructor_args);
+				break;
+			// Checkboxes
+			case EEM_Question::QST_type_checkbox:
+				$result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
+				break;
+			// Date
+			case EEM_Question::QST_type_date:
+				$result = new EE_Datepicker_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_html_textarea:
+				$input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				$result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
+				break;
+			case EEM_Question::QST_type_email:
+					$result = new EE_Email_Input($input_constructor_args);
+				break;
+			// Email confirm
+			case EEM_Question::QST_type_email_confirm:
+				$result = new EE_Email_Confirm_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_us_phone:
+				$result = new EE_Phone_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_int:
+				$result = new EE_Integer_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_decimal:
+				$result = new EE_Float_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_url:
+				$input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_year:
+				$result = new EE_Year_Input(
+					$input_constructor_args,
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
+						true,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
+						100,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
+						100,
+						$this
+					)
+				);
+				break;
+			case EEM_Question::QST_type_multi_select:
+				$result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
+				break;
+			// fallback
+			default:
+				$default_input = apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
+					null,
+					$this->type(),
+					$this,
+					$input_constructor_args
+				);
+				if (! $default_input) {
+					$default_input = new EE_Text_Input($input_constructor_args);
+				}
+				$result = $default_input;
+		}
+		return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
+	}
+
+
+	/**
+	 * Returns whether or not this question type should have question option entries
+	 *
+	 * @return bool
+	 */
+	public function should_have_question_options()
+	{
+		return in_array(
+			$this->type(),
+			$this->_model->question_types_with_options(),
+			true
+		);
+	}
 }

admin_pages/venues/templates/venue_virtual_location_metabox_content.template.php

Indentation +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
                         <?php esc_html_e('URL of Event:', 'event_espresso'); ?>
                     </label>
                     <?php //phpcs:disable Generic.Files.LineLength.TooLong
-                    // no new lines within <textarea> here because they'll output whitespace ?>
+					// no new lines within <textarea> here because they'll output whitespace ?>
                     <textarea id="url-event" cols="30" rows="4" tabindex="112" name="vnu_virtual_url"><?php $_venue->f('VNU_virtual_url'); ?></textarea>
                     <?php //phpcs:enable ?>
                 </p>

caffeinated/admin/extend/registrations/EE_Event_Registrations_List_Table.class.php

Indentation +557 added lines, -557 removed lines

@@ -12,566 +12,566 @@
 class EE_Event_Registrations_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * This property will hold the related Datetimes on an event IF the event id is included in the request.
-     *
-     * @var EE_Datetime[]
-     */
-    protected $_dtts_for_event = array();
-
-
-    /**
-     * The event if one is specified in the request
-     *
-     * @var EE_Event
-     */
-    protected $_evt = null;
-
-
-    /**
-     * The DTT_ID if the current view has a specified datetime.
-     *
-     * @var int $_cur_dtt_id
-     */
-    protected $_cur_dtt_id = 0;
-
-
-    /**
-     * EE_Event_Registrations_List_Table constructor.
-     *
-     * @param \Registrations_Admin_Page $admin_page
-     */
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_registration_status_array();
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees($this->_per_page)
-            : $this->_admin_page->get_event_attendees($this->_per_page, false, true);
-        $this->_all_data_count = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees(
-            $this->_per_page,
-            true
-        ) : $this->_admin_page->get_event_attendees($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $evt_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        $this->_wp_list_args = array(
-            'singular' => __('registrant', 'event_espresso'),
-            'plural'   => __('registrants', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $columns = array();
-        // $columns['_Reg_Status'] = '';
-        $this->_columns = array(
-            '_REG_att_checked_in' => '<span class="dashicons dashicons-yes ee-icon-size-18"></span>',
-            'ATT_name'            => __('Registrant', 'event_espresso'),
-            'ATT_email'           => __('Email Address', 'event_espresso'),
-            'Event'               => __('Event', 'event_espresso'),
-            'PRC_name'            => __('TKT Option', 'event_espresso'),
-            '_REG_final_price'    => __('Price', 'event_espresso'),
-            'TXN_paid'            => __('Paid', 'event_espresso'),
-            'TXN_total'           => __('Total', 'event_espresso'),
-        );
-        // Add/remove columns when an event has been selected
-        if (! empty($evt_id)) {
-            // Render a checkbox column
-            $columns['cb'] = '<input type="checkbox" />';
-            $this->_has_checkbox_column = true;
-            // Remove the 'Event' column
-            unset($this->_columns['Event']);
-        }
-        $this->_columns = array_merge($columns, $this->_columns);
-        $this->_primary_column = '_REG_att_checked_in';
-        if (! empty($evt_id)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_registrations_reports',
-                $evt_id
-            )
-        ) {
-            $this->_bottom_buttons = array(
-                'report' => array(
-                    'route'         => 'registrations_report',
-                    'extra_request' =>
-                        array(
-                            'EVT_ID'     => $evt_id,
-                            'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
-                        ),
-                ),
-            );
-        }
-        $this->_bottom_buttons['report_filtered'] = array(
-            'route'         => 'registrations_checkin_report',
-            'extra_request' => array(
-                'use_filters' => true,
-                'filters'     => array_merge(
-                    array(
-                        'EVT_ID' => $evt_id,
-                    ),
-                    array_diff_key(
-                        $this->_req_data,
-                        array_flip(
-                            array(
-                                'page',
-                                'action',
-                                'default_nonce',
-                            )
-                        )
-                    )
-                ),
-                'return_url'  => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
-            ),
-        );
-        $this->_sortable_columns = array(
-            /**
-             * Allows users to change the default sort if they wish.
-             * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
-             *
-             * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
-             * change the sorts on any list table involving registration contacts.  If you want to only change the filter
-             * for a specific list table you can use the provided reference to this object instance.
-             */
-            'ATT_name' => array(
-                'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
-                true,
-                $this,
-            )
-                ? array('ATT_lname' => true)
-                : array('ATT_fname' => true),
-            'Event'    => array('Event.EVT_name' => false),
-        );
-        $this->_hidden_columns = array();
-        $this->_evt = EEM_Event::instance()->get_one_by_ID($evt_id);
-        $this->_dtts_for_event = $this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : array();
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @return array
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = $where = array();
-        $current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
-        if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
-            // this means we don't have an event so let's setup a filter dropdown for all the events to select
-            // note possible capability restrictions
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                $where['status**'] = array('!=', 'private');
-            }
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-                $where['EVT_wp_user'] = get_current_user_id();
-            }
-            $events = EEM_Event::instance()->get_all(
-                array(
-                    $where,
-                    'order_by' => array('Datetime.DTT_EVT_start' => 'DESC'),
-                )
-            );
-            $evts[] = array(
-                'id'   => 0,
-                'text' => __('To toggle Check-in status, select an event', 'event_espresso'),
-            );
-            $checked = 'checked';
-            /** @var EE_Event $evt */
-            foreach ($events as $evt) {
-                // any registrations for this event?
-                if (! $evt->get_count_of_all_registrations()) {
-                    continue;
-                }
-                $evts[] = array(
-                    'id'    => $evt->ID(),
-                    'text'  => apply_filters(
-                        'FHEE__EE_Event_Registrations___get_table_filters__event_name',
-                        $evt->get('EVT_name'),
-                        $evt
-                    ),
-                    'class' => $evt->is_expired() ? 'ee-expired-event' : '',
-                );
-                if ($evt->ID() === $current_EVT_ID && $evt->is_expired()) {
-                    $checked = '';
-                }
-            }
-            $event_filter = '<div class="ee-event-filter">';
-            $event_filter .= EEH_Form_Fields::select_input('event_id', $evts, $current_EVT_ID);
-            $event_filter .= '<span class="ee-event-filter-toggle">';
-            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '> ';
-            $event_filter .= __('Hide Expired Events', 'event_espresso');
-            $event_filter .= '</span>';
-            $event_filter .= '</div>';
-            $filters[] = $event_filter;
-        }
-        if (! empty($this->_dtts_for_event)) {
-            // DTT datetimes filter
-            $this->_cur_dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0;
-            if (count($this->_dtts_for_event) > 1) {
-                $dtts[0] = __('To toggle check-in status, select a datetime.', 'event_espresso');
-                foreach ($this->_dtts_for_event as $dtt) {
-                    $datetime_string = $dtt->name();
-                    $datetime_string = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
-                    $datetime_string = $dtt->start_date_and_time() . ' - ' . $dtt->end_date_and_time() . $datetime_string;
-                    $dtts[ $dtt->ID() ] = $datetime_string;
-                }
-                $input = new EE_Select_Input(
-                    $dtts,
-                    array(
-                        'html_name' => 'DTT_ID',
-                        'html_id'   => 'DTT_ID',
-                        'default'   => $this->_cur_dtt_id,
-                    )
-                );
-                $filters[] = $input->get_html_for_input();
-                $filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_get_total_event_attendees();
-    }
-
-
-    /**
-     * @return int
-     * @throws \EE_Error
-     */
-    protected function _get_total_event_attendees()
-    {
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        $DTT_ID = $this->_cur_dtt_id;
-        $query_params = array();
-        if ($EVT_ID) {
-            $query_params[0]['EVT_ID'] = $EVT_ID;
-        }
-        // if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
-        if ($DTT_ID) {
-            $query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return EEM_Registration::instance()->count($query_params);
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column__Reg_Status(EE_Registration $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td reg-status-' . $item->status_ID() . '"></span>';
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
-    }
-
-
-    /**
-     * column_REG_att_checked_in
-     *
-     * @param EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column__REG_att_checked_in(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-
-        if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
-            $latest_related_datetime = $item->get_latest_related_datetime();
-            if ($latest_related_datetime instanceof EE_Datetime) {
-                $this->_cur_dtt_id = $latest_related_datetime->ID();
-            }
-        }
-        $checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
-            $item,
-            $this->_cur_dtt_id
-        );
-        $nonce = wp_create_nonce('checkin_nonce');
-        $toggle_active = ! empty($this->_cur_dtt_id)
-                         && EE_Registry::instance()->CAP->current_user_can(
-                             'ee_edit_checkin',
-                             'espresso_registrations_toggle_checkin_status',
-                             $item->ID()
-                         )
-            ? ' clickable trigger-checkin'
-            : '';
-        $mobile_view_content = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return '<span class="' . $checkin_status_dashicon->cssClasses() . $toggle_active . '"'
-               . ' data-_regid="' . $item->ID() . '"'
-               . ' data-dttid="' . $this->_cur_dtt_id . '"'
-               . ' data-nonce="' . $nonce . '">'
-               . '</span>'
-               . $mobile_view_content;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return mixed|string|void
-     * @throws \EE_Error
-     */
-    public function column_ATT_name(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        if (! $attendee instanceof EE_Attendee) {
-            return __('No contact record for this registration.', 'event_espresso');
-        }
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'view_registration', '_REG_ID' => $item->ID()),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-              . $item->attendee()->full_name()
-              . '</a>'
-            : $item->attendee()->full_name();
-        $name_link .= $item->count() === 1
-            ? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>	'
-            : '';
-        // add group details
-        $name_link .= '&nbsp;' . sprintf(__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
-        // add regcode
-        $link = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'view_registration', '_REG_ID' => $item->ID()),
-            REG_ADMIN_URL
-        );
-        $name_link .= '<br>';
-        $name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'view_registration',
-            $item->ID()
-        )
-            ? '<a href="' . $link . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-              . $item->reg_code()
-              . '</a>'
-            : $item->reg_code();
-        // status
-        $name_link .= '<br><span class="ee-status-text-small">';
-        $name_link .= EEH_Template::pretty_status($item->status_ID(), false, 'sentence');
-        $name_link .= '</span>';
-        $actions = array();
-        $DTT_ID = $this->_cur_dtt_id;
-        $latest_related_datetime = empty($DTT_ID) && ! empty($this->_req_data['event_id']) && $item instanceof EE_Registration
-            ? $item->get_latest_related_datetime()
-            : null;
-        $DTT_ID = $latest_related_datetime instanceof EE_Datetime
-            ? $latest_related_datetime->ID()
-            : $DTT_ID;
-        if (! empty($DTT_ID)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            )
-        ) {
-            $checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'registration_checkins', '_REG_ID' => $item->ID(), 'DTT_ID' => $DTT_ID),
-                REG_ADMIN_URL
-            );
-            // get the timestamps for this registration's checkins, related to the selected datetime
-            $timestamps = $item->get_many_related('Checkin', array(array('DTT_ID' => $DTT_ID)));
-            if (! empty($timestamps)) {
-                // get the last timestamp
-                $last_timestamp = end($timestamps);
-                // checked in or checked out?
-                $checkin_status = $last_timestamp->get('CHK_in')
-                    ? esc_html__('Checked In', 'event_espresso')
-                    : esc_html__('Checked Out', 'event_espresso');
-                // get timestamp string
-                $timestamp_string = $last_timestamp->get_datetime('CHK_timestamp');
-                $actions['checkin'] = '<a href="' . $checkin_list_url . '" title="'
-                                      . esc_attr__(
-                                          'View this registrant\'s check-ins/checkouts for the datetime',
-                                          'event_espresso'
-                                      ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
-            }
-        }
-        return (! empty($DTT_ID) && ! empty($timestamps))
-            ? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
-            : $name_link;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column_ATT_email(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        return $attendee instanceof EE_Attendee ? $attendee->email() : '';
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return bool|string
-     * @throws \EE_Error
-     */
-    public function column_Event(EE_Registration $item)
-    {
-        try {
-            $event = $this->_evt instanceof EE_Event ? $this->_evt : $item->event();
-            $chkin_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'event_registrations', 'event_id' => $event->ID()),
-                REG_ADMIN_URL
-            );
-            $event_label = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            ) ? '<a href="' . $chkin_lnk_url . '" title="'
-                . esc_attr__(
-                    'View Checkins for this Event',
-                    'event_espresso'
-                ) . '">' . $event->name() . '</a>' : $event->name();
-        } catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
-            $event_label = esc_html__('Unknown', 'event_espresso');
-        }
-        return $event_label;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return mixed|string|void
-     */
-    public function column_PRC_name(EE_Registration $item)
-    {
-        return $item->ticket() instanceof EE_Ticket ? $item->ticket()->name() : __("Unknown", "event_espresso");
-    }
-
-
-    /**
-     * column_REG_final_price
-     *
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column__REG_final_price(EE_Registration $item)
-    {
-        return '<span class="reg-pad-rght">' . ' ' . $item->pretty_final_price() . '</span>';
-    }
-
-
-    /**
-     * column_TXN_paid
-     *
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Registration $item)
-    {
-        if ($item->count() === 1) {
-            if ($item->transaction()->paid() >= $item->transaction()->total()) {
-                return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
-            } else {
-                $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $item->transaction_ID()),
-                    TXN_ADMIN_URL
-                );
-                return EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_transaction',
-                    'espresso_transactions_view_transaction'
-                ) ? '
+	/**
+	 * This property will hold the related Datetimes on an event IF the event id is included in the request.
+	 *
+	 * @var EE_Datetime[]
+	 */
+	protected $_dtts_for_event = array();
+
+
+	/**
+	 * The event if one is specified in the request
+	 *
+	 * @var EE_Event
+	 */
+	protected $_evt = null;
+
+
+	/**
+	 * The DTT_ID if the current view has a specified datetime.
+	 *
+	 * @var int $_cur_dtt_id
+	 */
+	protected $_cur_dtt_id = 0;
+
+
+	/**
+	 * EE_Event_Registrations_List_Table constructor.
+	 *
+	 * @param \Registrations_Admin_Page $admin_page
+	 */
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_registration_status_array();
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees($this->_per_page)
+			: $this->_admin_page->get_event_attendees($this->_per_page, false, true);
+		$this->_all_data_count = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees(
+			$this->_per_page,
+			true
+		) : $this->_admin_page->get_event_attendees($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$evt_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		$this->_wp_list_args = array(
+			'singular' => __('registrant', 'event_espresso'),
+			'plural'   => __('registrants', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$columns = array();
+		// $columns['_Reg_Status'] = '';
+		$this->_columns = array(
+			'_REG_att_checked_in' => '<span class="dashicons dashicons-yes ee-icon-size-18"></span>',
+			'ATT_name'            => __('Registrant', 'event_espresso'),
+			'ATT_email'           => __('Email Address', 'event_espresso'),
+			'Event'               => __('Event', 'event_espresso'),
+			'PRC_name'            => __('TKT Option', 'event_espresso'),
+			'_REG_final_price'    => __('Price', 'event_espresso'),
+			'TXN_paid'            => __('Paid', 'event_espresso'),
+			'TXN_total'           => __('Total', 'event_espresso'),
+		);
+		// Add/remove columns when an event has been selected
+		if (! empty($evt_id)) {
+			// Render a checkbox column
+			$columns['cb'] = '<input type="checkbox" />';
+			$this->_has_checkbox_column = true;
+			// Remove the 'Event' column
+			unset($this->_columns['Event']);
+		}
+		$this->_columns = array_merge($columns, $this->_columns);
+		$this->_primary_column = '_REG_att_checked_in';
+		if (! empty($evt_id)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_registrations_reports',
+				$evt_id
+			)
+		) {
+			$this->_bottom_buttons = array(
+				'report' => array(
+					'route'         => 'registrations_report',
+					'extra_request' =>
+						array(
+							'EVT_ID'     => $evt_id,
+							'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
+						),
+				),
+			);
+		}
+		$this->_bottom_buttons['report_filtered'] = array(
+			'route'         => 'registrations_checkin_report',
+			'extra_request' => array(
+				'use_filters' => true,
+				'filters'     => array_merge(
+					array(
+						'EVT_ID' => $evt_id,
+					),
+					array_diff_key(
+						$this->_req_data,
+						array_flip(
+							array(
+								'page',
+								'action',
+								'default_nonce',
+							)
+						)
+					)
+				),
+				'return_url'  => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
+			),
+		);
+		$this->_sortable_columns = array(
+			/**
+			 * Allows users to change the default sort if they wish.
+			 * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
+			 *
+			 * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
+			 * change the sorts on any list table involving registration contacts.  If you want to only change the filter
+			 * for a specific list table you can use the provided reference to this object instance.
+			 */
+			'ATT_name' => array(
+				'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
+				true,
+				$this,
+			)
+				? array('ATT_lname' => true)
+				: array('ATT_fname' => true),
+			'Event'    => array('Event.EVT_name' => false),
+		);
+		$this->_hidden_columns = array();
+		$this->_evt = EEM_Event::instance()->get_one_by_ID($evt_id);
+		$this->_dtts_for_event = $this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : array();
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= ' ee-status-strip reg-status-' . $item->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = $where = array();
+		$current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
+		if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
+			// this means we don't have an event so let's setup a filter dropdown for all the events to select
+			// note possible capability restrictions
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+				$where['status**'] = array('!=', 'private');
+			}
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+				$where['EVT_wp_user'] = get_current_user_id();
+			}
+			$events = EEM_Event::instance()->get_all(
+				array(
+					$where,
+					'order_by' => array('Datetime.DTT_EVT_start' => 'DESC'),
+				)
+			);
+			$evts[] = array(
+				'id'   => 0,
+				'text' => __('To toggle Check-in status, select an event', 'event_espresso'),
+			);
+			$checked = 'checked';
+			/** @var EE_Event $evt */
+			foreach ($events as $evt) {
+				// any registrations for this event?
+				if (! $evt->get_count_of_all_registrations()) {
+					continue;
+				}
+				$evts[] = array(
+					'id'    => $evt->ID(),
+					'text'  => apply_filters(
+						'FHEE__EE_Event_Registrations___get_table_filters__event_name',
+						$evt->get('EVT_name'),
+						$evt
+					),
+					'class' => $evt->is_expired() ? 'ee-expired-event' : '',
+				);
+				if ($evt->ID() === $current_EVT_ID && $evt->is_expired()) {
+					$checked = '';
+				}
+			}
+			$event_filter = '<div class="ee-event-filter">';
+			$event_filter .= EEH_Form_Fields::select_input('event_id', $evts, $current_EVT_ID);
+			$event_filter .= '<span class="ee-event-filter-toggle">';
+			$event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '> ';
+			$event_filter .= __('Hide Expired Events', 'event_espresso');
+			$event_filter .= '</span>';
+			$event_filter .= '</div>';
+			$filters[] = $event_filter;
+		}
+		if (! empty($this->_dtts_for_event)) {
+			// DTT datetimes filter
+			$this->_cur_dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0;
+			if (count($this->_dtts_for_event) > 1) {
+				$dtts[0] = __('To toggle check-in status, select a datetime.', 'event_espresso');
+				foreach ($this->_dtts_for_event as $dtt) {
+					$datetime_string = $dtt->name();
+					$datetime_string = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
+					$datetime_string = $dtt->start_date_and_time() . ' - ' . $dtt->end_date_and_time() . $datetime_string;
+					$dtts[ $dtt->ID() ] = $datetime_string;
+				}
+				$input = new EE_Select_Input(
+					$dtts,
+					array(
+						'html_name' => 'DTT_ID',
+						'html_id'   => 'DTT_ID',
+						'default'   => $this->_cur_dtt_id,
+					)
+				);
+				$filters[] = $input->get_html_for_input();
+				$filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_get_total_event_attendees();
+	}
+
+
+	/**
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	protected function _get_total_event_attendees()
+	{
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		$DTT_ID = $this->_cur_dtt_id;
+		$query_params = array();
+		if ($EVT_ID) {
+			$query_params[0]['EVT_ID'] = $EVT_ID;
+		}
+		// if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
+		if ($DTT_ID) {
+			$query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return EEM_Registration::instance()->count($query_params);
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column__Reg_Status(EE_Registration $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td reg-status-' . $item->status_ID() . '"></span>';
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
+	}
+
+
+	/**
+	 * column_REG_att_checked_in
+	 *
+	 * @param EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column__REG_att_checked_in(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+
+		if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
+			$latest_related_datetime = $item->get_latest_related_datetime();
+			if ($latest_related_datetime instanceof EE_Datetime) {
+				$this->_cur_dtt_id = $latest_related_datetime->ID();
+			}
+		}
+		$checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
+			$item,
+			$this->_cur_dtt_id
+		);
+		$nonce = wp_create_nonce('checkin_nonce');
+		$toggle_active = ! empty($this->_cur_dtt_id)
+						 && EE_Registry::instance()->CAP->current_user_can(
+							 'ee_edit_checkin',
+							 'espresso_registrations_toggle_checkin_status',
+							 $item->ID()
+						 )
+			? ' clickable trigger-checkin'
+			: '';
+		$mobile_view_content = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return '<span class="' . $checkin_status_dashicon->cssClasses() . $toggle_active . '"'
+			   . ' data-_regid="' . $item->ID() . '"'
+			   . ' data-dttid="' . $this->_cur_dtt_id . '"'
+			   . ' data-nonce="' . $nonce . '">'
+			   . '</span>'
+			   . $mobile_view_content;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return mixed|string|void
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_name(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		if (! $attendee instanceof EE_Attendee) {
+			return __('No contact record for this registration.', 'event_espresso');
+		}
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'view_registration', '_REG_ID' => $item->ID()),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+			  . $item->attendee()->full_name()
+			  . '</a>'
+			: $item->attendee()->full_name();
+		$name_link .= $item->count() === 1
+			? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>	'
+			: '';
+		// add group details
+		$name_link .= '&nbsp;' . sprintf(__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
+		// add regcode
+		$link = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'view_registration', '_REG_ID' => $item->ID()),
+			REG_ADMIN_URL
+		);
+		$name_link .= '<br>';
+		$name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'view_registration',
+			$item->ID()
+		)
+			? '<a href="' . $link . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+			  . $item->reg_code()
+			  . '</a>'
+			: $item->reg_code();
+		// status
+		$name_link .= '<br><span class="ee-status-text-small">';
+		$name_link .= EEH_Template::pretty_status($item->status_ID(), false, 'sentence');
+		$name_link .= '</span>';
+		$actions = array();
+		$DTT_ID = $this->_cur_dtt_id;
+		$latest_related_datetime = empty($DTT_ID) && ! empty($this->_req_data['event_id']) && $item instanceof EE_Registration
+			? $item->get_latest_related_datetime()
+			: null;
+		$DTT_ID = $latest_related_datetime instanceof EE_Datetime
+			? $latest_related_datetime->ID()
+			: $DTT_ID;
+		if (! empty($DTT_ID)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			)
+		) {
+			$checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'registration_checkins', '_REG_ID' => $item->ID(), 'DTT_ID' => $DTT_ID),
+				REG_ADMIN_URL
+			);
+			// get the timestamps for this registration's checkins, related to the selected datetime
+			$timestamps = $item->get_many_related('Checkin', array(array('DTT_ID' => $DTT_ID)));
+			if (! empty($timestamps)) {
+				// get the last timestamp
+				$last_timestamp = end($timestamps);
+				// checked in or checked out?
+				$checkin_status = $last_timestamp->get('CHK_in')
+					? esc_html__('Checked In', 'event_espresso')
+					: esc_html__('Checked Out', 'event_espresso');
+				// get timestamp string
+				$timestamp_string = $last_timestamp->get_datetime('CHK_timestamp');
+				$actions['checkin'] = '<a href="' . $checkin_list_url . '" title="'
+									  . esc_attr__(
+										  'View this registrant\'s check-ins/checkouts for the datetime',
+										  'event_espresso'
+									  ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
+			}
+		}
+		return (! empty($DTT_ID) && ! empty($timestamps))
+			? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
+			: $name_link;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column_ATT_email(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		return $attendee instanceof EE_Attendee ? $attendee->email() : '';
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return bool|string
+	 * @throws \EE_Error
+	 */
+	public function column_Event(EE_Registration $item)
+	{
+		try {
+			$event = $this->_evt instanceof EE_Event ? $this->_evt : $item->event();
+			$chkin_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'event_registrations', 'event_id' => $event->ID()),
+				REG_ADMIN_URL
+			);
+			$event_label = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			) ? '<a href="' . $chkin_lnk_url . '" title="'
+				. esc_attr__(
+					'View Checkins for this Event',
+					'event_espresso'
+				) . '">' . $event->name() . '</a>' : $event->name();
+		} catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
+			$event_label = esc_html__('Unknown', 'event_espresso');
+		}
+		return $event_label;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return mixed|string|void
+	 */
+	public function column_PRC_name(EE_Registration $item)
+	{
+		return $item->ticket() instanceof EE_Ticket ? $item->ticket()->name() : __("Unknown", "event_espresso");
+	}
+
+
+	/**
+	 * column_REG_final_price
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column__REG_final_price(EE_Registration $item)
+	{
+		return '<span class="reg-pad-rght">' . ' ' . $item->pretty_final_price() . '</span>';
+	}
+
+
+	/**
+	 * column_TXN_paid
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Registration $item)
+	{
+		if ($item->count() === 1) {
+			if ($item->transaction()->paid() >= $item->transaction()->total()) {
+				return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
+			} else {
+				$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $item->transaction_ID()),
+					TXN_ADMIN_URL
+				);
+				return EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_transaction',
+					'espresso_transactions_view_transaction'
+				) ? '
 				<span class="reg-pad-rght">
 					<a class="status-'
-                    . $item->transaction()->status_ID()
-                    . '" href="'
-                    . $view_txn_lnk_url
-                    . '"  title="'
-                    . esc_attr__('View Transaction', 'event_espresso')
-                    . '">
+					. $item->transaction()->status_ID()
+					. '" href="'
+					. $view_txn_lnk_url
+					. '"  title="'
+					. esc_attr__('View Transaction', 'event_espresso')
+					. '">
 						'
-                    . $item->transaction()->pretty_paid()
-                    . '
+					. $item->transaction()->pretty_paid()
+					. '
 					</a>
 				<span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
-            }
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
-
-
-    /**
-     *        column_TXN_total
-     *
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Registration $item)
-    {
-        $txn = $item->transaction();
-        $view_txn_url = add_query_arg(array('action' => 'view_transaction', 'TXN_ID' => $txn->ID()), TXN_ADMIN_URL);
-        if ($item->get('REG_count') === 1) {
-            $line_total_obj = $txn->total_line_item();
-            $txn_total = $line_total_obj instanceof EE_Line_Item
-                ? $line_total_obj->get_pretty('LIN_total')
-                : __(
-                    'View Transaction',
-                    'event_espresso'
-                );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction'
-            ) ? '<a href="'
-                . $view_txn_url
-                . '" title="'
-                . esc_attr__('View Transaction', 'event_espresso')
-                . '"><span class="reg-pad-rght">'
-                . $txn_total
-                . '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
+			}
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
+
+
+	/**
+	 *        column_TXN_total
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Registration $item)
+	{
+		$txn = $item->transaction();
+		$view_txn_url = add_query_arg(array('action' => 'view_transaction', 'TXN_ID' => $txn->ID()), TXN_ADMIN_URL);
+		if ($item->get('REG_count') === 1) {
+			$line_total_obj = $txn->total_line_item();
+			$txn_total = $line_total_obj instanceof EE_Line_Item
+				? $line_total_obj->get_pretty('LIN_total')
+				: __(
+					'View Transaction',
+					'event_espresso'
+				);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction'
+			) ? '<a href="'
+				. $view_txn_url
+				. '" title="'
+				. esc_attr__('View Transaction', 'event_espresso')
+				. '"><span class="reg-pad-rght">'
+				. $txn_total
+				. '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
 }

Spacing +32 added lines, -32 removed lines

@@ -81,7 +81,7 @@ 
             'TXN_total'           => __('Total', 'event_espresso'),
         );
         // Add/remove columns when an event has been selected
-        if (! empty($evt_id)) {
+        if ( ! empty($evt_id)) {
             // Render a checkbox column
             $columns['cb'] = '<input type="checkbox" />';
             $this->_has_checkbox_column = true;
@@ -90,7 +90,7 @@ 
         }
         $this->_columns = array_merge($columns, $this->_columns);
         $this->_primary_column = '_REG_att_checked_in';
-        if (! empty($evt_id)
+        if ( ! empty($evt_id)
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_registrations',
                 'espresso_registrations_registrations_reports',
@@ -162,7 +162,7 @@ 
     {
         $class = parent::_get_row_class($item);
         // add status class
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
+        $class .= ' ee-status-strip reg-status-'.$item->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -181,10 +181,10 @@ 
         if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
             // this means we don't have an event so let's setup a filter dropdown for all the events to select
             // note possible capability restrictions
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
                 $where['status**'] = array('!=', 'private');
             }
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
                 $where['EVT_wp_user'] = get_current_user_id();
             }
             $events = EEM_Event::instance()->get_all(
@@ -201,7 +201,7 @@ 
             /** @var EE_Event $evt */
             foreach ($events as $evt) {
                 // any registrations for this event?
-                if (! $evt->get_count_of_all_registrations()) {
+                if ( ! $evt->get_count_of_all_registrations()) {
                     continue;
                 }
                 $evts[] = array(
@@ -220,22 +220,22 @@ 
             $event_filter = '<div class="ee-event-filter">';
             $event_filter .= EEH_Form_Fields::select_input('event_id', $evts, $current_EVT_ID);
             $event_filter .= '<span class="ee-event-filter-toggle">';
-            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '> ';
+            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" '.$checked.'> ';
             $event_filter .= __('Hide Expired Events', 'event_espresso');
             $event_filter .= '</span>';
             $event_filter .= '</div>';
             $filters[] = $event_filter;
         }
-        if (! empty($this->_dtts_for_event)) {
+        if ( ! empty($this->_dtts_for_event)) {
             // DTT datetimes filter
             $this->_cur_dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0;
             if (count($this->_dtts_for_event) > 1) {
                 $dtts[0] = __('To toggle check-in status, select a datetime.', 'event_espresso');
                 foreach ($this->_dtts_for_event as $dtt) {
                     $datetime_string = $dtt->name();
-                    $datetime_string = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
-                    $datetime_string = $dtt->start_date_and_time() . ' - ' . $dtt->end_date_and_time() . $datetime_string;
-                    $dtts[ $dtt->ID() ] = $datetime_string;
+                    $datetime_string = ! empty($datetime_string) ? ' ('.$datetime_string.')' : '';
+                    $datetime_string = $dtt->start_date_and_time().' - '.$dtt->end_date_and_time().$datetime_string;
+                    $dtts[$dtt->ID()] = $datetime_string;
                 }
                 $input = new EE_Select_Input(
                     $dtts,
@@ -246,7 +246,7 @@ 
                     )
                 );
                 $filters[] = $input->get_html_for_input();
-                $filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
+                $filters[] = '<input type="hidden" name="event_id" value="'.$current_EVT_ID.'">';
             }
         }
         return $filters;
@@ -290,7 +290,7 @@ 
      */
     public function column__Reg_Status(EE_Registration $item)
     {
-        return '<span class="ee-status-strip ee-status-strip-td reg-status-' . $item->status_ID() . '"></span>';
+        return '<span class="ee-status-strip ee-status-strip-td reg-status-'.$item->status_ID().'"></span>';
     }
 
 
@@ -339,11 +339,11 @@ 
                          )
             ? ' clickable trigger-checkin'
             : '';
-        $mobile_view_content = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return '<span class="' . $checkin_status_dashicon->cssClasses() . $toggle_active . '"'
-               . ' data-_regid="' . $item->ID() . '"'
-               . ' data-dttid="' . $this->_cur_dtt_id . '"'
-               . ' data-nonce="' . $nonce . '">'
+        $mobile_view_content = ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
+        return '<span class="'.$checkin_status_dashicon->cssClasses().$toggle_active.'"'
+               . ' data-_regid="'.$item->ID().'"'
+               . ' data-dttid="'.$this->_cur_dtt_id.'"'
+               . ' data-nonce="'.$nonce.'">'
                . '</span>'
                . $mobile_view_content;
     }
@@ -357,7 +357,7 @@ 
     public function column_ATT_name(EE_Registration $item)
     {
         $attendee = $item->attendee();
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return __('No contact record for this registration.', 'event_espresso');
         }
         // edit attendee link
@@ -369,7 +369,7 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+            ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('View Registration Details', 'event_espresso').'">'
               . $item->attendee()->full_name()
               . '</a>'
             : $item->attendee()->full_name();
@@ -377,7 +377,7 @@ 
             ? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>	'
             : '';
         // add group details
-        $name_link .= '&nbsp;' . sprintf(__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
+        $name_link .= '&nbsp;'.sprintf(__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
         // add regcode
         $link = EE_Admin_Page::add_query_args_and_nonce(
             array('action' => 'view_registration', '_REG_ID' => $item->ID()),
@@ -389,7 +389,7 @@ 
             'view_registration',
             $item->ID()
         )
-            ? '<a href="' . $link . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+            ? '<a href="'.$link.'" title="'.esc_attr__('View Registration Details', 'event_espresso').'">'
               . $item->reg_code()
               . '</a>'
             : $item->reg_code();
@@ -405,7 +405,7 @@ 
         $DTT_ID = $latest_related_datetime instanceof EE_Datetime
             ? $latest_related_datetime->ID()
             : $DTT_ID;
-        if (! empty($DTT_ID)
+        if ( ! empty($DTT_ID)
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_checkins',
                 'espresso_registrations_registration_checkins'
@@ -417,7 +417,7 @@ 
             );
             // get the timestamps for this registration's checkins, related to the selected datetime
             $timestamps = $item->get_many_related('Checkin', array(array('DTT_ID' => $DTT_ID)));
-            if (! empty($timestamps)) {
+            if ( ! empty($timestamps)) {
                 // get the last timestamp
                 $last_timestamp = end($timestamps);
                 // checked in or checked out?
@@ -426,14 +426,14 @@ 
                     : esc_html__('Checked Out', 'event_espresso');
                 // get timestamp string
                 $timestamp_string = $last_timestamp->get_datetime('CHK_timestamp');
-                $actions['checkin'] = '<a href="' . $checkin_list_url . '" title="'
+                $actions['checkin'] = '<a href="'.$checkin_list_url.'" title="'
                                       . esc_attr__(
                                           'View this registrant\'s check-ins/checkouts for the datetime',
                                           'event_espresso'
-                                      ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
+                                      ).'">'.$checkin_status.': '.$timestamp_string.'</a>';
             }
         }
-        return (! empty($DTT_ID) && ! empty($timestamps))
+        return ( ! empty($DTT_ID) && ! empty($timestamps))
             ? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
             : $name_link;
     }
@@ -466,11 +466,11 @@ 
             $event_label = EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_checkins',
                 'espresso_registrations_registration_checkins'
-            ) ? '<a href="' . $chkin_lnk_url . '" title="'
+            ) ? '<a href="'.$chkin_lnk_url.'" title="'
                 . esc_attr__(
                     'View Checkins for this Event',
                     'event_espresso'
-                ) . '">' . $event->name() . '</a>' : $event->name();
+                ).'">'.$event->name().'</a>' : $event->name();
         } catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
             $event_label = esc_html__('Unknown', 'event_espresso');
         }
@@ -496,7 +496,7 @@ 
      */
     public function column__REG_final_price(EE_Registration $item)
     {
-        return '<span class="reg-pad-rght">' . ' ' . $item->pretty_final_price() . '</span>';
+        return '<span class="reg-pad-rght">'.' '.$item->pretty_final_price().'</span>';
     }
 
 
@@ -533,7 +533,7 @@ 
                     . $item->transaction()->pretty_paid()
                     . '
 					</a>
-				<span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
+				<span>' : '<span class="reg-pad-rght">'.$item->transaction()->pretty_paid().'</span>';
             }
         } else {
             return '<span class="reg-pad-rght"></span>';
@@ -569,7 +569,7 @@ 
                 . esc_attr__('View Transaction', 'event_espresso')
                 . '"><span class="reg-pad-rght">'
                 . $txn_total
-                . '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
+                . '</span></a>' : '<span class="reg-pad-rght">'.$txn_total.'</span>';
         } else {
             return '<span class="reg-pad-rght"></span>';
         }

core/templates/json_linked_data_for_event.template.php

Indentation +15 added lines, -15 removed lines

@@ -26,8 +26,8 @@ 
   "eventStatus": "https://schema.org/<?php echo $event_status; ?>",
   "offers": [
     <?php
-    $i = 0;
-    foreach ($event_tickets as $ticket) {?>
+	$i = 0;
+	foreach ($event_tickets as $ticket) {?>
     {
       "@type": "Offer",
       "url": "<?php echo $event_permalink; ?>",
@@ -36,18 +36,18 @@ 
       "price": "<?php echo $ticket['price']; ?>",
       "priceCurrency": "<?php echo $currency; ?>"
         <?php if (isset($ticket['availability'])) {
-            ?>,"availability": "http://schema.org/<?php echo $ticket['availability']; ?>"
+			?>,"availability": "http://schema.org/<?php echo $ticket['availability']; ?>"
         <?php } ?>
     }<?php
-    $i++;
-    if ($i < count($event_tickets)) {
-        echo ',';
-    }
-    }
-    ?>
+	$i++;
+	if ($i < count($event_tickets)) {
+		echo ',';
+	}
+	}
+	?>
     ]<?php
-    if ($venue_name) {
-        ?>,
+	if ($venue_name) {
+		?>,
   "location": {
     "@type": "Place",
     "name": <?php echo wp_json_encode($venue_name); ?>,
@@ -60,13 +60,13 @@ 
     }
   }
     <?php
-    } ?>
+	} ?>
     <?php
-    if ($event_image) {
-        ?>,
+	if ($event_image) {
+		?>,
   "image": "<?php echo $event_image; ?>"
     <?php
-    } ?>
+	} ?>
     <?php do_action('AHEE__json_linked_data_for_event__template'); ?>
 }
 

core/helpers/EEH_Schema.helper.php

Indentation +292 added lines, -292 removed lines

@@ -12,296 +12,296 @@
 {
 
 
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param EE_Event $event
-     * @throws EE_Error
-     */
-    public static function add_json_linked_data_for_event(EE_Event $event)
-    {
-        // Check we have a valid datetime for the event
-        if (! $event->primary_datetime() instanceof EE_Datetime) {
-            return;
-        }
-
-        $template_args = array(
-            'event_permalink' => '',
-            'event_name' => '',
-            'event_description' => '',
-            'event_start' => '',
-            'event_end' => '',
-            'event_attendance_mode' => '',
-            'event_status' => '',
-            'currency' => '',
-            'event_tickets' => array(),
-            'venue_name' => '',
-            'venue_url' => '',
-            'venue_locality' => '',
-            'venue_region' => '',
-            'venue_address' => '',
-            'event_image' => '',
-        );
-        $template_args['event_permalink'] = $event->get_permalink();
-        $template_args['event_name'] = $event->name();
-        $template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
-        // clone datetime so that date formats don't override those for the original datetime
-        $primary_datetime = clone $event->primary_datetime();
-        $template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
-        $template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
-        unset($primary_datetime);
-        switch ($event->status()) {
-            case EEM_Event::cancelled:
-                $event_status = 'EventCancelled';
-                break;
-            case EEM_Event::postponed:
-                $event_status = 'EventPostponed';
-                break;
-            default:
-                $event_status = 'EventScheduled';
-        }
-        $template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
-        $template_args['event_status'] = $event_status;
-        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $original_ticket) {
-            // clone tickets so that date formats don't override those for the original ticket
-            $ticket= clone $original_ticket;
-            $ID = $ticket->ID();
-            $template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['price'] = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                ''
-            );
-            switch ($ticket->ticket_status()) {
-                case 'TKO':
-                    $availability = 'InStock';
-                    break;
-                case 'TKS':
-                    $availability = 'SoldOut';
-                    break;
-                default:
-                    $availability = null;
-                    break;
-            }
-            $template_args['event_tickets'][ $ID ]['availability'] = $availability;
-            unset($ticket);
-        }
-        $VNU_ID = espresso_venue_id();
-        if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name'] = get_the_title($VNU_ID);
-            $template_args['venue_url'] = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region'] = $venue->state_name();
-            $template_args['venue_address'] = $venue->address();
-            if ($venue->virtual_url() !== '') {
-                $template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
-            }
-            if ($venue->virtual_url() !== '' && $venue->address() !== '') {
-                $template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
-            }
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
-
-
-    /**
-     *    location
-     *    The location of the event, organization or action.
-     *    Should include the Venue name AND schema formatted address info
-     *
-     * @access public
-     * @param string $location
-     * @return string
-     */
-    public static function location($location = null)
-    {
-        return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
-                                      . $location
-                                      . '</div>' : '';
-    }
-
-
-
-    /**
-     *    name
-     *    The name of the Event or Venue.
-     *
-     * @access public
-     * @param string $name
-     * @return string
-     */
-    public static function name($name = null)
-    {
-        return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
-    }
-
-
-
-    /**
-     *    streetAddress
-     *    The street address. For example, 1600 Amphitheatre Pkwy.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function streetAddress(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-            ? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    postOfficeBoxNumber
-     *    The post office box number for PO box addresses.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null)
-    {
-        // regex check for some form of PO Box or P.O. Box, etc, etc, etc
-        if (preg_match(
-            "/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
-            $obj_with_address->address2()
-        ) ) {
-            return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-                ? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
-        } else {
-            return $obj_with_address->address2();
-        }
-    }
-
-
-
-    /**
-     *    addressLocality
-     *    The locality (city, town, etc). For example, Mountain View.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressLocality(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-            ? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    addressRegion
-     *    The region (state, province, etc). For example, CA.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressRegion(EEI_Address $obj_with_address = null)
-    {
-        $state = $obj_with_address->state_name();
-        if (! empty($state)) {
-            return '<span itemprop="addressRegion">' . $state . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    addressCountry
-     *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressCountry(EEI_Address $obj_with_address = null)
-    {
-        $country = $obj_with_address->country_name();
-        if (! empty($country)) {
-            return '<span itemprop="addressCountry">' . $country . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    postalCode
-     *    The postal code. For example, 94043.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function postalCode(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
-                                                                                      . $obj_with_address->zip()
-                                                                                      . '</span>' : '';
-    }
-
-
-
-    /**
-     *    telephone
-     *    The telephone number.
-     *
-     * @access public
-     * @param string $phone_nmbr
-     * @return string
-     */
-    public static function telephone($phone_nmbr = null)
-    {
-        return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
-            : '';
-    }
-
-
-
-    /**
-     *    URL
-     *    URL of the item as a clickable link
-     *
-     * @access public
-     * @param string $url        - the URL that the link will resolve to
-     * @param string $text       - the text that will be used for the visible link
-     * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
-     * @return string (link)
-     */
-    public static function url($url = null, $text = null, $attributes = array())
-    {
-        // Check the URL includes a scheme
-        $parsed_url = parse_url($url);
-        if (empty($parsed_url['scheme'])) {
-            $url = 'http://' . ltrim($url, '/');
-        }
-
-        $atts = '';
-        foreach ($attributes as $attribute => $value) {
-            $atts .= ' ' . $attribute . '="' . $value . '"';
-        }
-        $text = $text !== null && $text !== '' ? $text : $url;
-        return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
-            : '';
-    }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param EE_Event $event
+	 * @throws EE_Error
+	 */
+	public static function add_json_linked_data_for_event(EE_Event $event)
+	{
+		// Check we have a valid datetime for the event
+		if (! $event->primary_datetime() instanceof EE_Datetime) {
+			return;
+		}
+
+		$template_args = array(
+			'event_permalink' => '',
+			'event_name' => '',
+			'event_description' => '',
+			'event_start' => '',
+			'event_end' => '',
+			'event_attendance_mode' => '',
+			'event_status' => '',
+			'currency' => '',
+			'event_tickets' => array(),
+			'venue_name' => '',
+			'venue_url' => '',
+			'venue_locality' => '',
+			'venue_region' => '',
+			'venue_address' => '',
+			'event_image' => '',
+		);
+		$template_args['event_permalink'] = $event->get_permalink();
+		$template_args['event_name'] = $event->name();
+		$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
+		// clone datetime so that date formats don't override those for the original datetime
+		$primary_datetime = clone $event->primary_datetime();
+		$template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
+		$template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
+		unset($primary_datetime);
+		switch ($event->status()) {
+			case EEM_Event::cancelled:
+				$event_status = 'EventCancelled';
+				break;
+			case EEM_Event::postponed:
+				$event_status = 'EventPostponed';
+				break;
+			default:
+				$event_status = 'EventScheduled';
+		}
+		$template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
+		$template_args['event_status'] = $event_status;
+		$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $original_ticket) {
+			// clone tickets so that date formats don't override those for the original ticket
+			$ticket= clone $original_ticket;
+			$ID = $ticket->ID();
+			$template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['price'] = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				''
+			);
+			switch ($ticket->ticket_status()) {
+				case 'TKO':
+					$availability = 'InStock';
+					break;
+				case 'TKS':
+					$availability = 'SoldOut';
+					break;
+				default:
+					$availability = null;
+					break;
+			}
+			$template_args['event_tickets'][ $ID ]['availability'] = $availability;
+			unset($ticket);
+		}
+		$VNU_ID = espresso_venue_id();
+		if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name'] = get_the_title($VNU_ID);
+			$template_args['venue_url'] = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region'] = $venue->state_name();
+			$template_args['venue_address'] = $venue->address();
+			if ($venue->virtual_url() !== '') {
+				$template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
+			}
+			if ($venue->virtual_url() !== '' && $venue->address() !== '') {
+				$template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
+			}
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args, EXTR_OVERWRITE);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
+
+
+	/**
+	 *    location
+	 *    The location of the event, organization or action.
+	 *    Should include the Venue name AND schema formatted address info
+	 *
+	 * @access public
+	 * @param string $location
+	 * @return string
+	 */
+	public static function location($location = null)
+	{
+		return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
+									  . $location
+									  . '</div>' : '';
+	}
+
+
+
+	/**
+	 *    name
+	 *    The name of the Event or Venue.
+	 *
+	 * @access public
+	 * @param string $name
+	 * @return string
+	 */
+	public static function name($name = null)
+	{
+		return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    streetAddress
+	 *    The street address. For example, 1600 Amphitheatre Pkwy.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function streetAddress(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
+			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    postOfficeBoxNumber
+	 *    The post office box number for PO box addresses.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null)
+	{
+		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
+		if (preg_match(
+			"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
+			$obj_with_address->address2()
+		) ) {
+			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
+				? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+		} else {
+			return $obj_with_address->address2();
+		}
+	}
+
+
+
+	/**
+	 *    addressLocality
+	 *    The locality (city, town, etc). For example, Mountain View.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressLocality(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
+			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    addressRegion
+	 *    The region (state, province, etc). For example, CA.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressRegion(EEI_Address $obj_with_address = null)
+	{
+		$state = $obj_with_address->state_name();
+		if (! empty($state)) {
+			return '<span itemprop="addressRegion">' . $state . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    addressCountry
+	 *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressCountry(EEI_Address $obj_with_address = null)
+	{
+		$country = $obj_with_address->country_name();
+		if (! empty($country)) {
+			return '<span itemprop="addressCountry">' . $country . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    postalCode
+	 *    The postal code. For example, 94043.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function postalCode(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
+																					  . $obj_with_address->zip()
+																					  . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    telephone
+	 *    The telephone number.
+	 *
+	 * @access public
+	 * @param string $phone_nmbr
+	 * @return string
+	 */
+	public static function telephone($phone_nmbr = null)
+	{
+		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+			: '';
+	}
+
+
+
+	/**
+	 *    URL
+	 *    URL of the item as a clickable link
+	 *
+	 * @access public
+	 * @param string $url        - the URL that the link will resolve to
+	 * @param string $text       - the text that will be used for the visible link
+	 * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
+	 * @return string (link)
+	 */
+	public static function url($url = null, $text = null, $attributes = array())
+	{
+		// Check the URL includes a scheme
+		$parsed_url = parse_url($url);
+		if (empty($parsed_url['scheme'])) {
+			$url = 'http://' . ltrim($url, '/');
+		}
+
+		$atts = '';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' ' . $attribute . '="' . $value . '"';
+		}
+		$text = $text !== null && $text !== '' ? $text : $url;
+		return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
+			: '';
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.5.rc.009');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.5.rc.009');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }