@@ -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 | } |
@@ -14,70 +14,70 @@ |
||
14 | 14 | interface EEI_Collection |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * add |
|
19 | - * |
|
20 | - * attaches an object to the Collection |
|
21 | - * and sets any supplied data associated with the current iterator entry |
|
22 | - * by calling EEI_Collection::set_info() |
|
23 | - * |
|
24 | - * @access public |
|
25 | - * @param object $object |
|
26 | - * @param mixed $info |
|
27 | - * @return bool |
|
28 | - */ |
|
29 | - public function add($object, $info = null); |
|
17 | + /** |
|
18 | + * add |
|
19 | + * |
|
20 | + * attaches an object to the Collection |
|
21 | + * and sets any supplied data associated with the current iterator entry |
|
22 | + * by calling EEI_Collection::set_info() |
|
23 | + * |
|
24 | + * @access public |
|
25 | + * @param object $object |
|
26 | + * @param mixed $info |
|
27 | + * @return bool |
|
28 | + */ |
|
29 | + public function add($object, $info = null); |
|
30 | 30 | |
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * set_info |
|
35 | - * |
|
36 | - * Sets the info associated with an object in the Collection |
|
37 | - * |
|
38 | - * @access public |
|
39 | - * @param object $object |
|
40 | - * @param mixed $info |
|
41 | - * @return bool |
|
42 | - */ |
|
43 | - public function set_info($object, $info = null); |
|
33 | + /** |
|
34 | + * set_info |
|
35 | + * |
|
36 | + * Sets the info associated with an object in the Collection |
|
37 | + * |
|
38 | + * @access public |
|
39 | + * @param object $object |
|
40 | + * @param mixed $info |
|
41 | + * @return bool |
|
42 | + */ |
|
43 | + public function set_info($object, $info = null); |
|
44 | 44 | |
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * get_by_info |
|
49 | - * |
|
50 | - * finds and returns an object in the Collection based on the info that was set using set_info() or add() |
|
51 | - * |
|
52 | - * @access public |
|
53 | - * @param mixed |
|
54 | - * @return null | object |
|
55 | - */ |
|
56 | - public function get_by_info($info); |
|
47 | + /** |
|
48 | + * get_by_info |
|
49 | + * |
|
50 | + * finds and returns an object in the Collection based on the info that was set using set_info() or add() |
|
51 | + * |
|
52 | + * @access public |
|
53 | + * @param mixed |
|
54 | + * @return null | object |
|
55 | + */ |
|
56 | + public function get_by_info($info); |
|
57 | 57 | |
58 | 58 | |
59 | 59 | |
60 | - /** |
|
61 | - * has |
|
62 | - * |
|
63 | - * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
64 | - * |
|
65 | - * @access public |
|
66 | - * @param object $object |
|
67 | - * @return bool |
|
68 | - */ |
|
69 | - public function has($object); |
|
60 | + /** |
|
61 | + * has |
|
62 | + * |
|
63 | + * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
64 | + * |
|
65 | + * @access public |
|
66 | + * @param object $object |
|
67 | + * @return bool |
|
68 | + */ |
|
69 | + public function has($object); |
|
70 | 70 | |
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * remove |
|
75 | - * |
|
76 | - * detaches an object from the Collection |
|
77 | - * |
|
78 | - * @access public |
|
79 | - * @param $object |
|
80 | - * @return void |
|
81 | - */ |
|
82 | - public function remove($object); |
|
73 | + /** |
|
74 | + * remove |
|
75 | + * |
|
76 | + * detaches an object from the Collection |
|
77 | + * |
|
78 | + * @access public |
|
79 | + * @param $object |
|
80 | + * @return void |
|
81 | + */ |
|
82 | + public function remove($object); |
|
83 | 83 | } |
@@ -6,63 +6,63 @@ |
||
6 | 6 | interface EEI_Transaction extends EEI_Base |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * @return EEI_Payment |
|
11 | - */ |
|
12 | - public function last_payment(); |
|
9 | + /** |
|
10 | + * @return EEI_Payment |
|
11 | + */ |
|
12 | + public function last_payment(); |
|
13 | 13 | |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * Gets the total that should eb paid for this transaction |
|
18 | - * |
|
19 | - * @return float |
|
20 | - */ |
|
21 | - public function total(); |
|
16 | + /** |
|
17 | + * Gets the total that should eb paid for this transaction |
|
18 | + * |
|
19 | + * @return float |
|
20 | + */ |
|
21 | + public function total(); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * Get the line item that represents the total for the transaction |
|
27 | - * |
|
28 | - * @return EEI_Line_Item |
|
29 | - */ |
|
30 | - public function total_line_item(); |
|
25 | + /** |
|
26 | + * Get the line item that represents the total for the transaction |
|
27 | + * |
|
28 | + * @return EEI_Line_Item |
|
29 | + */ |
|
30 | + public function total_line_item(); |
|
31 | 31 | |
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * Gets the primary registration for this transaction |
|
36 | - * |
|
37 | - * @return EEI_Registration |
|
38 | - */ |
|
39 | - public function primary_registration(); |
|
34 | + /** |
|
35 | + * Gets the primary registration for this transaction |
|
36 | + * |
|
37 | + * @return EEI_Registration |
|
38 | + */ |
|
39 | + public function primary_registration(); |
|
40 | 40 | |
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * Returns the balance due on the transaction |
|
45 | - * |
|
46 | - * @return float |
|
47 | - */ |
|
48 | - public function remaining(); |
|
43 | + /** |
|
44 | + * Returns the balance due on the transaction |
|
45 | + * |
|
46 | + * @return float |
|
47 | + */ |
|
48 | + public function remaining(); |
|
49 | 49 | |
50 | 50 | |
51 | 51 | |
52 | - /** |
|
53 | - * get Total Amount Paid to Date |
|
54 | - * |
|
55 | - * @access public |
|
56 | - * @return float |
|
57 | - */ |
|
58 | - public function paid(); |
|
52 | + /** |
|
53 | + * get Total Amount Paid to Date |
|
54 | + * |
|
55 | + * @access public |
|
56 | + * @return float |
|
57 | + */ |
|
58 | + public function paid(); |
|
59 | 59 | |
60 | 60 | |
61 | 61 | |
62 | - /** |
|
63 | - * Retrieves all the pending payments on this transaction |
|
64 | - * |
|
65 | - * @return EEI_Payment[] |
|
66 | - */ |
|
67 | - public function pending_payments(); |
|
62 | + /** |
|
63 | + * Retrieves all the pending payments on this transaction |
|
64 | + * |
|
65 | + * @return EEI_Payment[] |
|
66 | + */ |
|
67 | + public function pending_payments(); |
|
68 | 68 | } |
@@ -6,59 +6,59 @@ |
||
6 | 6 | interface EEI_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 | - /** |
|
22 | - * @return EE_State |
|
23 | - */ |
|
24 | - public function state_obj(); |
|
21 | + /** |
|
22 | + * @return EE_State |
|
23 | + */ |
|
24 | + public function state_obj(); |
|
25 | 25 | |
26 | 26 | |
27 | 27 | |
28 | - public function state_ID(); |
|
28 | + public function state_ID(); |
|
29 | 29 | |
30 | 30 | |
31 | 31 | |
32 | - public function state_name(); |
|
32 | + public function state_name(); |
|
33 | 33 | |
34 | 34 | |
35 | 35 | |
36 | - public function state_abbrev(); |
|
36 | + public function state_abbrev(); |
|
37 | 37 | |
38 | 38 | |
39 | 39 | |
40 | - public function state(); |
|
40 | + public function state(); |
|
41 | 41 | |
42 | 42 | |
43 | 43 | |
44 | - /** |
|
45 | - * @return EE_Country |
|
46 | - */ |
|
47 | - public function country_obj(); |
|
44 | + /** |
|
45 | + * @return EE_Country |
|
46 | + */ |
|
47 | + public function country_obj(); |
|
48 | 48 | |
49 | 49 | |
50 | 50 | |
51 | - public function country_ID(); |
|
51 | + public function country_ID(); |
|
52 | 52 | |
53 | 53 | |
54 | 54 | |
55 | - public function country_name(); |
|
55 | + public function country_name(); |
|
56 | 56 | |
57 | 57 | |
58 | 58 | |
59 | - public function country(); |
|
59 | + public function country(); |
|
60 | 60 | |
61 | 61 | |
62 | 62 | |
63 | - public function zip(); |
|
63 | + public function zip(); |
|
64 | 64 | } |
@@ -14,8 +14,8 @@ |
||
14 | 14 | interface ResettableInterface |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @return mixed |
|
19 | - */ |
|
20 | - public static function reset(); |
|
17 | + /** |
|
18 | + * @return mixed |
|
19 | + */ |
|
20 | + public static function reset(); |
|
21 | 21 | } |
@@ -6,5 +6,5 @@ |
||
6 | 6 | interface EEI_Event |
7 | 7 | { |
8 | 8 | |
9 | - public function name(); |
|
9 | + public function name(); |
|
10 | 10 | } |