eventespresso / event-espresso-core

core/interfaces/display/EEI_Has_Code.interface.php

Indentation +5 added lines, -5 removed lines

@@ -13,9 +13,9 @@
 interface EEI_Has_Code
 {
 
-    /**
-     * Return a code.
-     * @return string
-     */
-    public function code();
+	/**
+	 * Return a code.
+	 * @return string
+	 */
+	public function code();
 }

core/interfaces/EEHI_Money.interface.php

Indentation +12 added lines, -12 removed lines

@@ -6,16 +6,16 @@
 interface EEHI_Money
 {
 
-    /**
-     * For comparing floats. Default operator is '=', but see the $operator below for all options.
-     * This should be used to compare floats instead of normal '==' because floats
-     * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-     * but actually differ by 0.00000001.
-     *
-     * @param float  $float1
-     * @param float  $float2
-     * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-     * @return boolean whether the equation is true or false
-     */
-    public function compare_floats($float1, $float2, $operator = '=');
+	/**
+	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+	 * This should be used to compare floats instead of normal '==' because floats
+	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+	 * but actually differ by 0.00000001.
+	 *
+	 * @param float  $float1
+	 * @param float  $float2
+	 * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+	 * @return boolean whether the equation is true or false
+	 */
+	public function compare_floats($float1, $float2, $operator = '=');
 }

core/interfaces/InterminableInterface.php

Indentation +1 added lines, -1 removed lines

@@ -13,5 +13,5 @@
 interface InterminableInterface
 {
 
-    // no specific methods required
+	// no specific methods required
 }

core/interfaces/admin/EEI_Admin_Links.interface.php

Indentation +20 added lines, -20 removed lines

@@ -12,32 +12,32 @@
 {
 
 
-    /**
-     * Return the link to the admin details for the object.
-     * @return string
-     */
-    public function get_admin_details_link();
+	/**
+	 * Return the link to the admin details for the object.
+	 * @return string
+	 */
+	public function get_admin_details_link();
 
 
 
 
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     * @return string
-     */
-    public function get_admin_edit_link();
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 * @return string
+	 */
+	public function get_admin_edit_link();
 
 
-    /**
-     * Returns the link to a settings page for the object.
-     * @return string
-     */
-    public function get_admin_settings_link();
+	/**
+	 * Returns the link to a settings page for the object.
+	 * @return string
+	 */
+	public function get_admin_settings_link();
 
 
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     * @return string
-     */
-    public function get_admin_overview_link();
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 * @return string
+	 */
+	public function get_admin_overview_link();
 }

core/interfaces/payments/EEMI_Payment_Log.interface.php

Indentation +9 added lines, -9 removed lines

@@ -6,13 +6,13 @@
 interface EEMI_Payment_Log
 {
 
-    /**
-     * Logs a message
-     *
-     * @param string     $message
-     * @param int|string $id
-     * @param string     $model_name
-     * @return EE_Log
-     */
-    public function gateway_log($message, $id, $model_name);
+	/**
+	 * Logs a message
+	 *
+	 * @param string     $message
+	 * @param int|string $id
+	 * @param string     $model_name
+	 * @return EE_Log
+	 */
+	public function gateway_log($message, $id, $model_name);
 }

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();
 }