@@ -6,88 +6,88 @@ |
||
| 6 | 6 | interface EEHI_Line_Item |
| 7 | 7 | { |
| 8 | 8 | |
| 9 | - /** |
|
| 10 | - * Adds an item to the purchase in the right spot |
|
| 11 | - * |
|
| 12 | - * @param EE_Line_Item $total_line_item |
|
| 13 | - * @param EE_Line_Item $line_item |
|
| 14 | - */ |
|
| 15 | - public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item); |
|
| 9 | + /** |
|
| 10 | + * Adds an item to the purchase in the right spot |
|
| 11 | + * |
|
| 12 | + * @param EE_Line_Item $total_line_item |
|
| 13 | + * @param EE_Line_Item $line_item |
|
| 14 | + */ |
|
| 15 | + public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item); |
|
| 16 | 16 | |
| 17 | 17 | |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
| 21 | - * tax and updates the total line item accordingly |
|
| 22 | - * |
|
| 23 | - * @param EE_Line_Item $total_line_item |
|
| 24 | - * @param float $amount |
|
| 25 | - * @param string $name |
|
| 26 | - * @param string $description |
|
| 27 | - * @param string $code |
|
| 28 | - * @param boolean $add_to_existing_line_item if true and a duplicate line item with |
|
| 29 | - * the same code is found, $amount will be added onto it; otherwise will simply |
|
| 30 | - * set the taxes to match $amount |
|
| 31 | - * @return EE_Line_Item the new tax created |
|
| 32 | - */ |
|
| 33 | - public function set_total_tax_to( |
|
| 34 | - EE_Line_Item $total_line_item, |
|
| 35 | - $amount, |
|
| 36 | - $name = null, |
|
| 37 | - $description = null, |
|
| 38 | - $code = null, |
|
| 39 | - $add_to_existing_line_item = false |
|
| 40 | - ); |
|
| 19 | + /** |
|
| 20 | + * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
| 21 | + * tax and updates the total line item accordingly |
|
| 22 | + * |
|
| 23 | + * @param EE_Line_Item $total_line_item |
|
| 24 | + * @param float $amount |
|
| 25 | + * @param string $name |
|
| 26 | + * @param string $description |
|
| 27 | + * @param string $code |
|
| 28 | + * @param boolean $add_to_existing_line_item if true and a duplicate line item with |
|
| 29 | + * the same code is found, $amount will be added onto it; otherwise will simply |
|
| 30 | + * set the taxes to match $amount |
|
| 31 | + * @return EE_Line_Item the new tax created |
|
| 32 | + */ |
|
| 33 | + public function set_total_tax_to( |
|
| 34 | + EE_Line_Item $total_line_item, |
|
| 35 | + $amount, |
|
| 36 | + $name = null, |
|
| 37 | + $description = null, |
|
| 38 | + $code = null, |
|
| 39 | + $add_to_existing_line_item = false |
|
| 40 | + ); |
|
| 41 | 41 | |
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Makes all the line items which are children of $line_item taxable (or not). |
|
| 46 | - * Does NOT save the line items |
|
| 47 | - * |
|
| 48 | - * @param EE_Line_Item $line_item |
|
| 49 | - * @param boolean $taxable |
|
| 50 | - * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
| 51 | - * it will be whitelisted (ie, except from becoming taxable) |
|
| 52 | - */ |
|
| 53 | - public static function set_line_items_taxable( |
|
| 54 | - EE_Line_Item $line_item, |
|
| 55 | - $taxable = true, |
|
| 56 | - $code_substring_for_whitelist = null |
|
| 57 | - ); |
|
| 44 | + /** |
|
| 45 | + * Makes all the line items which are children of $line_item taxable (or not). |
|
| 46 | + * Does NOT save the line items |
|
| 47 | + * |
|
| 48 | + * @param EE_Line_Item $line_item |
|
| 49 | + * @param boolean $taxable |
|
| 50 | + * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
| 51 | + * it will be whitelisted (ie, except from becoming taxable) |
|
| 52 | + */ |
|
| 53 | + public static function set_line_items_taxable( |
|
| 54 | + EE_Line_Item $line_item, |
|
| 55 | + $taxable = true, |
|
| 56 | + $code_substring_for_whitelist = null |
|
| 57 | + ); |
|
| 58 | 58 | |
| 59 | 59 | |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
| 63 | - * in the correct spot in the line item tree. |
|
| 64 | - * |
|
| 65 | - * @param EE_Line_Item $total_line_item |
|
| 66 | - * @param string $name |
|
| 67 | - * @param float $unit_price |
|
| 68 | - * @param string $description |
|
| 69 | - * @param int $quantity |
|
| 70 | - * @param boolean $taxable |
|
| 71 | - * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
| 72 | - * @return boolean success |
|
| 73 | - */ |
|
| 74 | - public function add_unrelated_item( |
|
| 75 | - EE_Line_Item $total_line_item, |
|
| 76 | - $name, |
|
| 77 | - $unit_price, |
|
| 78 | - $description = '', |
|
| 79 | - $quantity = 1, |
|
| 80 | - $taxable = false, |
|
| 81 | - $code = null |
|
| 82 | - ); |
|
| 61 | + /** |
|
| 62 | + * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
| 63 | + * in the correct spot in the line item tree. |
|
| 64 | + * |
|
| 65 | + * @param EE_Line_Item $total_line_item |
|
| 66 | + * @param string $name |
|
| 67 | + * @param float $unit_price |
|
| 68 | + * @param string $description |
|
| 69 | + * @param int $quantity |
|
| 70 | + * @param boolean $taxable |
|
| 71 | + * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
| 72 | + * @return boolean success |
|
| 73 | + */ |
|
| 74 | + public function add_unrelated_item( |
|
| 75 | + EE_Line_Item $total_line_item, |
|
| 76 | + $name, |
|
| 77 | + $unit_price, |
|
| 78 | + $description = '', |
|
| 79 | + $quantity = 1, |
|
| 80 | + $taxable = false, |
|
| 81 | + $code = null |
|
| 82 | + ); |
|
| 83 | 83 | |
| 84 | 84 | |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Gets the line item for the taxes subtotal |
|
| 88 | - * |
|
| 89 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 90 | - * @return \EE_Line_Item |
|
| 91 | - */ |
|
| 92 | - public static function get_taxes_subtotal(EE_Line_Item $total_line_item); |
|
| 86 | + /** |
|
| 87 | + * Gets the line item for the taxes subtotal |
|
| 88 | + * |
|
| 89 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
| 90 | + * @return \EE_Line_Item |
|
| 91 | + */ |
|
| 92 | + public static function get_taxes_subtotal(EE_Line_Item $total_line_item); |
|
| 93 | 93 | } |
@@ -11,231 +11,231 @@ |
||
| 11 | 11 | interface EEI_Line_Item |
| 12 | 12 | { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * generic setter |
|
| 16 | - * @param string $field_name |
|
| 17 | - * @param mixed $field_value |
|
| 18 | - * @param bool $use_default |
|
| 19 | - */ |
|
| 20 | - public function set($field_name, $field_value, $use_default = false); |
|
| 14 | + /** |
|
| 15 | + * generic setter |
|
| 16 | + * @param string $field_name |
|
| 17 | + * @param mixed $field_value |
|
| 18 | + * @param bool $use_default |
|
| 19 | + */ |
|
| 20 | + public function set($field_name, $field_value, $use_default = false); |
|
| 21 | 21 | |
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @return string |
|
| 26 | - */ |
|
| 27 | - public function name(); |
|
| 24 | + /** |
|
| 25 | + * @return string |
|
| 26 | + */ |
|
| 27 | + public function name(); |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @return string |
|
| 33 | - */ |
|
| 34 | - public function desc(); |
|
| 31 | + /** |
|
| 32 | + * @return string |
|
| 33 | + */ |
|
| 34 | + public function desc(); |
|
| 35 | 35 | |
| 36 | 36 | |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * The unit price for the items of this line item |
|
| 40 | - * @return float |
|
| 41 | - */ |
|
| 42 | - public function unit_price(); |
|
| 38 | + /** |
|
| 39 | + * The unit price for the items of this line item |
|
| 40 | + * @return float |
|
| 41 | + */ |
|
| 42 | + public function unit_price(); |
|
| 43 | 43 | |
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * Returns the number of items in this line item |
|
| 48 | - * @return int |
|
| 49 | - */ |
|
| 50 | - public function quantity(); |
|
| 46 | + /** |
|
| 47 | + * Returns the number of items in this line item |
|
| 48 | + * @return int |
|
| 49 | + */ |
|
| 50 | + public function quantity(); |
|
| 51 | 51 | |
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Sets quantity |
|
| 56 | - * @param int $quantity |
|
| 57 | - */ |
|
| 58 | - public function set_quantity($quantity); |
|
| 54 | + /** |
|
| 55 | + * Sets quantity |
|
| 56 | + * @param int $quantity |
|
| 57 | + */ |
|
| 58 | + public function set_quantity($quantity); |
|
| 59 | 59 | |
| 60 | 60 | |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Returns the total amount due for this line item |
|
| 64 | - * (usually quantity x unit_price) |
|
| 65 | - * @return float |
|
| 66 | - */ |
|
| 67 | - public function total(); |
|
| 62 | + /** |
|
| 63 | + * Returns the total amount due for this line item |
|
| 64 | + * (usually quantity x unit_price) |
|
| 65 | + * @return float |
|
| 66 | + */ |
|
| 67 | + public function total(); |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Gets all teh children line items of type 'line-item' |
|
| 73 | - * @return EEI_Line_Item[] |
|
| 74 | - */ |
|
| 75 | - public function get_items(); |
|
| 71 | + /** |
|
| 72 | + * Gets all teh children line items of type 'line-item' |
|
| 73 | + * @return EEI_Line_Item[] |
|
| 74 | + */ |
|
| 75 | + public function get_items(); |
|
| 76 | 76 | |
| 77 | 77 | |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Gets the total for all the items purchased only |
|
| 81 | - * @return float |
|
| 82 | - */ |
|
| 83 | - public function get_items_total(); |
|
| 79 | + /** |
|
| 80 | + * Gets the total for all the items purchased only |
|
| 81 | + * @return float |
|
| 82 | + */ |
|
| 83 | + public function get_items_total(); |
|
| 84 | 84 | |
| 85 | 85 | |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Gets all the children line items of type 'tax' |
|
| 89 | - * @return EEI_Line_Item[] |
|
| 90 | - */ |
|
| 91 | - public function tax_descendants(); |
|
| 87 | + /** |
|
| 88 | + * Gets all the children line items of type 'tax' |
|
| 89 | + * @return EEI_Line_Item[] |
|
| 90 | + */ |
|
| 91 | + public function tax_descendants(); |
|
| 92 | 92 | |
| 93 | 93 | |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Gets the total amount of the tax sub-line items |
|
| 97 | - * @return float |
|
| 98 | - */ |
|
| 99 | - public function get_total_tax(); |
|
| 95 | + /** |
|
| 96 | + * Gets the total amount of the tax sub-line items |
|
| 97 | + * @return float |
|
| 98 | + */ |
|
| 99 | + public function get_total_tax(); |
|
| 100 | 100 | |
| 101 | 101 | |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Returns the name of the event the ticket is for |
|
| 105 | - * @return string |
|
| 106 | - */ |
|
| 107 | - public function ticket_event_name(); |
|
| 103 | + /** |
|
| 104 | + * Returns the name of the event the ticket is for |
|
| 105 | + * @return string |
|
| 106 | + */ |
|
| 107 | + public function ticket_event_name(); |
|
| 108 | 108 | |
| 109 | 109 | |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * Saves this line item to the DB, and recursively saves its descendants. |
|
| 113 | - * Also sets the transaction on this line item and all its descendants before saving |
|
| 114 | - * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 115 | - * @return int count of items saved |
|
| 116 | - */ |
|
| 117 | - public function save_this_and_descendants_to_txn($txn_id = null); |
|
| 111 | + /** |
|
| 112 | + * Saves this line item to the DB, and recursively saves its descendants. |
|
| 113 | + * Also sets the transaction on this line item and all its descendants before saving |
|
| 114 | + * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 115 | + * @return int count of items saved |
|
| 116 | + */ |
|
| 117 | + public function save_this_and_descendants_to_txn($txn_id = null); |
|
| 118 | 118 | |
| 119 | 119 | |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Indicates whether or not taxes should apply to this line item |
|
| 123 | - * @return boolean |
|
| 124 | - */ |
|
| 125 | - public function is_taxable(); |
|
| 121 | + /** |
|
| 122 | + * Indicates whether or not taxes should apply to this line item |
|
| 123 | + * @return boolean |
|
| 124 | + */ |
|
| 125 | + public function is_taxable(); |
|
| 126 | 126 | |
| 127 | 127 | |
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 131 | - * @return EEI_Line_Item[] |
|
| 132 | - */ |
|
| 133 | - public function children(); |
|
| 129 | + /** |
|
| 130 | + * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 131 | + * @return EEI_Line_Item[] |
|
| 132 | + */ |
|
| 133 | + public function children(); |
|
| 134 | 134 | |
| 135 | 135 | |
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Adds the line item as a child to this line item. If there is another child line |
|
| 139 | - * item with the same LIN_code, it is overwritten by this new one |
|
| 140 | - * @param EEI_Line_Item $line_item |
|
| 141 | - * @param bool $set_order |
|
| 142 | - * @return bool true for success, false for fail |
|
| 143 | - */ |
|
| 144 | - public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true); |
|
| 137 | + /** |
|
| 138 | + * Adds the line item as a child to this line item. If there is another child line |
|
| 139 | + * item with the same LIN_code, it is overwritten by this new one |
|
| 140 | + * @param EEI_Line_Item $line_item |
|
| 141 | + * @param bool $set_order |
|
| 142 | + * @return bool true for success, false for fail |
|
| 143 | + */ |
|
| 144 | + public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true); |
|
| 145 | 145 | |
| 146 | 146 | |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Gets the line item type |
|
| 150 | - * @return string |
|
| 151 | - */ |
|
| 152 | - public function type(); |
|
| 148 | + /** |
|
| 149 | + * Gets the line item type |
|
| 150 | + * @return string |
|
| 151 | + */ |
|
| 152 | + public function type(); |
|
| 153 | 153 | |
| 154 | 154 | |
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * Gets item_id |
|
| 158 | - * @return string |
|
| 159 | - */ |
|
| 160 | - public function OBJ_ID(); |
|
| 156 | + /** |
|
| 157 | + * Gets item_id |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 160 | + public function OBJ_ID(); |
|
| 161 | 161 | |
| 162 | 162 | |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Gets the related item type ( like: Ticket or Event ) |
|
| 166 | - * @return string |
|
| 167 | - */ |
|
| 168 | - public function OBJ_type(); |
|
| 164 | + /** |
|
| 165 | + * Gets the related item type ( like: Ticket or Event ) |
|
| 166 | + * @return string |
|
| 167 | + */ |
|
| 168 | + public function OBJ_type(); |
|
| 169 | 169 | |
| 170 | 170 | |
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Gets the final total on this item, taking taxes into account. |
|
| 174 | - * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 175 | - * If this is used on a grand-total line item, also updates the transaction's |
|
| 176 | - * TXN_total |
|
| 177 | - * @return float |
|
| 178 | - */ |
|
| 179 | - public function recalculate_total_including_taxes(); |
|
| 172 | + /** |
|
| 173 | + * Gets the final total on this item, taking taxes into account. |
|
| 174 | + * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 175 | + * If this is used on a grand-total line item, also updates the transaction's |
|
| 176 | + * TXN_total |
|
| 177 | + * @return float |
|
| 178 | + */ |
|
| 179 | + public function recalculate_total_including_taxes(); |
|
| 180 | 180 | |
| 181 | - /** |
|
| 182 | - * Checks if this item is a percentage modifier or not |
|
| 183 | - * @throws EE_Error |
|
| 184 | - * @return boolean |
|
| 185 | - */ |
|
| 186 | - public function is_percent(); |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Gets percent (between 100-.001) |
|
| 190 | - * @return float |
|
| 191 | - */ |
|
| 192 | - public function percent(); |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * Sets total |
|
| 196 | - * @param float $total |
|
| 197 | - * @return boolean |
|
| 198 | - */ |
|
| 199 | - public function set_total($total); |
|
| 200 | - |
|
| 201 | - /** |
|
| 202 | - * Sets unit_price |
|
| 203 | - * @param float $unit_price |
|
| 204 | - * @return boolean |
|
| 205 | - */ |
|
| 206 | - public function set_unit_price($unit_price); |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 210 | - * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 211 | - * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 212 | - * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted) |
|
| 213 | - * @param string $code |
|
| 214 | - * @param bool $stop_search_once_found |
|
| 215 | - * @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) |
|
| 216 | - */ |
|
| 217 | - public function delete_child_line_item($code, $stop_search_once_found = true); |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Forgets the cached model of the given relation Name. So the next time we request it, |
|
| 221 | - * we will fetch it again from the database. (Handy if you know it's changed somehow). |
|
| 222 | - * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM, |
|
| 223 | - * then only remove that one object from our cached array. Otherwise, clear the entire list |
|
| 224 | - * @param string $relationName one of the keys in the _model_relations array on the model. Eg 'Registration' |
|
| 225 | - * @param mixed $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL |
|
| 226 | - * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation) |
|
| 227 | - * @param bool $clear_all This flags clearing the entire cache relation property if this is HasMany or HABTM. |
|
| 228 | - * @throws EE_Error |
|
| 229 | - * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all |
|
| 230 | - */ |
|
| 231 | - public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false); |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Sets whether or not this model object should be allowed to be saved to the DB. |
|
| 235 | - * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless |
|
| 236 | - * you got new information that somehow made you change your mind. |
|
| 237 | - * @param boolean $allow_persist |
|
| 238 | - * @return boolean |
|
| 239 | - */ |
|
| 240 | - public function set_allow_persist($allow_persist); |
|
| 181 | + /** |
|
| 182 | + * Checks if this item is a percentage modifier or not |
|
| 183 | + * @throws EE_Error |
|
| 184 | + * @return boolean |
|
| 185 | + */ |
|
| 186 | + public function is_percent(); |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Gets percent (between 100-.001) |
|
| 190 | + * @return float |
|
| 191 | + */ |
|
| 192 | + public function percent(); |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * Sets total |
|
| 196 | + * @param float $total |
|
| 197 | + * @return boolean |
|
| 198 | + */ |
|
| 199 | + public function set_total($total); |
|
| 200 | + |
|
| 201 | + /** |
|
| 202 | + * Sets unit_price |
|
| 203 | + * @param float $unit_price |
|
| 204 | + * @return boolean |
|
| 205 | + */ |
|
| 206 | + public function set_unit_price($unit_price); |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 210 | + * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 211 | + * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 212 | + * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted) |
|
| 213 | + * @param string $code |
|
| 214 | + * @param bool $stop_search_once_found |
|
| 215 | + * @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) |
|
| 216 | + */ |
|
| 217 | + public function delete_child_line_item($code, $stop_search_once_found = true); |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Forgets the cached model of the given relation Name. So the next time we request it, |
|
| 221 | + * we will fetch it again from the database. (Handy if you know it's changed somehow). |
|
| 222 | + * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM, |
|
| 223 | + * then only remove that one object from our cached array. Otherwise, clear the entire list |
|
| 224 | + * @param string $relationName one of the keys in the _model_relations array on the model. Eg 'Registration' |
|
| 225 | + * @param mixed $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL |
|
| 226 | + * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation) |
|
| 227 | + * @param bool $clear_all This flags clearing the entire cache relation property if this is HasMany or HABTM. |
|
| 228 | + * @throws EE_Error |
|
| 229 | + * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all |
|
| 230 | + */ |
|
| 231 | + public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false); |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Sets whether or not this model object should be allowed to be saved to the DB. |
|
| 235 | + * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless |
|
| 236 | + * you got new information that somehow made you change your mind. |
|
| 237 | + * @param boolean $allow_persist |
|
| 238 | + * @return boolean |
|
| 239 | + */ |
|
| 240 | + public function set_allow_persist($allow_persist); |
|
| 241 | 241 | } |
@@ -11,9 +11,9 @@ |
||
| 11 | 11 | interface EEI_Has_Icon |
| 12 | 12 | { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Return the icon representing the object (usually a WP dashicon). |
|
| 16 | - * @return string |
|
| 17 | - */ |
|
| 18 | - public function get_icon(); |
|
| 14 | + /** |
|
| 15 | + * Return the icon representing the object (usually a WP dashicon). |
|
| 16 | + * @return string |
|
| 17 | + */ |
|
| 18 | + public function get_icon(); |
|
| 19 | 19 | } |
@@ -13,9 +13,9 @@ |
||
| 13 | 13 | interface EEI_Has_Code |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * Return a code. |
|
| 18 | - * @return string |
|
| 19 | - */ |
|
| 20 | - public function code(); |
|
| 16 | + /** |
|
| 17 | + * Return a code. |
|
| 18 | + * @return string |
|
| 19 | + */ |
|
| 20 | + public function code(); |
|
| 21 | 21 | } |
@@ -6,16 +6,16 @@ |
||
| 6 | 6 | interface EEHI_Money |
| 7 | 7 | { |
| 8 | 8 | |
| 9 | - /** |
|
| 10 | - * For comparing floats. Default operator is '=', but see the $operator below for all options. |
|
| 11 | - * This should be used to compare floats instead of normal '==' because floats |
|
| 12 | - * are inherently imprecise, and so you can sometimes have two floats that appear to be identical |
|
| 13 | - * but actually differ by 0.00000001. |
|
| 14 | - * |
|
| 15 | - * @param float $float1 |
|
| 16 | - * @param float $float2 |
|
| 17 | - * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne |
|
| 18 | - * @return boolean whether the equation is true or false |
|
| 19 | - */ |
|
| 20 | - public function compare_floats($float1, $float2, $operator = '='); |
|
| 9 | + /** |
|
| 10 | + * For comparing floats. Default operator is '=', but see the $operator below for all options. |
|
| 11 | + * This should be used to compare floats instead of normal '==' because floats |
|
| 12 | + * are inherently imprecise, and so you can sometimes have two floats that appear to be identical |
|
| 13 | + * but actually differ by 0.00000001. |
|
| 14 | + * |
|
| 15 | + * @param float $float1 |
|
| 16 | + * @param float $float2 |
|
| 17 | + * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne |
|
| 18 | + * @return boolean whether the equation is true or false |
|
| 19 | + */ |
|
| 20 | + public function compare_floats($float1, $float2, $operator = '='); |
|
| 21 | 21 | } |
@@ -13,5 +13,5 @@ |
||
| 13 | 13 | interface InterminableInterface |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - // no specific methods required |
|
| 16 | + // no specific methods required |
|
| 17 | 17 | } |
@@ -12,32 +12,32 @@ |
||
| 12 | 12 | { |
| 13 | 13 | |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Return the link to the admin details for the object. |
|
| 17 | - * @return string |
|
| 18 | - */ |
|
| 19 | - public function get_admin_details_link(); |
|
| 15 | + /** |
|
| 16 | + * Return the link to the admin details for the object. |
|
| 17 | + * @return string |
|
| 18 | + */ |
|
| 19 | + public function get_admin_details_link(); |
|
| 20 | 20 | |
| 21 | 21 | |
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function get_admin_edit_link(); |
|
| 24 | + /** |
|
| 25 | + * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function get_admin_edit_link(); |
|
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Returns the link to a settings page for the object. |
|
| 33 | - * @return string |
|
| 34 | - */ |
|
| 35 | - public function get_admin_settings_link(); |
|
| 31 | + /** |
|
| 32 | + * Returns the link to a settings page for the object. |
|
| 33 | + * @return string |
|
| 34 | + */ |
|
| 35 | + public function get_admin_settings_link(); |
|
| 36 | 36 | |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Returns the link to the "overview" for the object (typically the "list table" view). |
|
| 40 | - * @return string |
|
| 41 | - */ |
|
| 42 | - public function get_admin_overview_link(); |
|
| 38 | + /** |
|
| 39 | + * Returns the link to the "overview" for the object (typically the "list table" view). |
|
| 40 | + * @return string |
|
| 41 | + */ |
|
| 42 | + public function get_admin_overview_link(); |
|
| 43 | 43 | } |
@@ -6,13 +6,13 @@ |
||
| 6 | 6 | interface EEMI_Payment_Log |
| 7 | 7 | { |
| 8 | 8 | |
| 9 | - /** |
|
| 10 | - * Logs a message |
|
| 11 | - * |
|
| 12 | - * @param string $message |
|
| 13 | - * @param int|string $id |
|
| 14 | - * @param string $model_name |
|
| 15 | - * @return EE_Log |
|
| 16 | - */ |
|
| 17 | - public function gateway_log($message, $id, $model_name); |
|
| 9 | + /** |
|
| 10 | + * Logs a message |
|
| 11 | + * |
|
| 12 | + * @param string $message |
|
| 13 | + * @param int|string $id |
|
| 14 | + * @param string $model_name |
|
| 15 | + * @return EE_Log |
|
| 16 | + */ |
|
| 17 | + public function gateway_log($message, $id, $model_name); |
|
| 18 | 18 | } |
@@ -7,129 +7,129 @@ |
||
| 7 | 7 | interface EEI_Payment extends EEI_Base |
| 8 | 8 | { |
| 9 | 9 | |
| 10 | - /** |
|
| 11 | - * @return string indicating which the payment is approved, pending, cancelled or failed |
|
| 12 | - */ |
|
| 13 | - public function status(); |
|
| 10 | + /** |
|
| 11 | + * @return string indicating which the payment is approved, pending, cancelled or failed |
|
| 12 | + */ |
|
| 13 | + public function status(); |
|
| 14 | 14 | |
| 15 | 15 | |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @return float returns the amount the payment is for (whether or not its approved) |
|
| 19 | - */ |
|
| 20 | - public function amount(); |
|
| 17 | + /** |
|
| 18 | + * @return float returns the amount the payment is for (whether or not its approved) |
|
| 19 | + */ |
|
| 20 | + public function amount(); |
|
| 21 | 21 | |
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @return string of the currency for this payment |
|
| 26 | - */ |
|
| 27 | - public function currency_code(); |
|
| 24 | + /** |
|
| 25 | + * @return string of the currency for this payment |
|
| 26 | + */ |
|
| 27 | + public function currency_code(); |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * The gateway transaction's ID, usually assigned by the |
|
| 33 | - * payment provider |
|
| 34 | - * |
|
| 35 | - * @return string |
|
| 36 | - */ |
|
| 37 | - public function txn_id_chq_nmbr(); |
|
| 31 | + /** |
|
| 32 | + * The gateway transaction's ID, usually assigned by the |
|
| 33 | + * payment provider |
|
| 34 | + * |
|
| 35 | + * @return string |
|
| 36 | + */ |
|
| 37 | + public function txn_id_chq_nmbr(); |
|
| 38 | 38 | |
| 39 | 39 | |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @param string $status |
|
| 43 | - */ |
|
| 44 | - public function set_status($status); |
|
| 41 | + /** |
|
| 42 | + * @param string $status |
|
| 43 | + */ |
|
| 44 | + public function set_status($status); |
|
| 45 | 45 | |
| 46 | 46 | |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Sets the response from the gateway, which is displayable to the user. |
|
| 50 | - * Eg, 'payment was approved', 'payment failed because invalid date', etc. |
|
| 51 | - * |
|
| 52 | - * @param string $response |
|
| 53 | - */ |
|
| 54 | - public function set_gateway_response($response); |
|
| 48 | + /** |
|
| 49 | + * Sets the response from the gateway, which is displayable to the user. |
|
| 50 | + * Eg, 'payment was approved', 'payment failed because invalid date', etc. |
|
| 51 | + * |
|
| 52 | + * @param string $response |
|
| 53 | + */ |
|
| 54 | + public function set_gateway_response($response); |
|
| 55 | 55 | |
| 56 | 56 | |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Sets the response details, usually the entire contents of an IPN request, |
|
| 60 | - * or data about the direct payment data sent |
|
| 61 | - * |
|
| 62 | - * @param mixed $response_details |
|
| 63 | - */ |
|
| 64 | - public function set_details($response_details); |
|
| 58 | + /** |
|
| 59 | + * Sets the response details, usually the entire contents of an IPN request, |
|
| 60 | + * or data about the direct payment data sent |
|
| 61 | + * |
|
| 62 | + * @param mixed $response_details |
|
| 63 | + */ |
|
| 64 | + public function set_details($response_details); |
|
| 65 | 65 | |
| 66 | 66 | |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Returns whatever the details were set to be, which could be an array, object, string, integer, whatever. |
|
| 70 | - * |
|
| 71 | - * @return mixed |
|
| 72 | - */ |
|
| 73 | - public function details(); |
|
| 68 | + /** |
|
| 69 | + * Returns whatever the details were set to be, which could be an array, object, string, integer, whatever. |
|
| 70 | + * |
|
| 71 | + * @return mixed |
|
| 72 | + */ |
|
| 73 | + public function details(); |
|
| 74 | 74 | |
| 75 | 75 | |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Sets the URl to redirect to, to process payment |
|
| 79 | - * |
|
| 80 | - * @param string $url |
|
| 81 | - */ |
|
| 82 | - public function set_redirect_url($url); |
|
| 77 | + /** |
|
| 78 | + * Sets the URl to redirect to, to process payment |
|
| 79 | + * |
|
| 80 | + * @param string $url |
|
| 81 | + */ |
|
| 82 | + public function set_redirect_url($url); |
|
| 83 | 83 | |
| 84 | 84 | |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Sets the argument which should be passed to the redirect url (ie, usually POST variables) |
|
| 88 | - * |
|
| 89 | - * @param array $args |
|
| 90 | - */ |
|
| 91 | - public function set_redirect_args($args); |
|
| 86 | + /** |
|
| 87 | + * Sets the argument which should be passed to the redirect url (ie, usually POST variables) |
|
| 88 | + * |
|
| 89 | + * @param array $args |
|
| 90 | + */ |
|
| 91 | + public function set_redirect_args($args); |
|
| 92 | 92 | |
| 93 | 93 | |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Gets redirect_args |
|
| 97 | - * |
|
| 98 | - * @return array |
|
| 99 | - */ |
|
| 100 | - public function redirect_args(); |
|
| 95 | + /** |
|
| 96 | + * Gets redirect_args |
|
| 97 | + * |
|
| 98 | + * @return array |
|
| 99 | + */ |
|
| 100 | + public function redirect_args(); |
|
| 101 | 101 | |
| 102 | 102 | |
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * @return EEI_Transaction |
|
| 106 | - */ |
|
| 107 | - public function transaction(); |
|
| 104 | + /** |
|
| 105 | + * @return EEI_Transaction |
|
| 106 | + */ |
|
| 107 | + public function transaction(); |
|
| 108 | 108 | |
| 109 | 109 | |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * Sets the amount for this payment |
|
| 113 | - * |
|
| 114 | - * @param float $amount |
|
| 115 | - */ |
|
| 116 | - public function set_amount($amount); |
|
| 111 | + /** |
|
| 112 | + * Sets the amount for this payment |
|
| 113 | + * |
|
| 114 | + * @param float $amount |
|
| 115 | + */ |
|
| 116 | + public function set_amount($amount); |
|
| 117 | 117 | |
| 118 | 118 | |
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Sets the ID of the gateway transaction |
|
| 122 | - * |
|
| 123 | - * @param string $txn_id |
|
| 124 | - */ |
|
| 125 | - public function set_txn_id_chq_nmbr($txn_id); |
|
| 120 | + /** |
|
| 121 | + * Sets the ID of the gateway transaction |
|
| 122 | + * |
|
| 123 | + * @param string $txn_id |
|
| 124 | + */ |
|
| 125 | + public function set_txn_id_chq_nmbr($txn_id); |
|
| 126 | 126 | |
| 127 | 127 | |
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * Sets a string for some extra accounting info |
|
| 131 | - * |
|
| 132 | - * @param string $extra_accounting_info |
|
| 133 | - */ |
|
| 134 | - public function set_extra_accntng($extra_accounting_info); |
|
| 129 | + /** |
|
| 130 | + * Sets a string for some extra accounting info |
|
| 131 | + * |
|
| 132 | + * @param string $extra_accounting_info |
|
| 133 | + */ |
|
| 134 | + public function set_extra_accntng($extra_accounting_info); |
|
| 135 | 135 | } |