eventespresso / event-espresso-core

core/domain/entities/contexts/ContextInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface ContextInterface
 {
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 
 
-    /**
-     * @return string
-     */
-    public function description();
+	/**
+	 * @return string
+	 */
+	public function description();
 }

core/db_models/EEM_Question.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -364,7 +364,7 @@ 
      * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
      * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
      * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
+     * @return string of QST_ID for the question that corresponds to that QST_system
      */
     public function get_Question_ID_from_system_string($QST_system)
     {
@@ -425,7 +425,7 @@ 
 
 
     /**
-     * @return array
+     * @return EEM_Question
      */
     public function question_descriptions()
     {

Spacing +10 added lines, -10 removed lines

@@ -213,10 +213,10 @@ 
             'Question_Group_Question' => new EE_Has_Many_Relation()
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QST_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QST_system');
         parent::__construct($timezone);
     }
 
@@ -256,10 +256,10 @@ 
      */
     public function question_type_is_in_category($question_type, $category)
     {
-        if (!isset($this->_question_type_categories[ $category ])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
+        return in_array($question_type, $this->_question_type_categories[$category]);
     }
 
 
@@ -270,8 +270,8 @@ 
      */
     public function question_types_in_category($category)
     {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
+        if (isset($this->_question_type_categories[$category])) {
+            return $this->_question_type_categories[$category];
         }
         return array();
     }
@@ -410,8 +410,8 @@ 
     public function absolute_max_for_system_question($system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        if (isset($maxes[ $system_question_value ])) {
-            return $maxes[ $system_question_value ];
+        if (isset($maxes[$system_question_value])) {
+            return $maxes[$system_question_value];
         } else {
             return EE_INF;
         }

Indentation +425 added lines, -425 removed lines

@@ -10,429 +10,429 @@
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @access protected
-     * @var array $_question_type_categories {
-     * @type string $text
-     * @type string $single -answer-enum
-     * @type string $multi -answer-enum
-     *                    }
-     */
-    protected $_question_type_categories = array();
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @access protected
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = array();
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @access protected
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     * @var array
-     */
-    protected $question_types_with_max_lengh;
-
-
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Question', 'event_espresso');
-        $this->plural_item = __('Questions', 'event_espresso');
-        $this->_allowed_question_types = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            array(
-                EEM_Question::QST_type_text => __('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_email => __('Email', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
-                EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_url => __('URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('Year', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
-            )
-        );
-        $this->_question_descriptions = apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            array(
-                EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
-                EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
-                EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
-                EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
-                EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
-                EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
-                EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
-            )
-        );
-        $this->_question_type_categories = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            array(
-                'text' => array(
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_year
-                ),
-                'single-answer-enum' => array(
-                    EEM_Question::QST_type_radio,
-                    EEM_Question::QST_type_dropdown
-                ),
-                'multi-answer-enum' => array(
-                    EEM_Question::QST_type_checkbox,
-                    EEM_Question::QST_type_multi_select
-                )
-            )
-        );
-        $this->question_types_with_max_lengh = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            array(
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-                EEM_Question::QST_type_html_textarea
-            )
-        );
-
-        $this->_tables = array(
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
-        );
-        $this->_fields = array(
-            'Question' => array(
-                'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
-                'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
-                'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
-                'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
-                'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
-                'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
-                'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
-                'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
-                'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
-                'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
-                'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
-                'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
-            'Question_Option' => new EE_Has_Many_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        parent::__construct($timezone);
-    }
-
-    /**
-     * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
-     * but they can be extended
-     * @return string[]
-     */
-    public function allowed_question_types()
-    {
-        return $this->_allowed_question_types;
-    }
-
-    /**
-     * Gets all the question types in the same category
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category($question_type)
-    {
-        $question_types = array($question_type);
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-    /**
-     * Determines if the given question type is in the given question type category
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category($question_type, $category)
-    {
-        if (!isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category($category)
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     * @return array
-     */
-    public function question_types_with_options()
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-    /**
-     * Returns the question type categories 2d array
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories()
-    {
-        return $this->_question_type_categories;
-    }
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = array();
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
-    }
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                );
-                break;
-            default:
-                $question_system_ids = array();
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     */
-    public function get_Question_ID_from_system_string($QST_system)
-    {
-        return $this->get_var(array(array('QST_system' => $QST_system)));
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QST_order)", "%d")
-        );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     * @return array
-     */
-    public function system_question_maxes()
-    {
-        return array(
-            'fname' => 45,
-            'lname' => 45,
-            'address' => 255,
-            'address2' => 255,
-            'city' => 45,
-            'zip' => 12,
-            'email' => 255,
-            'phone' => 45,
-        );
-    }
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     * @param string $system_question_value
-     * @return int|float
-     */
-    public function absolute_max_for_system_question($system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        if (isset($maxes[ $system_question_value ])) {
-            return $maxes[ $system_question_value ];
-        } else {
-            return EE_INF;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions()
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     * @return array
-     */
-    public function questionTypesWithMaxLength()
-    {
-        return (array) $this->question_types_with_max_lengh;
-    }
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @access protected
+	 * @var array $_question_type_categories {
+	 * @type string $text
+	 * @type string $single -answer-enum
+	 * @type string $multi -answer-enum
+	 *                    }
+	 */
+	protected $_question_type_categories = array();
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @access protected
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = array();
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @access protected
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 * @var array
+	 */
+	protected $question_types_with_max_lengh;
+
+
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Question', 'event_espresso');
+		$this->plural_item = __('Questions', 'event_espresso');
+		$this->_allowed_question_types = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			array(
+				EEM_Question::QST_type_text => __('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_email => __('Email', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
+				EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_url => __('URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('Year', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
+			)
+		);
+		$this->_question_descriptions = apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			array(
+				EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
+				EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
+				EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
+				EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
+				EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
+				EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
+				EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
+			)
+		);
+		$this->_question_type_categories = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			array(
+				'text' => array(
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_year
+				),
+				'single-answer-enum' => array(
+					EEM_Question::QST_type_radio,
+					EEM_Question::QST_type_dropdown
+				),
+				'multi-answer-enum' => array(
+					EEM_Question::QST_type_checkbox,
+					EEM_Question::QST_type_multi_select
+				)
+			)
+		);
+		$this->question_types_with_max_lengh = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			array(
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+				EEM_Question::QST_type_html_textarea
+			)
+		);
+
+		$this->_tables = array(
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
+		);
+		$this->_fields = array(
+			'Question' => array(
+				'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
+				'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
+				'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
+				'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
+				'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
+				'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
+				'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
+				'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
+				'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
+				'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
+				'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
+				'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
+			'Question_Option' => new EE_Has_Many_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		parent::__construct($timezone);
+	}
+
+	/**
+	 * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
+	 * but they can be extended
+	 * @return string[]
+	 */
+	public function allowed_question_types()
+	{
+		return $this->_allowed_question_types;
+	}
+
+	/**
+	 * Gets all the question types in the same category
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category($question_type)
+	{
+		$question_types = array($question_type);
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category($question_type, $category)
+	{
+		if (!isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category($category)
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 * @return array
+	 */
+	public function question_types_with_options()
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+	/**
+	 * Returns the question type categories 2d array
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories()
+	{
+		return $this->_question_type_categories;
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = array();
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				);
+				break;
+			default:
+				$question_system_ids = array();
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 */
+	public function get_Question_ID_from_system_string($QST_system)
+	{
+		return $this->get_var(array(array('QST_system' => $QST_system)));
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QST_order)", "%d")
+		);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 * @return array
+	 */
+	public function system_question_maxes()
+	{
+		return array(
+			'fname' => 45,
+			'lname' => 45,
+			'address' => 255,
+			'address2' => 255,
+			'city' => 45,
+			'zip' => 12,
+			'email' => 255,
+			'phone' => 45,
+		);
+	}
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 * @param string $system_question_value
+	 * @return int|float
+	 */
+	public function absolute_max_for_system_question($system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		if (isset($maxes[ $system_question_value ])) {
+			return $maxes[ $system_question_value ];
+		} else {
+			return EE_INF;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions()
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength()
+	{
+		return (array) $this->question_types_with_max_lengh;
+	}
 }

acceptance_tests/tests/b-TestRegistrationSummaryCept.php

Indentation +41 added lines, -41 removed lines

@@ -14,8 +14,8 @@ 
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 //k now we need to make sure the registration multi-status message type is active because it isn't by default
@@ -73,38 +73,38 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->see(
-    'rsm_tester@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_tester@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 //verify count
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'rsm_tester@example.org',
-    'to',
-    'Registration Multi-status Summary',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Primary Registrant'
+	1,
+	'rsm_tester@example.org',
+	'to',
+	'Registration Multi-status Summary',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Primary Registrant'
 );
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT
@@ -134,25 +134,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->dontSee(
-    'rsm_testerb@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_testerb@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 //there should still only be one admin multi-status summary thing.
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/tests/c-TestCustomMessageTemplateCept.php

Indentation +27 added lines, -27 removed lines

@@ -18,14 +18,14 @@ 
 $event_one_link = $event_two_link = $event_three_link = '';
 
 $I->wantTo(
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
-    . 'template, that that custom template will be used.'
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
+	. 'template, that that custom template will be used.'
 );
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 $I->loginAsAdmin();
@@ -80,9 +80,9 @@ 
 
 
 $test_registration_details = array(
-    'fname' => 'CTGuy',
-    'lname' => 'Dude',
-    'email' => 'ctguy_dude@example.org'
+	'fname' => 'CTGuy',
+	'lname' => 'Dude',
+	'email' => 'ctguy_dude@example.org'
 );
 
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -108,23 +108,23 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
@@ -153,25 +153,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
 $I->dontSeeTextInViewMessageModal($custom_template_b_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSee($custom_template_a_label);
@@ -183,6 +183,6 @@ 
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/Helpers/RegistrationsAdmin.php

Indentation +134 added lines, -134 removed lines

@@ -15,139 +15,139 @@
 trait RegistrationsAdmin
 {
 
-    /**
-     * This will select all checkboxes on a registration list table for the given array of
-     * registration ids.
-     * Assumes the actor is on a list table page for registrations.
-     * @param $registration_ids
-     */
-    public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
-    {
-        foreach ($registration_ids as $registration_id) {
-            $this->actor()->checkOption(
-                RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
-            );
-        }
-    }
-
-
-    /**
-     * Navigates the actor to the default registration list table page.
-     * @param string $additional_params
-     */
-    public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(
-            RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
-        );
-        //wait for page to fully load
-        $this->actor()->wait(5);
-    }
-
-
-    /**
-     * Will enter the provided value in the registration list table search field and execute a search for that value.
-     * @param string $search_text
-     */
-    public function searchForRegistrationOnRegistrationListTableWithText($search_text)
-    {
-        $this->amOnDefaultRegistrationsListTableAdminPage();
-        $this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText('Displaying search results for');
-    }
-
-
-
-    /**
-     * This will filter the registration list table to view registrations for the given event id.
-     * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
-     * page.
-     *
-     * @param int $event_id  The id of the event viewing registrations for.
-     */
-    public function amViewingRegistrationsForEvent($event_id)
-    {
-        $this->actor()->amOnDefaultEventsListTablePage();
-        $this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
-        $this->actor()->waitForText('Viewing registrations for the event');
-    }
-
-
-    /**
-     * This helper will initiate registering for the given event via the backend.
-     * @param int $event_id  The event to initiate registration for.
-     */
-    public function amOnAdminRegistrationPageForEvent($event_id)
-    {
-        $this->actor()->amViewingRegistrationsForEvent($event_id);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
-        $this->actor()->waitForText('Adding Registration For');
-    }
-
-
-
-    /**
-     * This clicks the View Details Link for Registration with the given Id
-     * @param $registration_id
-     */
-    public function clickViewDetailsLinkForRegistrationWithId($registration_id)
-    {
-        $this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
-    }
-
-
-    /**
-     * /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param $status_label_or_value
-     */
-    public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
-    {
-        $this->actor()->selectOption(
-            RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
-            $status_label_or_value
-        );
-    }
-
-
-    /**
-     * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
-     * @param bool $send_related_messages
-     */
-    public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
-    {
-        $send_related_messages
-            ? $this->actor()->selectOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'Yes'
-            )
-            : $this->actor()->selecOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'No'
-            );
-    }
-
-
-
-    /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status and submits the change.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
-     */
-    public function changeRegistrationStatusOnRegistrationDetailsPageTo(
-        $status_label_or_value,
-        $send_related_messages = true
-    ) {
-        $this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
-        $this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
-        $this->actor()->waitForText('Registration status has been set to');
-    }
+	/**
+	 * This will select all checkboxes on a registration list table for the given array of
+	 * registration ids.
+	 * Assumes the actor is on a list table page for registrations.
+	 * @param $registration_ids
+	 */
+	public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
+	{
+		foreach ($registration_ids as $registration_id) {
+			$this->actor()->checkOption(
+				RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
+			);
+		}
+	}
+
+
+	/**
+	 * Navigates the actor to the default registration list table page.
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(
+			RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
+		);
+		//wait for page to fully load
+		$this->actor()->wait(5);
+	}
+
+
+	/**
+	 * Will enter the provided value in the registration list table search field and execute a search for that value.
+	 * @param string $search_text
+	 */
+	public function searchForRegistrationOnRegistrationListTableWithText($search_text)
+	{
+		$this->amOnDefaultRegistrationsListTableAdminPage();
+		$this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText('Displaying search results for');
+	}
+
+
+
+	/**
+	 * This will filter the registration list table to view registrations for the given event id.
+	 * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
+	 * page.
+	 *
+	 * @param int $event_id  The id of the event viewing registrations for.
+	 */
+	public function amViewingRegistrationsForEvent($event_id)
+	{
+		$this->actor()->amOnDefaultEventsListTablePage();
+		$this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
+		$this->actor()->waitForText('Viewing registrations for the event');
+	}
+
+
+	/**
+	 * This helper will initiate registering for the given event via the backend.
+	 * @param int $event_id  The event to initiate registration for.
+	 */
+	public function amOnAdminRegistrationPageForEvent($event_id)
+	{
+		$this->actor()->amViewingRegistrationsForEvent($event_id);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
+		$this->actor()->waitForText('Adding Registration For');
+	}
+
+
+
+	/**
+	 * This clicks the View Details Link for Registration with the given Id
+	 * @param $registration_id
+	 */
+	public function clickViewDetailsLinkForRegistrationWithId($registration_id)
+	{
+		$this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
+	}
+
+
+	/**
+	 * /**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param $status_label_or_value
+	 */
+	public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
+	{
+		$this->actor()->selectOption(
+			RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
+			$status_label_or_value
+		);
+	}
+
+
+	/**
+	 * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
+	 * @param bool $send_related_messages
+	 */
+	public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
+	{
+		$send_related_messages
+			? $this->actor()->selectOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'Yes'
+			)
+			: $this->actor()->selecOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'No'
+			);
+	}
+
+
+
+	/**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status and submits the change.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
+	 */
+	public function changeRegistrationStatusOnRegistrationDetailsPageTo(
+		$status_label_or_value,
+		$send_related_messages = true
+	) {
+		$this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
+		$this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
+		$this->actor()->waitForText('Registration status has been set to');
+	}
 
 }
\ No newline at end of file

acceptance_tests/Helpers/Checkout.php

Indentation +62 added lines, -62 removed lines

@@ -13,75 +13,75 @@
  */
 trait Checkout
 {
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutEmailFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutEmailFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
 
-    /**
-     * Clicks the next registration step button.
-     */
-    public function goToNextRegistrationStep()
-    {
-        $this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
-    }
+	/**
+	 * Clicks the next registration step button.
+	 */
+	public function goToNextRegistrationStep()
+	{
+		$this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
+	}
 
 
-    /**
-     * Selects the payment option for the given payment method slug.
-     *
-     * @param string $payment_method_slug
-     * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
-     *                                     payment option select box is complete.  Otherwise its up to calling code to
-     *                                     wait for whatever is needed after selecting the payment method.
-     */
-    public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
-    {
-        $this->waitForElementVisible(CheckoutPage::SELECTOR_PAYMENT_OPTIONS_CONTAINER);
-        $this->wait(5);
-        $this->actor()->selectOption(
-            CheckoutPage::PAYMENT_METHOD_STEP_FORM,
-            $payment_method_slug
-        );
-        if ($verify_selected) {
-            $this->actor()->waitForText('Important information regarding your payment');
-        }
-    }
+	/**
+	 * Selects the payment option for the given payment method slug.
+	 *
+	 * @param string $payment_method_slug
+	 * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
+	 *                                     payment option select box is complete.  Otherwise its up to calling code to
+	 *                                     wait for whatever is needed after selecting the payment method.
+	 */
+	public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
+	{
+		$this->waitForElementVisible(CheckoutPage::SELECTOR_PAYMENT_OPTIONS_CONTAINER);
+		$this->wait(5);
+		$this->actor()->selectOption(
+			CheckoutPage::PAYMENT_METHOD_STEP_FORM,
+			$payment_method_slug
+		);
+		if ($verify_selected) {
+			$this->actor()->waitForText('Important information regarding your payment');
+		}
+	}
 
 
-    /**
-     * Submits the payment options step form.
-     * Assumes the actor is in the context of the payment options SPCO step.
-     */
-    public function submitPaymentOptionsRegistrationStepForm()
-    {
-        $this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
-    }
+	/**
+	 * Submits the payment options step form.
+	 * Assumes the actor is in the context of the payment options SPCO step.
+	 */
+	public function submitPaymentOptionsRegistrationStepForm()
+	{
+		$this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
+	}
 
 }
\ No newline at end of file

acceptance_tests/Page/TicketSelector.php

Indentation +21 added lines, -21 removed lines

@@ -12,27 +12,27 @@
 class TicketSelector
 {
 
-    /**
-     * Return the selector for the ticket option select input for the given event id.
-     * @param int|string $event_id
-     * @return string
-     */
-    public static function ticketOptionByEventIdSelector($event_id)
-    {
-        return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
-    }
+	/**
+	 * Return the selector for the ticket option select input for the given event id.
+	 * @param int|string $event_id
+	 * @return string
+	 */
+	public static function ticketOptionByEventIdSelector($event_id)
+	{
+		return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
+	}
 
 
-    /**
-     * Return the selector for the submit button for the ticket selector for the given event id.
-     * @param int|string $event_id
-     * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
-     * @return string
-     */
-    public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
-    {
-        return $admin
-            ? "#ee-new-registration-step-button"
-            : "#ticket-selector-submit-$event_id-btn";
-    }
+	/**
+	 * Return the selector for the submit button for the ticket selector for the given event id.
+	 * @param int|string $event_id
+	 * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
+	 * @return string
+	 */
+	public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
+	{
+		return $admin
+			? "#ee-new-registration-step-button"
+			: "#ticket-selector-submit-$event_id-btn";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/RegistrationsAdmin.php

Indentation +43 added lines, -43 removed lines

@@ -12,47 +12,47 @@
 class RegistrationsAdmin extends CoreAdmin
 {
 
-    const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
-    const REGISTRATION_STATUS_APPROVED = 'RAP';
-    const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
-    const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
-    const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
-    const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
-    const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
-    const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function registrationsDefaultAdminListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_registrations', 'default', $additional_params);
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for all the checkbox for that id.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
-    {
-        return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for the link to the registration details.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
-    {
-        return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
-            . "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
-    }
+	const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
+	const REGISTRATION_STATUS_APPROVED = 'RAP';
+	const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
+	const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
+	const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
+	const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
+	const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
+	const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function registrationsDefaultAdminListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_registrations', 'default', $additional_params);
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for all the checkbox for that id.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
+	{
+		return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for the link to the registration details.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
+	{
+		return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
+			. "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/Checkout.php

Indentation +67 added lines, -67 removed lines

@@ -13,71 +13,71 @@
 class Checkout
 {
 
-    /**
-     * The class selector for the next step button in the checkout.
-     * @var string
-     */
-    const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
-
-
-    const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
-
-
-    const SELECTOR_PAYMENT_OPTIONS_CONTAINER = '#spco-available-methods-of-payment-dv';
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('fname', $attendee_number, $admin);
-    }
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('lname', $attendee_number, $admin);
-    }
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('email', $attendee_number, $admin);
-    }
-
-    /**
-     * @param string    $field_name
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1, $admin = false)
-    {
-        return $admin
-                ? "//fieldset[starts-with(@id, 'ee-registration-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]"
-                : "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
-    }
-
-
-    /**
-     * @param string $payment_method_slug Slug for the payment method.
-     * @return string
-     */
-    public static function fieldSelectorForPaymentOption($payment_method_slug)
-    {
-        return "#ee-available-payment-method-inputs-{$payment_method_slug}";
-    }
+	/**
+	 * The class selector for the next step button in the checkout.
+	 * @var string
+	 */
+	const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
+
+
+	const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
+
+
+	const SELECTOR_PAYMENT_OPTIONS_CONTAINER = '#spco-available-methods-of-payment-dv';
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('fname', $attendee_number, $admin);
+	}
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('lname', $attendee_number, $admin);
+	}
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('email', $attendee_number, $admin);
+	}
+
+	/**
+	 * @param string    $field_name
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1, $admin = false)
+	{
+		return $admin
+				? "//fieldset[starts-with(@id, 'ee-registration-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]"
+				: "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
+	}
+
+
+	/**
+	 * @param string $payment_method_slug Slug for the payment method.
+	 * @return string
+	 */
+	public static function fieldSelectorForPaymentOption($payment_method_slug)
+	{
+		return "#ee-available-payment-method-inputs-{$payment_method_slug}";
+	}
 }