@@ -6,17 +6,17 @@ |
||
6 | 6 | interface EEI_Contact |
7 | 7 | { |
8 | 8 | |
9 | - public function fname(); |
|
9 | + public function fname(); |
|
10 | 10 | |
11 | 11 | |
12 | 12 | |
13 | - public function lname(); |
|
13 | + public function lname(); |
|
14 | 14 | |
15 | 15 | |
16 | 16 | |
17 | - public function email(); |
|
17 | + public function email(); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - public function phone(); |
|
21 | + public function phone(); |
|
22 | 22 | } |
@@ -6,33 +6,33 @@ |
||
6 | 6 | interface EEI_Has_Address |
7 | 7 | { |
8 | 8 | |
9 | - public function address(); |
|
9 | + public function address(); |
|
10 | 10 | |
11 | 11 | |
12 | 12 | |
13 | - public function address2(); |
|
13 | + public function address2(); |
|
14 | 14 | |
15 | 15 | |
16 | 16 | |
17 | - public function city(); |
|
17 | + public function city(); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - public function state_ID(); |
|
21 | + public function state_ID(); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | - public function state_obj(); |
|
25 | + public function state_obj(); |
|
26 | 26 | |
27 | 27 | |
28 | 28 | |
29 | - public function country_ID(); |
|
29 | + public function country_ID(); |
|
30 | 30 | |
31 | 31 | |
32 | 32 | |
33 | - public function country_obj(); |
|
33 | + public function country_obj(); |
|
34 | 34 | |
35 | 35 | |
36 | 36 | |
37 | - public function zip(); |
|
37 | + public function zip(); |
|
38 | 38 | } |
@@ -6,22 +6,22 @@ |
||
6 | 6 | interface EEHI_Template |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * EEH_Template::format_currency |
|
11 | - * This helper takes a raw float value and formats it according to the default config country currency settings, or the country currency settings from the supplied country ISO code |
|
12 | - * |
|
13 | - * @param float $amount raw money value |
|
14 | - * @param boolean $return_raw whether to return the formatted float value only with no currency sign or code |
|
15 | - * @param boolean $display_code whether to display the country code (USD). Default = TRUE |
|
16 | - * @param string $CNT_ISO 2 letter ISO code for a country |
|
17 | - * @param string $cur_code_span_class |
|
18 | - * @return string the html output for the formatted money value |
|
19 | - */ |
|
20 | - public static function format_currency( |
|
21 | - $amount = null, |
|
22 | - $return_raw = false, |
|
23 | - $display_code = true, |
|
24 | - $CNT_ISO = '', |
|
25 | - $cur_code_span_class = 'currency-code' |
|
26 | - ); |
|
9 | + /** |
|
10 | + * EEH_Template::format_currency |
|
11 | + * This helper takes a raw float value and formats it according to the default config country currency settings, or the country currency settings from the supplied country ISO code |
|
12 | + * |
|
13 | + * @param float $amount raw money value |
|
14 | + * @param boolean $return_raw whether to return the formatted float value only with no currency sign or code |
|
15 | + * @param boolean $display_code whether to display the country code (USD). Default = TRUE |
|
16 | + * @param string $CNT_ISO 2 letter ISO code for a country |
|
17 | + * @param string $cur_code_span_class |
|
18 | + * @return string the html output for the formatted money value |
|
19 | + */ |
|
20 | + public static function format_currency( |
|
21 | + $amount = null, |
|
22 | + $return_raw = false, |
|
23 | + $display_code = true, |
|
24 | + $CNT_ISO = '', |
|
25 | + $cur_code_span_class = 'currency-code' |
|
26 | + ); |
|
27 | 27 | } |
@@ -6,27 +6,27 @@ |
||
6 | 6 | interface EEHI_File |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * ensure_file_exists_and_is_writable |
|
11 | - * ensures that a file exists and is writable, will attempt to create file if it does not exist |
|
12 | - * |
|
13 | - * @param string $full_file_path |
|
14 | - * @throws EE_Error |
|
15 | - * @return bool |
|
16 | - */ |
|
17 | - public static function ensure_file_exists_and_is_writable($full_file_path = ''); |
|
9 | + /** |
|
10 | + * ensure_file_exists_and_is_writable |
|
11 | + * ensures that a file exists and is writable, will attempt to create file if it does not exist |
|
12 | + * |
|
13 | + * @param string $full_file_path |
|
14 | + * @throws EE_Error |
|
15 | + * @return bool |
|
16 | + */ |
|
17 | + public static function ensure_file_exists_and_is_writable($full_file_path = ''); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * ensure_folder_exists_and_is_writable |
|
23 | - * ensures that a folder exists and is writable, will attempt to create folder if it does not exist |
|
24 | - * |
|
25 | - * @param string $folder |
|
26 | - * @throws EE_Error |
|
27 | - * @return bool |
|
28 | - */ |
|
29 | - public static function ensure_folder_exists_and_is_writable($folder = ''); |
|
21 | + /** |
|
22 | + * ensure_folder_exists_and_is_writable |
|
23 | + * ensures that a folder exists and is writable, will attempt to create folder if it does not exist |
|
24 | + * |
|
25 | + * @param string $folder |
|
26 | + * @throws EE_Error |
|
27 | + * @return bool |
|
28 | + */ |
|
29 | + public static function ensure_folder_exists_and_is_writable($folder = ''); |
|
30 | 30 | } |
31 | 31 | // End of file EEHI_File.interface.php |
32 | 32 | // Location: core/interfaces/EEHI_File.interface.php |
@@ -6,14 +6,14 @@ |
||
6 | 6 | interface EEI_Address_Formatter |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * @param string $address |
|
11 | - * @param string $address2 |
|
12 | - * @param string $city |
|
13 | - * @param string $state |
|
14 | - * @param string $zip |
|
15 | - * @param string $country |
|
16 | - * @param string $CNT_ISO |
|
17 | - */ |
|
18 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO); |
|
9 | + /** |
|
10 | + * @param string $address |
|
11 | + * @param string $address2 |
|
12 | + * @param string $city |
|
13 | + * @param string $state |
|
14 | + * @param string $zip |
|
15 | + * @param string $country |
|
16 | + * @param string $CNT_ISO |
|
17 | + */ |
|
18 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO); |
|
19 | 19 | } |
@@ -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 | } |
@@ -18,11 +18,11 @@ |
||
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * process |
|
23 | - * |
|
24 | - * @param \EEI_Line_Item $line_item |
|
25 | - * @return \EEI_Line_Item |
|
26 | - */ |
|
27 | - public function process(EEI_Line_Item $line_item); |
|
21 | + /** |
|
22 | + * process |
|
23 | + * |
|
24 | + * @param \EEI_Line_Item $line_item |
|
25 | + * @return \EEI_Line_Item |
|
26 | + */ |
|
27 | + public function process(EEI_Line_Item $line_item); |
|
28 | 28 | } |
@@ -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 | } |