@@ -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 | } |
@@ -9,55 +9,55 @@ |
||
9 | 9 | interface EEMI_Payment |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * returns a string for the approved status |
|
14 | - */ |
|
15 | - public function approved_status(); |
|
12 | + /** |
|
13 | + * returns a string for the approved status |
|
14 | + */ |
|
15 | + public function approved_status(); |
|
16 | 16 | |
17 | 17 | |
18 | 18 | |
19 | - /** |
|
20 | - * returns a string for the pending status |
|
21 | - */ |
|
22 | - public function pending_status(); |
|
19 | + /** |
|
20 | + * returns a string for the pending status |
|
21 | + */ |
|
22 | + public function pending_status(); |
|
23 | 23 | |
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * returns a string for the cancelled status |
|
28 | - */ |
|
29 | - public function cancelled_status(); |
|
26 | + /** |
|
27 | + * returns a string for the cancelled status |
|
28 | + */ |
|
29 | + public function cancelled_status(); |
|
30 | 30 | |
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * returns a string for the failed status |
|
35 | - */ |
|
36 | - public function failed_status(); |
|
33 | + /** |
|
34 | + * returns a string for the failed status |
|
35 | + */ |
|
36 | + public function failed_status(); |
|
37 | 37 | |
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * returns a string for the declined status |
|
42 | - */ |
|
43 | - public function declined_status(); |
|
40 | + /** |
|
41 | + * returns a string for the declined status |
|
42 | + */ |
|
43 | + public function declined_status(); |
|
44 | 44 | |
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * Function that returns an instance of this class. |
|
49 | - * |
|
50 | - * @return EEMI_Payment |
|
51 | - */ |
|
52 | - public static function instance(); |
|
47 | + /** |
|
48 | + * Function that returns an instance of this class. |
|
49 | + * |
|
50 | + * @return EEMI_Payment |
|
51 | + */ |
|
52 | + public static function instance(); |
|
53 | 53 | |
54 | 54 | |
55 | 55 | |
56 | - /** |
|
57 | - * Gets a payment by the transaction ID or cheque number |
|
58 | - * |
|
59 | - * @param int $txn_id |
|
60 | - * @return EEI_Payment |
|
61 | - */ |
|
62 | - public function get_payment_by_txn_id_chq_nmbr($txn_id); |
|
56 | + /** |
|
57 | + * Gets a payment by the transaction ID or cheque number |
|
58 | + * |
|
59 | + * @param int $txn_id |
|
60 | + * @return EEI_Payment |
|
61 | + */ |
|
62 | + public function get_payment_by_txn_id_chq_nmbr($txn_id); |
|
63 | 63 | } |
@@ -13,16 +13,16 @@ |
||
13 | 13 | |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * duplicate |
|
18 | - * |
|
19 | - * used for duplicating the current object and its related dependent data |
|
20 | - * |
|
21 | - * @access public |
|
22 | - * @param array $options key-value pairs of special options for duplicating, which varies by implemtor. |
|
23 | - * For example, it might have an option to duplicate related data or not, or to make a duplicate |
|
24 | - * with the exception of a particular attribute |
|
25 | - * @return object of the same class as what was called on |
|
26 | - */ |
|
27 | - public function duplicate($options = array()); |
|
16 | + /** |
|
17 | + * duplicate |
|
18 | + * |
|
19 | + * used for duplicating the current object and its related dependent data |
|
20 | + * |
|
21 | + * @access public |
|
22 | + * @param array $options key-value pairs of special options for duplicating, which varies by implemtor. |
|
23 | + * For example, it might have an option to duplicate related data or not, or to make a duplicate |
|
24 | + * with the exception of a particular attribute |
|
25 | + * @return object of the same class as what was called on |
|
26 | + */ |
|
27 | + public function duplicate($options = array()); |
|
28 | 28 | } |
@@ -13,26 +13,26 @@ |
||
13 | 13 | { |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * Detects any specific query variables in the request and uses those to setup appropriate |
|
18 | - * filter for any queries. |
|
19 | - * @return array |
|
20 | - */ |
|
21 | - public function filter_by_query_params(); |
|
16 | + /** |
|
17 | + * Detects any specific query variables in the request and uses those to setup appropriate |
|
18 | + * filter for any queries. |
|
19 | + * @return array |
|
20 | + */ |
|
21 | + public function filter_by_query_params(); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * This method should return a pretty label describing the results that are generated after injecting query |
|
29 | - * variables via the `filter_by_query_params` method. |
|
30 | - * |
|
31 | - * An example of the kind of label that would be returned is: |
|
32 | - * |
|
33 | - * "Showing all transactions for the Event: Happy Days Convention and the Registration with the ID: 42". |
|
34 | - * |
|
35 | - * @return string |
|
36 | - */ |
|
37 | - public function get_pretty_label_for_results(); |
|
27 | + /** |
|
28 | + * This method should return a pretty label describing the results that are generated after injecting query |
|
29 | + * variables via the `filter_by_query_params` method. |
|
30 | + * |
|
31 | + * An example of the kind of label that would be returned is: |
|
32 | + * |
|
33 | + * "Showing all transactions for the Event: Happy Days Convention and the Registration with the ID: 42". |
|
34 | + * |
|
35 | + * @return string |
|
36 | + */ |
|
37 | + public function get_pretty_label_for_results(); |
|
38 | 38 | } |
@@ -6,28 +6,28 @@ |
||
6 | 6 | interface EEI_Registration extends EEI_Base |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * Gets the registration code |
|
11 | - * |
|
12 | - * @return string |
|
13 | - */ |
|
14 | - public function reg_code(); |
|
9 | + /** |
|
10 | + * Gets the registration code |
|
11 | + * |
|
12 | + * @return string |
|
13 | + */ |
|
14 | + public function reg_code(); |
|
15 | 15 | |
16 | 16 | |
17 | 17 | |
18 | - /** |
|
19 | - * Gets the attendee corresponding to this registration |
|
20 | - * |
|
21 | - * @return EEI_Attendee |
|
22 | - */ |
|
23 | - public function attendee(); |
|
18 | + /** |
|
19 | + * Gets the attendee corresponding to this registration |
|
20 | + * |
|
21 | + * @return EEI_Attendee |
|
22 | + */ |
|
23 | + public function attendee(); |
|
24 | 24 | |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * Returns the event's name this registration is for |
|
29 | - * |
|
30 | - * @return string |
|
31 | - */ |
|
32 | - public function event_name(); |
|
27 | + /** |
|
28 | + * Returns the event's name this registration is for |
|
29 | + * |
|
30 | + * @return string |
|
31 | + */ |
|
32 | + public function event_name(); |
|
33 | 33 | } |
@@ -6,67 +6,67 @@ |
||
6 | 6 | interface EEI_Attendee |
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 full_name(); |
|
17 | + public function full_name(); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - public function email(); |
|
21 | + public function email(); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | - public function phone(); |
|
25 | + public function phone(); |
|
26 | 26 | |
27 | 27 | |
28 | 28 | |
29 | - public function address(); |
|
29 | + public function address(); |
|
30 | 30 | |
31 | 31 | |
32 | 32 | |
33 | - public function address2(); |
|
33 | + public function address2(); |
|
34 | 34 | |
35 | 35 | |
36 | 36 | |
37 | - public function city(); |
|
37 | + public function city(); |
|
38 | 38 | |
39 | 39 | |
40 | 40 | |
41 | - public function state_ID(); |
|
41 | + public function state_ID(); |
|
42 | 42 | |
43 | 43 | |
44 | 44 | |
45 | - public function state_name(); |
|
45 | + public function state_name(); |
|
46 | 46 | |
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * @return EE_State |
|
51 | - */ |
|
52 | - public function state_obj(); |
|
49 | + /** |
|
50 | + * @return EE_State |
|
51 | + */ |
|
52 | + public function state_obj(); |
|
53 | 53 | |
54 | 54 | |
55 | 55 | |
56 | - public function country_ID(); |
|
56 | + public function country_ID(); |
|
57 | 57 | |
58 | 58 | |
59 | 59 | |
60 | - public function country_name(); |
|
60 | + public function country_name(); |
|
61 | 61 | |
62 | 62 | |
63 | 63 | |
64 | - /** |
|
65 | - * @return EE_Country |
|
66 | - */ |
|
67 | - public function country_obj(); |
|
64 | + /** |
|
65 | + * @return EE_Country |
|
66 | + */ |
|
67 | + public function country_obj(); |
|
68 | 68 | |
69 | 69 | |
70 | 70 | |
71 | - public function zip(); |
|
71 | + public function zip(); |
|
72 | 72 | } |