eventespresso / event-espresso-core

core/interfaces/line_items/EEI_Line_Item_Object.interface.php

Indentation +10 added lines, -10 removed lines

@@ -11,16 +11,16 @@
 interface EEI_Line_Item_Object
 {
 
-    /**
-     * Return the name representing the object (i.e. Event Title, or Ticket Name).
-     * @return string
-     */
-    public function name();
+	/**
+	 * Return the name representing the object (i.e. Event Title, or Ticket Name).
+	 * @return string
+	 */
+	public function name();
 
 
-    /**
-     * Return the ID representation for the object.
-     * @return mixed int|string
-     */
-    public function ID();
+	/**
+	 * Return the ID representation for the object.
+	 * @return mixed int|string
+	 */
+	public function ID();
 }

core/interfaces/line_items/EEHI_Line_Item.interface.php

Indentation +72 added lines, -72 removed lines

@@ -6,88 +6,88 @@
 interface EEHI_Line_Item
 {
 
-    /**
-     * Adds an item to the purchase in the right spot
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $line_item
-     */
-    public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item);
+	/**
+	 * Adds an item to the purchase in the right spot
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $line_item
+	 */
+	public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item);
 
 
 
-    /**
-     * Overwrites the previous tax by clearing out the old taxes, and creates a new
-     * tax and updates the total line item accordingly
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param float        $amount
-     * @param string       $name
-     * @param string       $description
-     * @param string       $code
-     * @param boolean      $add_to_existing_line_item if true and a duplicate line item with
-     *                                                the same code is found, $amount will be added onto it; otherwise will simply
-     *                                                set the taxes to match $amount
-     * @return EE_Line_Item the new tax created
-     */
-    public function set_total_tax_to(
-        EE_Line_Item $total_line_item,
-        $amount,
-        $name = null,
-        $description = null,
-        $code = null,
-        $add_to_existing_line_item = false
-    );
+	/**
+	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
+	 * tax and updates the total line item accordingly
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $amount
+	 * @param string       $name
+	 * @param string       $description
+	 * @param string       $code
+	 * @param boolean      $add_to_existing_line_item if true and a duplicate line item with
+	 *                                                the same code is found, $amount will be added onto it; otherwise will simply
+	 *                                                set the taxes to match $amount
+	 * @return EE_Line_Item the new tax created
+	 */
+	public function set_total_tax_to(
+		EE_Line_Item $total_line_item,
+		$amount,
+		$name = null,
+		$description = null,
+		$code = null,
+		$add_to_existing_line_item = false
+	);
 
 
 
-    /**
-     * Makes all the line items which are children of $line_item taxable (or not).
-     * Does NOT save the line items
-     *
-     * @param EE_Line_Item $line_item
-     * @param boolean      $taxable
-     * @param string       $code_substring_for_whitelist if this string is part of the line item's code
-     *                                                   it will be whitelisted (ie, except from becoming taxable)
-     */
-    public static function set_line_items_taxable(
-        EE_Line_Item $line_item,
-        $taxable = true,
-        $code_substring_for_whitelist = null
-    );
+	/**
+	 * Makes all the line items which are children of $line_item taxable (or not).
+	 * Does NOT save the line items
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param boolean      $taxable
+	 * @param string       $code_substring_for_whitelist if this string is part of the line item's code
+	 *                                                   it will be whitelisted (ie, except from becoming taxable)
+	 */
+	public static function set_line_items_taxable(
+		EE_Line_Item $line_item,
+		$taxable = true,
+		$code_substring_for_whitelist = null
+	);
 
 
 
-    /**
-     * Adds a simple item ( unrelated to any other model object) to the total line item,
-     * in the correct spot in the line item tree.
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param string       $name
-     * @param float        $unit_price
-     * @param string       $description
-     * @param int          $quantity
-     * @param boolean      $taxable
-     * @param boolean      $code if set to a value, ensures there is only one line item with that code
-     * @return boolean success
-     */
-    public function add_unrelated_item(
-        EE_Line_Item $total_line_item,
-        $name,
-        $unit_price,
-        $description = '',
-        $quantity = 1,
-        $taxable = false,
-        $code = null
-    );
+	/**
+	 * Adds a simple item ( unrelated to any other model object) to the total line item,
+	 * in the correct spot in the line item tree.
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param string       $name
+	 * @param float        $unit_price
+	 * @param string       $description
+	 * @param int          $quantity
+	 * @param boolean      $taxable
+	 * @param boolean      $code if set to a value, ensures there is only one line item with that code
+	 * @return boolean success
+	 */
+	public function add_unrelated_item(
+		EE_Line_Item $total_line_item,
+		$name,
+		$unit_price,
+		$description = '',
+		$quantity = 1,
+		$taxable = false,
+		$code = null
+	);
 
 
 
-    /**
-     * Gets the line item for the taxes subtotal
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return \EE_Line_Item
-     */
-    public static function get_taxes_subtotal(EE_Line_Item $total_line_item);
+	/**
+	 * Gets the line item for the taxes subtotal
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return \EE_Line_Item
+	 */
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item);
 }

core/interfaces/display/EEI_Has_Icon.interface.php

Indentation +5 added lines, -5 removed lines

@@ -11,9 +11,9 @@
 interface EEI_Has_Icon
 {
 
-    /**
-     * Return the icon representing the object (usually a WP dashicon).
-     * @return string
-     */
-    public function get_icon();
+	/**
+	 * Return the icon representing the object (usually a WP dashicon).
+	 * @return string
+	 */
+	public function get_icon();
 }

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