eventespresso / event-espresso-core

core/db_classes/EE_Payment.class.php

Doc Comments +3 added lines, -3 removed lines

@@ -13,7 +13,7 @@ 
      * @param array  $props_n_values          incoming values
      * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
      *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
+     * @param string[]  $date_formats            incoming date_formats in an array where the first value is the
      *                                        date_format and the second value is the time format
      * @return EE_Payment
      * @throws \EE_Error
@@ -588,7 +588,7 @@ 
      * Gets all the extra meta info on this payment
      *
      * @param array $query_params like EEM_Base::get_all
-     * @return EE_Extra_Meta
+     * @return EE_Base_Class[]
      * @throws \EE_Error
      */
     public function extra_meta($query_params = array())
@@ -836,7 +836,7 @@ 
     /**
      * Returns the payment's transaction's primary registration
      *
-     * @return EE_Registration|null
+     * @return EE_Base_Class|null
      */
     public function get_primary_registration()
     {

Indentation +851 added lines, -851 removed lines

@@ -9,855 +9,855 @@
 class EE_Payment extends EE_Base_Class implements EEI_Payment
 {
 
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Set Transaction ID
-     *
-     * @access public
-     * @param int $TXN_ID
-     * @throws \EE_Error
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets the transaction related to this payment
-     *
-     * @return EE_Transaction
-     * @throws \EE_Error
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-    /**
-     * Set Status
-     *
-     * @access public
-     * @param string $STS_ID
-     * @throws \EE_Error
-     */
-    public function set_status($STS_ID = '')
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Set Payment Timestamp
-     *
-     * @access public
-     * @param int $timestamp
-     * @throws \EE_Error
-     */
-    public function set_timestamp($timestamp = 0)
-    {
-        $this->set('PAY_timestamp', $timestamp);
-    }
-
-
-    /**
-     * Set Payment Method
-     *
-     * @access public
-     * @param string $PAY_source
-     * @throws \EE_Error
-     */
-    public function set_source($PAY_source = '')
-    {
-        $this->set('PAY_source', $PAY_source);
-    }
-
-
-    /**
-     * Set Payment Amount
-     *
-     * @access public
-     * @param float $amount
-     * @throws \EE_Error
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PAY_amount', (float) $amount);
-    }
-
-
-    /**
-     * Set Payment Gateway Response
-     *
-     * @access public
-     * @param string $gateway_response
-     * @throws \EE_Error
-     */
-    public function set_gateway_response($gateway_response = '')
-    {
-        $this->set('PAY_gateway_response', $gateway_response);
-    }
-
-
-    /**
-     * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
-     * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
-     * used on it
-     *
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public function gateway()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment::gateway',
-            __(
-                'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-        return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
-    }
-
-
-    /**
-     * Set Gateway Transaction ID
-     *
-     * @access public
-     * @param string $txn_id_chq_nmbr
-     * @throws \EE_Error
-     */
-    public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
-    {
-        $this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
-    }
-
-
-    /**
-     * Set Purchase Order Number
-     *
-     * @access public
-     * @param string $po_number
-     * @throws \EE_Error
-     */
-    public function set_po_number($po_number = '')
-    {
-        $this->set('PAY_po_number', $po_number);
-    }
-
-
-    /**
-     * Set Extra Accounting Field
-     *
-     * @access public
-     * @param string $extra_accntng
-     * @throws \EE_Error
-     */
-    public function set_extra_accntng($extra_accntng = '')
-    {
-        $this->set('PAY_extra_accntng', $extra_accntng);
-    }
-
-
-    /**
-     * Set Payment made via admin flag
-     *
-     * @access public
-     * @param bool $via_admin
-     * @throws \EE_Error
-     */
-    public function set_payment_made_via_admin($via_admin = false)
-    {
-        if ($via_admin) {
-            $this->set('PAY_source', EEM_Payment_Method::scope_admin);
-        } else {
-            $this->set('PAY_source', EEM_Payment_Method::scope_cart);
-        }
-    }
-
-
-    /**
-     * Set Payment Details
-     *
-     * @access public
-     * @param string|array $details
-     * @throws \EE_Error
-     */
-    public function set_details($details = '')
-    {
-        if (is_array($details)) {
-            array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $details = wp_strip_all_tags($details);
-        }
-        $this->set('PAY_details', $details);
-    }
-
-
-    /**
-     * Sets redirect_url
-     *
-     * @param string $redirect_url
-     * @throws \EE_Error
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->set('PAY_redirect_url', $redirect_url);
-    }
-
-
-    /**
-     * Sets redirect_args
-     *
-     * @param array $redirect_args
-     * @throws \EE_Error
-     */
-    public function set_redirect_args($redirect_args)
-    {
-        $this->set('PAY_redirect_args', $redirect_args);
-    }
-
-
-    /**
-     * get Payment Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function status()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Timestamp
-     *
-     * @access public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
-    public function timestamp($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
-    }
-
-
-    /**
-     * get Payment Source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function source()
-    {
-        return $this->get('PAY_source');
-    }
-
-
-    /**
-     * get Payment Amount
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function amount()
-    {
-        return (float) $this->get('PAY_amount');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function amount_no_code()
-    {
-        return $this->get_pretty('PAY_amount', 'no_currency_code');
-    }
-
-
-    /**
-     * get Payment Gateway Response
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function gateway_response()
-    {
-        return $this->get('PAY_gateway_response');
-    }
-
-
-    /**
-     * get Payment Gateway Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function txn_id_chq_nmbr()
-    {
-        return $this->get('PAY_txn_id_chq_nmbr');
-    }
-
-
-    /**
-     * get Purchase Order Number
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function po_number()
-    {
-        return $this->get('PAY_po_number');
-    }
-
-
-    /**
-     * get Extra Accounting Field
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function extra_accntng()
-    {
-        return $this->get('PAY_extra_accntng');
-    }
-
-
-    /**
-     * get Payment made via admin source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function payment_made_via_admin()
-    {
-        return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
-    }
-
-
-    /**
-     * get Payment Details
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function details()
-    {
-        return $this->get('PAY_details');
-    }
-
-
-    /**
-     * Gets redirect_url
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_url()
-    {
-        return $this->get('PAY_redirect_url');
-    }
-
-
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function redirect_args()
-    {
-        return $this->get('PAY_redirect_args');
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws \EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->STS_ID() => __('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->STS_ID()) {
-            case EEM_Payment::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_pending:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->STS_ID() ];
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is approved or not
-     * @throws \EE_Error
-     */
-    public function is_approved()
-    {
-        return $this->status_is(EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * Generally determines if the status of this payment equals
-     * the $STS_ID string
-     *
-     * @param string $STS_ID an ID from the esp_status table/
-     *                       one of the status_id_* on the EEM_Payment model
-     * @return boolean whether the status of this payment equals the status id
-     * @throws \EE_Error
-     */
-    protected function status_is($STS_ID)
-    {
-        return $STS_ID === $this->STS_ID() ? true : false;
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is pending or not
-     * @throws \EE_Error
-     */
-    public function is_pending()
-    {
-        return $this->status_is(EEM_Payment::status_id_pending);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_cancelled()
-    {
-        return $this->status_is(EEM_Payment::status_id_cancelled);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_declined()
-    {
-        return $this->status_is(EEM_Payment::status_id_declined);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_failed()
-    {
-        return $this->status_is(EEM_Payment::status_id_failed);
-    }
-
-
-    /**
-     * For determining if the payment is actually a refund ( ie: has a negative value )
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_a_refund()
-    {
-        return $this->amount() < 0 ? true : false;
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws \EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Extra_Meta
-     * @throws \EE_Error
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function payment_method()
-    {
-        return $this->get_first_related('Payment_Method');
-    }
-
-
-    /**
-     * Gets the HTML for redirecting the user to an offsite gateway
-     * You can pass it special content to put inside the form, or use
-     * the default inner content (or possibly generate this all yourself using
-     * redirect_url() and redirect_args() or redirect_args_as_inputs()).
-     * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
-     * (and any querystring variables in the redirect_url are converted into html inputs
-     * so browsers submit them properly)
-     *
-     * @param string $inside_form_html
-     * @return string html
-     * @throws \EE_Error
-     */
-    public function redirect_form($inside_form_html = null)
-    {
-        $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
-            // what ? no inner form content?
-            if ($inside_form_html === null) {
-                $inside_form_html = EEH_HTML::p(
-                    sprintf(
-                        __(
-                            'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
-                            'event_espresso'
-                        ),
-                        EEH_HTML::br(2),
-                        '<input type="submit" value="',
-                        '">'
-                    ),
-                    '',
-                    '',
-                    'text-align:center;'
-                );
-            }
-            $method = apply_filters(
-                'FHEE__EE_Payment__redirect_form__method',
-                $this->redirect_args() ? 'POST' : 'GET',
-                $this
-            );
-            // if it's a GET request, we need to remove all the GET params in the querystring
-            // and put them into the form instead
-            if ($method === 'GET') {
-                $querystring = parse_url($redirect_url, PHP_URL_QUERY);
-                $get_params = null;
-                parse_str($querystring, $get_params);
-                $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
-            }
-            $form = EEH_HTML::nl(1)
-                    . '<form method="'
-                    . $method
-                    . '" name="gateway_form" action="'
-                    . $redirect_url
-                    . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
-            $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
-            return $form;
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Changes all the name-value pairs of the redirect args into html inputs
-     * and returns the html as a string
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_args_as_inputs()
-    {
-        return $this->_args_as_inputs($this->redirect_args());
-    }
-
-
-    /**
-     * Converts a 1d array of key-value pairs into html hidden inputs
-     * and returns the string of html
-     *
-     * @param array $args key-value pairs
-     * @return string
-     */
-    protected function _args_as_inputs($args)
-    {
-        $html = '';
-        if ($args !== null && is_array($args)) {
-            foreach ($args as $name => $value) {
-                $html .= EEH_HTML::nl(0)
-                         . '<input type="hidden" name="'
-                         . $name
-                         . '" value="'
-                         . esc_attr($value)
-                         . '"/>';
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * Returns the currency of the payment.
-     * (At the time of writing, this will always be the currency in the configuration;
-     * however in the future it is anticipated that this will be stored on the payment
-     * object itself)
-     *
-     * @return string for the currency code
-     */
-    public function currency_code()
-    {
-        return EE_Config::instance()->currency->code;
-    }
-
-
-    /**
-     * apply wp_strip_all_tags to all elements within an array
-     *
-     * @access private
-     * @param mixed $item
-     */
-    private function _strip_all_tags_within_array(&$item)
-    {
-        if (is_object($item)) {
-            $item = (array) $item;
-        }
-        if (is_array($item)) {
-            array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $item = wp_strip_all_tags($item);
-        }
-    }
-
-
-    /**
-     * Returns TRUE is this payment was set to approved during this request (or
-     * is approved and was created during this request). False otherwise.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function just_approved()
-    {
-        $original_status = EEH_Array::is_set(
-            $this->_props_n_values_provided_in_constructor,
-            'STS_ID',
-            $this->get_model()->field_settings_for('STS_ID')->get_default_value()
-        );
-        $current_status = $this->status();
-        if ($original_status !== EEM_Payment::status_id_approved
-            && $current_status === EEM_Payment::status_id_approved
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parents' get_pretty() function just for legacy reasons
-     * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        if ($field_name === 'PAY_gateway') {
-            return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
-        }
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * Gets details regarding which registrations this payment was applied to
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     *
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if ($primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Set Transaction ID
+	 *
+	 * @access public
+	 * @param int $TXN_ID
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets the transaction related to this payment
+	 *
+	 * @return EE_Transaction
+	 * @throws \EE_Error
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+	/**
+	 * Set Status
+	 *
+	 * @access public
+	 * @param string $STS_ID
+	 * @throws \EE_Error
+	 */
+	public function set_status($STS_ID = '')
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Set Payment Timestamp
+	 *
+	 * @access public
+	 * @param int $timestamp
+	 * @throws \EE_Error
+	 */
+	public function set_timestamp($timestamp = 0)
+	{
+		$this->set('PAY_timestamp', $timestamp);
+	}
+
+
+	/**
+	 * Set Payment Method
+	 *
+	 * @access public
+	 * @param string $PAY_source
+	 * @throws \EE_Error
+	 */
+	public function set_source($PAY_source = '')
+	{
+		$this->set('PAY_source', $PAY_source);
+	}
+
+
+	/**
+	 * Set Payment Amount
+	 *
+	 * @access public
+	 * @param float $amount
+	 * @throws \EE_Error
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PAY_amount', (float) $amount);
+	}
+
+
+	/**
+	 * Set Payment Gateway Response
+	 *
+	 * @access public
+	 * @param string $gateway_response
+	 * @throws \EE_Error
+	 */
+	public function set_gateway_response($gateway_response = '')
+	{
+		$this->set('PAY_gateway_response', $gateway_response);
+	}
+
+
+	/**
+	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
+	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
+	 * used on it
+	 *
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function gateway()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment::gateway',
+			__(
+				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+		return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
+	}
+
+
+	/**
+	 * Set Gateway Transaction ID
+	 *
+	 * @access public
+	 * @param string $txn_id_chq_nmbr
+	 * @throws \EE_Error
+	 */
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
+	{
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
+	}
+
+
+	/**
+	 * Set Purchase Order Number
+	 *
+	 * @access public
+	 * @param string $po_number
+	 * @throws \EE_Error
+	 */
+	public function set_po_number($po_number = '')
+	{
+		$this->set('PAY_po_number', $po_number);
+	}
+
+
+	/**
+	 * Set Extra Accounting Field
+	 *
+	 * @access public
+	 * @param string $extra_accntng
+	 * @throws \EE_Error
+	 */
+	public function set_extra_accntng($extra_accntng = '')
+	{
+		$this->set('PAY_extra_accntng', $extra_accntng);
+	}
+
+
+	/**
+	 * Set Payment made via admin flag
+	 *
+	 * @access public
+	 * @param bool $via_admin
+	 * @throws \EE_Error
+	 */
+	public function set_payment_made_via_admin($via_admin = false)
+	{
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
+		} else {
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
+		}
+	}
+
+
+	/**
+	 * Set Payment Details
+	 *
+	 * @access public
+	 * @param string|array $details
+	 * @throws \EE_Error
+	 */
+	public function set_details($details = '')
+	{
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$details = wp_strip_all_tags($details);
+		}
+		$this->set('PAY_details', $details);
+	}
+
+
+	/**
+	 * Sets redirect_url
+	 *
+	 * @param string $redirect_url
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->set('PAY_redirect_url', $redirect_url);
+	}
+
+
+	/**
+	 * Sets redirect_args
+	 *
+	 * @param array $redirect_args
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_args($redirect_args)
+	{
+		$this->set('PAY_redirect_args', $redirect_args);
+	}
+
+
+	/**
+	 * get Payment Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Timestamp
+	 *
+	 * @access public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function timestamp($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+	}
+
+
+	/**
+	 * get Payment Source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function source()
+	{
+		return $this->get('PAY_source');
+	}
+
+
+	/**
+	 * get Payment Amount
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function amount()
+	{
+		return (float) $this->get('PAY_amount');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function amount_no_code()
+	{
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
+	}
+
+
+	/**
+	 * get Payment Gateway Response
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function gateway_response()
+	{
+		return $this->get('PAY_gateway_response');
+	}
+
+
+	/**
+	 * get Payment Gateway Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function txn_id_chq_nmbr()
+	{
+		return $this->get('PAY_txn_id_chq_nmbr');
+	}
+
+
+	/**
+	 * get Purchase Order Number
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function po_number()
+	{
+		return $this->get('PAY_po_number');
+	}
+
+
+	/**
+	 * get Extra Accounting Field
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function extra_accntng()
+	{
+		return $this->get('PAY_extra_accntng');
+	}
+
+
+	/**
+	 * get Payment made via admin source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function payment_made_via_admin()
+	{
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
+	}
+
+
+	/**
+	 * get Payment Details
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function details()
+	{
+		return $this->get('PAY_details');
+	}
+
+
+	/**
+	 * Gets redirect_url
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_url()
+	{
+		return $this->get('PAY_redirect_url');
+	}
+
+
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function redirect_args()
+	{
+		return $this->get('PAY_redirect_args');
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->STS_ID() => __('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->STS_ID()) {
+			case EEM_Payment::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_pending:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->STS_ID() ];
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is approved or not
+	 * @throws \EE_Error
+	 */
+	public function is_approved()
+	{
+		return $this->status_is(EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * Generally determines if the status of this payment equals
+	 * the $STS_ID string
+	 *
+	 * @param string $STS_ID an ID from the esp_status table/
+	 *                       one of the status_id_* on the EEM_Payment model
+	 * @return boolean whether the status of this payment equals the status id
+	 * @throws \EE_Error
+	 */
+	protected function status_is($STS_ID)
+	{
+		return $STS_ID === $this->STS_ID() ? true : false;
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is pending or not
+	 * @throws \EE_Error
+	 */
+	public function is_pending()
+	{
+		return $this->status_is(EEM_Payment::status_id_pending);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_is(EEM_Payment::status_id_cancelled);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_declined()
+	{
+		return $this->status_is(EEM_Payment::status_id_declined);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_failed()
+	{
+		return $this->status_is(EEM_Payment::status_id_failed);
+	}
+
+
+	/**
+	 * For determining if the payment is actually a refund ( ie: has a negative value )
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_a_refund()
+	{
+		return $this->amount() < 0 ? true : false;
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws \EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Extra_Meta
+	 * @throws \EE_Error
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function payment_method()
+	{
+		return $this->get_first_related('Payment_Method');
+	}
+
+
+	/**
+	 * Gets the HTML for redirecting the user to an offsite gateway
+	 * You can pass it special content to put inside the form, or use
+	 * the default inner content (or possibly generate this all yourself using
+	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
+	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
+	 * (and any querystring variables in the redirect_url are converted into html inputs
+	 * so browsers submit them properly)
+	 *
+	 * @param string $inside_form_html
+	 * @return string html
+	 * @throws \EE_Error
+	 */
+	public function redirect_form($inside_form_html = null)
+	{
+		$redirect_url = $this->redirect_url();
+		if (! empty($redirect_url)) {
+			// what ? no inner form content?
+			if ($inside_form_html === null) {
+				$inside_form_html = EEH_HTML::p(
+					sprintf(
+						__(
+							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
+							'event_espresso'
+						),
+						EEH_HTML::br(2),
+						'<input type="submit" value="',
+						'">'
+					),
+					'',
+					'',
+					'text-align:center;'
+				);
+			}
+			$method = apply_filters(
+				'FHEE__EE_Payment__redirect_form__method',
+				$this->redirect_args() ? 'POST' : 'GET',
+				$this
+			);
+			// if it's a GET request, we need to remove all the GET params in the querystring
+			// and put them into the form instead
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
+				$get_params = null;
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+			}
+			$form = EEH_HTML::nl(1)
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
+			$form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+			$form .= $inside_form_html;
+			$form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+			return $form;
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Changes all the name-value pairs of the redirect args into html inputs
+	 * and returns the html as a string
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_args_as_inputs()
+	{
+		return $this->_args_as_inputs($this->redirect_args());
+	}
+
+
+	/**
+	 * Converts a 1d array of key-value pairs into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param array $args key-value pairs
+	 * @return string
+	 */
+	protected function _args_as_inputs($args)
+	{
+		$html = '';
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= EEH_HTML::nl(0)
+						 . '<input type="hidden" name="'
+						 . $name
+						 . '" value="'
+						 . esc_attr($value)
+						 . '"/>';
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * Returns the currency of the payment.
+	 * (At the time of writing, this will always be the currency in the configuration;
+	 * however in the future it is anticipated that this will be stored on the payment
+	 * object itself)
+	 *
+	 * @return string for the currency code
+	 */
+	public function currency_code()
+	{
+		return EE_Config::instance()->currency->code;
+	}
+
+
+	/**
+	 * apply wp_strip_all_tags to all elements within an array
+	 *
+	 * @access private
+	 * @param mixed $item
+	 */
+	private function _strip_all_tags_within_array(&$item)
+	{
+		if (is_object($item)) {
+			$item = (array) $item;
+		}
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$item = wp_strip_all_tags($item);
+		}
+	}
+
+
+	/**
+	 * Returns TRUE is this payment was set to approved during this request (or
+	 * is approved and was created during this request). False otherwise.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function just_approved()
+	{
+		$original_status = EEH_Array::is_set(
+			$this->_props_n_values_provided_in_constructor,
+			'STS_ID',
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
+		);
+		$current_status = $this->status();
+		if ($original_status !== EEM_Payment::status_id_approved
+			&& $current_status === EEM_Payment::status_id_approved
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parents' get_pretty() function just for legacy reasons
+	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
+		}
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Gets details regarding which registrations this payment was applied to
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 *
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if ($primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -296,7 +296,7 @@ 
      */
     public function timestamp($dt_frmt = '', $tm_frmt = '')
     {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
     }
 
 
@@ -481,7 +481,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->STS_ID() ];
+        return $icon.$status[$this->STS_ID()];
     }
 
 
@@ -627,7 +627,7 @@ 
     public function redirect_form($inside_form_html = null)
     {
         $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
+        if ( ! empty($redirect_url)) {
             // what ? no inner form content?
             if ($inside_form_html === null) {
                 $inside_form_html = EEH_HTML::p(
@@ -657,7 +657,7 @@ 
                 $get_params = null;
                 parse_str($querystring, $get_params);
                 $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+                $redirect_url = str_replace('?'.$querystring, '', $redirect_url);
             }
             $form = EEH_HTML::nl(1)
                     . '<form method="'
@@ -665,9 +665,9 @@ 
                     . '" name="gateway_form" action="'
                     . $redirect_url
                     . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+            $form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
             $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+            $form .= EEH_HTML::nl(-1).'</form>'.EEH_HTML::nl(-1);
             return $form;
         } else {
             return null;

core/db_classes/EE_Post_Meta.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
      * Sets meta_id
      *
      * @param int $meta_id
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_id($meta_id)
     {
@@ -68,7 +68,7 @@ 
      * Sets post_id
      *
      * @param int $post_id
-     * @return boolean
+     * @return boolean|null
      */
     public function set_post_id($post_id)
     {
@@ -90,7 +90,7 @@ 
      * Sets meta_key
      *
      * @param string $meta_key
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_key($meta_key)
     {
@@ -112,7 +112,7 @@ 
      * Sets meta_value
      *
      * @param mixed $meta_value
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_value($meta_value)
     {

Indentation +108 added lines, -108 removed lines

@@ -10,112 +10,112 @@
 class EE_Post_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets meta_id
-     *
-     * @return int
-     */
-    public function meta_id()
-    {
-        return $this->get('meta_id');
-    }
-
-
-    /**
-     * Sets meta_id
-     *
-     * @param int $meta_id
-     * @return boolean
-     */
-    public function set_meta_id($meta_id)
-    {
-        return $this->set('meta_id', $meta_id);
-    }
-
-    /**
-     * Gets post_id
-     *
-     * @return int
-     */
-    public function post_id()
-    {
-        return $this->get('post_id');
-    }
-
-
-    /**
-     * Sets post_id
-     *
-     * @param int $post_id
-     * @return boolean
-     */
-    public function set_post_id($post_id)
-    {
-        return $this->set('post_id', $post_id);
-    }
-
-    /**
-     * Gets meta_key
-     *
-     * @return string
-     */
-    public function meta_key()
-    {
-        return $this->get('meta_key');
-    }
-
-
-    /**
-     * Sets meta_key
-     *
-     * @param string $meta_key
-     * @return boolean
-     */
-    public function set_meta_key($meta_key)
-    {
-        return $this->set('meta_key', $meta_key);
-    }
-
-    /**
-     * Gets meta_value
-     *
-     * @return mixed
-     */
-    public function meta_value()
-    {
-        return $this->get('meta_value');
-    }
-
-
-    /**
-     * Sets meta_value
-     *
-     * @param mixed $meta_value
-     * @return boolean
-     */
-    public function set_meta_value($meta_value)
-    {
-        return $this->set('meta_value', $meta_value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets meta_id
+	 *
+	 * @return int
+	 */
+	public function meta_id()
+	{
+		return $this->get('meta_id');
+	}
+
+
+	/**
+	 * Sets meta_id
+	 *
+	 * @param int $meta_id
+	 * @return boolean
+	 */
+	public function set_meta_id($meta_id)
+	{
+		return $this->set('meta_id', $meta_id);
+	}
+
+	/**
+	 * Gets post_id
+	 *
+	 * @return int
+	 */
+	public function post_id()
+	{
+		return $this->get('post_id');
+	}
+
+
+	/**
+	 * Sets post_id
+	 *
+	 * @param int $post_id
+	 * @return boolean
+	 */
+	public function set_post_id($post_id)
+	{
+		return $this->set('post_id', $post_id);
+	}
+
+	/**
+	 * Gets meta_key
+	 *
+	 * @return string
+	 */
+	public function meta_key()
+	{
+		return $this->get('meta_key');
+	}
+
+
+	/**
+	 * Sets meta_key
+	 *
+	 * @param string $meta_key
+	 * @return boolean
+	 */
+	public function set_meta_key($meta_key)
+	{
+		return $this->set('meta_key', $meta_key);
+	}
+
+	/**
+	 * Gets meta_value
+	 *
+	 * @return mixed
+	 */
+	public function meta_value()
+	{
+		return $this->get('meta_value');
+	}
+
+
+	/**
+	 * Sets meta_value
+	 *
+	 * @param mixed $meta_value
+	 * @return boolean
+	 */
+	public function set_meta_value($meta_value)
+	{
+		return $this->set('meta_value', $meta_value);
+	}
 }

core/db_classes/EE_Price.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
      * @param array  $props_n_values  incoming values from the database
      * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
      *                                the website will be used.
-     * @return EE_Attendee
+     * @return EE_Price
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {

Indentation +286 added lines, -286 removed lines

@@ -10,290 +10,290 @@
 class EE_Price extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Price type ID
-     *
-     * @access        public
-     * @param        int $PRT_ID
-     */
-    public function set_type($PRT_ID = 0)
-    {
-        $this->set('PRT_ID', $PRT_ID);
-    }
-
-
-    /**
-     *        Set Price Amount
-     *
-     * @access        public
-     * @param        float $PRC_amount
-     */
-    public function set_amount($PRC_amount = 0.00)
-    {
-        $this->set('PRC_amount', $PRC_amount);
-    }
-
-
-    /**
-     *        Set Price Name
-     *
-     * @access        public
-     * @param        string $PRC_name
-     */
-    public function set_name($PRC_name = '')
-    {
-        $this->set('PRC_name', $PRC_name);
-    }
-
-
-    /**
-     *        Set Price Description
-     *
-     * @access        public
-     * @param        string $PRC_desc
-     */
-    public function set_description($PRC_desc = '')
-    {
-        $this->Set('PRC_desc', $PRC_desc);
-    }
-
-
-    /**
-     *        set is_default
-     *
-     * @access        public
-     * @param        bool $PRC_is_default
-     */
-    public function set_is_default($PRC_is_default = false)
-    {
-        $this->set('PRC_is_default', $PRC_is_default);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $PRC_deleted
-     */
-    public function set_deleted($PRC_deleted = null)
-    {
-        $this->set('PRC_deleted', $PRC_deleted);
-    }
-
-
-    /**
-     *    get Price type
-     *
-     * @access        public
-     * @return        int
-     */
-    public function type()
-    {
-        return $this->get('PRT_ID');
-    }
-
-
-    /**
-     *    get Price Amount
-     *
-     * @access        public
-     * @return        float
-     */
-    public function amount()
-    {
-        return $this->get('PRC_amount');
-    }
-
-
-    /**
-     *    get Price Name
-     *
-     * @access        public
-     * @return        string
-     */
-    public function name()
-    {
-        return $this->get('PRC_name');
-    }
-
-
-    /**
-     *    get Price description
-     *
-     * @access        public
-     * @return        string
-     */
-    public function desc()
-    {
-        return $this->get('PRC_desc');
-    }
-
-
-    /**
-     *    get overrides
-     *
-     * @access        public
-     * @return        int
-     */
-    public function overrides()
-    {
-        return $this->get('PRC_overrides');
-    }
-
-
-    /**
-     *    get order
-     *
-     * @access        public
-     * @return        int
-     */
-    public function order()
-    {
-        return $this->get('PRC_order');
-    }
-
-
-    /**
-     * get the author of the price
-     *
-     * @since 4.5.0
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PRC_wp_user');
-    }
-
-
-    /**
-     *    get is_default
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function is_default()
-    {
-        return $this->get('PRC_is_default');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function deleted()
-    {
-        return $this->get('PRC_deleted');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function parent()
-    {
-        return $this->get('PRC_parent');
-    }
-
-
-    // some helper methods for getting info on the price_type for this price
-
-    /**
-     * return whether the price is a base price or not
-     *
-     * @return boolean
-     */
-    public function is_base_price()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->base_type() === 1;
-    }
-
-
-    /**
-     *
-     * @return EE_Price_Type
-     */
-    public function type_obj()
-    {
-        return $this->get_first_related('Price_Type');
-    }
-
-
-    /**
-     * Simply indicates whether this price increases or decreases the total
-     *
-     * @return boolean true = discount, otherwise adds to the total
-     */
-    public function is_discount()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->is_discount();
-    }
-
-
-    /**
-     * whether the price is a percentage or not
-     *
-     * @return boolean
-     */
-    public function is_percent()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->get('PRT_is_percent');
-    }
-
-
-    /**
-     * return pretty price dependant on whether its a dollar or percent.
-     *
-     * @since 4.4.0
-     *
-     * @return string
-     */
-    public function pretty_price()
-    {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_price_without_currency_symbol()
-    {
-        return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Price type ID
+	 *
+	 * @access        public
+	 * @param        int $PRT_ID
+	 */
+	public function set_type($PRT_ID = 0)
+	{
+		$this->set('PRT_ID', $PRT_ID);
+	}
+
+
+	/**
+	 *        Set Price Amount
+	 *
+	 * @access        public
+	 * @param        float $PRC_amount
+	 */
+	public function set_amount($PRC_amount = 0.00)
+	{
+		$this->set('PRC_amount', $PRC_amount);
+	}
+
+
+	/**
+	 *        Set Price Name
+	 *
+	 * @access        public
+	 * @param        string $PRC_name
+	 */
+	public function set_name($PRC_name = '')
+	{
+		$this->set('PRC_name', $PRC_name);
+	}
+
+
+	/**
+	 *        Set Price Description
+	 *
+	 * @access        public
+	 * @param        string $PRC_desc
+	 */
+	public function set_description($PRC_desc = '')
+	{
+		$this->Set('PRC_desc', $PRC_desc);
+	}
+
+
+	/**
+	 *        set is_default
+	 *
+	 * @access        public
+	 * @param        bool $PRC_is_default
+	 */
+	public function set_is_default($PRC_is_default = false)
+	{
+		$this->set('PRC_is_default', $PRC_is_default);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $PRC_deleted
+	 */
+	public function set_deleted($PRC_deleted = null)
+	{
+		$this->set('PRC_deleted', $PRC_deleted);
+	}
+
+
+	/**
+	 *    get Price type
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function type()
+	{
+		return $this->get('PRT_ID');
+	}
+
+
+	/**
+	 *    get Price Amount
+	 *
+	 * @access        public
+	 * @return        float
+	 */
+	public function amount()
+	{
+		return $this->get('PRC_amount');
+	}
+
+
+	/**
+	 *    get Price Name
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function name()
+	{
+		return $this->get('PRC_name');
+	}
+
+
+	/**
+	 *    get Price description
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function desc()
+	{
+		return $this->get('PRC_desc');
+	}
+
+
+	/**
+	 *    get overrides
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function overrides()
+	{
+		return $this->get('PRC_overrides');
+	}
+
+
+	/**
+	 *    get order
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function order()
+	{
+		return $this->get('PRC_order');
+	}
+
+
+	/**
+	 * get the author of the price
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PRC_wp_user');
+	}
+
+
+	/**
+	 *    get is_default
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function is_default()
+	{
+		return $this->get('PRC_is_default');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function deleted()
+	{
+		return $this->get('PRC_deleted');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function parent()
+	{
+		return $this->get('PRC_parent');
+	}
+
+
+	// some helper methods for getting info on the price_type for this price
+
+	/**
+	 * return whether the price is a base price or not
+	 *
+	 * @return boolean
+	 */
+	public function is_base_price()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->base_type() === 1;
+	}
+
+
+	/**
+	 *
+	 * @return EE_Price_Type
+	 */
+	public function type_obj()
+	{
+		return $this->get_first_related('Price_Type');
+	}
+
+
+	/**
+	 * Simply indicates whether this price increases or decreases the total
+	 *
+	 * @return boolean true = discount, otherwise adds to the total
+	 */
+	public function is_discount()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->is_discount();
+	}
+
+
+	/**
+	 * whether the price is a percentage or not
+	 *
+	 * @return boolean
+	 */
+	public function is_percent()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->get('PRT_is_percent');
+	}
+
+
+	/**
+	 * return pretty price dependant on whether its a dollar or percent.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @return string
+	 */
+	public function pretty_price()
+	{
+		return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_price_without_currency_symbol()
+	{
+		return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      */
     public function pretty_price()
     {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount').'%';
     }
 
 

core/db_classes/EE_Question.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -371,7 +371,7 @@ 
      * Question, that relationship will be overwritten.
      *
      * @param EE_Question_Option $option
-     * @return boolean success
+     * @return EE_Base_Class success
      */
     public function add_option(EE_Question_Option $option)
     {
@@ -396,7 +396,7 @@ 
      * Marks the option as deleted.
      *
      * @param EE_Question_Option $option
-     * @return boolean success
+     * @return EE_Base_Class success
      */
     public function remove_option(EE_Question_Option $option)
     {

Indentation +657 added lines, -657 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -335,7 +335,7 @@ 
      */
     public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return array();
         }
         $query_params = array();
@@ -509,7 +509,7 @@ 
             ),
             $input_constructor_args
         );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+        if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
             $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
         }
         // has this question been answered ?
@@ -647,7 +647,7 @@ 
                     $this,
                     $input_constructor_args
                 );
-                if (! $default_input) {
+                if ( ! $default_input) {
                     $default_input = new EE_Text_Input($input_constructor_args);
                 }
                 $result = $default_input;

core/db_classes/EE_Question_Form_Input.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -241,7 +241,7 @@ 
      *        generate_question_form_inputs_for_object
      *
      * @access    protected
-     * @param bool|object $object $object
+     * @param EE_Base_Class|null $object $object
      * @param    array    $input_types
      * @return        array
      */
@@ -354,7 +354,7 @@ 
      *
      * @access public
      * @param \EE_Question_Option $QSO EE_Question_Option
-     * @return boolean
+     * @return boolean|null
      */
     public function add_temp_option(EE_Question_Option $QSO)
     {
@@ -367,8 +367,8 @@ 
      *
      * @access public
      * @param    string $property
-     * @param    mixed  $value
-     * @return mixed
+     * @param    boolean  $value
+     * @return boolean|null
      */
     public function set($property = null, $value = null)
     {
@@ -416,7 +416,7 @@ 
      *    get_meta
      *
      * @access public
-     * @param mixed $key
+     * @param string $key
      * @return mixed
      */
     public function get_meta($key = false)

Indentation +409 added lines, -409 removed lines

@@ -14,413 +14,413 @@
 class EE_Question_Form_Input
 {
 
-    /**
-     *    EE_Question object
-     *
-     * @access private
-     * @var object
-     */
-    private $_QST = null;
-
-    /**
-     *    EE_Answer object
-     *
-     * @access private
-     * @var object
-     */
-    private $_ANS = null;
-
-    /**
-     *    $_QST_meta
-     * @access private
-     * @var array
-     */
-    private $_QST_meta = array();
-
-    /**
-     *    $QST_input_name
-     * @access private
-     * @var string
-     */
-    private $QST_input_name = '';
-
-    /**
-     *    $QST_input_id
-     * @access private
-     * @var string
-     */
-    private $QST_input_id = '';
-
-    /**
-     *    $QST_input_class
-     * @access private
-     * @var string
-     */
-    private $QST_input_class = '';
-
-
-    /**
-     * constructor for questions
-     *
-     * @param \EE_Question $QST EE_Question object
-     * @param \EE_Answer   $ANS EE_Answer object
-     * @param array        $q_meta
-     * @access public
-     * @return \EE_Question_Form_Input
-     */
-    public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = array())
-    {
-        if (empty($QST) || empty($ANS)) {
-            EE_Error::add_error(
-                __('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $this->_QST = $QST;
-        $this->_ANS = $ANS;
-        $this->set_question_form_input_meta($q_meta);
-        $this->set_question_form_input_init();
-    }
-
-
-    /**
-     * sets meta data for the question form input
-     *
-     * @access public
-     * @param array $q_meta
-     * @return void
-     */
-    public function set_question_form_input_meta($q_meta = array())
-    {
-        $default_q_meta = array(
-            'att_nmbr'       => 1,
-            'ticket_id'      => '',
-            'date'           => '',
-            'time'           => '',
-            'input_name'     => '',
-            'input_id'       => '',
-            'input_class'    => '',
-            'input_prefix'   => 'qstn',
-            'append_qstn_id' => true,
-            'htmlentities'   => true,
-            'allow_null'     => false,
-        );
-        $this->_QST_meta = array_merge($default_q_meta, $q_meta);
-    }
-
-
-    /**
-     * set_question_form_input_init
-     *
-     * @access public
-     * @return void
-     */
-    public function set_question_form_input_init()
-    {
-        $qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
-        $this->_set_input_name($qstn_id);
-        $this->_set_input_id($qstn_id);
-        $this->_set_input_class($qstn_id);
-        $this->set_question_form_input_answer($qstn_id);
-    }
-
-
-    /**
-     * set_input_name
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     */
-    private function _set_input_name($qstn_id)
-    {
-        if (! empty($qstn_id)) {
-            $ANS_ID = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
-        }
-        $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
-    }
-
-
-    /**
-     * get property values for question form input
-     *
-     * @access public
-     * @param    string $property
-     * @return mixed
-     */
-    public function get($property = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                return $this->_QST->get($property);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                return $this->_ANS->get($property);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                return $this->{$property};
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access private
-     * @param    string $classname
-     * @param    string $property
-     * @return boolean
-     */
-    private function _question_form_input_property_exists($classname, $property)
-    {
-        // first try regular property exists method which works as expected in PHP 5.3+
-        $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
-            // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
-            $reflector = new ReflectionClass($classname);
-            $prop = $reflector->hasProperty($property);
-        }
-        return $prop;
-    }
-
-
-    /**
-     * set_input_id
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     */
-    private function _set_input_id($qstn_id)
-    {
-        $input_id = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
-            ? $this->_QST_meta['input_id'] : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
-        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id) ? $input_id . '-' . $qstn_id
-            : $input_id;
-    }
-
-
-    /**
-     * set_input_class
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_input_class()
-    {
-        $this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
-    }
-
-
-    /**
-     * set_question_form_input_answer
-     *
-     * @access public
-     * @param mixed    int | string    $qstn_id
-     * @return void
-     */
-    public function set_question_form_input_answer($qstn_id)
-    {
-        // check for answer in $_REQUEST in case we are reprocessing a form after an error
-        if (isset($this->_QST_meta['EVT_ID']) && isset($this->_QST_meta['att_nmbr']) && isset($this->_QST_meta['date']) && isset($this->_QST_meta['time']) && isset($this->_QST_meta['price_id'])) {
-            if (isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])) {
-                $answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
-                $this->_ANS->set('ANS_value', $answer);
-            }
-        }
-    }
-
-
-    /**
-     *        generate_question_form_inputs_for_object
-     *
-     * @access    protected
-     * @param bool|object $object $object
-     * @param    array    $input_types
-     * @return        array
-     */
-    public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
-    {
-        if (! is_object($object)) {
-            return false;
-        }
-        $inputs = array();
-        $fields = $object->get_model()->field_settings(false);
-        // $pk = $object->ID(); <<< NO!
-        // EEH_Debug_Tools::printr( $object, get_class( $object ) . '<br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // EEH_Debug_Tools::printr( $fields, '$fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // EEH_Debug_Tools::printr( $input_types, '$input_types  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        foreach ($fields as $field_ID => $field) {
-            if ($field instanceof EE_Model_Field_Base) {
-                // echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                // EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                if (isset($input_types[ $field_ID ])) {
-                    // get saved value for field
-                    $value = $object->get($field_ID);
-                    // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                    // if no saved value, then use default
-                    $value = $value !== null ? $value : $field->get_default_value();
-                    // if ( $field_ID == 'CNT_active' )
-                    // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                    // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
-                    // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']' : $field_ID;
-                    // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class'] : '';
-                    // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities'] : true;
-                    // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4']) ? $input_types[ $field_ID ]['label_b4']
-                        : false;
-                    // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label'] : false;
-
-                    // create EE_Question_Form_Input object
-                    $QFI = new EE_Question_Form_Input(
-                        EE_Question::new_instance(
-                            array(
-                                'QST_ID'           => 0,
-                                'QST_display_text' => $field->get_nicename(),
-                                'QST_type'         => $type,
-                            )
-                        ),
-                        EE_Answer::new_instance(
-                            array(
-                                'ANS_ID'    => 0,
-                                'QST_ID'    => 0,
-                                'REG_ID'    => 0,
-                                'ANS_value' => $value,
-                            )
-                        ),
-                        array(
-                            'input_id'         => $field_ID . '-' . $object->ID(),
-                            'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
-                            'input_prefix'     => '',
-                            'append_qstn_id'   => false,
-                            'htmlentities'     => $htmlentities,
-                            'label_b4'         => $label_b4,
-                            'use_desc_4_label' => $use_desc_4_label,
-                        )
-                    );
-                    // does question type have options ?
-                    if (in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
-                    ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
-                            $option = stripslashes_deep($option);
-                            $option_id = ! empty($option['id']) ? $option['id'] : 0;
-                            $QSO = EE_Question_Option::new_instance(
-                                array(
-                                    'QSO_value'   => (string) $option_id,
-                                    'QSO_desc'    => $option['text'],
-                                    'QSO_deleted' => false,
-                                )
-                            );
-                            // all QST (and ANS) properties can be accessed indirectly thru QFI
-                            $QFI->add_temp_option($QSO);
-                        }
-                    }
-                    // we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
-                    if ($field_ID == $object->get_model()->primary_key_name()) {
-                        $QFI->set('QST_disabled', true);
-                    }
-                    // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    $inputs[ $field_ID ] = $QFI;
-                    // if ( $field_ID == 'CNT_active' ) {
-                    // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    // }
-                }
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     *    add_temp_option
-     *
-     * @access public
-     * @param \EE_Question_Option $QSO EE_Question_Option
-     * @return boolean
-     */
-    public function add_temp_option(EE_Question_Option $QSO)
-    {
-        $this->_QST->add_temp_option($QSO);
-    }
-
-
-    /**
-     * set property values for question form input
-     *
-     * @access public
-     * @param    string $property
-     * @param    mixed  $value
-     * @return mixed
-     */
-    public function set($property = null, $value = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                $this->_QST->set($property, $value);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                $this->_ANS->set($property, $value);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                echo "<hr>$property is a prop of QFI";
-                $this->{$property} = $value;
-                return true;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access public
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        $temp_options = $this->_QST->temp_options();
-        return ! empty($temp_options)
-            ? $temp_options
-            : $this->_QST->options(
-                $notDeletedOptionsOnly,
-                $selected_value_to_always_include
-            );
-    }
-
-
-    /**
-     *    get_meta
-     *
-     * @access public
-     * @param mixed $key
-     * @return mixed
-     */
-    public function get_meta($key = false)
-    {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
-    }
+	/**
+	 *    EE_Question object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_QST = null;
+
+	/**
+	 *    EE_Answer object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_ANS = null;
+
+	/**
+	 *    $_QST_meta
+	 * @access private
+	 * @var array
+	 */
+	private $_QST_meta = array();
+
+	/**
+	 *    $QST_input_name
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_name = '';
+
+	/**
+	 *    $QST_input_id
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_id = '';
+
+	/**
+	 *    $QST_input_class
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_class = '';
+
+
+	/**
+	 * constructor for questions
+	 *
+	 * @param \EE_Question $QST EE_Question object
+	 * @param \EE_Answer   $ANS EE_Answer object
+	 * @param array        $q_meta
+	 * @access public
+	 * @return \EE_Question_Form_Input
+	 */
+	public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = array())
+	{
+		if (empty($QST) || empty($ANS)) {
+			EE_Error::add_error(
+				__('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$this->_QST = $QST;
+		$this->_ANS = $ANS;
+		$this->set_question_form_input_meta($q_meta);
+		$this->set_question_form_input_init();
+	}
+
+
+	/**
+	 * sets meta data for the question form input
+	 *
+	 * @access public
+	 * @param array $q_meta
+	 * @return void
+	 */
+	public function set_question_form_input_meta($q_meta = array())
+	{
+		$default_q_meta = array(
+			'att_nmbr'       => 1,
+			'ticket_id'      => '',
+			'date'           => '',
+			'time'           => '',
+			'input_name'     => '',
+			'input_id'       => '',
+			'input_class'    => '',
+			'input_prefix'   => 'qstn',
+			'append_qstn_id' => true,
+			'htmlentities'   => true,
+			'allow_null'     => false,
+		);
+		$this->_QST_meta = array_merge($default_q_meta, $q_meta);
+	}
+
+
+	/**
+	 * set_question_form_input_init
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_question_form_input_init()
+	{
+		$qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
+		$this->_set_input_name($qstn_id);
+		$this->_set_input_id($qstn_id);
+		$this->_set_input_class($qstn_id);
+		$this->set_question_form_input_answer($qstn_id);
+	}
+
+
+	/**
+	 * set_input_name
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 */
+	private function _set_input_name($qstn_id)
+	{
+		if (! empty($qstn_id)) {
+			$ANS_ID = $this->get('ANS_ID');
+			$qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+		}
+		$this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
+			: $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+	}
+
+
+	/**
+	 * get property values for question form input
+	 *
+	 * @access public
+	 * @param    string $property
+	 * @return mixed
+	 */
+	public function get($property = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				return $this->_QST->get($property);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				return $this->_ANS->get($property);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				return $this->{$property};
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access private
+	 * @param    string $classname
+	 * @param    string $property
+	 * @return boolean
+	 */
+	private function _question_form_input_property_exists($classname, $property)
+	{
+		// first try regular property exists method which works as expected in PHP 5.3+
+		$prop = EEH_Class_Tools::has_property($classname, $property);
+		if (! $prop) {
+			// use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
+			$reflector = new ReflectionClass($classname);
+			$prop = $reflector->hasProperty($property);
+		}
+		return $prop;
+	}
+
+
+	/**
+	 * set_input_id
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 */
+	private function _set_input_id($qstn_id)
+	{
+		$input_id = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
+			? $this->_QST_meta['input_id'] : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
+		$this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id) ? $input_id . '-' . $qstn_id
+			: $input_id;
+	}
+
+
+	/**
+	 * set_input_class
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_input_class()
+	{
+		$this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
+	}
+
+
+	/**
+	 * set_question_form_input_answer
+	 *
+	 * @access public
+	 * @param mixed    int | string    $qstn_id
+	 * @return void
+	 */
+	public function set_question_form_input_answer($qstn_id)
+	{
+		// check for answer in $_REQUEST in case we are reprocessing a form after an error
+		if (isset($this->_QST_meta['EVT_ID']) && isset($this->_QST_meta['att_nmbr']) && isset($this->_QST_meta['date']) && isset($this->_QST_meta['time']) && isset($this->_QST_meta['price_id'])) {
+			if (isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])) {
+				$answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
+				$this->_ANS->set('ANS_value', $answer);
+			}
+		}
+	}
+
+
+	/**
+	 *        generate_question_form_inputs_for_object
+	 *
+	 * @access    protected
+	 * @param bool|object $object $object
+	 * @param    array    $input_types
+	 * @return        array
+	 */
+	public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
+	{
+		if (! is_object($object)) {
+			return false;
+		}
+		$inputs = array();
+		$fields = $object->get_model()->field_settings(false);
+		// $pk = $object->ID(); <<< NO!
+		// EEH_Debug_Tools::printr( $object, get_class( $object ) . '<br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// EEH_Debug_Tools::printr( $fields, '$fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// EEH_Debug_Tools::printr( $input_types, '$input_types  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		foreach ($fields as $field_ID => $field) {
+			if ($field instanceof EE_Model_Field_Base) {
+				// echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+				// EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+				if (isset($input_types[ $field_ID ])) {
+					// get saved value for field
+					$value = $object->get($field_ID);
+					// echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+					// if no saved value, then use default
+					$value = $value !== null ? $value : $field->get_default_value();
+					// if ( $field_ID == 'CNT_active' )
+					// echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+					// determine question type
+					$type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+					// input name
+					$input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
+						? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']' : $field_ID;
+					// css class for input
+					$class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
+						? ' ' . $input_types[ $field_ID ]['class'] : '';
+					// whether to apply htmlentities to answer
+					$htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
+						? $input_types[ $field_ID ]['htmlentities'] : true;
+					// whether to apply htmlentities to answer
+					$label_b4 = isset($input_types[ $field_ID ]['label_b4']) ? $input_types[ $field_ID ]['label_b4']
+						: false;
+					// whether to apply htmlentities to answer
+					$use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
+						? $input_types[ $field_ID ]['use_desc_4_label'] : false;
+
+					// create EE_Question_Form_Input object
+					$QFI = new EE_Question_Form_Input(
+						EE_Question::new_instance(
+							array(
+								'QST_ID'           => 0,
+								'QST_display_text' => $field->get_nicename(),
+								'QST_type'         => $type,
+							)
+						),
+						EE_Answer::new_instance(
+							array(
+								'ANS_ID'    => 0,
+								'QST_ID'    => 0,
+								'REG_ID'    => 0,
+								'ANS_value' => $value,
+							)
+						),
+						array(
+							'input_id'         => $field_ID . '-' . $object->ID(),
+							'input_name'       => $input_name,
+							'input_class'      => $field_ID . $class,
+							'input_prefix'     => '',
+							'append_qstn_id'   => false,
+							'htmlentities'     => $htmlentities,
+							'label_b4'         => $label_b4,
+							'use_desc_4_label' => $use_desc_4_label,
+						)
+					);
+					// does question type have options ?
+					if (in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
+						&& isset($input_types[ $field_ID ])
+						&& isset($input_types[ $field_ID ]['options'])
+					) {
+						foreach ($input_types[ $field_ID ]['options'] as $option) {
+							$option = stripslashes_deep($option);
+							$option_id = ! empty($option['id']) ? $option['id'] : 0;
+							$QSO = EE_Question_Option::new_instance(
+								array(
+									'QSO_value'   => (string) $option_id,
+									'QSO_desc'    => $option['text'],
+									'QSO_deleted' => false,
+								)
+							);
+							// all QST (and ANS) properties can be accessed indirectly thru QFI
+							$QFI->add_temp_option($QSO);
+						}
+					}
+					// we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
+					if ($field_ID == $object->get_model()->primary_key_name()) {
+						$QFI->set('QST_disabled', true);
+					}
+					// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+					$inputs[ $field_ID ] = $QFI;
+					// if ( $field_ID == 'CNT_active' ) {
+					// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+					// }
+				}
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 *    add_temp_option
+	 *
+	 * @access public
+	 * @param \EE_Question_Option $QSO EE_Question_Option
+	 * @return boolean
+	 */
+	public function add_temp_option(EE_Question_Option $QSO)
+	{
+		$this->_QST->add_temp_option($QSO);
+	}
+
+
+	/**
+	 * set property values for question form input
+	 *
+	 * @access public
+	 * @param    string $property
+	 * @param    mixed  $value
+	 * @return mixed
+	 */
+	public function set($property = null, $value = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				$this->_QST->set($property, $value);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				$this->_ANS->set($property, $value);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				echo "<hr>$property is a prop of QFI";
+				$this->{$property} = $value;
+				return true;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access public
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		$temp_options = $this->_QST->temp_options();
+		return ! empty($temp_options)
+			? $temp_options
+			: $this->_QST->options(
+				$notDeletedOptionsOnly,
+				$selected_value_to_always_include
+			);
+	}
+
+
+	/**
+	 *    get_meta
+	 *
+	 * @access public
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function get_meta($key = false)
+	{
+		return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -137,13 +137,13 @@ 
      */
     private function _set_input_name($qstn_id)
     {
-        if (! empty($qstn_id)) {
+        if ( ! empty($qstn_id)) {
             $ANS_ID = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+            $qstn_id = ! empty($ANS_ID) ? '['.$qstn_id.']['.$ANS_ID.']' : '['.$qstn_id.']';
         }
         $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+            ? $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'].$qstn_id
+            : $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'];
     }
 
 
@@ -156,7 +156,7 @@ 
      */
     public function get($property = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 return $this->_QST->get($property);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -181,7 +181,7 @@ 
     {
         // first try regular property exists method which works as expected in PHP 5.3+
         $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
+        if ( ! $prop) {
             // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
             $reflector = new ReflectionClass($classname);
             $prop = $reflector->hasProperty($property);
@@ -201,7 +201,7 @@ 
     {
         $input_id = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
             ? $this->_QST_meta['input_id'] : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
-        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id) ? $input_id . '-' . $qstn_id
+        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id) ? $input_id.'-'.$qstn_id
             : $input_id;
     }
 
@@ -229,8 +229,8 @@ 
     {
         // check for answer in $_REQUEST in case we are reprocessing a form after an error
         if (isset($this->_QST_meta['EVT_ID']) && isset($this->_QST_meta['att_nmbr']) && isset($this->_QST_meta['date']) && isset($this->_QST_meta['time']) && isset($this->_QST_meta['price_id'])) {
-            if (isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])) {
-                $answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
+            if (isset($_REQUEST['qstn'][$this->_QST_meta['EVT_ID']][$this->_QST_meta['att_nmbr']][$this->_QST_meta['date']][$this->_QST_meta['time']][$this->_QST_meta['price_id']][$qstn_id])) {
+                $answer = $_REQUEST['qstn'][$this->_QST_meta['EVT_ID']][$this->_QST_meta['att_nmbr']][$this->_QST_meta['date']][$this->_QST_meta['time']][$this->_QST_meta['price_id']][$qstn_id];
                 $this->_ANS->set('ANS_value', $answer);
             }
         }
@@ -247,7 +247,7 @@ 
      */
     public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             return false;
         }
         $inputs = array();
@@ -260,7 +260,7 @@ 
             if ($field instanceof EE_Model_Field_Base) {
                 // echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
                 // EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                if (isset($input_types[ $field_ID ])) {
+                if (isset($input_types[$field_ID])) {
                     // get saved value for field
                     $value = $object->get($field_ID);
                     // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
@@ -269,22 +269,22 @@ 
                     // if ( $field_ID == 'CNT_active' )
                     // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
                     // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+                    $type = isset($input_types[$field_ID]) ? $input_types[$field_ID]['type'] : 'TEXT';
                     // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']' : $field_ID;
+                    $input_name = isset($input_types[$field_ID]) && isset($input_types[$field_ID]['input_name'])
+                        ? $input_types[$field_ID]['input_name'].'['.$field_ID.']' : $field_ID;
                     // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class'] : '';
+                    $class = isset($input_types[$field_ID]['class']) && ! empty($input_types[$field_ID]['class'])
+                        ? ' '.$input_types[$field_ID]['class'] : '';
                     // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities'] : true;
+                    $htmlentities = isset($input_types[$field_ID]['htmlentities'])
+                        ? $input_types[$field_ID]['htmlentities'] : true;
                     // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4']) ? $input_types[ $field_ID ]['label_b4']
+                    $label_b4 = isset($input_types[$field_ID]['label_b4']) ? $input_types[$field_ID]['label_b4']
                         : false;
                     // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label'] : false;
+                    $use_desc_4_label = isset($input_types[$field_ID]['use_desc_4_label'])
+                        ? $input_types[$field_ID]['use_desc_4_label'] : false;
 
                     // create EE_Question_Form_Input object
                     $QFI = new EE_Question_Form_Input(
@@ -304,9 +304,9 @@ 
                             )
                         ),
                         array(
-                            'input_id'         => $field_ID . '-' . $object->ID(),
+                            'input_id'         => $field_ID.'-'.$object->ID(),
                             'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
+                            'input_class'      => $field_ID.$class,
                             'input_prefix'     => '',
                             'append_qstn_id'   => false,
                             'htmlentities'     => $htmlentities,
@@ -316,10 +316,10 @@ 
                     );
                     // does question type have options ?
                     if (in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
+                        && isset($input_types[$field_ID])
+                        && isset($input_types[$field_ID]['options'])
                     ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
+                        foreach ($input_types[$field_ID]['options'] as $option) {
                             $option = stripslashes_deep($option);
                             $option_id = ! empty($option['id']) ? $option['id'] : 0;
                             $QSO = EE_Question_Option::new_instance(
@@ -338,7 +338,7 @@ 
                         $QFI->set('QST_disabled', true);
                     }
                     // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    $inputs[ $field_ID ] = $QFI;
+                    $inputs[$field_ID] = $QFI;
                     // if ( $field_ID == 'CNT_active' ) {
                     // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
                     // }
@@ -372,7 +372,7 @@ 
      */
     public function set($property = null, $value = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 $this->_QST->set($property, $value);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -421,6 +421,6 @@ 
      */
     public function get_meta($key = false)
     {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+        return $key && isset($this->_QST_meta[$key]) ? $this->_QST_meta[$key] : false;
     }
 }

core/db_classes/EE_Question_Group.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -215,7 +215,7 @@ 
      * Adds the question to this question group
      *
      * @param EE_Question || int $question object or ID
-     * @return boolean if successful
+     * @return EE_Base_Class if successful
      */
     public function add_question($questionObjectOrID)
     {
@@ -227,7 +227,7 @@ 
      * Removes the question from this question group
      *
      * @param EE_Question || int $question object or ID
-     * @return boolean of success
+     * @return EE_Base_Class of success
      */
     public function remove_question($questionObjectOrID)
     {

Indentation +276 added lines, -276 removed lines

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

core/db_classes/EE_Question_Option.class.php

Doc Comments +7 added lines, -7 removed lines

@@ -39,7 +39,7 @@ 
      * @param array  $props_n_values  incoming values from the database
      * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
      *                                the website will be used.
-     * @return EE_Attendee
+     * @return EE_Question_Option
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {
@@ -51,7 +51,7 @@ 
      * Sets the option's key value
      *
      * @param string $value
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_value($value)
     {
@@ -63,7 +63,7 @@ 
      * Sets the option's Display Text
      *
      * @param string $text
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_desc($text)
     {
@@ -76,7 +76,7 @@ 
      *
      * @access public
      * @param integer $order
-     * @return bool      $success
+     * @return boolean|null      $success
      */
     public function set_order($order)
     {
@@ -88,7 +88,7 @@ 
      * Sets the ID of the related question
      *
      * @param int $question_ID
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_question_ID($question_ID)
     {
@@ -100,7 +100,7 @@ 
      * Sets the option's opt_group
      *
      * @param string $text
-     * @return bool success
+     * @return string success
      */
     public function set_opt_group($text)
     {
@@ -220,7 +220,7 @@ 
      * Sets QSO_system
      *
      * @param string $QSO_system
-     * @return bool
+     * @return boolean|null
      */
     public function set_system($QSO_system)
     {

Indentation +216 added lines, -216 removed lines

@@ -10,220 +10,220 @@
 class EE_Question_Option extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
 
-    /**
-     * Question Option Opt Group Name
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_QSO_opt_group = null;
-
-
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Sets the option's key value
-     *
-     * @param string $value
-     * @return bool success
-     */
-    public function set_value($value)
-    {
-        $this->set('QSO_value', $value);
-    }
-
-
-    /**
-     * Sets the option's Display Text
-     *
-     * @param string $text
-     * @return bool success
-     */
-    public function set_desc($text)
-    {
-        $this->set('QSO_desc', $text);
-    }
-
-
-    /**
-     * Sets the order for this option
-     *
-     * @access public
-     * @param integer $order
-     * @return bool      $success
-     */
-    public function set_order($order)
-    {
-        $this->set('QSO_order', $order);
-    }
-
-
-    /**
-     * Sets the ID of the related question
-     *
-     * @param int $question_ID
-     * @return bool success
-     */
-    public function set_question_ID($question_ID)
-    {
-        $this->set('QST_ID', $question_ID);
-    }
-
-
-    /**
-     * Sets the option's opt_group
-     *
-     * @param string $text
-     * @return bool success
-     */
-    public function set_opt_group($text)
-    {
-        return $this->_QSO_opt_group = $text;
-    }
-
-
-    /**
-     * Gets the option's key value
-     *
-     * @return string
-     */
-    public function value()
-    {
-        return $this->get('QSO_value');
-    }
-
-
-    /**
-     * Gets the option's display text
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('QSO_desc');
-    }
-
-
-    /**
-     * Returns whether this option has been deleted or not
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QSO_deleted');
-    }
-
-
-    /**
-     * Returns the order or the Question Option
-     *
-     * @access public
-     * @return integer
-     */
-    public function order()
-    {
-        return $this->get('QSO_option');
-    }
-
-
-    /**
-     * Gets the related question's ID
-     *
-     * @return int
-     */
-    public function question_ID()
-    {
-        return $this->get('QST_ID');
-    }
-
-
-    /**
-     * Returns the question related to this question option
-     *
-     * @return EE_Question
-     */
-    public function question()
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the option's opt_group
-     *
-     * @return string
-     */
-    public function opt_group()
-    {
-        return $this->_QSO_opt_group;
-    }
-
-    /**
-     * Duplicates this question option. By default the new question option will be for the same question,
-     * but that can be overriden by setting the 'QST_ID' option
-     *
-     * @param array $options {
-     * @type int    $QST_ID  the QST_ID attribute of this question option, otherwise it will be for the same question
-     *                       as the original
-     */
-    public function duplicate($options = array())
-    {
-        $new_question_option = clone $this;
-        $new_question_option->set('QSO_ID', null);
-        if (array_key_exists(
-            'QST_ID',
-            $options
-        )) {// use array_key_exists instead of isset because NULL might be a valid value
-            $new_question_option->set_question_ID($options['QST_ID']);
-        }
-        $new_question_option->save();
-    }
-
-    /**
-     * Gets the QSO_system value
-     *
-     * @return string|null
-     */
-    public function system()
-    {
-        return $this->get('QSO_system');
-    }
-
-    /**
-     * Sets QSO_system
-     *
-     * @param string $QSO_system
-     * @return bool
-     */
-    public function set_system($QSO_system)
-    {
-        return $this->set('QSO_system', $QSO_system);
-    }
+	/**
+	 * Question Option Opt Group Name
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_QSO_opt_group = null;
+
+
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Sets the option's key value
+	 *
+	 * @param string $value
+	 * @return bool success
+	 */
+	public function set_value($value)
+	{
+		$this->set('QSO_value', $value);
+	}
+
+
+	/**
+	 * Sets the option's Display Text
+	 *
+	 * @param string $text
+	 * @return bool success
+	 */
+	public function set_desc($text)
+	{
+		$this->set('QSO_desc', $text);
+	}
+
+
+	/**
+	 * Sets the order for this option
+	 *
+	 * @access public
+	 * @param integer $order
+	 * @return bool      $success
+	 */
+	public function set_order($order)
+	{
+		$this->set('QSO_order', $order);
+	}
+
+
+	/**
+	 * Sets the ID of the related question
+	 *
+	 * @param int $question_ID
+	 * @return bool success
+	 */
+	public function set_question_ID($question_ID)
+	{
+		$this->set('QST_ID', $question_ID);
+	}
+
+
+	/**
+	 * Sets the option's opt_group
+	 *
+	 * @param string $text
+	 * @return bool success
+	 */
+	public function set_opt_group($text)
+	{
+		return $this->_QSO_opt_group = $text;
+	}
+
+
+	/**
+	 * Gets the option's key value
+	 *
+	 * @return string
+	 */
+	public function value()
+	{
+		return $this->get('QSO_value');
+	}
+
+
+	/**
+	 * Gets the option's display text
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('QSO_desc');
+	}
+
+
+	/**
+	 * Returns whether this option has been deleted or not
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QSO_deleted');
+	}
+
+
+	/**
+	 * Returns the order or the Question Option
+	 *
+	 * @access public
+	 * @return integer
+	 */
+	public function order()
+	{
+		return $this->get('QSO_option');
+	}
+
+
+	/**
+	 * Gets the related question's ID
+	 *
+	 * @return int
+	 */
+	public function question_ID()
+	{
+		return $this->get('QST_ID');
+	}
+
+
+	/**
+	 * Returns the question related to this question option
+	 *
+	 * @return EE_Question
+	 */
+	public function question()
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the option's opt_group
+	 *
+	 * @return string
+	 */
+	public function opt_group()
+	{
+		return $this->_QSO_opt_group;
+	}
+
+	/**
+	 * Duplicates this question option. By default the new question option will be for the same question,
+	 * but that can be overriden by setting the 'QST_ID' option
+	 *
+	 * @param array $options {
+	 * @type int    $QST_ID  the QST_ID attribute of this question option, otherwise it will be for the same question
+	 *                       as the original
+	 */
+	public function duplicate($options = array())
+	{
+		$new_question_option = clone $this;
+		$new_question_option->set('QSO_ID', null);
+		if (array_key_exists(
+			'QST_ID',
+			$options
+		)) {// use array_key_exists instead of isset because NULL might be a valid value
+			$new_question_option->set_question_ID($options['QST_ID']);
+		}
+		$new_question_option->save();
+	}
+
+	/**
+	 * Gets the QSO_system value
+	 *
+	 * @return string|null
+	 */
+	public function system()
+	{
+		return $this->get('QSO_system');
+	}
+
+	/**
+	 * Sets QSO_system
+	 *
+	 * @param string $QSO_system
+	 * @return bool
+	 */
+	public function set_system($QSO_system)
+	{
+		return $this->set('QSO_system', $QSO_system);
+	}
 }

core/db_classes/EE_Status.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -52,7 +52,7 @@ 
      * Sets code
      *
      * @param string $code
-     * @return boolean
+     * @return boolean|null
      */
     public function set_code($code)
     {
@@ -75,7 +75,7 @@ 
      * Sets desc
      *
      * @param string $desc
-     * @return boolean
+     * @return boolean|null
      */
     public function set_desc($desc)
     {
@@ -98,7 +98,7 @@ 
      * Sets type
      *
      * @param string $type
-     * @return boolean
+     * @return boolean|null
      */
     public function set_type($type)
     {
@@ -121,7 +121,7 @@ 
      * Sets can_edit
      *
      * @param boolean $can_edit
-     * @return boolean
+     * @return boolean|null
      */
     public function set_can_edit($can_edit)
     {
@@ -144,7 +144,7 @@ 
      * Sets open
      *
      * @param boolean $open
-     * @return boolean
+     * @return boolean|null
      */
     public function set_open($open)
     {

Indentation +138 added lines, -138 removed lines

@@ -12,142 +12,142 @@
 class EE_Status extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @param bool   $plural
-     * @param string $schema
-     * @return string
-     */
-    public function code($plural = false, $schema = 'upper')
-    {
-        $id = $this->get('STS_ID');
-        $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @return boolean
-     */
-    public function set_code($code)
-    {
-        $this->set('STS_code', $code);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('STS_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @return boolean
-     */
-    public function set_desc($desc)
-    {
-        $this->set('STS_desc', $desc);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('STS_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @return boolean
-     */
-    public function set_type($type)
-    {
-        $this->set('STS_type', $type);
-    }
-
-
-    /**
-     * Gets can_edit
-     *
-     * @return boolean
-     */
-    public function can_edit()
-    {
-        return $this->get('STS_can_edit');
-    }
-
-
-    /**
-     * Sets can_edit
-     *
-     * @param boolean $can_edit
-     * @return boolean
-     */
-    public function set_can_edit($can_edit)
-    {
-        $this->set('STS_can_edit', $can_edit);
-    }
-
-
-    /**
-     * Gets open
-     *
-     * @return boolean
-     */
-    public function open()
-    {
-        return $this->get('STS_open');
-    }
-
-
-    /**
-     * Sets open
-     *
-     * @param boolean $open
-     * @return boolean
-     */
-    public function set_open($open)
-    {
-        $this->set('STS_open', $open);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @param bool   $plural
+	 * @param string $schema
+	 * @return string
+	 */
+	public function code($plural = false, $schema = 'upper')
+	{
+		$id = $this->get('STS_ID');
+		$code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
+		return $code[ $id ];
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @return boolean
+	 */
+	public function set_code($code)
+	{
+		$this->set('STS_code', $code);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('STS_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @return boolean
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('STS_desc', $desc);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('STS_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @return boolean
+	 */
+	public function set_type($type)
+	{
+		$this->set('STS_type', $type);
+	}
+
+
+	/**
+	 * Gets can_edit
+	 *
+	 * @return boolean
+	 */
+	public function can_edit()
+	{
+		return $this->get('STS_can_edit');
+	}
+
+
+	/**
+	 * Sets can_edit
+	 *
+	 * @param boolean $can_edit
+	 * @return boolean
+	 */
+	public function set_can_edit($can_edit)
+	{
+		$this->set('STS_can_edit', $can_edit);
+	}
+
+
+	/**
+	 * Gets open
+	 *
+	 * @return boolean
+	 */
+	public function open()
+	{
+		return $this->get('STS_open');
+	}
+
+
+	/**
+	 * Sets open
+	 *
+	 * @param boolean $open
+	 * @return boolean
+	 */
+	public function set_open($open)
+	{
+		$this->set('STS_open', $open);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     {
         $id = $this->get('STS_ID');
         $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
+        return $code[$id];
     }
 
 

core/db_classes/EE_Term.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
      * Sets name
      *
      * @param string $name
-     * @return boolean
+     * @return boolean|null
      */
     public function set_name($name)
     {
@@ -89,7 +89,7 @@ 
      * Sets slug
      *
      * @param string $slug
-     * @return boolean
+     * @return boolean|null
      */
     public function set_slug($slug)
     {

Indentation +70 added lines, -70 removed lines

@@ -12,87 +12,87 @@
 class EE_Term extends EE_Base_Class
 {
 
-    public $post_type;
+	public $post_type;
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        if (! isset($fieldValues['slug'])) {
-            $fieldValues['slug'] = $fieldValues['name'];
-        }
-        parent::__construct($fieldValues, $bydb, $timezone);
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		if (! isset($fieldValues['slug'])) {
+			$fieldValues['slug'] = $fieldValues['name'];
+		}
+		parent::__construct($fieldValues, $bydb, $timezone);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('name');
-    }
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('name');
+	}
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function set_name($name)
-    {
-        $this->set('name', $name);
-    }
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function set_name($name)
+	{
+		$this->set('name', $name);
+	}
 
 
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('slug');
-    }
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('slug');
+	}
 
 
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     * @return boolean
-     */
-    public function set_slug($slug)
-    {
-        $this->set('slug', $slug);
-    }
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 * @return boolean
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('slug', $slug);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
     {
-        if (! isset($fieldValues['slug'])) {
+        if ( ! isset($fieldValues['slug'])) {
             $fieldValues['slug'] = $fieldValues['name'];
         }
         parent::__construct($fieldValues, $bydb, $timezone);