eventespresso / event-espresso-core

core/libraries/form_sections/base/EE_Form_Section_HTML_From_Template.form.php

Indentation +5 added lines, -5 removed lines

@@ -11,11 +11,11 @@
  */
 class EE_Form_Section_HTML_From_Template extends EE_Form_Section_HTML
 {
-    public function __construct($template_file, $args = array(), $options_array = array())
-    {
-        $html = EEH_Template::locate_template($template_file, $args);
+	public function __construct($template_file, $args = array(), $options_array = array())
+	{
+		$html = EEH_Template::locate_template($template_file, $args);
 
 //      echo " filepath:$template_file html $html";
-        parent::__construct($html, $options_array);
-    }
+		parent::__construct($html, $options_array);
+	}
 }

core/libraries/form_sections/base/EE_Form_Section_Validatable.form.php

Indentation +146 added lines, -146 removed lines

@@ -21,150 +21,150 @@
 abstract class EE_Form_Section_Validatable extends EE_Form_Section_Base
 {
 
-    /**
-     * Array of validation errors in this section. Does not contain validation errors in subsections, however.
-     * Those are stored individually on each subsection.
-     *
-     * @var EE_Validation_Error[]
-     */
-    protected $_validation_errors = array();
-
-
-
-    /**
-     * Errors on this form section. Note: EE_Form_Section_Proper
-     * has another function for getting all errors in this form section and subsections
-     * called get_validation_errors_accumulated
-     *
-     * @return EE_Validation_Error[]
-     */
-    public function get_validation_errors()
-    {
-        return $this->_validation_errors;
-    }
-
-
-
-    /**
-     * returns a comma-separated list of all the validation errors in it.
-     * If we want this to be customizable, we may decide to create a strategy for displaying it
-     *
-     * @return string
-     */
-    public function get_validation_error_string()
-    {
-        $validation_error_messages = array();
-        if ($this->get_validation_errors()) {
-            foreach ($this->get_validation_errors() as $validation_error) {
-                if ($validation_error instanceof EE_Validation_Error) {
-                    $validation_error_messages[] = $validation_error->getMessage();
-                }
-            }
-        }
-        return implode(", ", $validation_error_messages);
-    }
-
-
-
-    /**
-     * Performs validation on this form section (and subsections). Should be called after _normalize()
-     *
-     * @return boolean of whether or not the form section is valid
-     */
-    abstract protected function _validate();
-
-
-
-    /**
-     * Checks if this field has any validation errors
-     *
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if (count($this->_validation_errors)) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-
-    /**
-     * Sanitizes input for this form section
-     *
-     * @param array $req_data is the full request data like $_POST
-     * @return boolean of whether a normalization error occurred
-     */
-    abstract protected function _normalize($req_data);
-
-
-
-    /**
-     * Creates a validation error from the arguments provided, and adds it to the form section's list.
-     * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
-     * adds it to the list of validation errors of errors
-     *
-     * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
-     *                                      proper EE_Validation_Error object
-     * @param string    $error_code         a short key which can be used to uniquely identify the error
-     * @param Exception $previous_exception if there was an exception that caused the error, that exception
-     * @return void
-     */
-    public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
-    {
-        if ($message_or_object instanceof EE_Validation_Error) {
-            $validation_error = $message_or_object;
-            $validation_error->set_form_section($this);
-        } else {
-            $validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
-        }
-        $this->_validation_errors[] = $validation_error;
-    }
-
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * gets the sections like
-     * <br><code>password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }</code>
-     * except we leave it as a PHP object, and leave wp_localize_script to
-     * turn it into a JSON object which can be used by the js
-     *
-     * @return array
-     */
-    abstract public function get_jquery_validation_rules();
-
-
-
-    /**
-     * Checks if this form section's data is present in the req data specified
-     *
-     * @param array $req_data usually $_POST, if null that's what's used
-     * @return boolean
-     */
-    abstract public function form_data_present_in($req_data = null);
-
-
-
-    /**
-     * Removes teh sensitive data from this form section (usually done after
-     * utilizing the data business function, but before saving it somewhere. Eg,
-     * may remove a password from the form after verifying it was correct)
-     *
-     * @return void
-     */
-    abstract public function clean_sensitive_data();
+	/**
+	 * Array of validation errors in this section. Does not contain validation errors in subsections, however.
+	 * Those are stored individually on each subsection.
+	 *
+	 * @var EE_Validation_Error[]
+	 */
+	protected $_validation_errors = array();
+
+
+
+	/**
+	 * Errors on this form section. Note: EE_Form_Section_Proper
+	 * has another function for getting all errors in this form section and subsections
+	 * called get_validation_errors_accumulated
+	 *
+	 * @return EE_Validation_Error[]
+	 */
+	public function get_validation_errors()
+	{
+		return $this->_validation_errors;
+	}
+
+
+
+	/**
+	 * returns a comma-separated list of all the validation errors in it.
+	 * If we want this to be customizable, we may decide to create a strategy for displaying it
+	 *
+	 * @return string
+	 */
+	public function get_validation_error_string()
+	{
+		$validation_error_messages = array();
+		if ($this->get_validation_errors()) {
+			foreach ($this->get_validation_errors() as $validation_error) {
+				if ($validation_error instanceof EE_Validation_Error) {
+					$validation_error_messages[] = $validation_error->getMessage();
+				}
+			}
+		}
+		return implode(", ", $validation_error_messages);
+	}
+
+
+
+	/**
+	 * Performs validation on this form section (and subsections). Should be called after _normalize()
+	 *
+	 * @return boolean of whether or not the form section is valid
+	 */
+	abstract protected function _validate();
+
+
+
+	/**
+	 * Checks if this field has any validation errors
+	 *
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if (count($this->_validation_errors)) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+
+	/**
+	 * Sanitizes input for this form section
+	 *
+	 * @param array $req_data is the full request data like $_POST
+	 * @return boolean of whether a normalization error occurred
+	 */
+	abstract protected function _normalize($req_data);
+
+
+
+	/**
+	 * Creates a validation error from the arguments provided, and adds it to the form section's list.
+	 * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
+	 * adds it to the list of validation errors of errors
+	 *
+	 * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
+	 *                                      proper EE_Validation_Error object
+	 * @param string    $error_code         a short key which can be used to uniquely identify the error
+	 * @param Exception $previous_exception if there was an exception that caused the error, that exception
+	 * @return void
+	 */
+	public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
+	{
+		if ($message_or_object instanceof EE_Validation_Error) {
+			$validation_error = $message_or_object;
+			$validation_error->set_form_section($this);
+		} else {
+			$validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
+		}
+		$this->_validation_errors[] = $validation_error;
+	}
+
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * gets the sections like
+	 * <br><code>password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 * except we leave it as a PHP object, and leave wp_localize_script to
+	 * turn it into a JSON object which can be used by the js
+	 *
+	 * @return array
+	 */
+	abstract public function get_jquery_validation_rules();
+
+
+
+	/**
+	 * Checks if this form section's data is present in the req data specified
+	 *
+	 * @param array $req_data usually $_POST, if null that's what's used
+	 * @return boolean
+	 */
+	abstract public function form_data_present_in($req_data = null);
+
+
+
+	/**
+	 * Removes teh sensitive data from this form section (usually done after
+	 * utilizing the data business function, but before saving it somewhere. Eg,
+	 * may remove a password from the form after verifying it was correct)
+	 *
+	 * @return void
+	 */
+	abstract public function clean_sensitive_data();
 }

core/libraries/form_sections/payment_methods/EE_Billing_Info_Form.form.php

Indentation +69 added lines, -69 removed lines

@@ -14,74 +14,74 @@
 class EE_Billing_Info_Form extends EE_Form_Section_Proper
 {
 
-    /**
-     * The payment method this billing form is for
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance;
-
-
-
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array $options_array @see EE_Form_Section_Proper::__construct()
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = array())
-    {
-        $this->_pm_instance = $payment_method;
-        $this->_layout_strategy = new EE_Div_Per_Section_Layout();
-        parent::__construct($options_array);
-    }
-
-
-
-    /**
-     * Sets the payment method for this billing form
-     * @param EE_Payment_Method $payment_method
-     * @return void
-     */
-    public function set_payment_method(EE_Payment_Method $payment_method)
-    {
-        $this->_pm_instance = $payment_method;
-    }
-
-
-
-    /**
-     * Returns the instance of the payment method this billing form is for
-     * @return EE_Payment_Method
-     */
-    public function payment_method()
-    {
-        return $this->_pm_instance;
-    }
-
-
-
-    /**
-     * payment_fields_autofilled_notice_html
-     * @return string
-     */
-    public function payment_fields_autofilled_notice_html()
-    {
-        return  new EE_Form_Section_HTML(
-            EEH_HTML::p(
-                apply_filters('FHEE__EE_Billing_Info_Form__payment_fields_autofilled_notice_html_text', __('Payment fields have been autofilled because you are in debug mode', 'event_espresso')),
-                '',
-                'important-notice'
-            )
-        );
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
-    }
+	/**
+	 * The payment method this billing form is for
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance;
+
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array $options_array @see EE_Form_Section_Proper::__construct()
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = array())
+	{
+		$this->_pm_instance = $payment_method;
+		$this->_layout_strategy = new EE_Div_Per_Section_Layout();
+		parent::__construct($options_array);
+	}
+
+
+
+	/**
+	 * Sets the payment method for this billing form
+	 * @param EE_Payment_Method $payment_method
+	 * @return void
+	 */
+	public function set_payment_method(EE_Payment_Method $payment_method)
+	{
+		$this->_pm_instance = $payment_method;
+	}
+
+
+
+	/**
+	 * Returns the instance of the payment method this billing form is for
+	 * @return EE_Payment_Method
+	 */
+	public function payment_method()
+	{
+		return $this->_pm_instance;
+	}
+
+
+
+	/**
+	 * payment_fields_autofilled_notice_html
+	 * @return string
+	 */
+	public function payment_fields_autofilled_notice_html()
+	{
+		return  new EE_Form_Section_HTML(
+			EEH_HTML::p(
+				apply_filters('FHEE__EE_Billing_Info_Form__payment_fields_autofilled_notice_html_text', __('Payment fields have been autofilled because you are in debug mode', 'event_espresso')),
+				'',
+				'important-notice'
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
+	}
 }
 // End of file EE_Billing_Info_Form.form.php

Spacing +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      */
     public function html_class()
     {
-        return ! empty($this->_html_class) ? $this->_html_class . ' ee-billing-form' : 'ee-billing-form';
+        return ! empty($this->_html_class) ? $this->_html_class.' ee-billing-form' : 'ee-billing-form';
     }
 }
 // End of file EE_Billing_Info_Form.form.php

core/libraries/form_sections/payment_methods/EE_Billing_Attendee_Info_Form.form.php

Indentation +126 added lines, -126 removed lines

@@ -14,139 +14,139 @@
 class EE_Billing_Attendee_Info_Form extends EE_Billing_Info_Form
 {
 
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array $options_array @see EE_Form_Section_Proper::__construct()
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = array())
-    {
-        $options_array['subsections'] = array_merge(
-            array(
-                'first_name'    => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => __('First Name', 'event_espresso') )),
-                'last_name'     => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => __('Last Name', 'event_espresso') )),
-                'email'             => new EE_Email_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => __('Email', 'event_espresso') )),
-                'address'           => new EE_Text_Input(array( 'html_label_text'=>  __('Address', 'event_espresso'), 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
-                'address2'      => new EE_Text_Input(array( 'html_label_text'=> __('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
-                'city'                  => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => __('City', 'event_espresso') )),
-                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => __('State', 'event_espresso') ))),
-                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => __('Country', 'event_espresso') ))),
-                'zip'                   => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => __('Zip', 'event_espresso') )),
-                'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => __('Phone', 'event_espresso') )),
-            ),
-            isset($options_array['subsections']) ? $options_array['subsections'] : array()
-        );
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array $options_array @see EE_Form_Section_Proper::__construct()
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = array())
+	{
+		$options_array['subsections'] = array_merge(
+			array(
+				'first_name'    => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => __('First Name', 'event_espresso') )),
+				'last_name'     => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => __('Last Name', 'event_espresso') )),
+				'email'             => new EE_Email_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => __('Email', 'event_espresso') )),
+				'address'           => new EE_Text_Input(array( 'html_label_text'=>  __('Address', 'event_espresso'), 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
+				'address2'      => new EE_Text_Input(array( 'html_label_text'=> __('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
+				'city'                  => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => __('City', 'event_espresso') )),
+				'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => __('State', 'event_espresso') ))),
+				'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => __('Country', 'event_espresso') ))),
+				'zip'                   => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => __('Zip', 'event_espresso') )),
+				'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => __('Phone', 'event_espresso') )),
+			),
+			isset($options_array['subsections']) ? $options_array['subsections'] : array()
+		);
 
-        parent::__construct($payment_method, $options_array);
-    }
+		parent::__construct($payment_method, $options_array);
+	}
 
-    /**
-     * Sets the defaults for the billing form according to the attendee's details
-     * @param EE_Attendee $attendee
-     */
-    public function populate_from_attendee($attendee)
-    {
-        $attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
-        /** @var $attendee EE_Attendee */
-        $this->populate_defaults(
-            apply_filters(
-                'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
-                array(
-                    'first_name'=>$attendee->fname(),
-                    'last_name'=>$attendee->lname(),
-                    'email'=>$attendee->email(),
-                    'address'=>$attendee->address(),
-                    'address2'=>$attendee->address2(),
-                    'city'=>$attendee->city(),
-                    'state'=> $attendee->state_ID(),
-                    'country'=> $attendee->country_ID(),
-                    'zip'=>$attendee->zip(),
-                    'phone'=>$attendee->phone(),
-                ),
-                $attendee,
-                $this
-            )
-        );
-    }
+	/**
+	 * Sets the defaults for the billing form according to the attendee's details
+	 * @param EE_Attendee $attendee
+	 */
+	public function populate_from_attendee($attendee)
+	{
+		$attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
+		/** @var $attendee EE_Attendee */
+		$this->populate_defaults(
+			apply_filters(
+				'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
+				array(
+					'first_name'=>$attendee->fname(),
+					'last_name'=>$attendee->lname(),
+					'email'=>$attendee->email(),
+					'address'=>$attendee->address(),
+					'address2'=>$attendee->address2(),
+					'city'=>$attendee->city(),
+					'state'=> $attendee->state_ID(),
+					'country'=> $attendee->country_ID(),
+					'zip'=>$attendee->zip(),
+					'phone'=>$attendee->phone(),
+				),
+				$attendee,
+				$this
+			)
+		);
+	}
 
 
 
-    /**
-     * copy_billing_form_data_to_attendee
-     * copies info from the billing form to the attendee's details
-     * @param \EE_Attendee $attendee - the attendee object to copy details to
-     * @return \EE_Attendee
-     */
-    public function copy_billing_form_data_to_attendee(EE_Attendee $attendee)
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        // copy first_name
-        if (! empty($data['first_name'])) {
-            $attendee->set_fname($data['first_name']);
-        }
-        // copy last_name
-        if (! empty($data['last_name'])) {
-            $attendee->set_lname($data['last_name']);
-        }
-        // copy email
-        if (! empty($data['email'])) {
-            $attendee->set_email($data['email']);
-        }
-        // copy address
-        if (! empty($data['address'])) {
-            $attendee->set_address($data['address']);
-        }
-        // copy address2
-        if (! empty($data['address2'])) {
-            $attendee->set_address2($data['address2']);
-        }
-        // copy city
-        if (! empty($data['city'])) {
-            $attendee->set_city($data['city']);
-        }
-        // copy state
-        if (! empty($data['state'])) {
-            $attendee->set_state($data['state']);
-        }
-        // copy country
-        if (! empty($data['country'])) {
-            $attendee->set_country($data['country']);
-        }
-        // copy zip
-        if (! empty($data['zip'])) {
-            $attendee->set_zip($data['zip']);
-        }
-        // copy phone
-        if (! empty($data['phone'])) {
-            $attendee->set_phone($data['phone']);
-        }
-        return $attendee;
-    }
+	/**
+	 * copy_billing_form_data_to_attendee
+	 * copies info from the billing form to the attendee's details
+	 * @param \EE_Attendee $attendee - the attendee object to copy details to
+	 * @return \EE_Attendee
+	 */
+	public function copy_billing_form_data_to_attendee(EE_Attendee $attendee)
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		// copy first_name
+		if (! empty($data['first_name'])) {
+			$attendee->set_fname($data['first_name']);
+		}
+		// copy last_name
+		if (! empty($data['last_name'])) {
+			$attendee->set_lname($data['last_name']);
+		}
+		// copy email
+		if (! empty($data['email'])) {
+			$attendee->set_email($data['email']);
+		}
+		// copy address
+		if (! empty($data['address'])) {
+			$attendee->set_address($data['address']);
+		}
+		// copy address2
+		if (! empty($data['address2'])) {
+			$attendee->set_address2($data['address2']);
+		}
+		// copy city
+		if (! empty($data['city'])) {
+			$attendee->set_city($data['city']);
+		}
+		// copy state
+		if (! empty($data['state'])) {
+			$attendee->set_state($data['state']);
+		}
+		// copy country
+		if (! empty($data['country'])) {
+			$attendee->set_country($data['country']);
+		}
+		// copy zip
+		if (! empty($data['zip'])) {
+			$attendee->set_zip($data['zip']);
+		}
+		// copy phone
+		if (! empty($data['phone'])) {
+			$attendee->set_phone($data['phone']);
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * create_attendee_from_billing_form_data
-     * uses info from the billing form to create a new attendee
-     * @return \EE_Attendee
-     */
-    public function create_attendee_from_billing_form_data()
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        return EE_Attendee::new_instance(array(
-            'ATT_fname'         => ! empty($data['first_name']) ? $data['first_name'] : '',
-            'ATT_lname'         => ! empty($data['last_name']) ? $data['last_name'] : '',
-            'ATT_email'         => ! empty($data['email']) ? $data['email'] : '',
-            'ATT_address'       => ! empty($data['address']) ? $data['address'] : '',
-            'ATT_address2'  => ! empty($data['address2']) ? $data['address2'] : '',
-            'ATT_city'          => ! empty($data['city']) ? $data['city'] : '',
-            'STA_ID'                => ! empty($data['state']) ? $data['state'] : '',
-            'CNT_ISO'           => ! empty($data['country']) ? $data['country'] : '',
-            'ATT_zip'               => ! empty($data['zip']) ? $data['zip'] : '',
-            'ATT_phone'         => ! empty($data['phone']) ? $data['phone'] : '',
-        ));
-    }
+	/**
+	 * create_attendee_from_billing_form_data
+	 * uses info from the billing form to create a new attendee
+	 * @return \EE_Attendee
+	 */
+	public function create_attendee_from_billing_form_data()
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		return EE_Attendee::new_instance(array(
+			'ATT_fname'         => ! empty($data['first_name']) ? $data['first_name'] : '',
+			'ATT_lname'         => ! empty($data['last_name']) ? $data['last_name'] : '',
+			'ATT_email'         => ! empty($data['email']) ? $data['email'] : '',
+			'ATT_address'       => ! empty($data['address']) ? $data['address'] : '',
+			'ATT_address2'  => ! empty($data['address2']) ? $data['address2'] : '',
+			'ATT_city'          => ! empty($data['city']) ? $data['city'] : '',
+			'STA_ID'                => ! empty($data['state']) ? $data['state'] : '',
+			'CNT_ISO'           => ! empty($data['country']) ? $data['country'] : '',
+			'ATT_zip'               => ! empty($data['zip']) ? $data['zip'] : '',
+			'ATT_phone'         => ! empty($data['phone']) ? $data['phone'] : '',
+		));
+	}
 }
 
 // End of file EE_Billing_Attendee_Info_Form.form.php

Spacing +20 added lines, -20 removed lines

@@ -23,16 +23,16 @@ 
     {
         $options_array['subsections'] = array_merge(
             array(
-                'first_name'    => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => __('First Name', 'event_espresso') )),
-                'last_name'     => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => __('Last Name', 'event_espresso') )),
-                'email'             => new EE_Email_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => __('Email', 'event_espresso') )),
-                'address'           => new EE_Text_Input(array( 'html_label_text'=>  __('Address', 'event_espresso'), 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
-                'address2'      => new EE_Text_Input(array( 'html_label_text'=> __('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
-                'city'                  => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => __('City', 'event_espresso') )),
-                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => __('State', 'event_espresso') ))),
-                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => __('Country', 'event_espresso') ))),
-                'zip'                   => new EE_Text_Input(array( 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => __('Zip', 'event_espresso') )),
-                'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => __('Phone', 'event_espresso') )),
+                'first_name'    => new EE_Text_Input(array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => __('First Name', 'event_espresso'))),
+                'last_name'     => new EE_Text_Input(array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => __('Last Name', 'event_espresso'))),
+                'email'             => new EE_Email_Input(array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => __('Email', 'event_espresso'))),
+                'address'           => new EE_Text_Input(array('html_label_text'=>  __('Address', 'event_espresso'), 'required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address')),
+                'address2'      => new EE_Text_Input(array('html_label_text'=> __('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2')),
+                'city'                  => new EE_Text_Input(array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => __('City', 'event_espresso'))),
+                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => __('State', 'event_espresso')))),
+                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => __('Country', 'event_espresso')))),
+                'zip'                   => new EE_Text_Input(array('required'=>true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => __('Zip', 'event_espresso'))),
+                'phone'         => new EE_Text_Input(array('html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => __('Phone', 'event_espresso'))),
             ),
             isset($options_array['subsections']) ? $options_array['subsections'] : array()
         );
@@ -82,43 +82,43 @@ 
         // grab billing form data
         $data = $this->valid_data();
         // copy first_name
-        if (! empty($data['first_name'])) {
+        if ( ! empty($data['first_name'])) {
             $attendee->set_fname($data['first_name']);
         }
         // copy last_name
-        if (! empty($data['last_name'])) {
+        if ( ! empty($data['last_name'])) {
             $attendee->set_lname($data['last_name']);
         }
         // copy email
-        if (! empty($data['email'])) {
+        if ( ! empty($data['email'])) {
             $attendee->set_email($data['email']);
         }
         // copy address
-        if (! empty($data['address'])) {
+        if ( ! empty($data['address'])) {
             $attendee->set_address($data['address']);
         }
         // copy address2
-        if (! empty($data['address2'])) {
+        if ( ! empty($data['address2'])) {
             $attendee->set_address2($data['address2']);
         }
         // copy city
-        if (! empty($data['city'])) {
+        if ( ! empty($data['city'])) {
             $attendee->set_city($data['city']);
         }
         // copy state
-        if (! empty($data['state'])) {
+        if ( ! empty($data['state'])) {
             $attendee->set_state($data['state']);
         }
         // copy country
-        if (! empty($data['country'])) {
+        if ( ! empty($data['country'])) {
             $attendee->set_country($data['country']);
         }
         // copy zip
-        if (! empty($data['zip'])) {
+        if ( ! empty($data['zip'])) {
             $attendee->set_zip($data['zip']);
         }
         // copy phone
-        if (! empty($data['phone'])) {
+        if ( ! empty($data['phone'])) {
             $attendee->set_phone($data['phone']);
         }
         return $attendee;

core/libraries/form_sections/helpers/EE_Validation_Error.error.php

Indentation +41 added lines, -41 removed lines

@@ -2,47 +2,47 @@
 
 class EE_Validation_Error extends Exception
 {
-    /**
-     * Form Section from which this error originated.
-     * @var EE_Form_Section
-     */
-    protected $_form_section;
-    /**
-     * a short string for uniquely identifying the error, which isn't internationalized and
-     * machines can use to identify the error
-     * @var string
-     */
-    protected $_string_code;
+	/**
+	 * Form Section from which this error originated.
+	 * @var EE_Form_Section
+	 */
+	protected $_form_section;
+	/**
+	 * a short string for uniquely identifying the error, which isn't internationalized and
+	 * machines can use to identify the error
+	 * @var string
+	 */
+	protected $_string_code;
 
-    /**
-     * When creating a validation error, we need to know which field the error relates to.
-     * @param string $message message you want to display about this error
-     * @param string $string_code a code for uniquely identifying the exception
-     * @param EE_Form_Section_Validatable $form_section
-     * @param Exception $previous if there was an exception that caused this exception
-     */
-    public function __construct($message = null, $string_code = null, $form_section = null, $previous = null)
-    {
-        $this->_form_section = $form_section;
-        $this->_string_code = $string_code;
-        parent::__construct($message, 500, $previous);
-    }
+	/**
+	 * When creating a validation error, we need to know which field the error relates to.
+	 * @param string $message message you want to display about this error
+	 * @param string $string_code a code for uniquely identifying the exception
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @param Exception $previous if there was an exception that caused this exception
+	 */
+	public function __construct($message = null, $string_code = null, $form_section = null, $previous = null)
+	{
+		$this->_form_section = $form_section;
+		$this->_string_code = $string_code;
+		parent::__construct($message, 500, $previous);
+	}
 
-    /**
-     * returns teh form section which caused the error.
-     * @return EE_Form_Section_Validatable
-     */
-    public function get_form_section()
-    {
-        return $this->_form_section;
-    }
-    /**
-     * Sets teh form seciton of the error, in case it wasnt set previously
-     * @param EE_Form_Section_Validatable $form_section
-     * @return void
-     */
-    public function set_form_section($form_section)
-    {
-        $this->_form_section = $form_section;
-    }
+	/**
+	 * returns teh form section which caused the error.
+	 * @return EE_Form_Section_Validatable
+	 */
+	public function get_form_section()
+	{
+		return $this->_form_section;
+	}
+	/**
+	 * Sets teh form seciton of the error, in case it wasnt set previously
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @return void
+	 */
+	public function set_form_section($form_section)
+	{
+		$this->_form_section = $form_section;
+	}
 }

core/libraries/form_sections/EE_Sample_Form.form.php

Indentation +54 added lines, -54 removed lines

@@ -1,60 +1,60 @@
 <?php
 class EE_Sample_Form extends EE_Form_Section_Proper
 {
-    public function __construct()
-    {
-        $this->_subsections = array(
-            'h1'=>new EE_Form_Section_HTML('hello wordl'),
-            'name'=>new EE_Text_Input(array('required'=>true,'default'=>'your name here')),
-            'email'=>new EE_Email_Input(array('required'=>false)),
-            'shirt_size'=>new EE_Select_Input(array(''=>'Please select...', 's'=>  __("Small", "event_espresso"),'m'=>  __("Medium", "event_espresso"),'l'=>  __("Large", "event_espresso")), array('required'=>true,'default'=>'s')),
-            'month_normal'=>new EE_Month_Input(),
-            'month_leading_zero'=>new EE_Month_Input(true),
-            'year_2'=>new EE_Year_Input(false, 1, 1),
-            'year_4'=>new EE_Year_Input(true, 0, 10, array('default'=>'2017')),
-            'yes_no'=>new EE_Yes_No_Input(array('html_label_text'=>  __("Yes or No", "event_espresso"))),
-            'credit_card'=>new EE_Credit_Card_Input(),
-            'image_1'=>new EE_Admin_File_Uploader_Input(),
-            'image_2'=>new EE_Admin_File_Uploader_Input(),
-            'skillz'=>new EE_Checkbox_Multi_Input(array('php'=>'PHP','mysql'=>'MYSQL'), array('default'=>array('php'))),
-            'float'=>new EE_Float_Input(),
-            'essay'=>new EE_Text_Area_Input(),
-            'amenities'=>new EE_Select_Multiple_Input(
-                array(
-                    'hottub'=>'Hot Tub',
-                    'balcony'=>"Balcony",
-                    'skylight'=>'SkyLight',
-                    'no_axe'=>'No Axe Murderers'
-                ),
-                array(
-                    'default'=>array(
-                        'hottub',
-                        'no_axe' ),
-                )
-            ),
-            'payment_methods'=>new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
-            );
-        $this->_layout_strategy = new EE_Div_Per_Section_Layout();
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		$this->_subsections = array(
+			'h1'=>new EE_Form_Section_HTML('hello wordl'),
+			'name'=>new EE_Text_Input(array('required'=>true,'default'=>'your name here')),
+			'email'=>new EE_Email_Input(array('required'=>false)),
+			'shirt_size'=>new EE_Select_Input(array(''=>'Please select...', 's'=>  __("Small", "event_espresso"),'m'=>  __("Medium", "event_espresso"),'l'=>  __("Large", "event_espresso")), array('required'=>true,'default'=>'s')),
+			'month_normal'=>new EE_Month_Input(),
+			'month_leading_zero'=>new EE_Month_Input(true),
+			'year_2'=>new EE_Year_Input(false, 1, 1),
+			'year_4'=>new EE_Year_Input(true, 0, 10, array('default'=>'2017')),
+			'yes_no'=>new EE_Yes_No_Input(array('html_label_text'=>  __("Yes or No", "event_espresso"))),
+			'credit_card'=>new EE_Credit_Card_Input(),
+			'image_1'=>new EE_Admin_File_Uploader_Input(),
+			'image_2'=>new EE_Admin_File_Uploader_Input(),
+			'skillz'=>new EE_Checkbox_Multi_Input(array('php'=>'PHP','mysql'=>'MYSQL'), array('default'=>array('php'))),
+			'float'=>new EE_Float_Input(),
+			'essay'=>new EE_Text_Area_Input(),
+			'amenities'=>new EE_Select_Multiple_Input(
+				array(
+					'hottub'=>'Hot Tub',
+					'balcony'=>"Balcony",
+					'skylight'=>'SkyLight',
+					'no_axe'=>'No Axe Murderers'
+				),
+				array(
+					'default'=>array(
+						'hottub',
+						'no_axe' ),
+				)
+			),
+			'payment_methods'=>new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
+			);
+		$this->_layout_strategy = new EE_Div_Per_Section_Layout();
+		parent::__construct();
+	}
 
-    /**
-     * Extra validation for the 'name' input.
-     * @param EE_Text_Input $form_input
-     */
-    public function _validate_name($form_input)
-    {
-        if ($form_input->raw_value() != 'Mike') {
-            $form_input->add_validation_error(__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
-        }
-    }
+	/**
+	 * Extra validation for the 'name' input.
+	 * @param EE_Text_Input $form_input
+	 */
+	public function _validate_name($form_input)
+	{
+		if ($form_input->raw_value() != 'Mike') {
+			$form_input->add_validation_error(__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
+		}
+	}
 
-    public function _validate()
-    {
-        parent::_validate();
-        if ($this->_subsections['shirt_size']->normalized_value() =='s'
-                && $this->_subsections['year_4']->normalized_value() < 2010) {
-            $this->add_validation_error(__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
-        }
-    }
+	public function _validate()
+	{
+		parent::_validate();
+		if ($this->_subsections['shirt_size']->normalized_value() =='s'
+				&& $this->_subsections['year_4']->normalized_value() < 2010) {
+			$this->add_validation_error(__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -5,9 +5,9 @@ 
     {
         $this->_subsections = array(
             'h1'=>new EE_Form_Section_HTML('hello wordl'),
-            'name'=>new EE_Text_Input(array('required'=>true,'default'=>'your name here')),
+            'name'=>new EE_Text_Input(array('required'=>true, 'default'=>'your name here')),
             'email'=>new EE_Email_Input(array('required'=>false)),
-            'shirt_size'=>new EE_Select_Input(array(''=>'Please select...', 's'=>  __("Small", "event_espresso"),'m'=>  __("Medium", "event_espresso"),'l'=>  __("Large", "event_espresso")), array('required'=>true,'default'=>'s')),
+            'shirt_size'=>new EE_Select_Input(array(''=>'Please select...', 's'=>  __("Small", "event_espresso"), 'm'=>  __("Medium", "event_espresso"), 'l'=>  __("Large", "event_espresso")), array('required'=>true, 'default'=>'s')),
             'month_normal'=>new EE_Month_Input(),
             'month_leading_zero'=>new EE_Month_Input(true),
             'year_2'=>new EE_Year_Input(false, 1, 1),
@@ -16,7 +16,7 @@ 
             'credit_card'=>new EE_Credit_Card_Input(),
             'image_1'=>new EE_Admin_File_Uploader_Input(),
             'image_2'=>new EE_Admin_File_Uploader_Input(),
-            'skillz'=>new EE_Checkbox_Multi_Input(array('php'=>'PHP','mysql'=>'MYSQL'), array('default'=>array('php'))),
+            'skillz'=>new EE_Checkbox_Multi_Input(array('php'=>'PHP', 'mysql'=>'MYSQL'), array('default'=>array('php'))),
             'float'=>new EE_Float_Input(),
             'essay'=>new EE_Text_Area_Input(),
             'amenities'=>new EE_Select_Multiple_Input(
@@ -52,7 +52,7 @@ 
     public function _validate()
     {
         parent::_validate();
-        if ($this->_subsections['shirt_size']->normalized_value() =='s'
+        if ($this->_subsections['shirt_size']->normalized_value() == 's'
                 && $this->_subsections['year_4']->normalized_value() < 2010) {
             $this->add_validation_error(__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
         }

core/libraries/payment_methods/EE_Offsite_Gateway.lib.php

Indentation +102 added lines, -102 removed lines

@@ -15,117 +15,117 @@
 abstract class EE_Offsite_Gateway extends EE_Gateway
 {
 
-    /**
-     * whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @type bool
-     */
-    protected $_uses_separate_IPN_request = false;
+	/**
+	 * whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @type bool
+	 */
+	protected $_uses_separate_IPN_request = false;
 
 
-    /**
-     * @return EE_Offsite_Gateway
-     */
-    public function __construct()
-    {
-        $this->_supports_receiving_refunds = true;
-        parent::__construct();
-    }
+	/**
+	 * @return EE_Offsite_Gateway
+	 */
+	public function __construct()
+	{
+		$this->_supports_receiving_refunds = true;
+		parent::__construct();
+	}
 
 
-    /**
-     * Adds information into the payment object's redirect_url and redirect_args so
-     * client code can use that payment to know where (and with what information)
-     * to redirect the user to in order to make the payment on the offsite gateway's website.
-     * Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param EE_Payment $payment    to process
-     * @param array      $billing_info
-     * @param string     $return_url URL to send the user to after a successful payment on the payment provider's
-     *                               website
-     * @param string     $notify_url URL to send the instant payment notification
-     * @param string     $cancel_url URL to send the user to after a cancelled payment attempt on teh payment
-     *                               provider's website
-     * @return EE_Payment
-     */
-    abstract public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    );
+	/**
+	 * Adds information into the payment object's redirect_url and redirect_args so
+	 * client code can use that payment to know where (and with what information)
+	 * to redirect the user to in order to make the payment on the offsite gateway's website.
+	 * Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param EE_Payment $payment    to process
+	 * @param array      $billing_info
+	 * @param string     $return_url URL to send the user to after a successful payment on the payment provider's
+	 *                               website
+	 * @param string     $notify_url URL to send the instant payment notification
+	 * @param string     $cancel_url URL to send the user to after a cancelled payment attempt on teh payment
+	 *                               provider's website
+	 * @return EE_Payment
+	 */
+	abstract public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	);
 
 
-    /**
-     * Often used for IPNs. But applies the info in $update_info to the payment.
-     * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
-     * the payment method passes in. Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param array           $update_info of whatever
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment updated
-     */
-    abstract public function handle_payment_update($update_info, $transaction);
+	/**
+	 * Often used for IPNs. But applies the info in $update_info to the payment.
+	 * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
+	 * the payment method passes in. Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param array           $update_info of whatever
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment updated
+	 */
+	abstract public function handle_payment_update($update_info, $transaction);
 
 
-    /**
-     * uses_separate_IPN_request
-     *
-     * return true or false for whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
-     *
-     * @return bool
-     */
-    public function uses_separate_IPN_request()
-    {
-        return $this->_uses_separate_IPN_request;
-    }
+	/**
+	 * uses_separate_IPN_request
+	 *
+	 * return true or false for whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
+	 *
+	 * @return bool
+	 */
+	public function uses_separate_IPN_request()
+	{
+		return $this->_uses_separate_IPN_request;
+	}
 
 
-    /**
-     * set_uses_separate_IPN_request
-     *
-     * @access protected
-     * @param boolean $uses_separate_IPN_request
-     */
-    protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
-    {
-        $this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * set_uses_separate_IPN_request
+	 *
+	 * @access protected
+	 * @param boolean $uses_separate_IPN_request
+	 */
+	protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
+	{
+		$this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Allows gateway to dynamically decide whether or not to handle a payment update
-     * by overriding this method. By default, if this is a "true" IPN (meaning
-     * it's a separate request from when the user returns from the offsite gateway)
-     * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
-     * this will return true, otherwise it will return false.
-     * If however, this is a request when the user is returning
-     * from an offsite gateway, and this gateway class is setup to process the payment
-     * data when the user returns, then this will return true.
-     *
-     * @param array   $request_data
-     * @param boolean $separate_IPN_request
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
-    {
-        if ($separate_IPN_request) {
-            // payment data being sent in a request separate from the user
-            // it is this other request that will update the TXN and payment info
-            return $this->_uses_separate_IPN_request;
-        } else {
-            // it's a request where the user returned from an offsite gateway WITH the payment data
-            return ! $this->_uses_separate_IPN_request;
-        }
-    }
+	/**
+	 * Allows gateway to dynamically decide whether or not to handle a payment update
+	 * by overriding this method. By default, if this is a "true" IPN (meaning
+	 * it's a separate request from when the user returns from the offsite gateway)
+	 * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
+	 * this will return true, otherwise it will return false.
+	 * If however, this is a request when the user is returning
+	 * from an offsite gateway, and this gateway class is setup to process the payment
+	 * data when the user returns, then this will return true.
+	 *
+	 * @param array   $request_data
+	 * @param boolean $separate_IPN_request
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
+	{
+		if ($separate_IPN_request) {
+			// payment data being sent in a request separate from the user
+			// it is this other request that will update the TXN and payment info
+			return $this->_uses_separate_IPN_request;
+		} else {
+			// it's a request where the user returned from an offsite gateway WITH the payment data
+			return ! $this->_uses_separate_IPN_request;
+		}
+	}
 }

core/libraries/payment_methods/EE_PMT_Base.lib.php

Spacing +18 added lines, -18 removed lines

@@ -117,7 +117,7 @@ 
             $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
             do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
         }
-        if (! isset($this->_has_billing_form)) {
+        if ( ! isset($this->_has_billing_form)) {
             // by default, On Site gateways have a billing form
             if ($this->payment_occurs() == EE_PMT_Base::onsite) {
                 $this->set_has_billing_form(true);
@@ -126,7 +126,7 @@ 
             }
         }
 
-        if (! $this->_pretty_name) {
+        if ( ! $this->_pretty_name) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -138,7 +138,7 @@ 
         }
         // if the child didn't specify a default button, use the credit card one
         if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+            $this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods'.DS.'pay-by-credit-card.png';
         }
     }
 
@@ -159,7 +159,7 @@ 
     {
         $reflector = new ReflectionClass(get_class($this));
         $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
+        $this->_file_folder = dirname($fn).DS;
     }
 
 
@@ -192,7 +192,7 @@ 
      */
     public function file_folder()
     {
-        if (! $this->_file_folder) {
+        if ( ! $this->_file_folder) {
             $this->_set_file_folder();
         }
         return $this->_file_folder;
@@ -204,7 +204,7 @@ 
      */
     public function file_url()
     {
-        if (! $this->_file_url) {
+        if ( ! $this->_file_url) {
             $this->_set_file_url();
         }
         return $this->_file_url;
@@ -238,7 +238,7 @@ 
      */
     public function settings_form()
     {
-        if (! $this->_settings_form) {
+        if ( ! $this->_settings_form) {
             $this->_settings_form = $this->generate_new_settings_form();
             $this->_settings_form->set_payment_method_type($this);
             // if we have already assigned a model object to this pmt, make
@@ -292,7 +292,7 @@ 
     public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
     {
         // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+        if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
             $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
         }
         // if we know who the attendee is, and this is a billing form
@@ -394,7 +394,7 @@ 
             $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
             // if we didn't already have a payment in progress for the same thing,
             // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 $payment = EE_Payment::new_instance(
                     array_merge(
                         $duplicate_properties,
@@ -495,7 +495,7 @@ 
     public function handle_ipn($req_data, $transaction)
     {
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
             throw new EE_Error(
                 sprintf(
                     __("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
@@ -518,7 +518,7 @@ 
      */
     protected function _save_billing_info_to_attendee($billing_form, $transaction)
     {
-        if (! $transaction || ! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction || ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __("Cannot save billing info because no transaction was specified", "event_espresso"),
                 __FILE__,
@@ -528,7 +528,7 @@ 
             return false;
         }
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 __("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
                 __FILE__,
@@ -538,7 +538,7 @@ 
             return false;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 __(
                     "Cannot save billing info because the transaction's primary registration has no attendee!",
@@ -651,7 +651,7 @@ 
      */
     public function payment_occurs()
     {
-        if (! $this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
             return EE_PMT_Base::onsite;
@@ -682,7 +682,7 @@ 
     public function payment_overview_content(EE_Payment $payment)
     {
         return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php',
+            EE_LIBRARIES.'payment_methods'.DS.'templates'.DS.'payment_details_content.template.php',
             array('payment_method' => $this->_pm_instance, 'payment' => $payment),
             true
         );
@@ -769,7 +769,7 @@ 
      */
     public function get_help_tab_name()
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
     /**
@@ -780,7 +780,7 @@ 
      */
     public function cap_name()
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
     /**
@@ -814,7 +814,7 @@ 
     public function introductory_html()
     {
         return EEH_Template::locate_template(
-            $this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php',
+            $this->file_folder().'templates'.DS.strtolower($this->system_name()).'_intro.template.php',
             array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
         );
     }

Indentation +808 added lines, -808 removed lines

@@ -21,812 +21,812 @@
 abstract class EE_PMT_Base
 {
 
-    const onsite = 'on-site';
-    const offsite = 'off-site';
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = false;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = null;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = null;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = true;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string
-     */
-    protected $_pretty_name = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_button_url = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_description = null;
-
-
-    /**
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @return EE_PMT_Base
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', DS, $this->file_folder());
-        $file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url = $file_path;
-    }
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description()
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder()
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url()
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     */
-    public function set_instance($payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they setup the payment method
-     *
-     * @return EE_Payment_Method_Form
-     */
-    public function settings_form()
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure its reflected in teh form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form($form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form()
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param \EE_Transaction $transaction
-     * @param array           $extra_args
-     * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
-     */
-    public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            ($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $transaction instanceof EE_Transaction
-                && $transaction->primary_registration() instanceof EE_Registration
-                && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-            ),
-            $this->_billing_form,
-            $transaction
-        )) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form($form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether or not this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https()
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     *
-     * @param EE_Transaction       $transaction
-     * @param float                $amount
-     * @param EE_Billing_Info_Form $billing_info
-     * @param string               $return_url
-     * @param string               $fail_url
-     * @param string               $method
-     * @param bool                 $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_info = null,
-        $return_url = null,
-        $fail_url = '',
-        $method = 'CART',
-        $by_admin = false
-    ) {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            // there is a gateway, so we're going to make a payment object
-            // but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = array(
-                'STS_ID'               => EEM_Payment::status_id_failed,
-                'TXN_ID'               => $transaction->ID(),
-                'PMD_ID'               => $this->_pm_instance->ID(),
-                'PAY_source'           => $method,
-                'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            );
-            $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
-            // if we didn't already have a payment in progress for the same thing,
-            // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        array(
-                            'PAY_timestamp'       => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number'       => null,
-                            'PAY_extra_accntng'   => null,
-                            'PAY_details'         => null,
-                        )
-                    )
-                );
-            }
-            // make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        array(
-                            'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug(),
-                        )
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                array(
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                )
-            );
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            return $billing_form->input_pretty_values(true);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function handle_ipn($req_data, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    __("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        $payment = $this->_gateway->handle_payment_update($req_data, $transaction);
-        return $payment;
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction                $transaction
-     * @return boolean success
-     */
-    protected function _save_billing_info_to_attendee($billing_form, $transaction)
-    {
-        if (! $transaction || ! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                __("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                __(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn($req_data = array())
-    {
-        throw new EE_Error(
-            sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     */
-    public function finalize_payment_for($transaction)
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether or not this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->supports_sending_refunds();
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @throws EE_Error
-     * @return EE_Payment
-     */
-    public function process_refund(EE_Payment $payment, $refund_info = array())
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs()
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        } elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php',
-            array('payment_method' => $this->_pm_instance, 'payment' => $payment),
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return array();
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     * @return string
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string
-     */
-    public function pretty_name()
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string
-     */
-    public function default_button_url()
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway()
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link()
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name()
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name()
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html()
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php',
-            array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
-        );
-    }
+	const onsite = 'on-site';
+	const offsite = 'off-site';
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = false;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = null;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = null;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = true;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_description = null;
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @return EE_PMT_Base
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		$fn = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . DS;
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', DS, $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url = $file_path;
+	}
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description()
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder()
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url()
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 */
+	public function set_instance($payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they setup the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	public function settings_form()
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure its reflected in teh form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form($form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form()
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param array           $extra_args
+	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 */
+	public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $transaction instanceof EE_Transaction
+				&& $transaction->primary_registration() instanceof EE_Registration
+				&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+			),
+			$this->_billing_form,
+			$transaction
+		)) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form($form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether or not this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https()
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 *
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount
+	 * @param EE_Billing_Info_Form $billing_info
+	 * @param string               $return_url
+	 * @param string               $fail_url
+	 * @param string               $method
+	 * @param bool                 $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_info = null,
+		$return_url = null,
+		$fail_url = '',
+		$method = 'CART',
+		$by_admin = false
+	) {
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			// there is a gateway, so we're going to make a payment object
+			// but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = array(
+				'STS_ID'               => EEM_Payment::status_id_failed,
+				'TXN_ID'               => $transaction->ID(),
+				'PMD_ID'               => $this->_pm_instance->ID(),
+				'PAY_source'           => $method,
+				'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			);
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
+			// if we didn't already have a payment in progress for the same thing,
+			// then we actually want to make a new payment
+			if (! $payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						array(
+							'PAY_timestamp'       => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number'       => null,
+							'PAY_extra_accntng'   => null,
+							'PAY_details'         => null,
+						)
+					)
+				);
+			}
+			// make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						array(
+							'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug(),
+						)
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+							'event_espresso'
+						),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				array(
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				)
+			);
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function handle_ipn($req_data, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
+		return $payment;
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction                $transaction
+	 * @return boolean success
+	 */
+	protected function _save_billing_info_to_attendee($billing_form, $transaction)
+	{
+		if (! $transaction || ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				__("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn($req_data = array())
+	{
+		throw new EE_Error(
+			sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 */
+	public function finalize_payment_for($transaction)
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether or not this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->supports_sending_refunds();
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @throws EE_Error
+	 * @return EE_Payment
+	 */
+	public function process_refund(EE_Payment $payment, $refund_info = array())
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs()
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		} elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php',
+			array('payment_method' => $this->_pm_instance, 'payment' => $payment),
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return array();
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 * @return string
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string
+	 */
+	public function default_button_url()
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway()
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link()
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name()
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name()
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html()
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php',
+			array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
+		);
+	}
 }

core/libraries/payment_methods/EE_Onsite_Gateway.lib.php

Indentation +31 added lines, -31 removed lines

@@ -15,36 +15,36 @@
 abstract class EE_Onsite_Gateway extends EE_Gateway
 {
 
-    /**
-     * @return EE_Onsite_Gateway
-     */
-    public function __construct()
-    {
-        $this->_supports_sending_refunds = true;
-        parent::__construct();
-    }
+	/**
+	 * @return EE_Onsite_Gateway
+	 */
+	public function __construct()
+	{
+		$this->_supports_sending_refunds = true;
+		parent::__construct();
+	}
 
-    /**
-     * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
-     * usually send a request directly to the payment provider and update the payment's status based on that;
-     * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
-     * for sending the request via http_remote_request(). Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param EEI_Payment $payment
-     * @param array       $billing_info {
-     * @type              $first_name   string
-     * @type              $last_name    string
-     * @type              $email        string
-     * @type              $address      string
-     * @type              $address2     string
-     * @type              $city         string
-     * @type              $state        string name of the state (NOT int)
-     * @type              $country      string 2-character ISO code see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-     * @type              $zip          string
-     * @type              $phone        string
-     *                                  } unless a child class specifies these array keys are NOT present
-     * @return EE_Payment updated
-     */
-    abstract public function do_direct_payment($payment, $billing_info = null);
+	/**
+	 * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
+	 * usually send a request directly to the payment provider and update the payment's status based on that;
+	 * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
+	 * for sending the request via http_remote_request(). Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info {
+	 * @type              $first_name   string
+	 * @type              $last_name    string
+	 * @type              $email        string
+	 * @type              $address      string
+	 * @type              $address2     string
+	 * @type              $city         string
+	 * @type              $state        string name of the state (NOT int)
+	 * @type              $country      string 2-character ISO code see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+	 * @type              $zip          string
+	 * @type              $phone        string
+	 *                                  } unless a child class specifies these array keys are NOT present
+	 * @return EE_Payment updated
+	 */
+	abstract public function do_direct_payment($payment, $billing_info = null);
 }