eventespresso / event-espresso-core

core/interfaces/payments/EEI_Payment.interface.php

Indentation +83 added lines, -83 removed lines

@@ -7,129 +7,129 @@
 interface EEI_Payment extends EEI_Base
 {
 
-    /**
-     * @return string indicating which the payment is approved, pending, cancelled or failed
-     */
-    public function status();
+	/**
+	 * @return string indicating which the payment is approved, pending, cancelled or failed
+	 */
+	public function status();
 
 
 
-    /**
-     * @return float returns the amount the payment is for (whether or not its approved)
-     */
-    public function amount();
+	/**
+	 * @return float returns the amount the payment is for (whether or not its approved)
+	 */
+	public function amount();
 
 
 
-    /**
-     * @return string of the currency for this payment
-     */
-    public function currency_code();
+	/**
+	 * @return string of the currency for this payment
+	 */
+	public function currency_code();
 
 
 
-    /**
-     * The gateway transaction's ID, usually assigned by the
-     * payment provider
-     *
-     * @return string
-     */
-    public function txn_id_chq_nmbr();
+	/**
+	 * The gateway transaction's ID, usually assigned by the
+	 * payment provider
+	 *
+	 * @return string
+	 */
+	public function txn_id_chq_nmbr();
 
 
 
-    /**
-     * @param string $status
-     */
-    public function set_status($status);
+	/**
+	 * @param string $status
+	 */
+	public function set_status($status);
 
 
 
-    /**
-     * Sets the response from the gateway, which is displayable to the user.
-     * Eg, 'payment was approved', 'payment failed because invalid date', etc.
-     *
-     * @param string $response
-     */
-    public function set_gateway_response($response);
+	/**
+	 * Sets the response from the gateway, which is displayable to the user.
+	 * Eg, 'payment was approved', 'payment failed because invalid date', etc.
+	 *
+	 * @param string $response
+	 */
+	public function set_gateway_response($response);
 
 
 
-    /**
-     * Sets the response details, usually the entire contents of an IPN request,
-     * or data about the direct payment data sent
-     *
-     * @param mixed $response_details
-     */
-    public function set_details($response_details);
+	/**
+	 * Sets the response details, usually the entire contents of an IPN request,
+	 * or data about the direct payment data sent
+	 *
+	 * @param mixed $response_details
+	 */
+	public function set_details($response_details);
 
 
 
-    /**
-     * Returns whatever the details were set to be, which could be an array, object, string, integer, whatever.
-     *
-     * @return mixed
-     */
-    public function details();
+	/**
+	 * Returns whatever the details were set to be, which could be an array, object, string, integer, whatever.
+	 *
+	 * @return mixed
+	 */
+	public function details();
 
 
 
-    /**
-     * Sets the URl to redirect to, to process payment
-     *
-     * @param string $url
-     */
-    public function set_redirect_url($url);
+	/**
+	 * Sets the URl to redirect to, to process payment
+	 *
+	 * @param string $url
+	 */
+	public function set_redirect_url($url);
 
 
 
-    /**
-     * Sets the argument which should be passed to the redirect url (ie, usually POST variables)
-     *
-     * @param array $args
-     */
-    public function set_redirect_args($args);
+	/**
+	 * Sets the argument which should be passed to the redirect url (ie, usually POST variables)
+	 *
+	 * @param array $args
+	 */
+	public function set_redirect_args($args);
 
 
 
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     */
-    public function redirect_args();
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 */
+	public function redirect_args();
 
 
 
-    /**
-     * @return EEI_Transaction
-     */
-    public function transaction();
+	/**
+	 * @return EEI_Transaction
+	 */
+	public function transaction();
 
 
 
-    /**
-     * Sets the amount for this payment
-     *
-     * @param float $amount
-     */
-    public function set_amount($amount);
+	/**
+	 * Sets the amount for this payment
+	 *
+	 * @param float $amount
+	 */
+	public function set_amount($amount);
 
 
 
-    /**
-     * Sets the ID of the gateway transaction
-     *
-     * @param string $txn_id
-     */
-    public function set_txn_id_chq_nmbr($txn_id);
+	/**
+	 * Sets the ID of the gateway transaction
+	 *
+	 * @param string $txn_id
+	 */
+	public function set_txn_id_chq_nmbr($txn_id);
 
 
 
-    /**
-     * Sets a string for some extra accounting info
-     *
-     * @param string $extra_accounting_info
-     */
-    public function set_extra_accntng($extra_accounting_info);
+	/**
+	 * Sets a string for some extra accounting info
+	 *
+	 * @param string $extra_accounting_info
+	 */
+	public function set_extra_accntng($extra_accounting_info);
 }

core/interfaces/payments/EEMI_Payment.interface.php

Indentation +33 added lines, -33 removed lines

@@ -9,55 +9,55 @@
 interface EEMI_Payment
 {
 
-    /**
-     * returns a string for the approved status
-     */
-    public function approved_status();
+	/**
+	 * returns a string for the approved status
+	 */
+	public function approved_status();
 
 
 
-    /**
-     * returns a string for the pending status
-     */
-    public function pending_status();
+	/**
+	 * returns a string for the pending status
+	 */
+	public function pending_status();
 
 
 
-    /**
-     * returns a string for the cancelled status
-     */
-    public function cancelled_status();
+	/**
+	 * returns a string for the cancelled status
+	 */
+	public function cancelled_status();
 
 
 
-    /**
-     * returns a string for the failed status
-     */
-    public function failed_status();
+	/**
+	 * returns a string for the failed status
+	 */
+	public function failed_status();
 
 
 
-    /**
-     * returns a string for the declined status
-     */
-    public function declined_status();
+	/**
+	 * returns a string for the declined status
+	 */
+	public function declined_status();
 
 
 
-    /**
-     * Function that returns an instance of this class.
-     *
-     * @return EEMI_Payment
-     */
-    public static function instance();
+	/**
+	 * Function that returns an instance of this class.
+	 *
+	 * @return EEMI_Payment
+	 */
+	public static function instance();
 
 
 
-    /**
-     * Gets a payment by the transaction ID or cheque number
-     *
-     * @param int $txn_id
-     * @return EEI_Payment
-     */
-    public function get_payment_by_txn_id_chq_nmbr($txn_id);
+	/**
+	 * Gets a payment by the transaction ID or cheque number
+	 *
+	 * @param int $txn_id
+	 * @return EEI_Payment
+	 */
+	public function get_payment_by_txn_id_chq_nmbr($txn_id);
 }

core/interfaces/EEI_Duplicatable.interface.php

Indentation +12 added lines, -12 removed lines

@@ -13,16 +13,16 @@
 
 
 
-    /**
-     * duplicate
-     *
-     * used for duplicating the current object and its related dependent data
-     *
-     * @access public
-     * @param array $options key-value pairs of special options for duplicating, which varies by implemtor.
-     *  For example, it might have an option to duplicate related data or not, or to make a duplicate
-     *  with the exception of a particular attribute
-     * @return object of the same class as what was called on
-     */
-    public function duplicate($options = array());
+	/**
+	 * duplicate
+	 *
+	 * used for duplicating the current object and its related dependent data
+	 *
+	 * @access public
+	 * @param array $options key-value pairs of special options for duplicating, which varies by implemtor.
+	 *  For example, it might have an option to duplicate related data or not, or to make a duplicate
+	 *  with the exception of a particular attribute
+	 * @return object of the same class as what was called on
+	 */
+	public function duplicate($options = array());
 }

core/interfaces/EEI_Query_Filter.interface.php

Indentation +17 added lines, -17 removed lines

@@ -13,26 +13,26 @@
 {
 
 
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     * @return array
-     */
-    public function filter_by_query_params();
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 * @return array
+	 */
+	public function filter_by_query_params();
 
 
 
 
 
-    /**
-     * This method should return a pretty label describing the results that are generated after injecting query
-     * variables via the `filter_by_query_params` method.
-     *
-     * An example of the kind of label that would be returned is:
-     *
-     * "Showing all transactions for the Event: Happy Days Convention and the Registration with the ID: 42".
-     *
-     * @return string
-     */
-    public function get_pretty_label_for_results();
+	/**
+	 * This method should return a pretty label describing the results that are generated after injecting query
+	 * variables via the `filter_by_query_params` method.
+	 *
+	 * An example of the kind of label that would be returned is:
+	 *
+	 * "Showing all transactions for the Event: Happy Days Convention and the Registration with the ID: 42".
+	 *
+	 * @return string
+	 */
+	public function get_pretty_label_for_results();
 }

core/interfaces/EEI_Registration.interface.php

Indentation +18 added lines, -18 removed lines

@@ -6,28 +6,28 @@
 interface EEI_Registration extends EEI_Base
 {
 
-    /**
-     * Gets the registration code
-     *
-     * @return string
-     */
-    public function reg_code();
+	/**
+	 * Gets the registration code
+	 *
+	 * @return string
+	 */
+	public function reg_code();
 
 
 
-    /**
-     * Gets the attendee corresponding to this registration
-     *
-     * @return EEI_Attendee
-     */
-    public function attendee();
+	/**
+	 * Gets the attendee corresponding to this registration
+	 *
+	 * @return EEI_Attendee
+	 */
+	public function attendee();
 
 
 
-    /**
-     * Returns the event's name this registration is for
-     *
-     * @return string
-     */
-    public function event_name();
+	/**
+	 * Returns the event's name this registration is for
+	 *
+	 * @return string
+	 */
+	public function event_name();
 }

core/interfaces/EEI_Attendee.interface.php

Indentation +21 added lines, -21 removed lines

@@ -6,67 +6,67 @@
 interface EEI_Attendee
 {
 
-    public function fname();
+	public function fname();
 
 
 
-    public function lname();
+	public function lname();
 
 
 
-    public function full_name();
+	public function full_name();
 
 
 
-    public function email();
+	public function email();
 
 
 
-    public function phone();
+	public function phone();
 
 
 
-    public function address();
+	public function address();
 
 
 
-    public function address2();
+	public function address2();
 
 
 
-    public function city();
+	public function city();
 
 
 
-    public function state_ID();
+	public function state_ID();
 
 
 
-    public function state_name();
+	public function state_name();
 
 
 
-    /**
-     * @return EE_State
-     */
-    public function state_obj();
+	/**
+	 * @return EE_State
+	 */
+	public function state_obj();
 
 
 
-    public function country_ID();
+	public function country_ID();
 
 
 
-    public function country_name();
+	public function country_name();
 
 
 
-    /**
-     * @return EE_Country
-     */
-    public function country_obj();
+	/**
+	 * @return EE_Country
+	 */
+	public function country_obj();
 
 
 
-    public function zip();
+	public function zip();
 }

core/interfaces/EEI_Collection.interface.php

Indentation +54 added lines, -54 removed lines

@@ -14,70 +14,70 @@
 interface EEI_Collection
 {
 
-    /**
-     * add
-     *
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EEI_Collection::set_info()
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = null);
+	/**
+	 * add
+	 *
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EEI_Collection::set_info()
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = null);
 
 
 
-    /**
-     * set_info
-     *
-     * Sets the info associated with an object in the Collection
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = null);
+	/**
+	 * set_info
+	 *
+	 * Sets the info associated with an object in the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = null);
 
 
 
-    /**
-     * get_by_info
-     *
-     * finds and returns an object in the Collection based on the info that was set using set_info() or add()
-     *
-     * @access public
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info);
+	/**
+	 * get_by_info
+	 *
+	 * finds and returns an object in the Collection based on the info that was set using set_info() or add()
+	 *
+	 * @access public
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info);
 
 
 
-    /**
-     * has
-     *
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param object $object
-     * @return bool
-     */
-    public function has($object);
+	/**
+	 * has
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object);
 
 
 
-    /**
-     * remove
-     *
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return void
-     */
-    public function remove($object);
+	/**
+	 * remove
+	 *
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return void
+	 */
+	public function remove($object);
 }

core/interfaces/EEI_Transaction.interface.php

Indentation +41 added lines, -41 removed lines

@@ -6,63 +6,63 @@
 interface EEI_Transaction extends EEI_Base
 {
 
-    /**
-     * @return EEI_Payment
-     */
-    public function last_payment();
+	/**
+	 * @return EEI_Payment
+	 */
+	public function last_payment();
 
 
 
-    /**
-     * Gets the total that should eb paid for this transaction
-     *
-     * @return float
-     */
-    public function total();
+	/**
+	 * Gets the total that should eb paid for this transaction
+	 *
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Get the line item that represents the total for the transaction
-     *
-     * @return EEI_Line_Item
-     */
-    public function total_line_item();
+	/**
+	 * Get the line item that represents the total for the transaction
+	 *
+	 * @return EEI_Line_Item
+	 */
+	public function total_line_item();
 
 
 
-    /**
-     * Gets the primary registration for this transaction
-     *
-     * @return EEI_Registration
-     */
-    public function primary_registration();
+	/**
+	 * Gets the primary registration for this transaction
+	 *
+	 * @return EEI_Registration
+	 */
+	public function primary_registration();
 
 
 
-    /**
-     * Returns the balance due on the transaction
-     *
-     * @return float
-     */
-    public function remaining();
+	/**
+	 * Returns the balance due on the transaction
+	 *
+	 * @return float
+	 */
+	public function remaining();
 
 
 
-    /**
-     *        get Total Amount Paid to Date
-     *
-     * @access        public
-     * @return float
-     */
-    public function paid();
+	/**
+	 *        get Total Amount Paid to Date
+	 *
+	 * @access        public
+	 * @return float
+	 */
+	public function paid();
 
 
 
-    /**
-     * Retrieves all the pending payments on this transaction
-     *
-     * @return EEI_Payment[]
-     */
-    public function pending_payments();
+	/**
+	 * Retrieves all the pending payments on this transaction
+	 *
+	 * @return EEI_Payment[]
+	 */
+	public function pending_payments();
 }

core/interfaces/EEI_Address.interface.php

Indentation +19 added lines, -19 removed lines

@@ -6,59 +6,59 @@
 interface EEI_Address
 {
 
-    public function address();
+	public function address();
 
 
 
-    public function address2();
+	public function address2();
 
 
 
-    public function city();
+	public function city();
 
 
 
-    /**
-     * @return EE_State
-     */
-    public function state_obj();
+	/**
+	 * @return EE_State
+	 */
+	public function state_obj();
 
 
 
-    public function state_ID();
+	public function state_ID();
 
 
 
-    public function state_name();
+	public function state_name();
 
 
 
-    public function state_abbrev();
+	public function state_abbrev();
 
 
 
-    public function state();
+	public function state();
 
 
 
-    /**
-     * @return EE_Country
-     */
-    public function country_obj();
+	/**
+	 * @return EE_Country
+	 */
+	public function country_obj();
 
 
 
-    public function country_ID();
+	public function country_ID();
 
 
 
-    public function country_name();
+	public function country_name();
 
 
 
-    public function country();
+	public function country();
 
 
 
-    public function zip();
+	public function zip();
 }