@@ -12,9 +12,9 @@ |
||
12 | 12 | { |
13 | 13 | |
14 | 14 | |
15 | - /** |
|
16 | - * Expect a EE_messenger object back that is serving as the sending messenger for a message. |
|
17 | - * @return EE_messenger |
|
18 | - */ |
|
19 | - public function sending_messenger(); |
|
15 | + /** |
|
16 | + * Expect a EE_messenger object back that is serving as the sending messenger for a message. |
|
17 | + * @return EE_messenger |
|
18 | + */ |
|
19 | + public function sending_messenger(); |
|
20 | 20 | } |
@@ -11,16 +11,16 @@ |
||
11 | 11 | interface EEI_Line_Item_Object |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * Return the name representing the object (i.e. Event Title, or Ticket Name). |
|
16 | - * @return string |
|
17 | - */ |
|
18 | - public function name(); |
|
14 | + /** |
|
15 | + * Return the name representing the object (i.e. Event Title, or Ticket Name). |
|
16 | + * @return string |
|
17 | + */ |
|
18 | + public function name(); |
|
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * Return the ID representation for the object. |
|
23 | - * @return mixed int|string |
|
24 | - */ |
|
25 | - public function ID(); |
|
21 | + /** |
|
22 | + * Return the ID representation for the object. |
|
23 | + * @return mixed int|string |
|
24 | + */ |
|
25 | + public function ID(); |
|
26 | 26 | } |
@@ -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,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 | } |