eventespresso / event-espresso-core

core/db_models/EEM_Question.model.php

Indentation +573 added lines, -573 removed lines

@@ -10,578 +10,578 @@
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
 
-    // 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 a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // 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 an email input
-    const QST_type_email_confirm = 'EMAIL_CONFIRM';
-
-    // 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 integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    // 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 valid URL
-    const QST_type_url = 'URL';
-
-    // 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 a YEAR
-    const QST_type_year = 'YEAR';
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = [];
-
-
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-    /**
-     * 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.
-     *
-     * @var array   $_question_type_categories {
-     * @type string $text
-     * @type string $single                    -answer-enum
-     * @type string $multi                     -answer-enum
-     *                    }
-     */
-    protected $_question_type_categories = [];
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     *
-     * @var array
-     */
-    protected $question_types_with_max_length;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item                  = esc_html__('Question', 'event_espresso');
-        $this->plural_item                    = esc_html__('Questions', 'event_espresso');
-        $this->_allowed_question_types        = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
-                EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
-                EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
-                EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
-                EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
-            ]
-        );
-        $this->_question_descriptions         = apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__(
-                    'Allows multiple preset options to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_country       => esc_html__(
-                    'A dropdown that lists countries',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_date          => esc_html__(
-                    'A popup calendar that allows date selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_decimal       => esc_html__(
-                    'A text field that allows number values with decimals',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_dropdown      => esc_html__(
-                    'A dropdown that allows a single selection',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email         => esc_html__(
-                    'A text field that must contain a valid Email address',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email_confirm => esc_html__(
-                    'A text field that must contain a valid Email address and be equal to Email field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_html_textarea => esc_html__(
-                    'A multi line text input field that allows HTML',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_int           => esc_html__(
-                    'A text field that only allows whole numbers (no decimals)',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_multi_select  => esc_html__(
-                    'A dropdown that allows multiple selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_radio         => esc_html__(
-                    'Allows a single preset option to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_state         => esc_html__(
-                    'A dropdown that lists states/provinces',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_text          => esc_html__(
-                    'A single line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_textarea      => esc_html__(
-                    'A multi line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_url           => esc_html__(
-                    'A text field that must contain a valid URL',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_us_phone      => esc_html__(
-                    'A text field that must contain a valid US phone number',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_year          => esc_html__(
-                    'A dropdown that lists the last 100 years',
-                    'event_espresso'
-                ),
-            ]
-        );
-        $this->_question_type_categories      = (array)apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            [
-                'text'               => [
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_email_confirm,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_year,
-                ],
-                'single-answer-enum' => [
-                    EEM_Question::QST_type_dropdown,
-                    EEM_Question::QST_type_radio,
-                ],
-                'multi-answer-enum'  => [
-                    EEM_Question::QST_type_multi_select,
-                    EEM_Question::QST_type_checkbox,
-                ],
-            ]
-        );
-        $this->question_types_with_max_length = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            [
-                EEM_Question::QST_type_html_textarea,
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-            ]
-        );
-
-        $this->_tables          = [
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
-        ];
-        $this->_fields          = [
-            'Question' => [
-                'QST_ID'            => new EE_Primary_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso')
-                ),
-                'QST_admin_label'   => new EE_Plain_Text_Field(
-                    'QST_admin_label',
-                    esc_html__('Question Label (admin-only)', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_admin_only'    => new EE_Boolean_Field(
-                    'QST_admin_only',
-                    esc_html__('Admin-Only Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_deleted'       => new EE_Trashed_Flag_Field(
-                    'QST_deleted',
-                    esc_html__('Flag Indicating question was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_display_text'  => new EE_Post_Content_Field(
-                    'QST_display_text',
-                    esc_html__('Question Text', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_max'           => new EE_Infinite_Integer_Field(
-                    'QST_max',
-                    esc_html__('Max Size', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'QST_order'         => new EE_Integer_Field(
-                    'QST_order',
-                    esc_html__('Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QST_required'      => new EE_Boolean_Field(
-                    'QST_required',
-                    esc_html__('Required Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_required_text' => new EE_Simple_HTML_Field(
-                    'QST_required_text',
-                    esc_html__('Text to Display if Not Provided', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_system'        => new EE_Plain_Text_Field(
-                    'QST_system',
-                    esc_html__('Internal string ID for question', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QST_type'          => new EE_Enum_Text_Field(
-                    'QST_type',
-                    esc_html__('Question Type', 'event_espresso'),
-                    false,
-                    'TEXT',
-                    $this->_allowed_question_types
-                ),
-                'QST_wp_user'       => new EE_WP_User_Field(
-                    'QST_wp_user',
-                    esc_html__('Question Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Answer'                  => new EE_Has_Many_Relation(),
-            'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation(),
-            'Question_Option'         => new EE_Has_Many_Relation(),
-            'WP_User'                 => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('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(): array
-    {
-        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(string $question_type): array
-    {
-        $question_types = [$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(string $question_type, string $category): bool
-    {
-        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(string $category): array
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return [];
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     *
-     * @return array
-     */
-    public function question_types_with_options(): array
-    {
-        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(): array
-    {
-        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(string $system_question_group_id): array
-    {
-        $question_system_ids = [];
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_email_confirm,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = [
-                    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(string $system_question_group_id): array
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                ];
-                break;
-            default:
-                $question_system_ids = [];
-        }
-        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
-     * @throws EE_Error
-     */
-    public function get_Question_ID_from_system_string($QST_system): int
-    {
-        return $this->get_var([['QST_system' => $QST_system]]);
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_latest_question_order(): int
-    {
-        $columns_to_select = [
-            'max_order' => ["MAX(QST_order)", "%d"],
-        ];
-        $max               = $this->_get_all_wpdb_results([], 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(): array
-    {
-        return [
-            'fname'         => 45,
-            'lname'         => 45,
-            'address'       => 255,
-            'address2'      => 255,
-            'city'          => 45,
-            'zip'           => 12,
-            'email'         => 255,
-            'email_confirm' => 255,
-            'phone'         => 45,
-        ];
-    }
-
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     *
-     * @param string $system_question_value
-     * @return int|float
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     */
-    public function absolute_max_for_system_question(string $system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        return isset($maxes[ $system_question_value ]) ?
-            $maxes[ $system_question_value ]
-            : EE_INF;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions(): array
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     *
-     * @return array
-     */
-    public function questionTypesWithMaxLength(): array
-    {
-        return (array)$this->question_types_with_max_length;
-    }
+	// 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 a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// 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 an email input
+	const QST_type_email_confirm = 'EMAIL_CONFIRM';
+
+	// 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 integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	// 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 valid URL
+	const QST_type_url = 'URL';
+
+	// 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 a YEAR
+	const QST_type_year = 'YEAR';
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = [];
+
+
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+	/**
+	 * 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.
+	 *
+	 * @var array   $_question_type_categories {
+	 * @type string $text
+	 * @type string $single                    -answer-enum
+	 * @type string $multi                     -answer-enum
+	 *                    }
+	 */
+	protected $_question_type_categories = [];
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 *
+	 * @var array
+	 */
+	protected $question_types_with_max_length;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item                  = esc_html__('Question', 'event_espresso');
+		$this->plural_item                    = esc_html__('Questions', 'event_espresso');
+		$this->_allowed_question_types        = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
+				EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
+				EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
+				EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
+				EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
+			]
+		);
+		$this->_question_descriptions         = apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__(
+					'Allows multiple preset options to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_country       => esc_html__(
+					'A dropdown that lists countries',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_date          => esc_html__(
+					'A popup calendar that allows date selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_decimal       => esc_html__(
+					'A text field that allows number values with decimals',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_dropdown      => esc_html__(
+					'A dropdown that allows a single selection',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email         => esc_html__(
+					'A text field that must contain a valid Email address',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email_confirm => esc_html__(
+					'A text field that must contain a valid Email address and be equal to Email field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_html_textarea => esc_html__(
+					'A multi line text input field that allows HTML',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_int           => esc_html__(
+					'A text field that only allows whole numbers (no decimals)',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_multi_select  => esc_html__(
+					'A dropdown that allows multiple selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_radio         => esc_html__(
+					'Allows a single preset option to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_state         => esc_html__(
+					'A dropdown that lists states/provinces',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_text          => esc_html__(
+					'A single line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_textarea      => esc_html__(
+					'A multi line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_url           => esc_html__(
+					'A text field that must contain a valid URL',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_us_phone      => esc_html__(
+					'A text field that must contain a valid US phone number',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_year          => esc_html__(
+					'A dropdown that lists the last 100 years',
+					'event_espresso'
+				),
+			]
+		);
+		$this->_question_type_categories      = (array)apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			[
+				'text'               => [
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_email_confirm,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_year,
+				],
+				'single-answer-enum' => [
+					EEM_Question::QST_type_dropdown,
+					EEM_Question::QST_type_radio,
+				],
+				'multi-answer-enum'  => [
+					EEM_Question::QST_type_multi_select,
+					EEM_Question::QST_type_checkbox,
+				],
+			]
+		);
+		$this->question_types_with_max_length = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			[
+				EEM_Question::QST_type_html_textarea,
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+			]
+		);
+
+		$this->_tables          = [
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
+		];
+		$this->_fields          = [
+			'Question' => [
+				'QST_ID'            => new EE_Primary_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso')
+				),
+				'QST_admin_label'   => new EE_Plain_Text_Field(
+					'QST_admin_label',
+					esc_html__('Question Label (admin-only)', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_admin_only'    => new EE_Boolean_Field(
+					'QST_admin_only',
+					esc_html__('Admin-Only Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_deleted'       => new EE_Trashed_Flag_Field(
+					'QST_deleted',
+					esc_html__('Flag Indicating question was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_display_text'  => new EE_Post_Content_Field(
+					'QST_display_text',
+					esc_html__('Question Text', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_max'           => new EE_Infinite_Integer_Field(
+					'QST_max',
+					esc_html__('Max Size', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'QST_order'         => new EE_Integer_Field(
+					'QST_order',
+					esc_html__('Question Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QST_required'      => new EE_Boolean_Field(
+					'QST_required',
+					esc_html__('Required Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_required_text' => new EE_Simple_HTML_Field(
+					'QST_required_text',
+					esc_html__('Text to Display if Not Provided', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_system'        => new EE_Plain_Text_Field(
+					'QST_system',
+					esc_html__('Internal string ID for question', 'event_espresso'),
+					false,
+					''
+				),
+				'QST_type'          => new EE_Enum_Text_Field(
+					'QST_type',
+					esc_html__('Question Type', 'event_espresso'),
+					false,
+					'TEXT',
+					$this->_allowed_question_types
+				),
+				'QST_wp_user'       => new EE_WP_User_Field(
+					'QST_wp_user',
+					esc_html__('Question Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Answer'                  => new EE_Has_Many_Relation(),
+			'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation(),
+			'Question_Option'         => new EE_Has_Many_Relation(),
+			'WP_User'                 => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('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(): array
+	{
+		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(string $question_type): array
+	{
+		$question_types = [$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(string $question_type, string $category): bool
+	{
+		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(string $category): array
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return [];
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 *
+	 * @return array
+	 */
+	public function question_types_with_options(): array
+	{
+		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(): array
+	{
+		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(string $system_question_group_id): array
+	{
+		$question_system_ids = [];
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_email_confirm,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = [
+					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(string $system_question_group_id): array
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				];
+				break;
+			default:
+				$question_system_ids = [];
+		}
+		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
+	 * @throws EE_Error
+	 */
+	public function get_Question_ID_from_system_string($QST_system): int
+	{
+		return $this->get_var([['QST_system' => $QST_system]]);
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_latest_question_order(): int
+	{
+		$columns_to_select = [
+			'max_order' => ["MAX(QST_order)", "%d"],
+		];
+		$max               = $this->_get_all_wpdb_results([], 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(): array
+	{
+		return [
+			'fname'         => 45,
+			'lname'         => 45,
+			'address'       => 255,
+			'address2'      => 255,
+			'city'          => 45,
+			'zip'           => 12,
+			'email'         => 255,
+			'email_confirm' => 255,
+			'phone'         => 45,
+		];
+	}
+
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 *
+	 * @param string $system_question_value
+	 * @return int|float
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 */
+	public function absolute_max_for_system_question(string $system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		return isset($maxes[ $system_question_value ]) ?
+			$maxes[ $system_question_value ]
+			: EE_INF;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions(): array
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 *
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength(): array
+	{
+		return (array)$this->question_types_with_max_length;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -132,7 +132,7 @@ 
                 EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
             ]
         );
-        $this->_question_descriptions         = apply_filters(
+        $this->_question_descriptions = apply_filters(
             'FHEE__EEM_Question__construct__question_descriptions',
             [
                 EEM_Question::QST_type_checkbox      => esc_html__(
@@ -205,7 +205,7 @@ 
                 ),
             ]
         );
-        $this->_question_type_categories      = (array)apply_filters(
+        $this->_question_type_categories = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_type_categories',
             [
                 'text'               => [
@@ -326,13 +326,13 @@ 
             'WP_User'                 => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $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 ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('QST_system');
 
         parent::__construct($timezone);
@@ -380,10 +380,10 @@ 
      */
     public function question_type_is_in_category(string $question_type, string $category): bool
     {
-        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]);
     }
 
 
@@ -395,8 +395,8 @@ 
      */
     public function question_types_in_category(string $category): array
     {
-        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 [];
     }
@@ -560,8 +560,8 @@ 
     public function absolute_max_for_system_question(string $system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        return isset($maxes[ $system_question_value ]) ?
-            $maxes[ $system_question_value ]
+        return isset($maxes[$system_question_value]) ?
+            $maxes[$system_question_value]
             : EE_INF;
     }
 
@@ -582,6 +582,6 @@ 
      */
     public function questionTypesWithMaxLength(): array
     {
-        return (array)$this->question_types_with_max_length;
+        return (array) $this->question_types_with_max_length;
     }
 }

core/db_models/EEM_Event_Question_Group.model.php

Indentation +100 added lines, -100 removed lines

@@ -15,113 +15,113 @@
 class EEM_Event_Question_Group extends EEM_Base
 {
 
-    /**
-     * Name of the field indicating an event should use the question group for the primary attendee
-     */
-    const PRIMARY = 'EQG_primary';
+	/**
+	 * Name of the field indicating an event should use the question group for the primary attendee
+	 */
+	const PRIMARY = 'EQG_primary';
 
-    /**
-     * Name of hte field indicating an event should use the question group for additional attendees
-     */
-    const ADDITIONAL = 'EQG_additional';
+	/**
+	 * Name of hte field indicating an event should use the question group for additional attendees
+	 */
+	const ADDITIONAL = 'EQG_additional';
 
-    // private instance of the Event_Question_Group object
-    protected static $_instance = null;
+	// private instance of the Event_Question_Group object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = __('Event to Question Group Link', 'event_espresso');
-        $this->plural_item      = __('Event to Question Group Links', 'event_espresso');
-        $this->_tables          = [
-            'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
-        ];
-        $this->_fields          = [
-            'Event_Question_Group' => [
-                'EQG_ID'         => new EE_Primary_Key_Int_Field(
-                    'EQG_ID',
-                    __('Event to Question Group Link ID', 'event_espresso')
-                ),
-                'EVT_ID'         => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    __('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'QSG_ID'         => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    __('Question Group Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'EQG_additional' => new EE_Boolean_Field(
-                    'EQG_additional',
-                    __(
-                        'Flag indicating question is only for additional attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'EQG_primary'    => new EE_Boolean_Field(
-                    'EQG_primary',
-                    __(
-                        'Flag indicating question is only for primary attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'          => new EE_Belongs_To_Relation(),
-            'Question_Group' => new EE_Belongs_To_Relation(),
-        ];
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = __('Event to Question Group Link', 'event_espresso');
+		$this->plural_item      = __('Event to Question Group Links', 'event_espresso');
+		$this->_tables          = [
+			'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
+		];
+		$this->_fields          = [
+			'Event_Question_Group' => [
+				'EQG_ID'         => new EE_Primary_Key_Int_Field(
+					'EQG_ID',
+					__('Event to Question Group Link ID', 'event_espresso')
+				),
+				'EVT_ID'         => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'QSG_ID'         => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					__('Question Group Id', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'EQG_additional' => new EE_Boolean_Field(
+					'EQG_additional',
+					__(
+						'Flag indicating question is only for additional attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'EQG_primary'    => new EE_Boolean_Field(
+					'EQG_primary',
+					__(
+						'Flag indicating question is only for primary attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'          => new EE_Belongs_To_Relation(),
+			'Question_Group' => new EE_Belongs_To_Relation(),
+		];
 
-        // this model is generally available for reading
-        $path_to_event = 'Event';
+		// this model is generally available for reading
+		$path_to_event = 'Event';
 
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
-     * this is concerning primary attendees or additional attendees.
-     * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
-     * EQG_additional.
-     *
-     * @param string|boolean|int $context
-     * @return string
-     * @since 4.10.0.p
-     */
-    public function fieldNameForContext($context): string
-    {
-        // Basically do a strict switch statement.
-        switch (true) {
-            case $context === 'additional':
-            case $context === false:
-            case $context === 0:
-                $field_name = EEM_Event_Question_Group::ADDITIONAL;
-                break;
-            case $context === 'primary':
-            case $context === true:
-            case $context === 1:
-            default:
-                $field_name = EEM_Event_Question_Group::PRIMARY;
-        }
-        return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
-    }
+	/**
+	 * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
+	 * this is concerning primary attendees or additional attendees.
+	 * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
+	 * EQG_additional.
+	 *
+	 * @param string|boolean|int $context
+	 * @return string
+	 * @since 4.10.0.p
+	 */
+	public function fieldNameForContext($context): string
+	{
+		// Basically do a strict switch statement.
+		switch (true) {
+			case $context === 'additional':
+			case $context === false:
+			case $context === 0:
+				$field_name = EEM_Event_Question_Group::ADDITIONAL;
+				break;
+			case $context === 'primary':
+			case $context === true:
+			case $context === 1:
+			default:
+				$field_name = EEM_Event_Question_Group::PRIMARY;
+		}
+		return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
+	}
 }

core/db_models/EEM_Question_Option.model.php

Indentation +69 added lines, -69 removed lines

@@ -10,79 +10,79 @@
 class EEM_Question_Option extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Question Option', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Options', 'event_espresso');
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Question Option', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Options', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Option' => [
-                'QSO_ID'      => new EE_Primary_Key_Int_Field(
-                    'QSO_ID', esc_html__('Question Option ID', 'event_espresso')
-                ),
-                'QST_ID'      => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QSO_deleted' => new EE_Trashed_Flag_Field(
-                    'QSO_deleted',
-                    esc_html__('Flag indicating Option was trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_desc'    => new EE_Post_Content_Field(
-                    'QSO_desc',
-                    esc_html__('Question Option Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSO_order'   => new EE_Integer_Field(
-                    'QSO_order',
-                    esc_html__('Question Option Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QSO_system'  => new EE_Plain_Text_Field(
-                    'QSO_system',
-                    esc_html__('Internal string ID for question option', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'QSO_value'   => new EE_Plain_Text_Field(
-                    'QSO_value',
-                    esc_html__("Question Option Value", "event_espresso"),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question' => new EE_Belongs_To_Relation(),
-        ];
+		$this->_tables          = [
+			'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
+		];
+		$this->_fields          = [
+			'Question_Option' => [
+				'QSO_ID'      => new EE_Primary_Key_Int_Field(
+					'QSO_ID', esc_html__('Question Option ID', 'event_espresso')
+				),
+				'QST_ID'      => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QSO_deleted' => new EE_Trashed_Flag_Field(
+					'QSO_deleted',
+					esc_html__('Flag indicating Option was trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_desc'    => new EE_Post_Content_Field(
+					'QSO_desc',
+					esc_html__('Question Option Description', 'event_espresso'),
+					false,
+					''
+				),
+				'QSO_order'   => new EE_Integer_Field(
+					'QSO_order',
+					esc_html__('Question Option Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QSO_system'  => new EE_Plain_Text_Field(
+					'QSO_system',
+					esc_html__('Internal string ID for question option', 'event_espresso'),
+					true,
+					null
+				),
+				'QSO_value'   => new EE_Plain_Text_Field(
+					'QSO_value',
+					esc_html__("Question Option Value", "event_espresso"),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question' => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_caps_slug              = 'questions';
-        $this->_model_chain_to_wp_user = 'Question';
+		$this->_caps_slug              = 'questions';
+		$this->_model_chain_to_wp_user = 'Question';
 
-        // 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('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
+		// 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('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Question_Group.model.php

Indentation +124 added lines, -124 removed lines

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

core/db_models/strategies/EE_Restriction_Generator_Base.strategy.php

Indentation +208 added lines, -208 removed lines

@@ -42,236 +42,236 @@
 abstract class EE_Restriction_Generator_Base
 {
 
-    /**
-     * One of EEM_Base::valid_cap_contexts()
-     *
-     * @var string
-     */
-    protected $_action;
+	/**
+	 * One of EEM_Base::valid_cap_contexts()
+	 *
+	 * @var string
+	 */
+	protected $_action;
 
-    /**
-     * The restrictions generated by this object. FALSE before any are made.
-     *
-     * @var EE_Default_Where_Conditions[]
-     */
-    protected $_cap_restrictions_generated = false;
+	/**
+	 * The restrictions generated by this object. FALSE before any are made.
+	 *
+	 * @var EE_Default_Where_Conditions[]
+	 */
+	protected $_cap_restrictions_generated = false;
 
-    /**
-     * Model for which restrictions are generated
-     *
-     * @var EEM_Base
-     */
-    protected $_model;
+	/**
+	 * Model for which restrictions are generated
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_model;
 
 
-    /**
-     * Puts the last necessary info onto the restriction generator class. This is usually
-     * called by EEM_Base during its constructor, so child classes don't have to
-     * always provide this info.
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     */
-    public function _construct_finalize(EEM_Base $model, string $action)
-    {
-        $this->_model  = $model;
-        $this->_action = $action;
-    }
+	/**
+	 * Puts the last necessary info onto the restriction generator class. This is usually
+	 * called by EEM_Base during its constructor, so child classes don't have to
+	 * always provide this info.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 */
+	public function _construct_finalize(EEM_Base $model, string $action)
+	{
+		$this->_model  = $model;
+		$this->_action = $action;
+	}
 
 
-    /**
-     * Returns the model set for this restriction generator
-     *
-     * @return EEM_Base | EEM_Soft_Delete_Base
-     * @throws EE_Error
-     */
-    public function model()
-    {
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_model;
-    }
+	/**
+	 * Returns the model set for this restriction generator
+	 *
+	 * @return EEM_Base | EEM_Soft_Delete_Base
+	 * @throws EE_Error
+	 */
+	public function model()
+	{
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_model;
+	}
 
 
-    /**
-     * Returns the action this restriction generator will generate restrictions for.
-     * It should be one of EEM_Base::valid_cap_contexts()
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function action(): string
-    {
-        if (! $this->_action) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_action;
-    }
+	/**
+	 * Returns the action this restriction generator will generate restrictions for.
+	 * It should be one of EEM_Base::valid_cap_contexts()
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function action(): string
+	{
+		if (! $this->_action) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_action;
+	}
 
 
-    /**
-     * Returns whether or not _construct_finalize() has been called on this restriction generator object
-     *
-     * @return boolean
-     */
-    public function construction_finalized(): bool
-    {
-        return $this->_model instanceof EEM_Base && $this->_action;
-    }
+	/**
+	 * Returns whether or not _construct_finalize() has been called on this restriction generator object
+	 *
+	 * @return boolean
+	 */
+	public function construction_finalized(): bool
+	{
+		return $this->_model instanceof EEM_Base && $this->_action;
+	}
 
 
-    /**
-     * Gets the capability restrictions generated by this object. Caches them in
-     * case they are required for subsequent requests
-     *
-     * @return array @see EEM_Base::_cap_restrictions
-     */
-    public function generate_restrictions(): array
-    {
-        if ($this->_cap_restrictions_generated === false) {
-            $this->_cap_restrictions_generated =
-                apply_filters(
-                    'FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time',
-                    $this->_generate_restrictions(),
-                    $this
-                );
-        }
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time',
-            $this->_cap_restrictions_generated,
-            $this
-        );
-    }
+	/**
+	 * Gets the capability restrictions generated by this object. Caches them in
+	 * case they are required for subsequent requests
+	 *
+	 * @return array @see EEM_Base::_cap_restrictions
+	 */
+	public function generate_restrictions(): array
+	{
+		if ($this->_cap_restrictions_generated === false) {
+			$this->_cap_restrictions_generated =
+				apply_filters(
+					'FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time',
+					$this->_generate_restrictions(),
+					$this
+				);
+		}
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time',
+			$this->_cap_restrictions_generated,
+			$this
+		);
+	}
 
 
-    /**
-     * Provided with the model, and using global knowledge about what capabilities exist,
-     * generates an array for use in one of the sub-arrays in EEM_Base::_cap_restrictions,
-     * where keys are capability names, and values are children of EE_Default_Where_Conditions
-     *
-     * @return array @see EEM_Base::_cap_restrictions
-     */
-    abstract protected function _generate_restrictions(): array;
+	/**
+	 * Provided with the model, and using global knowledge about what capabilities exist,
+	 * generates an array for use in one of the sub-arrays in EEM_Base::_cap_restrictions,
+	 * where keys are capability names, and values are children of EE_Default_Where_Conditions
+	 *
+	 * @return array @see EEM_Base::_cap_restrictions
+	 */
+	abstract protected function _generate_restrictions(): array;
 
 
-    /**
-     * Whether or not this restriction generator has already done its job of
-     * making restrictions and caching them on itself in case its asked later
-     *
-     * @return boolean
-     */
-    public function has_generated_cap_restrictions(): bool
-    {
-        return $this->_cap_restrictions_generated === false;
-    }
+	/**
+	 * Whether or not this restriction generator has already done its job of
+	 * making restrictions and caching them on itself in case its asked later
+	 *
+	 * @return boolean
+	 */
+	public function has_generated_cap_restrictions(): bool
+	{
+		return $this->_cap_restrictions_generated === false;
+	}
 
 
-    /**
-     * Given an action like 'edit' generates the cap name based off
-     * the EEM_Base::_cap_slug, which for events would be 'events', to generate the
-     * cap name like 'ee_edit_events'.
-     * If a $qualifier is passed,
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return string
-     */
-    public static function get_cap_name(EEM_Base $model, string $action): string
-    {
-        $prefix = $model->is_wp_core_model() ? '' : 'ee_';
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator__get_cap_name',
-            "{$prefix}{$action}_{$model->cap_slug()}",
-            $model,
-            $action
-        );
-    }
+	/**
+	 * Given an action like 'edit' generates the cap name based off
+	 * the EEM_Base::_cap_slug, which for events would be 'events', to generate the
+	 * cap name like 'ee_edit_events'.
+	 * If a $qualifier is passed,
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return string
+	 */
+	public static function get_cap_name(EEM_Base $model, string $action): string
+	{
+		$prefix = $model->is_wp_core_model() ? '' : 'ee_';
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator__get_cap_name',
+			"{$prefix}{$action}_{$model->cap_slug()}",
+			$model,
+			$action
+		);
+	}
 
 
-    /**
-     * Checks if there is a cap for this model and this action
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return boolean
-     * @throws EE_Error
-     */
-    public static function is_cap(EEM_Base $model, string $action): bool
-    {
-        $caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities();
-        return in_array(self::get_cap_name($model, $action), $caps_for_admin);
-    }
+	/**
+	 * Checks if there is a cap for this model and this action
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public static function is_cap(EEM_Base $model, string $action): bool
+	{
+		$caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities();
+		return in_array(self::get_cap_name($model, $action), $caps_for_admin);
+	}
 
 
-    /**
-     * Returns the default capability used to determine if the current user can
-     * access something.
-     *
-     * @return string
-     */
-    public static function get_default_restrictions_cap(): string
-    {
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator_Base__default_restrictions_cap',
-            'manage_options'
-        );
-    }
+	/**
+	 * Returns the default capability used to determine if the current user can
+	 * access something.
+	 *
+	 * @return string
+	 */
+	public static function get_default_restrictions_cap(): string
+	{
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator_Base__default_restrictions_cap',
+			'manage_options'
+		);
+	}
 
 
-    /**
-     * Gets WHERE conditions for the query that show the post model is published,
-     * or that it's sold out and it was previously published
-     *
-     * @param array   $where_conditions
-     * @param boolean $check_if_published  if true, will add conditions like status=publish
-     *                                     if false, will add conditions like status!=private
-     * @param string  $path_to_event_model including the period at the end
-     * @return array
-     * @throws EE_Error
-     */
-    protected function addPublishedPostConditions(
-        $where_conditions = [],
-        $check_if_published = true,
-        $path_to_event_model = ''
-    ): array {
-        if ($check_if_published) {
-            $published_value = 'publish';
-        } else {
-            $published_value = ['!=', 'private'];
-        }
-        // only add a check for the previous event status
-        // if the model is the event or it's related to the event model
-        if (
-            $this->model() instanceof EEM_Event
-            || strpos($path_to_event_model, 'Event') !== false
-        ) {
-            $where_conditions['OR*status'] = [
-                $path_to_event_model . 'status' => $published_value,
-                'AND'                           => [
-                    $path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
-                    $path_to_event_model . 'Post_Meta.meta_value' => $published_value,
-                ],
-            ];
-        } else {
-            $where_conditions[ $path_to_event_model . 'status' ] = $published_value;
-        }
-        return $where_conditions;
-    }
+	/**
+	 * Gets WHERE conditions for the query that show the post model is published,
+	 * or that it's sold out and it was previously published
+	 *
+	 * @param array   $where_conditions
+	 * @param boolean $check_if_published  if true, will add conditions like status=publish
+	 *                                     if false, will add conditions like status!=private
+	 * @param string  $path_to_event_model including the period at the end
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function addPublishedPostConditions(
+		$where_conditions = [],
+		$check_if_published = true,
+		$path_to_event_model = ''
+	): array {
+		if ($check_if_published) {
+			$published_value = 'publish';
+		} else {
+			$published_value = ['!=', 'private'];
+		}
+		// only add a check for the previous event status
+		// if the model is the event or it's related to the event model
+		if (
+			$this->model() instanceof EEM_Event
+			|| strpos($path_to_event_model, 'Event') !== false
+		) {
+			$where_conditions['OR*status'] = [
+				$path_to_event_model . 'status' => $published_value,
+				'AND'                           => [
+					$path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
+					$path_to_event_model . 'Post_Meta.meta_value' => $published_value,
+				],
+			];
+		} else {
+			$where_conditions[ $path_to_event_model . 'status' ] = $published_value;
+		}
+		return $where_conditions;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -87,7 +87,7 @@ 
      */
     public function model()
     {
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -111,7 +111,7 @@ 
      */
     public function action(): string
     {
-        if (! $this->_action) {
+        if ( ! $this->_action) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -263,14 +263,14 @@ 
             || strpos($path_to_event_model, 'Event') !== false
         ) {
             $where_conditions['OR*status'] = [
-                $path_to_event_model . 'status' => $published_value,
+                $path_to_event_model.'status' => $published_value,
                 'AND'                           => [
-                    $path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
-                    $path_to_event_model . 'Post_Meta.meta_value' => $published_value,
+                    $path_to_event_model.'Post_Meta.meta_key'   => '_previous_event_status',
+                    $path_to_event_model.'Post_Meta.meta_value' => $published_value,
                 ],
             ];
         } else {
-            $where_conditions[ $path_to_event_model . 'status' ] = $published_value;
+            $where_conditions[$path_to_event_model.'status'] = $published_value;
         }
         return $where_conditions;
     }