eventespresso / event-espresso-core

core/db_models/EEM_Payment_Method.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -214,7 +214,7 @@ 
     /**
      * Overrides parent ot also check by the slug
      * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
+     * @param EE_Payment_Method $base_class_obj_or_id
      * @param boolean                      $ensure_is_in_db
      * @return EE_Payment_Method
      * @throws EE_Error
@@ -382,8 +382,8 @@ 
      * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
      * It will ONLY return a payment method for a PAYMENT recorded against the registration.
      *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
+     * @param EE_Registration $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+     * @return null|EE_Base_Class
      */
     public function get_last_used_for_registration($registration_or_reg_id)
     {

Indentation +376 added lines, -376 removed lines

@@ -20,381 +20,381 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     *
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     * @Constructor
-     * @access   protected
-     * @return EEM_Payment_Method
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singlular_item = __('Payment Method', 'event_espresso');
-        $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
-        $this->_fields = array(
-            'Payment_Method' => array(
-                'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
-                'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
-                'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
-                'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
-                'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
-                'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
-                'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
-                'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
-                'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
-                'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
-                'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
-                'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
-        ) );
-        $this->_model_relations = array(
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 *
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 * @Constructor
+	 * @access   protected
+	 * @return EEM_Payment_Method
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+		$this->_fields = array(
+			'Payment_Method' => array(
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
+		) );
+		$this->_model_relations = array(
  //         'Event'=>new EE_HABTM_Relation('Event_Payment_Method'),
-            'Payment' => new EE_Has_Many_Relation(),
-            'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets one by the slug provided
-     * @param string $slug
-     * @return EE_Payment_Method
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
-    }
-
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            array(
-                self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
-                self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
-            )
-        );
-    }
-
-
-
-    /**
-     * Determines if this is an valid scope
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets all active payment methods
-     * @param string $scope one of
-     * @param array  $query_params
-     * @throws EE_Error
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_active($scope = null, $query_params = array())
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Counts all active gateways in the specified scope
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array $query_params
-     * @return int
-     */
-    public function count_active($scope = null, $query_params = array())
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params like EEM_Base::get_all.
-     * @return array like param of EEM_Base::get_all()
-     * @throws EE_Error
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
-            } else {
-                throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
-            }
-        } else {
-            $acceptable_scopes = array();
-            $count = 0;
-            foreach ($this->scopes() as $scope_name => $desc) {
-                $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
-            }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
-        }
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params like EEM_Base::get_all.
-     * @return array like param of EEM_Base::get_all()
-     * @throws EE_Error
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method
-     */
-    public function get_one_active($scope = null, $query_params = array())
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     * @param string $type
-     * @return EE_Payment_Method
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
-    }
-
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
-    }
-
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
-     * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                $current_button_url = $payment_method->button_url();
-                $buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
-                    'current_ssl' => str_replace("http://", "https://", $current_button_url),
-                    'current' => str_replace("https://", "http://", $current_button_url),
-                    'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
-                    'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
-                ));
-                foreach ($buttons_urls_to_try as $button_url_to_try) {
-                    if ((// this is the current url and it exists, regardless of SSL issues
-                                $button_url_to_try == $current_button_url &&
-                                EEH_URL::remote_file_exists(
-                                    $button_url_to_try,
-                                    array(
-                                            'sslverify' => false,
-                                            'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
-                                            )
-                                )
-                            )
-                            ||
-                            (// this is NOT the current url and it exists with a working SSL cert
-                                $button_url_to_try != $current_button_url &&
-                                EEH_URL::remote_file_exists($button_url_to_try)
-                            ) ) {
-                        if ($current_button_url != $button_url_to_try) {
-                            $payment_method->save(array( 'PMD_button_url' => $button_url_to_try ));
-                            EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
-                        }
-                        // this image exists. So if wasn't set before, now it is;
-                        // or if it was already set, we have nothing to do
-                        break;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $payment_method->set_active(false);
-            }
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_objects($rows = array())
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = array();
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        __(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     * @param EE_Transaction $transaction
-     * @param string    $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     *
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
-     * It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = array(
-            0 => array(
-                'Payment.Registration.REG_ID' => $registration_id,
-            ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
-        );
-        return $this->get_one($query_params);
-    }
+			'Payment' => new EE_Has_Many_Relation(),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets one by the slug provided
+	 * @param string $slug
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+	}
+
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			array(
+				self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Determines if this is an valid scope
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets all active payment methods
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @throws EE_Error
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_active($scope = null, $query_params = array())
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array $query_params
+	 * @return int
+	 */
+	public function count_active($scope = null, $query_params = array())
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params like EEM_Base::get_all.
+	 * @return array like param of EEM_Base::get_all()
+	 * @throws EE_Error
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+			} else {
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
+			}
+		} else {
+			$acceptable_scopes = array();
+			$count = 0;
+			foreach ($this->scopes() as $scope_name => $desc) {
+				$count++;
+				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+			}
+			return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+		}
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params like EEM_Base::get_all.
+	 * @return array like param of EEM_Base::get_all()
+	 * @throws EE_Error
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_active($scope = null, $query_params = array())
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 * @param string $type
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one(array( array( 'PMD_type' => $type ) ));
+	}
+
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 * @see EEM_Base::ensure_is_obj()
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
+	}
+
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
+	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				$current_button_url = $payment_method->button_url();
+				$buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
+					'current_ssl' => str_replace("http://", "https://", $current_button_url),
+					'current' => str_replace("https://", "http://", $current_button_url),
+					'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
+					'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
+				));
+				foreach ($buttons_urls_to_try as $button_url_to_try) {
+					if ((// this is the current url and it exists, regardless of SSL issues
+								$button_url_to_try == $current_button_url &&
+								EEH_URL::remote_file_exists(
+									$button_url_to_try,
+									array(
+											'sslverify' => false,
+											'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+											)
+								)
+							)
+							||
+							(// this is NOT the current url and it exists with a working SSL cert
+								$button_url_to_try != $current_button_url &&
+								EEH_URL::remote_file_exists($button_url_to_try)
+							) ) {
+						if ($current_button_url != $button_url_to_try) {
+							$payment_method->save(array( 'PMD_button_url' => $button_url_to_try ));
+							EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
+						}
+						// this image exists. So if wasn't set before, now it is;
+						// or if it was already set, we have nothing to do
+						break;
+					}
+				}
+			} catch (EE_Error $e) {
+				$payment_method->set_active(false);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_objects($rows = array())
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = array();
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 * @param EE_Transaction $transaction
+	 * @param string    $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 *
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
+	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Payment|null
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = array(
+			0 => array(
+				'Payment.Registration.REG_ID' => $registration_id,
+			),
+			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+		);
+		return $this->get_one($query_params);
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -44,7 +44,7 @@ 
     {
         $this->singlular_item = __('Payment Method', 'event_espresso');
         $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+        $this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
         $this->_fields = array(
             'Payment_Method' => array(
                 'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
@@ -79,7 +79,7 @@ 
      */
     public function get_one_by_slug($slug)
     {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+        return $this->get_one(array(array('PMD_slug' => $slug)));
     }
 
 
@@ -110,7 +110,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         } else {
             return false;
@@ -128,8 +128,8 @@ 
      */
     public function get_all_active($scope = null, $query_params = array())
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+            $query_params['order_by'] = array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC');
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
     }
@@ -157,7 +157,7 @@ 
     {
         if ($scope) {
             if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+                return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
             } else {
                 throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
             }
@@ -166,9 +166,9 @@ 
             $count = 0;
             foreach ($this->scopes() as $scope_name => $desc) {
                 $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+                $acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
             }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+            return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
         }
     }
 
@@ -206,7 +206,7 @@ 
      */
     public function get_one_of_type($type)
     {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
+        return $this->get_one(array(array('PMD_type' => $type)));
     }
 
 
@@ -279,7 +279,7 @@ 
                                     $button_url_to_try,
                                     array(
                                             'sslverify' => false,
-                                            'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+                                            'limit_response_size' => 4095, // we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
                                             )
                                 )
                             )
@@ -287,9 +287,9 @@ 
                             (// this is NOT the current url and it exists with a working SSL cert
                                 $button_url_to_try != $current_button_url &&
                                 EEH_URL::remote_file_exists($button_url_to_try)
-                            ) ) {
+                            )) {
                         if ($current_button_url != $button_url_to_try) {
-                            $payment_method->save(array( 'PMD_button_url' => $button_url_to_try ));
+                            $payment_method->save(array('PMD_button_url' => $button_url_to_try));
                             EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
                         }
                         // this image exists. So if wasn't set before, now it is;
@@ -322,7 +322,7 @@ 
         $usable_payment_methods = array();
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -336,7 +336,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         __(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -344,7 +344,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true
@@ -369,7 +369,7 @@ 
         // give addons a chance to override what payment methods are chosen based on the transaction
         return apply_filters(
             'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+            $this->get_all_active($scope, array('group_by' => 'PMD_type')),
             $transaction,
             $scope
         );
@@ -393,7 +393,7 @@ 
             0 => array(
                 'Payment.Registration.REG_ID' => $registration_id,
             ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+            'order_by' => array('Payment.PAY_ID' => 'DESC')
         );
         return $this->get_one($query_params);
     }

core/db_models/EEM_Price.model.php

Doc Comments +5 added lines, -5 removed lines

@@ -66,7 +66,7 @@ 
      *      instantiate a new price object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Base_Class|null       array on success, FALSE on fail
      */
     public function get_new_price()
     {
@@ -96,7 +96,7 @@ 
      *
      * @access        public
      * @param int $EVT_ID
-     * @return array on success
+     * @return EE_Base_Class[] on success
      */
     public function get_all_event_prices($EVT_ID = 0)
     {
@@ -223,7 +223,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
     {
@@ -241,7 +241,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
     {
@@ -258,7 +258,7 @@ 
      *
      *      @access     public
      *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
+     *      @return         EE_Base_Class[]     false on fail
      */
     public function get_all_prices_that_are_type($type = 0)
     {

Indentation +275 added lines, -275 removed lines

@@ -10,279 +10,279 @@
 class EEM_Price extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Price object
-    protected static $_instance = null;
-
-
-
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_Price
-     */
-    protected function __construct($timezone)
-    {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->singular_item = __('Price', 'event_espresso');
-        $this->plural_item = __('Prices', 'event_espresso');
-
-        $this->_tables = array(
-            'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
-        );
-        $this->_fields = array(
-            'Price'=> array(
-                'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
-                'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
-                'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
-                'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
-                'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
-                'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
-                'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
-                'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
-                'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
-                'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
-                'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
-            'Price_Type'=>new EE_Belongs_To_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     *      instantiate a new price object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price()
-    {
-        return $this->create_default_object();
-    }
-
-
-
-
-
-    /**
-     *      retrieve  ALL prices from db
-     *
-     *      @access     public
-     *      @return     EE_PRice[]
-     */
-    public function get_all_prices()
-    {
-        // retrieve all prices
-        return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
-    }
-
-
-
-    /**
-     *        retrieve all active prices for a particular event
-     *
-     * @access        public
-     * @param int $EVT_ID
-     * @return array on success
-     */
-    public function get_all_event_prices($EVT_ID = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-    /**
-     *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
-     *
-     *      @access     public
-     *      @param      boolean         $count  return count
-     *      @return         array           on success
-     *      @return         boolean     false on fail
-     */
-    public function get_all_default_prices($count = false)
-    {
-        $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
-            'PRC_deleted' => 0,
-            'PRC_is_default' => 1
-        );
-        $_query_params = array(
-            $_where,
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        );
-        return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
-    }
-
-
-
-
-
-
-
-
-
-
-    /**
-     *      retrieve all prices that are taxes
-     *
-     *      @access     public
-     *      @return         array               on success
-     *      @return         array top-level keys are the price's order and their values are an array,
-     *                      next-level keys are the price's ID, and their values are EE_Price objects
-     */
-    public function get_all_prices_that_are_taxes()
-    {
-        $taxes = array();
-        $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
-        ));
-        foreach ($all_taxes as $tax) {
-            if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
-            }
-        }
-        return $taxes;
-    }
-
-
-
-
-
-    /**
-     *      retrieve all prices for an ticket plus default global prices, but not taxes
-     *
-     *      @access     public
-     *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
-     *      @return         boolean         false on fail
-     */
-    public function get_all_ticket_prices_for_admin($TKT_ID = 0)
-    {
-        $array_of_price_objects = array();
-        if (empty($TKT_ID)) {
-            // if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
-            // return that list
-            $default_prices = $this->get_all_default_prices();
-
-            if ($default_prices) {
-                foreach ($default_prices as $price) {
-                    if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
-                    }
-                }
-                return $array_of_price_objects;
-            } else {
-                return array();
-            }
-        } else {
-            $ticket_prices = $this->get_all(array(
-                array(
-                    'TKT_ID'=>$TKT_ID,
-                    'PRC_deleted' => 0
-                    ),
-                'order_by'=> array('PRC_order' => 'ASC')
-            ));
-        }
-
-        if (!empty($ticket_prices)) {
-            foreach ($ticket_prices as $price) {
-                if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
-                }
-            }
-            return $array_of_price_objects;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_type
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
-            return $this->_sort_event_prices_by_order($price_a, $price_b);
-        }
-        return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_order
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->order() == $price_b->order()) {
-            return 0;
-        }
-        return $price_a->order() < $price_b->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *      get all prices of a specific type
-     *
-     *      @access     public
-     *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
-     */
-    public function get_all_prices_that_are_type($type = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'PRT_ID'=>$type
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-
-    /**
-     * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
-     * Of course you don't have to use it, but this is the order we usually want to sort prices by
-     * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
-     */
-    public function _order_by_array_for_get_all_method()
-    {
-        return array(
-                'PRC_order'=>'ASC',
-                'Price_Type.PRT_order'=>'ASC',
-                'PRC_ID'=>'ASC'
-        );
-    }
+	// private instance of the EEM_Price object
+	protected static $_instance = null;
+
+
+
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_Price
+	 */
+	protected function __construct($timezone)
+	{
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->singular_item = __('Price', 'event_espresso');
+		$this->plural_item = __('Prices', 'event_espresso');
+
+		$this->_tables = array(
+			'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
+		);
+		$this->_fields = array(
+			'Price'=> array(
+				'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
+				'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
+				'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
+				'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
+				'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
+				'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
+				'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
+				'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
+				'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
+				'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
+				'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
+			'Price_Type'=>new EE_Belongs_To_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 *      instantiate a new price object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price()
+	{
+		return $this->create_default_object();
+	}
+
+
+
+
+
+	/**
+	 *      retrieve  ALL prices from db
+	 *
+	 *      @access     public
+	 *      @return     EE_PRice[]
+	 */
+	public function get_all_prices()
+	{
+		// retrieve all prices
+		return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
+	}
+
+
+
+	/**
+	 *        retrieve all active prices for a particular event
+	 *
+	 * @access        public
+	 * @param int $EVT_ID
+	 * @return array on success
+	 */
+	public function get_all_event_prices($EVT_ID = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'EVT_ID'=>$EVT_ID,
+				'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+	/**
+	 *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
+	 *
+	 *      @access     public
+	 *      @param      boolean         $count  return count
+	 *      @return         array           on success
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_default_prices($count = false)
+	{
+		$_where = array(
+			'Price_Type.PBT_ID'=>array('!=',4),
+			'PRC_deleted' => 0,
+			'PRC_is_default' => 1
+		);
+		$_query_params = array(
+			$_where,
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		);
+		return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
+	}
+
+
+
+
+
+
+
+
+
+
+	/**
+	 *      retrieve all prices that are taxes
+	 *
+	 *      @access     public
+	 *      @return         array               on success
+	 *      @return         array top-level keys are the price's order and their values are an array,
+	 *                      next-level keys are the price's ID, and their values are EE_Price objects
+	 */
+	public function get_all_prices_that_are_taxes()
+	{
+		$taxes = array();
+		$all_taxes = $this->get_all(array(
+			array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
+			'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+		));
+		foreach ($all_taxes as $tax) {
+			if ($tax instanceof EE_Price) {
+				$taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+			}
+		}
+		return $taxes;
+	}
+
+
+
+
+
+	/**
+	 *      retrieve all prices for an ticket plus default global prices, but not taxes
+	 *
+	 *      @access     public
+	 *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
+	 *      @return         boolean         false on fail
+	 */
+	public function get_all_ticket_prices_for_admin($TKT_ID = 0)
+	{
+		$array_of_price_objects = array();
+		if (empty($TKT_ID)) {
+			// if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
+			// return that list
+			$default_prices = $this->get_all_default_prices();
+
+			if ($default_prices) {
+				foreach ($default_prices as $price) {
+					if ($price instanceof EE_Price) {
+						$array_of_price_objects[ $price->type() ][] = $price;
+					}
+				}
+				return $array_of_price_objects;
+			} else {
+				return array();
+			}
+		} else {
+			$ticket_prices = $this->get_all(array(
+				array(
+					'TKT_ID'=>$TKT_ID,
+					'PRC_deleted' => 0
+					),
+				'order_by'=> array('PRC_order' => 'ASC')
+			));
+		}
+
+		if (!empty($ticket_prices)) {
+			foreach ($ticket_prices as $price) {
+				if ($price instanceof EE_Price) {
+					$array_of_price_objects[ $price->type() ][] = $price;
+				}
+			}
+			return $array_of_price_objects;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_type
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
+			return $this->_sort_event_prices_by_order($price_a, $price_b);
+		}
+		return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_order
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->order() == $price_b->order()) {
+			return 0;
+		}
+		return $price_a->order() < $price_b->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *      get all prices of a specific type
+	 *
+	 *      @access     public
+	 *      @param      int                 $type - PRT_ID
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_prices_that_are_type($type = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'PRT_ID'=>$type
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+
+	/**
+	 * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
+	 * Of course you don't have to use it, but this is the order we usually want to sort prices by
+	 * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
+	 */
+	public function _order_by_array_for_get_all_method()
+	{
+		return array(
+				'PRC_order'=>'ASC',
+				'Price_Type.PRT_order'=>'ASC',
+				'PRC_ID'=>'ASC'
+		);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -24,7 +24,7 @@ 
      */
     protected function __construct($timezone)
     {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->singular_item = __('Price', 'event_espresso');
         $this->plural_item = __('Prices', 'event_espresso');
 
@@ -52,11 +52,11 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
         parent::__construct($timezone);
     }
 
@@ -103,7 +103,7 @@ 
         return $this->get_all(array(
             array(
                 'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+                'Price_Type.PBT_ID'=>array('!=', EEM_Price_Type::base_type_tax)
             ),
             'order_by'=>$this->_order_by_array_for_get_all_method()
         ));
@@ -121,7 +121,7 @@ 
     public function get_all_default_prices($count = false)
     {
         $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
+            'Price_Type.PBT_ID'=>array('!=', 4),
             'PRC_deleted' => 0,
             'PRC_is_default' => 1
         );
@@ -153,12 +153,12 @@ 
     {
         $taxes = array();
         $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+            array('Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax),
+            'order_by' => array('Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC')
         ));
         foreach ($all_taxes as $tax) {
             if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+                $taxes[$tax->order()][$tax->ID()] = $tax;
             }
         }
         return $taxes;
@@ -186,7 +186,7 @@ 
             if ($default_prices) {
                 foreach ($default_prices as $price) {
                     if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
+                        $array_of_price_objects[$price->type()][] = $price;
                     }
                 }
                 return $array_of_price_objects;
@@ -203,10 +203,10 @@ 
             ));
         }
 
-        if (!empty($ticket_prices)) {
+        if ( ! empty($ticket_prices)) {
             foreach ($ticket_prices as $price) {
                 if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
+                    $array_of_price_objects[$price->type()][] = $price;
                 }
             }
             return $array_of_price_objects;

core/db_models/EEM_Price_Type.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * return an array of Base types. Keys are INTs which are used in the database,
      * values are text-representations of the base type.
-     * @return array
+     * @return integer
      */
     public function get_base_types()
     {
@@ -107,7 +107,7 @@ 
      *      instantiate a new price type object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Price_Type       array on success, FALSE on fail
      */
     public function get_new_price_type()
     {

Indentation +123 added lines, -123 removed lines

@@ -11,108 +11,108 @@ 
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the Price Type object
-    protected static $_instance = null;
-    // An array of the price type objects
-    public $type = null;
-
-    /**
-    *   Price Base types
-    *
-    *   @access private
-    *   @var int
-    */
-    public $base_types = null;
-
-    /**
-     * return an array of Base types. Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     * @return array
-     */
-    public function get_base_types()
-    {
-        return $this->base_types;
-    }
-
-    /**
-     * Gets the name of the base
-     * @param type $base_type_int
-     * @return type
-     */
-    public function get_base_type_name($base_type_int)
-    {
-        return $this->base_types[ $base_type_int ];
-    }
-
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-    const base_type_discount = 2;
-    const base_type_surcharge = 3;
-    const base_type_tax = 4;
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @return void
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->base_types = array(
-            EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
-        $this->singular_item = __('Price Type', 'event_espresso');
-        $this->plural_item = __('Price Types', 'event_espresso');
-
-        $this->_tables = array(
-            'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
-        );
-        $this->_fields = array(
-            'Price_Type'=>array(
-                'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
-                'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
-                'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
-                'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
-                'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
-                'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
-                'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Price'=>new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
-
-
-
-
-    /**
-     *      instantiate a new price type object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price_type()
-    {
-        return EE_Price_Type::new_instance();
-    }
+	// private instance of the Price Type object
+	protected static $_instance = null;
+	// An array of the price type objects
+	public $type = null;
+
+	/**
+	 *   Price Base types
+	 *
+	 *   @access private
+	 *   @var int
+	 */
+	public $base_types = null;
+
+	/**
+	 * return an array of Base types. Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 * @return array
+	 */
+	public function get_base_types()
+	{
+		return $this->base_types;
+	}
+
+	/**
+	 * Gets the name of the base
+	 * @param type $base_type_int
+	 * @return type
+	 */
+	public function get_base_type_name($base_type_int)
+	{
+		return $this->base_types[ $base_type_int ];
+	}
+
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+	const base_type_discount = 2;
+	const base_type_surcharge = 3;
+	const base_type_tax = 4;
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @return void
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->base_types = array(
+			EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
+		$this->singular_item = __('Price Type', 'event_espresso');
+		$this->plural_item = __('Price Types', 'event_espresso');
+
+		$this->_tables = array(
+			'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
+		);
+		$this->_fields = array(
+			'Price_Type'=>array(
+				'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
+				'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
+				'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
+				'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
+				'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
+				'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
+				'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Price'=>new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
+
+
+
+
+	/**
+	 *      instantiate a new price type object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price_type()
+	{
+		return EE_Price_Type::new_instance();
+	}
 
 
 
@@ -131,33 +131,33 @@ 
  *
  * @param type $query_params
  * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+ * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+ * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
  * @return boolean
  */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
 
-        $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+		$would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
 
-        // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = array();
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
-            }
-            $msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
+		// check if any prices use this price type
+		$prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = array();
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name()."(".$price->ID().")";
+			}
+			$msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
 
 
 
-        return parent::delete_permanently($query_params);
-    }
+		return parent::delete_permanently($query_params);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
     /**
@@ -94,7 +94,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -141,10 +141,10 @@ 
         $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+        $prc_query_params = array(array('PRT_ID'=>array('IN', $would_be_deleted_price_type_ids)));
         if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
             $prices_names_and_ids = array();
             foreach ($prices as $price) {

core/db_models/EEM_System_Status.model.php

Doc Comments +2 added lines, -4 removed lines

@@ -15,8 +15,6 @@ 
      *      This function is a singleton method used to instantiate the EEM_Attendee object
      *
      *      @access public
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_System_Status
      */
     public static function instance()
     {
@@ -157,7 +155,7 @@ 
 
     /**
      *
-     * @return array like EE_Config class
+     * @return EE_Config like EE_Config class
      */
     public function get_ee_config()
     {
@@ -214,7 +212,7 @@ 
 
     /**
      * Checks if site responds ot HTTPS
-     * @return boolean
+     * @return string
      */
     public function get_https_enabled()
     {

Spacing +14 added lines, -14 removed lines

@@ -93,9 +93,9 @@ 
         $active_plugins = array_map('strtolower', $active_plugins);
         $plugin_info = array();
         foreach ($active_plugins as $plugin) {
-                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR.'/'.$plugin);
 
-                $plugin_info[ $plugin ] = $plugin_data;
+                $plugin_info[$plugin] = $plugin_data;
         }
         return $plugin_info;
     }
@@ -108,9 +108,9 @@ 
     {
         $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
         if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
+            $wp_memory_to_display = '<mark class="error">'.sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"').'</mark>';
         } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+            $wp_memory_to_display = '<mark class="yes">'.size_format($wp_memory_int).'</mark>';
         }
         return array(
             'name'=>get_bloginfo('name', 'display'),
@@ -149,7 +149,7 @@ 
         $options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
         $presentable_migration_scripts = array();
         foreach ($options as $option_array) {
-            $presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
+            $presentable_migration_scripts[str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name'])] = maybe_unserialize($option_array['option_value']);
         }
         return $presentable_migration_scripts;
 //      return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
@@ -175,18 +175,18 @@ 
 
         $pi = preg_replace(
             array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-            '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+            '#<h1>Configuration</h1>#', "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
             "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
             '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
             .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
             '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
             '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
             "# +#", '#<tr>#', '#</tr>#'),
-            array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+            array('$1', '', '', '', '</$1>'."\n", '<', ' ', ' ', ' ', '', ' ',
             '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
             "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
             '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-            '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+            '<tr><td>Zend Engine</td><td>$2</td></tr>'."\n".
             '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
             ob_get_clean()
         );
@@ -206,7 +206,7 @@ 
             foreach ($askapache as $m) {
                 $m2 = isset($m[2]) ? $m[2] : null;
             }
-              $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
+              $pi[$n][$m[1]] = ( ! isset($m[3]) || $m2 == $m[3]) ? $m2 : array_slice($m, 2);
         }
 
         return $pi;
@@ -235,8 +235,8 @@ 
      */
     public function get_wp_maintenance_mode()
     {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+        $opened = file_exists(ABSPATH.'.maintenance');
+        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso');
     }
     /**
      * Whether or not logging is enabled
@@ -244,8 +244,8 @@ 
      */
     public function get_logging_enabled()
     {
-            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
+            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR.'/logs/espresso_log.txt', 'a');
+            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
     }
     /**
      *  Whether curl ro fsock works
@@ -262,7 +262,7 @@ 
         } elseif ($curl_works) {
             $status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
         } else {
-            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso').'</mark>';
         }
         return $status;
     }

Indentation +273 added lines, -273 removed lines

@@ -6,79 +6,79 @@ 
 class EEM_System_Status
 {
 
-    // private instance of the EEM_System_Status object
-    protected static $_instance = null;
+	// private instance of the EEM_System_Status object
+	protected static $_instance = null;
 
 
 
-    /**
-     *      This function is a singleton method used to instantiate the EEM_Attendee object
-     *
-     *      @access public
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_System_Status
-     */
-    public static function instance()
-    {
+	/**
+	 *      This function is a singleton method used to instantiate the EEM_Attendee object
+	 *
+	 *      @access public
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_System_Status
+	 */
+	public static function instance()
+	{
 
-        // check if instance of EEM_System_Status already exists
-        if (self::$_instance === null) {
-            // instantiate EEM_System_Status
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-    private function __construct()
-    {
-    }
-    /**
-     *
-     * @return array where each key is a function name on this class, and each value is SOMETHING--
-     * it might be a value, an array, or an object
-     */
-    public function get_system_stati()
-    {
-        return apply_filters(
-            'FHEE__EEM_System_Status__get_system_stati',
-            array(
-                'ee_version'=>$this->get_ee_version(),
-                'ee_activation_history'=>$this->get_ee_activation_history(),
-                'ee_config'=>$this->get_ee_config(),
-                'ee_migration_history'=>$this->get_ee_migration_history(),
-                'active_plugins'=>$this->get_active_plugins(),
-                'wp_settings'=>$this->get_wp_settings(),
-                'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
-                'https_enabled'=>$this->get_https_enabled(),
-                'logging_enabled' => $this->get_logging_enabled(),
-                'remote_posting' => $this->get_remote_posting(),
-                'php_version'=>$this->php_version(),
-                'php.ini_settings'=>$this->get_php_ini_all(),
-                'php_info'=>$this->get_php_info(),
-            ),
-            $this
-        );
-    }
-    /**
-     *
-     * @return string
-     */
-    public function get_ee_version()
-    {
-        return espresso_version();
-    }
-    /**
-     *
-     * @return string
-     */
-    public function php_version()
-    {
-        return phpversion();
-    }
-    /**
-     *
-     * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
-     * Sub-arrays like described in wp function get_plugin_data. Ie,     *
-     *  'Name' => 'Plugin Name',
+		// check if instance of EEM_System_Status already exists
+		if (self::$_instance === null) {
+			// instantiate EEM_System_Status
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+	private function __construct()
+	{
+	}
+	/**
+	 *
+	 * @return array where each key is a function name on this class, and each value is SOMETHING--
+	 * it might be a value, an array, or an object
+	 */
+	public function get_system_stati()
+	{
+		return apply_filters(
+			'FHEE__EEM_System_Status__get_system_stati',
+			array(
+				'ee_version'=>$this->get_ee_version(),
+				'ee_activation_history'=>$this->get_ee_activation_history(),
+				'ee_config'=>$this->get_ee_config(),
+				'ee_migration_history'=>$this->get_ee_migration_history(),
+				'active_plugins'=>$this->get_active_plugins(),
+				'wp_settings'=>$this->get_wp_settings(),
+				'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
+				'https_enabled'=>$this->get_https_enabled(),
+				'logging_enabled' => $this->get_logging_enabled(),
+				'remote_posting' => $this->get_remote_posting(),
+				'php_version'=>$this->php_version(),
+				'php.ini_settings'=>$this->get_php_ini_all(),
+				'php_info'=>$this->get_php_info(),
+			),
+			$this
+		);
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function get_ee_version()
+	{
+		return espresso_version();
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function php_version()
+	{
+		return phpversion();
+	}
+	/**
+	 *
+	 * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
+	 * Sub-arrays like described in wp function get_plugin_data. Ie,     *
+	 *  'Name' => 'Plugin Name',
         'PluginURI' => 'Plugin URI',
         'Version' => 'Version',
         'Description' => 'Description',
@@ -87,221 +87,221 @@ 
         'TextDomain' => 'Text Domain',
         'DomainPath' => 'Domain Path',
         'Network' => 'Network',
-     */
-    public function get_active_plugins()
-    {
-        $active_plugins = (array) get_option('active_plugins', array());
-        if (is_multisite()) {
-            $active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
-        }
-        $active_plugins = array_map('strtolower', $active_plugins);
-        $plugin_info = array();
-        foreach ($active_plugins as $plugin) {
-                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+	 */
+	public function get_active_plugins()
+	{
+		$active_plugins = (array) get_option('active_plugins', array());
+		if (is_multisite()) {
+			$active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
+		}
+		$active_plugins = array_map('strtolower', $active_plugins);
+		$plugin_info = array();
+		foreach ($active_plugins as $plugin) {
+				$plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
 
-                $plugin_info[ $plugin ] = $plugin_data;
-        }
-        return $plugin_info;
-    }
+				$plugin_info[ $plugin ] = $plugin_data;
+		}
+		return $plugin_info;
+	}
 
-    /**
-     *
-     * @return array with keys 'home_url' and 'site_url'
-     */
-    public function get_wp_settings()
-    {
-        $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
-        if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
-        } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
-        }
-        return array(
-            'name'=>get_bloginfo('name', 'display'),
-            'is_multisite'=>is_multisite(),
-            'version'=>  get_bloginfo('version', 'display'),
-            'home_url'=>home_url(),
-            'site_url'=>site_url(),
-            'WP_DEBUG'=>WP_DEBUG,
-            'permalink_structure'=>get_option('permalink_structure'),
-            'theme'=>wp_get_theme(),
-            'gmt_offset'=>get_option('gmt_offset'),
-            'timezone_string'=>get_option('timezone_string'),
-            'admin_email'=>  get_bloginfo('admin_email', 'display'),
-            'language'=>get_bloginfo('language', 'display'),
-            'wp_max_upload_size' => size_format(wp_max_upload_size()),
-            'wp_memory' => $wp_memory_to_display
-            );
-    }
+	/**
+	 *
+	 * @return array with keys 'home_url' and 'site_url'
+	 */
+	public function get_wp_settings()
+	{
+		$wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
+		if ($wp_memory_int < 67108864) {
+			$wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
+		} else {
+			$wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+		}
+		return array(
+			'name'=>get_bloginfo('name', 'display'),
+			'is_multisite'=>is_multisite(),
+			'version'=>  get_bloginfo('version', 'display'),
+			'home_url'=>home_url(),
+			'site_url'=>site_url(),
+			'WP_DEBUG'=>WP_DEBUG,
+			'permalink_structure'=>get_option('permalink_structure'),
+			'theme'=>wp_get_theme(),
+			'gmt_offset'=>get_option('gmt_offset'),
+			'timezone_string'=>get_option('timezone_string'),
+			'admin_email'=>  get_bloginfo('admin_email', 'display'),
+			'language'=>get_bloginfo('language', 'display'),
+			'wp_max_upload_size' => size_format(wp_max_upload_size()),
+			'wp_memory' => $wp_memory_to_display
+			);
+	}
 
-    /**
-     * Gets an array of information about the history of ee versions installed
-     * @return array
-     */
-    public function get_ee_activation_history()
-    {
-        return get_option('espresso_db_update');
-    }
+	/**
+	 * Gets an array of information about the history of ee versions installed
+	 * @return array
+	 */
+	public function get_ee_activation_history()
+	{
+		return get_option('espresso_db_update');
+	}
 
 
-    /**
-     * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function get_ee_migration_history()
-    {
-        $options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
-        $presentable_migration_scripts = array();
-        foreach ($options as $option_array) {
-            $presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
-        }
-        return $presentable_migration_scripts;
+	/**
+	 * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function get_ee_migration_history()
+	{
+		$options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
+		$presentable_migration_scripts = array();
+		foreach ($options as $option_array) {
+			$presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
+		}
+		return $presentable_migration_scripts;
 //      return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
-    }
+	}
 
-    /**
-     *
-     * @return array like EE_Config class
-     */
-    public function get_ee_config()
-    {
-        return EE_Config::instance();
-    }
+	/**
+	 *
+	 * @return array like EE_Config class
+	 */
+	public function get_ee_config()
+	{
+		return EE_Config::instance();
+	}
 
-    /**
-     * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
-     * @return array like the output of phpinfo(), but in an array
-     */
-    public function get_php_info()
-    {
-        ob_start();
-        phpinfo(-1);
+	/**
+	 * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
+	 * @return array like the output of phpinfo(), but in an array
+	 */
+	public function get_php_info()
+	{
+		ob_start();
+		phpinfo(-1);
 
-        $pi = preg_replace(
-            array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-            '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
-            "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
-            .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
-            '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
-            "# +#", '#<tr>#', '#</tr>#'),
-            array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
-            '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
-            "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
-            '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-            '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
-            '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
-            ob_get_clean()
-        );
+		$pi = preg_replace(
+			array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
+			'#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+			"#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
+			.'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
+			'#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
+			"# +#", '#<tr>#', '#</tr>#'),
+			array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+			'<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
+			"\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
+			'<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
+			'<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+			'<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
+			ob_get_clean()
+		);
 
-        $sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
-        unset($sections[0]);
+		$sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
+		unset($sections[0]);
 
-        $pi = array();
-        foreach ($sections as $section) {
-            $n = substr($section, 0, strpos($section, '</h2>'));
-            preg_match_all(
-                '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
-                $section,
-                $askapache,
-                PREG_SET_ORDER
-            );
-            foreach ($askapache as $m) {
-                $m2 = isset($m[2]) ? $m[2] : null;
-            }
-              $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
-        }
+		$pi = array();
+		foreach ($sections as $section) {
+			$n = substr($section, 0, strpos($section, '</h2>'));
+			preg_match_all(
+				'#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
+				$section,
+				$askapache,
+				PREG_SET_ORDER
+			);
+			foreach ($askapache as $m) {
+				$m2 = isset($m[2]) ? $m[2] : null;
+			}
+			  $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
+		}
 
-        return $pi;
-    }
+		return $pi;
+	}
 
-    /**
-     * Checks if site responds ot HTTPS
-     * @return boolean
-     */
-    public function get_https_enabled()
-    {
-        $home = str_replace("http://", "https://", home_url());
-        $response = wp_remote_get($home);
-        if ($response instanceof WP_Error) {
-            $error_string = '';
-            foreach ($response->errors as $short_name => $description_array) {
-                $error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
-            }
-            return $error_string;
-        }
-        return "ok!";
-    }
-    /**
-     * Whether or not a .maintenance file is detected
-     * @return string descripting wp_maintenance_mode status
-     */
-    public function get_wp_maintenance_mode()
-    {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
-    }
-    /**
-     * Whether or not logging is enabled
-     * @return string descripting logging's status
-     */
-    public function get_logging_enabled()
-    {
-            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
-    }
-    /**
-     *  Whether curl ro fsock works
-     * @return string describing posting's status
-     */
-    public function get_remote_posting()
-    {
-        $fsock_works = function_exists('fsockopen');
-        $curl_works = function_exists('curl_init');
-        if ($fsock_works && $curl_works) {
-            $status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
-        } elseif ($fsock_works) {
-            $status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
-        } elseif ($curl_works) {
-            $status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-        } else {
-            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
-        }
-        return $status;
-    }
-    /**
-     * Gets all the php.ini settings
-     * @return array
-     */
-    public function get_php_ini_all()
-    {
-        return ini_get_all();
-    }
-    /**
-     * Transforms the php.ini notation for numbers (like '2M') to an integer.
-     *
-     * @param type $size
-     * @return int
-     */
-    public function let_to_num($size)
-    {
-        $l      = substr($size, -1);
-        $ret    = substr($size, 0, -1);
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch (strtoupper($l)) {
-            case 'P':
-                $ret *= 1024;
-            case 'T':
-                $ret *= 1024;
-            case 'G':
-                $ret *= 1024;
-            case 'M':
-                $ret *= 1024;
-            case 'K':
-                $ret *= 1024;
-        }
-        // phpcs:enable
-        return $ret;
-    }
+	/**
+	 * Checks if site responds ot HTTPS
+	 * @return boolean
+	 */
+	public function get_https_enabled()
+	{
+		$home = str_replace("http://", "https://", home_url());
+		$response = wp_remote_get($home);
+		if ($response instanceof WP_Error) {
+			$error_string = '';
+			foreach ($response->errors as $short_name => $description_array) {
+				$error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
+			}
+			return $error_string;
+		}
+		return "ok!";
+	}
+	/**
+	 * Whether or not a .maintenance file is detected
+	 * @return string descripting wp_maintenance_mode status
+	 */
+	public function get_wp_maintenance_mode()
+	{
+		$opened = file_exists(ABSPATH . '.maintenance');
+		return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+	}
+	/**
+	 * Whether or not logging is enabled
+	 * @return string descripting logging's status
+	 */
+	public function get_logging_enabled()
+	{
+			$opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
+			return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
+	}
+	/**
+	 *  Whether curl ro fsock works
+	 * @return string describing posting's status
+	 */
+	public function get_remote_posting()
+	{
+		$fsock_works = function_exists('fsockopen');
+		$curl_works = function_exists('curl_init');
+		if ($fsock_works && $curl_works) {
+			$status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
+		} elseif ($fsock_works) {
+			$status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
+		} elseif ($curl_works) {
+			$status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
+		} else {
+			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+		}
+		return $status;
+	}
+	/**
+	 * Gets all the php.ini settings
+	 * @return array
+	 */
+	public function get_php_ini_all()
+	{
+		return ini_get_all();
+	}
+	/**
+	 * Transforms the php.ini notation for numbers (like '2M') to an integer.
+	 *
+	 * @param type $size
+	 * @return int
+	 */
+	public function let_to_num($size)
+	{
+		$l      = substr($size, -1);
+		$ret    = substr($size, 0, -1);
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch (strtoupper($l)) {
+			case 'P':
+				$ret *= 1024;
+			case 'T':
+				$ret *= 1024;
+			case 'G':
+				$ret *= 1024;
+			case 'M':
+				$ret *= 1024;
+			case 'K':
+				$ret *= 1024;
+		}
+		// phpcs:enable
+		return $ret;
+	}
 }

core/db_models/fields/EE_WP_Post_Status_Field.php

Doc Comments -2 removed lines

@@ -32,8 +32,6 @@
      *                                    )
      *                                    )
      * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
      */
     public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
     {

Indentation +97 added lines, -97 removed lines

@@ -3,114 +3,114 @@
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
 
-    protected $_wp_post_stati;
+	protected $_wp_post_stati;
 
 
-    /**
-     * constructor
-     *
-     * @param string  $table_column       column on table
-     * @param string  $nicename           nice name for column(field)
-     * @param bool    $nullable           is this field nullable
-     * @param string  $default_value      default status
-     * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
-     *                                    they can be registered via this property.  The format of the array should be
-     *                                    as follows: array(
-     *                                    'status_reference' => array(
-     *                                    'label' => __('Status Reference Label', 'event_espresso')
-     *                                    'public' => true, //'Whether posts of this status should be shown on the
-     *                                    frontend of the site'
-     *                                    'exclude_from_search' => false, //'Whether posts of this status should be
-     *                                    excluded from wp searches'
-     *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
-     *                                    in queries for the admin "all" view in list table views.
-     *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
-     *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
-     *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
-     *                                    on the admin screen( or you won't see your status count ).
-     *                                    )
-     *                                    )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
-    {
-        $this->_register_new_stati($new_stati);
-        $this->_set_allowed_enum_values();
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
-    }
+	/**
+	 * constructor
+	 *
+	 * @param string  $table_column       column on table
+	 * @param string  $nicename           nice name for column(field)
+	 * @param bool    $nullable           is this field nullable
+	 * @param string  $default_value      default status
+	 * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
+	 *                                    they can be registered via this property.  The format of the array should be
+	 *                                    as follows: array(
+	 *                                    'status_reference' => array(
+	 *                                    'label' => __('Status Reference Label', 'event_espresso')
+	 *                                    'public' => true, //'Whether posts of this status should be shown on the
+	 *                                    frontend of the site'
+	 *                                    'exclude_from_search' => false, //'Whether posts of this status should be
+	 *                                    excluded from wp searches'
+	 *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
+	 *                                    in queries for the admin "all" view in list table views.
+	 *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
+	 *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
+	 *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
+	 *                                    on the admin screen( or you won't see your status count ).
+	 *                                    )
+	 *                                    )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
+	 *                                    set to true, it will be stored as an INT
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
+	{
+		$this->_register_new_stati($new_stati);
+		$this->_set_allowed_enum_values();
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
+	}
 
 
-    /**
-     * This registers any new statuses sent via the $new_stati array on construct
-     *
-     * @access protected
-     * @param  array $new_stati statuses
-     * @return void
-     */
-    protected function _register_new_stati($new_stati)
-    {
+	/**
+	 * This registers any new statuses sent via the $new_stati array on construct
+	 *
+	 * @access protected
+	 * @param  array $new_stati statuses
+	 * @return void
+	 */
+	protected function _register_new_stati($new_stati)
+	{
 
-        foreach ((array) $new_stati as $status_key => $status_args) {
-            $args = array(
-                'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
-                'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
-                'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
-                'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
-                'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
-                'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
-            );
-            register_post_status($status_key, $status_args);
-        }
-    }
+		foreach ((array) $new_stati as $status_key => $status_args) {
+			$args = array(
+				'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
+				'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
+				'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
+				'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
+				'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
+				'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
+			);
+			register_post_status($status_key, $status_args);
+		}
+	}
 
 
-    /**
-     * This sets the _allowed_enum_values property using the $wp_post_stati array
-     *
-     * @access protected
-     * @regurn void
-     */
-    protected function _set_allowed_enum_values()
-    {
-        // first let's get the post_statuses
-        global $wp_post_statuses;
-        $this->_wp_post_stati = $wp_post_statuses;
+	/**
+	 * This sets the _allowed_enum_values property using the $wp_post_stati array
+	 *
+	 * @access protected
+	 * @regurn void
+	 */
+	protected function _set_allowed_enum_values()
+	{
+		// first let's get the post_statuses
+		global $wp_post_statuses;
+		$this->_wp_post_stati = $wp_post_statuses;
 
-        foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
-        }
-    }
+		foreach ($this->_wp_post_stati as $post_status => $args_object) {
+			$this->_allowed_enum_values[ $post_status ] = $args_object->label;
+		}
+	}
 
-    /**
-     * Before calling parent, first double-checks our list of acceptable post
-     * types is up-to-date
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $this->_set_allowed_enum_values();
-        return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * Before calling parent, first double-checks our list of acceptable post
+	 * types is up-to-date
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$this->_set_allowed_enum_values();
+		return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+	}
 
 
 
-    // helper methods for getting various $wp_post_statuses stuff.
+	// helper methods for getting various $wp_post_statuses stuff.
 
-    /**
-     * This just returns the status object for the given status
-     *
-     * @access public
-     * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
-     * @param  string $status What status object you want
-     * @return std_object         the status object or FALSE if it doesn't exist.
-     */
-    public function get_status_object($status)
-    {
-        return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
-    }
+	/**
+	 * This just returns the status object for the given status
+	 *
+	 * @access public
+	 * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
+	 * @param  string $status What status object you want
+	 * @return std_object         the status object or FALSE if it doesn't exist.
+	 */
+	public function get_status_object($status)
+	{
+		return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
         $this->_wp_post_stati = $wp_post_statuses;
 
         foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
+            $this->_allowed_enum_values[$post_status] = $args_object->label;
         }
     }
 
@@ -111,6 +111,6 @@ 
      */
     public function get_status_object($status)
     {
-        return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
+        return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
     }
 }

core/db_models/helpers/EE_Model_Query_Info_Carrier.php

Doc Comments +14 added lines, -1 removed lines

@@ -44,19 +44,33 @@ 
    
     private $_group_by_sql;
    
+    /**
+     * @param string $limit_sql
+     */
     public function set_limit_sql($limit_sql)
     {
         $this->_limit_sql = $limit_sql;
     }
     
+    /**
+     * @param string $order_by_sql
+     */
     public function set_order_by_sql($order_by_sql)
     {
         $this->_order_by_sql = $order_by_sql;
     }
+
+    /**
+     * @param string $group_by_sql
+     */
     public function set_group_by_sql($group_by_sql)
     {
         $this->_group_by_sql = $group_by_sql;
     }
+
+    /**
+     * @param string $having_sql
+     */
     public function set_having_sql($having_sql)
     {
         $this->_having_sql = $having_sql;
@@ -81,7 +95,6 @@ 
     *
     * @param type $model_included_name
     * @param type $join_sql
-    * @param type $data_types
     */
     public function __construct($model_included_name = array(), $join_sql = '')
     {

Indentation +90 added lines, -90 removed lines

@@ -14,141 +14,141 @@ 
    /**
     * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
     */
-    private $_join_sql;
+	private $_join_sql;
    /**
     *
     * @var array stating all the models that have been included thus far,so we don't get duplicates.
     * Keys are the model relation chains to them from the queried model
     * (eg, "Registration.Transaction.Payment"), and valuesare model names (eg "Payment")
     */
-    private $_models_included;
+	private $_models_included;
    
    /**
     * After we've acquired all the data types, we can create this sql.
     * @var string
     */
-    private $_where_sql;
+	private $_where_sql;
    /**
     * Full join sql. Eg, in a select query, that's everything after the "FROM", and before the "WHERE", so it includes
     * the declaration of the main model's tables, and then appends all the joining sql to other models
     * @var string
     */
-    private $_main_join_sql;
+	private $_main_join_sql;
    
    
-    private $_limit_sql;
+	private $_limit_sql;
    
-    private $_order_by_sql;
+	private $_order_by_sql;
    
-    private $_having_sql;
+	private $_having_sql;
    
-    private $_group_by_sql;
+	private $_group_by_sql;
    
-    public function set_limit_sql($limit_sql)
-    {
-        $this->_limit_sql = $limit_sql;
-    }
+	public function set_limit_sql($limit_sql)
+	{
+		$this->_limit_sql = $limit_sql;
+	}
     
-    public function set_order_by_sql($order_by_sql)
-    {
-        $this->_order_by_sql = $order_by_sql;
-    }
-    public function set_group_by_sql($group_by_sql)
-    {
-        $this->_group_by_sql = $group_by_sql;
-    }
-    public function set_having_sql($having_sql)
-    {
-        $this->_having_sql = $having_sql;
-    }
-    public function get_limit_sql()
-    {
-        return $this->_limit_sql;
-    }
-    public function get_order_by_sql()
-    {
-        return $this->_order_by_sql;
-    }
-    public function get_group_by_sql()
-    {
-        return $this->_group_by_sql;
-    }
-    public function get_having_sql()
-    {
-        return $this->_having_sql;
-    }
+	public function set_order_by_sql($order_by_sql)
+	{
+		$this->_order_by_sql = $order_by_sql;
+	}
+	public function set_group_by_sql($group_by_sql)
+	{
+		$this->_group_by_sql = $group_by_sql;
+	}
+	public function set_having_sql($having_sql)
+	{
+		$this->_having_sql = $having_sql;
+	}
+	public function get_limit_sql()
+	{
+		return $this->_limit_sql;
+	}
+	public function get_order_by_sql()
+	{
+		return $this->_order_by_sql;
+	}
+	public function get_group_by_sql()
+	{
+		return $this->_group_by_sql;
+	}
+	public function get_having_sql()
+	{
+		return $this->_having_sql;
+	}
    /**
     *
     * @param type $model_included_name
     * @param type $join_sql
     * @param type $data_types
     */
-    public function __construct($model_included_name = array(), $join_sql = '')
-    {
-        $this->_models_included = $model_included_name;
-        $this->_join_sql = $join_sql;
-    }
+	public function __construct($model_included_name = array(), $join_sql = '')
+	{
+		$this->_models_included = $model_included_name;
+		$this->_join_sql = $join_sql;
+	}
    
    /**
     * Merges info from the other EEM_Related_Model_Info_Carrier into this one.
     * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier
     */
-    public function merge($other_model_query_info_carrier)
-    {
-        if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
-            $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
-            $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
-        }
-        // otherwise don't merge our data.
-        // yes, this means that we must immediately merge any model data into our grand list
-        // as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
-        // which is carrying info from two models WHERE one is already included but the other is NOT
-    }
+	public function merge($other_model_query_info_carrier)
+	{
+		if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
+			$model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+			$this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
+			$this->_join_sql .= $other_model_query_info_carrier->_join_sql;
+		}
+		// otherwise don't merge our data.
+		// yes, this means that we must immediately merge any model data into our grand list
+		// as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
+		// which is carrying info from two models WHERE one is already included but the other is NOT
+	}
    /**
     * Checks whether or not we have already included all the models mentione din $model_names on the query info varrier
     * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only
     * @return boolean
     */
-    protected function _have_already_included_one_of_these_models($model_names)
-    {
-        foreach ($this->_models_included as $model_relation_path => $model_included) {
-            if (array_key_exists($model_relation_path, $model_names)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	protected function _have_already_included_one_of_these_models($model_names)
+	{
+		foreach ($this->_models_included as $model_relation_path => $model_included) {
+			if (array_key_exists($model_relation_path, $model_names)) {
+				return true;
+			}
+		}
+		return false;
+	}
    /**
     * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details
     * @return array like EE_Model_Query_Info_Carrier::_models_included
     */
-    public function get_model_names_included()
-    {
-        return $this->_models_included;
-    }
+	public function get_model_names_included()
+	{
+		return $this->_models_included;
+	}
    /**
     * sets the $where_sql for later use from client code
     * @param string $where_sql
     */
-    public function set_where_sql($where_sql)
-    {
-        $this->_where_sql = $where_sql;
-    }
-    public function get_where_sql()
-    {
-        return $this->_where_sql;
-    }
+	public function set_where_sql($where_sql)
+	{
+		$this->_where_sql = $where_sql;
+	}
+	public function get_where_sql()
+	{
+		return $this->_where_sql;
+	}
 
    /**
     * Gets the SQL for joining the main model to other models involves in the query, which was set earlier on
     * the EE_Model_Query_info_Carrier by calling set_main_model_join_sql()
     * @return string
     */
-    public function get_main_model_join_sql()
-    {
-        return $this->_main_join_sql;
-    }
+	public function get_main_model_join_sql()
+	{
+		return $this->_main_join_sql;
+	}
 
 
    /**
@@ -158,12 +158,12 @@ 
     * after the FROM and before the WHERE.)
     * @param string $join_sql
     */
-    public function set_main_model_join_sql($join_sql)
-    {
-        $this->_main_join_sql = $join_sql;
-    }
-    public function get_full_join_sql()
-    {
-        return $this->_main_join_sql . $this->_join_sql;
-    }
+	public function set_main_model_join_sql($join_sql)
+	{
+		$this->_main_join_sql = $join_sql;
+	}
+	public function get_full_join_sql()
+	{
+		return $this->_main_join_sql . $this->_join_sql;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
     public function merge($other_model_query_info_carrier)
     {
         if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+            $model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included();
             $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
             $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
         }
@@ -164,6 +164,6 @@ 
     }
     public function get_full_join_sql()
     {
-        return $this->_main_join_sql . $this->_join_sql;
+        return $this->_main_join_sql.$this->_join_sql;
     }
 }

core/db_models/helpers/EE_Secondary_Table.php

Doc Comments +2 added lines, -1 removed lines

@@ -54,7 +54,7 @@ 
      * creates join statement FROM primary table
      * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
      *
-     * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+     * @param string $primary_table_alias_with_model_chain_prefix
      * @return string of SQL
      */
     public function get_join_sql($primary_table_alias_with_model_chain_prefix)
@@ -78,6 +78,7 @@ 
      * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
      * " LEFT JOIN primary_table AS Primary ON ...".
      * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+     * @param string $secondary_table_alias_with_model_chain_prefix
      * @return string
      */
     public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)

Indentation +105 added lines, -105 removed lines

@@ -7,118 +7,118 @@
  */
 class EE_Secondary_Table extends EE_Table_Base
 {
-    protected $_extra_join_conditions;
+	protected $_extra_join_conditions;
 
-    /**
-     *
-     * @global type $wpdb
-     * @param string $table_name with or without wpdb prefix
-     * @param string $pk_column name of primary key column on THIS table
-     * @param string $fk_column the name of the COLUMN that is a foreign key to the primary table's primary key
-     * @param string $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
-     * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
-     *                  or whether each site on a multisite install has a copy of this table
-     */
-    public function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false)
-    {
-        $this->_fk_on_table = $fk_column;
-        $this->_extra_join_conditions = $extra_join_conditions;
-        parent::__construct($table_name, $pk_column, $global);
-    }
-    public function get_fk_on_table()
-    {
-        return $this->_fk_on_table;
-    }
-    public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
-    {
-        $this->_table_to_join_with = $table;
-    }
-    /**
-     *
-     * @return string of sql like "Event.post_type = 'event'", which gets added to
-     * the end of the join statement with the primary table
-     */
-    public function get_extra_join_conditions()
-    {
-        return $this->_extra_join_conditions;
-    }
-    /**
-     *
-     * @return EE_Primary_Table
-     */
-    public function get_table_to_join_with()
-    {
-        return $this->_table_to_join_with;
-    }
-    /**
-     * creates join statement FROM primary table
-     * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
-     *
-     * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
-     * @return string of SQL
-     */
-    public function get_join_sql($primary_table_alias_with_model_chain_prefix)
-    {
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param string $table_name with or without wpdb prefix
+	 * @param string $pk_column name of primary key column on THIS table
+	 * @param string $fk_column the name of the COLUMN that is a foreign key to the primary table's primary key
+	 * @param string $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
+	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
+	 *                  or whether each site on a multisite install has a copy of this table
+	 */
+	public function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false)
+	{
+		$this->_fk_on_table = $fk_column;
+		$this->_extra_join_conditions = $extra_join_conditions;
+		parent::__construct($table_name, $pk_column, $global);
+	}
+	public function get_fk_on_table()
+	{
+		return $this->_fk_on_table;
+	}
+	public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
+	{
+		$this->_table_to_join_with = $table;
+	}
+	/**
+	 *
+	 * @return string of sql like "Event.post_type = 'event'", which gets added to
+	 * the end of the join statement with the primary table
+	 */
+	public function get_extra_join_conditions()
+	{
+		return $this->_extra_join_conditions;
+	}
+	/**
+	 *
+	 * @return EE_Primary_Table
+	 */
+	public function get_table_to_join_with()
+	{
+		return $this->_table_to_join_with;
+	}
+	/**
+	 * creates join statement FROM primary table
+	 * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
+	 *
+	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+	 * @return string of SQL
+	 */
+	public function get_join_sql($primary_table_alias_with_model_chain_prefix)
+	{
 
-        $table_name = $this->get_table_name();
-        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
-        $other_table_pk = $this->get_table_to_join_with()->get_pk_column();
-        $fk = $this->get_fk_on_table();
-        $join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
+		$table_name = $this->get_table_name();
+		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+		$other_table_pk = $this->get_table_to_join_with()->get_pk_column();
+		$fk = $this->get_fk_on_table();
+		$join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql.="AND ".$this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
 
 
-    /**
-     * Produces join SQL like get_join_sql, except instead of joining the primary table to the
-     * secondary table, does the inverse: joins the secondary table to the primary one. (Eg, isntead of
-     * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
-     * " LEFT JOIN primary_table AS Primary ON ...".
-     * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
-     * @return string
-     */
-    public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
-    {
-        $primary_table_name =$this->get_table_to_join_with()->get_table_name();
-        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
-        $fk = $this->get_fk_on_table();
-        $join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
+	/**
+	 * Produces join SQL like get_join_sql, except instead of joining the primary table to the
+	 * secondary table, does the inverse: joins the secondary table to the primary one. (Eg, isntead of
+	 * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
+	 * " LEFT JOIN primary_table AS Primary ON ...".
+	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+	 * @return string
+	 */
+	public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
+	{
+		$primary_table_name =$this->get_table_to_join_with()->get_table_name();
+		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
+		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+		$fk = $this->get_fk_on_table();
+		$join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql.="AND ".$this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
 
-    /**
-     * This prepares the join on the other table using a select with a internal limit.
-     * @param  mixed (array|string) $limit limit
-     * @return string                       SQL to return
-     */
-    public function get_select_join_limit_join($limit)
-    {
-        // first get the select
-        $select = $this->get_select_join_limit($limit);
-        $join_sql = $this->get_join_sql($select);
-        return $join_sql;
-    }
+	/**
+	 * This prepares the join on the other table using a select with a internal limit.
+	 * @param  mixed (array|string) $limit limit
+	 * @return string                       SQL to return
+	 */
+	public function get_select_join_limit_join($limit)
+	{
+		// first get the select
+		$select = $this->get_select_join_limit($limit);
+		$join_sql = $this->get_join_sql($select);
+		return $join_sql;
+	}
 
 
 
-    public function get_fully_qualified_fk_column()
-    {
-        $table_alias = $this->get_table_alias();
-        $fk = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
-    }
+	public function get_fully_qualified_fk_column()
+	{
+		$table_alias = $this->get_table_alias();
+		$fk = $this->get_fk_on_table();
+		return $table_alias . '.' . $fk;
+	}
 
-    public function get_fully_qualified_pk_on_fk_table()
-    {
-        $table_alias = $this->get_table_to_join_with()->get_table_alias();
-        $pk = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
-    }
+	public function get_fully_qualified_pk_on_fk_table()
+	{
+		$table_alias = $this->get_table_to_join_with()->get_table_alias();
+		$pk = $this->get_table_to_join_with()->get_pk_column();
+		return $table_alias . '.' . $pk;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -61,12 +61,12 @@ 
     {
 
         $table_name = $this->get_table_name();
-        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix).$this->get_table_alias();
         $other_table_pk = $this->get_table_to_join_with()->get_pk_column();
         $fk = $this->get_fk_on_table();
         $join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -82,13 +82,13 @@ 
      */
     public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
     {
-        $primary_table_name =$this->get_table_to_join_with()->get_table_name();
-        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+        $primary_table_name = $this->get_table_to_join_with()->get_table_name();
+        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix).$this->get_table_to_join_with()->get_table_alias();
+        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column(); // $this->get_pk_column();
         $fk = $this->get_fk_on_table();
         $join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -112,13 +112,13 @@ 
     {
         $table_alias = $this->get_table_alias();
         $fk = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
+        return $table_alias.'.'.$fk;
     }
 
     public function get_fully_qualified_pk_on_fk_table()
     {
         $table_alias = $this->get_table_to_join_with()->get_table_alias();
         $pk = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
+        return $table_alias.'.'.$pk;
     }
 }

core/db_models/strategies/EE_CPT_Minimum_Where_Conditions.strategy.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,10 @@ 
 
     protected $_post_type;
     protected $_meta_field;
+
+    /**
+     * @param string $post_type
+     */
     public function __construct($post_type, $meta_field_to_chk = '')
     {
         $this->_post_type = $post_type;
@@ -40,7 +44,6 @@ 
     }
     /**
      * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
      * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
      */
     protected function _get_default_where_conditions()

Indentation +36 added lines, -36 removed lines

@@ -3,7 +3,7 @@ 
 /**
  *
  * Class EE_CPT_Minimum_Where_Conditions
-  *
+ *
  * Strategy specifically for adding where conditions specific to CPT models.
  * But only sets the minimum, so any row of the right type will get used
  *
@@ -16,39 +16,39 @@ 
 class EE_CPT_Minimum_Where_Conditions extends EE_Default_Where_Conditions
 {
 
-    protected $_post_type;
-    protected $_meta_field;
-    public function __construct($post_type, $meta_field_to_chk = '')
-    {
-        $this->_post_type = $post_type;
-        $this->_meta_field = $meta_field_to_chk;
-    }
-    /**
-     * Gets the field with the specified column. Note, this function might not work
-     * properly if two fields refer to columns with the same name on different tables
-     * @param string $column column name
-     * @return EE_Model_Field_Base
-     */
-    protected function _get_field_on_column($column)
-    {
-        $all_fields = $this->_model->field_settings(true);
-        foreach ($all_fields as $field_name => $field_obj) {
-            if ($column == $field_obj->get_table_column()) {
-                return $field_obj;
-            }
-        }
-    }
-    /**
-     * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
-     * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
-     */
-    protected function _get_default_where_conditions()
-    {
-        // find post_type field
-        $post_type_field = $this->_get_field_on_column('post_type');
-        return array(
-            $post_type_field->get_name() => $this->_post_type
-        );
-    }
+	protected $_post_type;
+	protected $_meta_field;
+	public function __construct($post_type, $meta_field_to_chk = '')
+	{
+		$this->_post_type = $post_type;
+		$this->_meta_field = $meta_field_to_chk;
+	}
+	/**
+	 * Gets the field with the specified column. Note, this function might not work
+	 * properly if two fields refer to columns with the same name on different tables
+	 * @param string $column column name
+	 * @return EE_Model_Field_Base
+	 */
+	protected function _get_field_on_column($column)
+	{
+		$all_fields = $this->_model->field_settings(true);
+		foreach ($all_fields as $field_name => $field_obj) {
+			if ($column == $field_obj->get_table_column()) {
+				return $field_obj;
+			}
+		}
+	}
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
+	 * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
+	 */
+	protected function _get_default_where_conditions()
+	{
+		// find post_type field
+		$post_type_field = $this->_get_field_on_column('post_type');
+		return array(
+			$post_type_field->get_name() => $this->_post_type
+		);
+	}
 }

core/db_models/strategies/EE_CPT_Where_Conditions.strategy.php

Doc Comments -1 removed lines

@@ -16,7 +16,6 @@
 {
     /**
      * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
      * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
      */
     protected function _get_default_where_conditions()

Indentation +16 added lines, -16 removed lines

@@ -3,7 +3,7 @@ 
 /**
  *
  * Class EE_Default_Where_Conditions
-  *
+ *
  * Strategy specifically for adding where conditions specific to CPT models.
  *
  * @package         Event Espresso
@@ -14,19 +14,19 @@ 
  */
 class EE_CPT_Where_Conditions extends EE_CPT_Minimum_Where_Conditions
 {
-    /**
-     * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
-     * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
-     */
-    protected function _get_default_where_conditions()
-    {
-        $status_field = $this->_get_field_on_column('post_status');
-        return array_merge(
-            parent::_get_default_where_conditions(),
-            array(
-                $status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
-            )
-        );
-    }
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
+	 * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
+	 */
+	protected function _get_default_where_conditions()
+	{
+		$status_field = $this->_get_field_on_column('post_status');
+		return array_merge(
+			parent::_get_default_where_conditions(),
+			array(
+				$status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
+			)
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
         return array_merge(
             parent::_get_default_where_conditions(),
             array(
-                $status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
+                $status_field->get_name() => array('NOT IN', array('auto-draft', 'trash'))
             )
         );
     }