eventespresso / event-espresso-core

core/interfaces/EEHI_File.interface.php

Indentation +18 added lines, -18 removed lines

@@ -6,27 +6,27 @@
 interface EEHI_File
 {
 
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist
-     *
-     * @param string $full_file_path
-     * @throws EE_Error
-     * @return bool
-     */
-    public static function ensure_file_exists_and_is_writable($full_file_path = '');
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist
+	 *
+	 * @param string $full_file_path
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	public static function ensure_file_exists_and_is_writable($full_file_path = '');
 
 
 
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     *
-     * @param string $folder
-     * @throws EE_Error
-     * @return bool
-     */
-    public static function ensure_folder_exists_and_is_writable($folder = '');
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 *
+	 * @param string $folder
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	public static function ensure_folder_exists_and_is_writable($folder = '');
 }
 // End of file EEHI_File.interface.php
 // Location: core/interfaces/EEHI_File.interface.php

core/interfaces/EEI_Address_Formatter.interface.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
 interface EEI_Address_Formatter
 {
 
-    /**
-     * @param string $address
-     * @param string $address2
-     * @param string $city
-     * @param string $state
-     * @param string $zip
-     * @param string $country
-     * @param string $CNT_ISO
-     */
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO);
+	/**
+	 * @param string $address
+	 * @param string $address2
+	 * @param string $city
+	 * @param string $state
+	 * @param string $zip
+	 * @param string $country
+	 * @param string $CNT_ISO
+	 */
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO);
 }

core/interfaces/messages/EEI_Has_Sending_Messenger.interface.php

Indentation +5 added lines, -5 removed lines

@@ -12,9 +12,9 @@
 {
 
 
-    /**
-     * Expect a EE_messenger object back that is serving as the sending messenger for a message.
-     * @return EE_messenger
-     */
-    public function sending_messenger();
+	/**
+	 * Expect a EE_messenger object back that is serving as the sending messenger for a message.
+	 * @return EE_messenger
+	 */
+	public function sending_messenger();
 }

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/EEI_Line_Item_Filter.interface.php

Indentation +7 added lines, -7 removed lines

@@ -18,11 +18,11 @@
 
 
 
-    /**
-     * process
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item);
+	/**
+	 * process
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item);
 }

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/line_items/EEI_Line_Item.interface.php

Indentation +169 added lines, -169 removed lines

@@ -11,231 +11,231 @@
 interface EEI_Line_Item
 {
 
-    /**
-     * generic setter
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false);
+	/**
+	 * generic setter
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false);
 
 
 
-    /**
-     * @return string
-     */
-    public function name();
+	/**
+	 * @return string
+	 */
+	public function name();
 
 
 
-    /**
-     * @return string
-     */
-    public function desc();
+	/**
+	 * @return string
+	 */
+	public function desc();
 
 
 
-    /**
-     * The unit price for the items of this line item
-     * @return float
-     */
-    public function unit_price();
+	/**
+	 * The unit price for the items of this line item
+	 * @return float
+	 */
+	public function unit_price();
 
 
 
-    /**
-     * Returns the number of items in this line item
-     * @return int
-     */
-    public function quantity();
+	/**
+	 * Returns the number of items in this line item
+	 * @return int
+	 */
+	public function quantity();
 
 
 
-    /**
-     * Sets quantity
-     * @param int $quantity
-     */
-    public function set_quantity($quantity);
+	/**
+	 * Sets quantity
+	 * @param int $quantity
+	 */
+	public function set_quantity($quantity);
 
 
 
-    /**
-     * Returns the total amount due for this line item
-     * (usually quantity x unit_price)
-     * @return float
-     */
-    public function total();
+	/**
+	 * Returns the total amount due for this line item
+	 * (usually quantity x unit_price)
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Gets all teh children line items of type 'line-item'
-     * @return EEI_Line_Item[]
-     */
-    public function get_items();
+	/**
+	 * Gets all teh children line items of type 'line-item'
+	 * @return EEI_Line_Item[]
+	 */
+	public function get_items();
 
 
 
-    /**
-     * Gets the total for all the items purchased only
-     * @return float
-     */
-    public function get_items_total();
+	/**
+	 * Gets the total for all the items purchased only
+	 * @return float
+	 */
+	public function get_items_total();
 
 
 
-    /**
-     * Gets all the children line items of type 'tax'
-     * @return EEI_Line_Item[]
-     */
-    public function tax_descendants();
+	/**
+	 * Gets all the children line items of type 'tax'
+	 * @return EEI_Line_Item[]
+	 */
+	public function tax_descendants();
 
 
 
-    /**
-     * Gets the total amount of the tax sub-line items
-     * @return float
-     */
-    public function get_total_tax();
+	/**
+	 * Gets the total amount of the tax sub-line items
+	 * @return float
+	 */
+	public function get_total_tax();
 
 
 
-    /**
-     * Returns the name of the event the ticket is for
-     * @return string
-     */
-    public function ticket_event_name();
+	/**
+	 * Returns the name of the event the ticket is for
+	 * @return string
+	 */
+	public function ticket_event_name();
 
 
 
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null);
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null);
 
 
 
-    /**
-     * Indicates whether or not taxes should apply to this line item
-     * @return boolean
-     */
-    public function is_taxable();
+	/**
+	 * Indicates whether or not taxes should apply to this line item
+	 * @return boolean
+	 */
+	public function is_taxable();
 
 
 
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     * @return EEI_Line_Item[]
-     */
-    public function children();
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 * @return EEI_Line_Item[]
+	 */
+	public function children();
 
 
 
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     * @param EEI_Line_Item $line_item
-     * @param bool         $set_order
-     * @return bool true for success, false for fail
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true);
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 * @param EEI_Line_Item $line_item
+	 * @param bool         $set_order
+	 * @return bool true for success, false for fail
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true);
 
 
 
-    /**
-     * Gets the line item type
-     * @return string
-     */
-    public function type();
+	/**
+	 * Gets the line item type
+	 * @return string
+	 */
+	public function type();
 
 
 
-    /**
-     * Gets item_id
-     * @return string
-     */
-    public function OBJ_ID();
+	/**
+	 * Gets item_id
+	 * @return string
+	 */
+	public function OBJ_ID();
 
 
 
-    /**
-     * Gets the related item type ( like: Ticket or Event )
-     * @return string
-     */
-    public function OBJ_type();
+	/**
+	 * Gets the related item type ( like: Ticket or Event )
+	 * @return string
+	 */
+	public function OBJ_type();
 
 
 
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total
-     * @return float
-     */
-    public function recalculate_total_including_taxes();
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total
+	 * @return float
+	 */
+	public function recalculate_total_including_taxes();
 
-    /**
-     * Checks if this item is a percentage modifier or not
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_percent();
-
-    /**
-     * Gets percent (between 100-.001)
-     * @return float
-     */
-    public function percent();
-
-    /**
-     * Sets total
-     * @param float $total
-     * @return boolean
-     */
-    public function set_total($total);
-
-    /**
-     * Sets unit_price
-     * @param float $unit_price
-     * @return boolean
-     */
-    public function set_unit_price($unit_price);
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
-     * @param string $code
-     * @param bool $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true);
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist);
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_percent();
+
+	/**
+	 * Gets percent (between 100-.001)
+	 * @return float
+	 */
+	public function percent();
+
+	/**
+	 * Sets total
+	 * @param float $total
+	 * @return boolean
+	 */
+	public function set_total($total);
+
+	/**
+	 * Sets unit_price
+	 * @param float $unit_price
+	 * @return boolean
+	 */
+	public function set_unit_price($unit_price);
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
+	 * @param string $code
+	 * @param bool $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true);
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist);
 }

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