@@ -47,7 +47,7 @@ |
||
47 | 47 | /** |
48 | 48 | * This retrieves any EE_Message_Template_Group in the repo by its ID. |
49 | 49 | * |
50 | - * @param $GRP_ID |
|
50 | + * @param integer $GRP_ID |
|
51 | 51 | * @return EE_Message_Template_Group | null |
52 | 52 | */ |
53 | 53 | public function get_by_ID($GRP_ID) |
@@ -14,115 +14,115 @@ |
||
14 | 14 | { |
15 | 15 | |
16 | 16 | |
17 | - /** |
|
18 | - * EE_Message_Template_Group_Collection constructor. |
|
19 | - */ |
|
20 | - public function __construct() |
|
21 | - { |
|
22 | - $this->interface = 'EE_Message_Template_Group'; |
|
23 | - } |
|
17 | + /** |
|
18 | + * EE_Message_Template_Group_Collection constructor. |
|
19 | + */ |
|
20 | + public function __construct() |
|
21 | + { |
|
22 | + $this->interface = 'EE_Message_Template_Group'; |
|
23 | + } |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * Adds the Message Template Group object to the repository. |
|
28 | - * |
|
29 | - * @param $message_template_group |
|
30 | - * @param array|int $EVT_ID Some templates are specific to EVT, so this is provided as a way of |
|
31 | - * indexing the template by key. If this template is shared among multiple events then |
|
32 | - * include the events as an array. |
|
33 | - * @return bool |
|
34 | - */ |
|
35 | - public function add($message_template_group, $EVT_ID = array()) |
|
36 | - { |
|
37 | - $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID; |
|
38 | - if ($message_template_group instanceof $this->interface) { |
|
39 | - $data['key'] = $this->getKey( |
|
40 | - $message_template_group->messenger(), |
|
41 | - $message_template_group->message_type(), |
|
42 | - $EVT_ID |
|
43 | - ); |
|
44 | - return parent::add($message_template_group, $data); |
|
45 | - } |
|
46 | - return false; |
|
47 | - } |
|
26 | + /** |
|
27 | + * Adds the Message Template Group object to the repository. |
|
28 | + * |
|
29 | + * @param $message_template_group |
|
30 | + * @param array|int $EVT_ID Some templates are specific to EVT, so this is provided as a way of |
|
31 | + * indexing the template by key. If this template is shared among multiple events then |
|
32 | + * include the events as an array. |
|
33 | + * @return bool |
|
34 | + */ |
|
35 | + public function add($message_template_group, $EVT_ID = array()) |
|
36 | + { |
|
37 | + $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID; |
|
38 | + if ($message_template_group instanceof $this->interface) { |
|
39 | + $data['key'] = $this->getKey( |
|
40 | + $message_template_group->messenger(), |
|
41 | + $message_template_group->message_type(), |
|
42 | + $EVT_ID |
|
43 | + ); |
|
44 | + return parent::add($message_template_group, $data); |
|
45 | + } |
|
46 | + return false; |
|
47 | + } |
|
48 | 48 | |
49 | 49 | |
50 | - /** |
|
51 | - * This retrieves any EE_Message_Template_Group in the repo by its ID. |
|
52 | - * |
|
53 | - * @param $GRP_ID |
|
54 | - * @return EE_Message_Template_Group | null |
|
55 | - */ |
|
56 | - public function get_by_ID($GRP_ID) |
|
57 | - { |
|
58 | - $this->rewind(); |
|
59 | - while ($this->valid()) { |
|
60 | - if ($this->current()->ID() === $GRP_ID) { |
|
61 | - /** @var EE_Message_Template_Group $message_template_group */ |
|
62 | - $message_template_group = $this->current(); |
|
63 | - $this->rewind(); |
|
64 | - return $message_template_group; |
|
65 | - } |
|
66 | - $this->next(); |
|
67 | - } |
|
68 | - return null; |
|
69 | - } |
|
50 | + /** |
|
51 | + * This retrieves any EE_Message_Template_Group in the repo by its ID. |
|
52 | + * |
|
53 | + * @param $GRP_ID |
|
54 | + * @return EE_Message_Template_Group | null |
|
55 | + */ |
|
56 | + public function get_by_ID($GRP_ID) |
|
57 | + { |
|
58 | + $this->rewind(); |
|
59 | + while ($this->valid()) { |
|
60 | + if ($this->current()->ID() === $GRP_ID) { |
|
61 | + /** @var EE_Message_Template_Group $message_template_group */ |
|
62 | + $message_template_group = $this->current(); |
|
63 | + $this->rewind(); |
|
64 | + return $message_template_group; |
|
65 | + } |
|
66 | + $this->next(); |
|
67 | + } |
|
68 | + return null; |
|
69 | + } |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * Generates a hash used to identify a given Message Template Group. |
|
74 | - * |
|
75 | - * @param string $messenger The EE_messenger->name |
|
76 | - * @param string $message_type The EE_message_type->name |
|
77 | - * @param int $EVT_ID Optional. If the template is for a specific EVT then that should be included. |
|
78 | - * @deprecated 4.9.40.rc.017 Use getKey instead. |
|
79 | - * @return string |
|
80 | - */ |
|
81 | - public function get_key($messenger, $message_type, $EVT_ID = 0) |
|
82 | - { |
|
83 | - $EVT_ID = (array) $EVT_ID; |
|
84 | - return $this->getKey($messenger, $message_type, $EVT_ID); |
|
85 | - } |
|
72 | + /** |
|
73 | + * Generates a hash used to identify a given Message Template Group. |
|
74 | + * |
|
75 | + * @param string $messenger The EE_messenger->name |
|
76 | + * @param string $message_type The EE_message_type->name |
|
77 | + * @param int $EVT_ID Optional. If the template is for a specific EVT then that should be included. |
|
78 | + * @deprecated 4.9.40.rc.017 Use getKey instead. |
|
79 | + * @return string |
|
80 | + */ |
|
81 | + public function get_key($messenger, $message_type, $EVT_ID = 0) |
|
82 | + { |
|
83 | + $EVT_ID = (array) $EVT_ID; |
|
84 | + return $this->getKey($messenger, $message_type, $EVT_ID); |
|
85 | + } |
|
86 | 86 | |
87 | 87 | |
88 | - /** |
|
89 | - * Generates a hash used to identify a given Message Template Group |
|
90 | - * @param string $messenger The EE_messenger->name |
|
91 | - * @param string $message_type The EE_message_type->name |
|
92 | - * @param array $EVT_ID Optional. If the template is for a specific EVT_ID (or events) then that should |
|
93 | - * be included. |
|
94 | - * @since 4.9.40.rc.017 |
|
95 | - * @return string |
|
96 | - */ |
|
97 | - public function getKey($messenger, $message_type, array $EVT_ID = array()) |
|
98 | - { |
|
99 | - sort($EVT_ID); |
|
100 | - $EVT_ID = implode(',', array_unique($EVT_ID)); |
|
101 | - return md5($messenger . $message_type . $EVT_ID); |
|
102 | - } |
|
88 | + /** |
|
89 | + * Generates a hash used to identify a given Message Template Group |
|
90 | + * @param string $messenger The EE_messenger->name |
|
91 | + * @param string $message_type The EE_message_type->name |
|
92 | + * @param array $EVT_ID Optional. If the template is for a specific EVT_ID (or events) then that should |
|
93 | + * be included. |
|
94 | + * @since 4.9.40.rc.017 |
|
95 | + * @return string |
|
96 | + */ |
|
97 | + public function getKey($messenger, $message_type, array $EVT_ID = array()) |
|
98 | + { |
|
99 | + sort($EVT_ID); |
|
100 | + $EVT_ID = implode(',', array_unique($EVT_ID)); |
|
101 | + return md5($messenger . $message_type . $EVT_ID); |
|
102 | + } |
|
103 | 103 | |
104 | 104 | |
105 | - /** |
|
106 | - * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching |
|
107 | - * the given string. |
|
108 | - * |
|
109 | - * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching. |
|
110 | - * @return null|EE_Message_Template_Group |
|
111 | - */ |
|
112 | - public function get_by_key($key) |
|
113 | - { |
|
114 | - $this->rewind(); |
|
115 | - while ($this->valid()) { |
|
116 | - $data = $this->getInfo(); |
|
117 | - if (isset($data['key']) && $data['key'] === $key) { |
|
118 | - /** @var EE_Message_Template_Group $message_template_group */ |
|
119 | - $message_template_group = $this->current(); |
|
120 | - $this->rewind(); |
|
121 | - return $message_template_group; |
|
122 | - } |
|
123 | - $this->next(); |
|
124 | - } |
|
125 | - return null; |
|
126 | - } |
|
105 | + /** |
|
106 | + * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching |
|
107 | + * the given string. |
|
108 | + * |
|
109 | + * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching. |
|
110 | + * @return null|EE_Message_Template_Group |
|
111 | + */ |
|
112 | + public function get_by_key($key) |
|
113 | + { |
|
114 | + $this->rewind(); |
|
115 | + while ($this->valid()) { |
|
116 | + $data = $this->getInfo(); |
|
117 | + if (isset($data['key']) && $data['key'] === $key) { |
|
118 | + /** @var EE_Message_Template_Group $message_template_group */ |
|
119 | + $message_template_group = $this->current(); |
|
120 | + $this->rewind(); |
|
121 | + return $message_template_group; |
|
122 | + } |
|
123 | + $this->next(); |
|
124 | + } |
|
125 | + return null; |
|
126 | + } |
|
127 | 127 | |
128 | 128 | } |
@@ -98,7 +98,7 @@ |
||
98 | 98 | { |
99 | 99 | sort($EVT_ID); |
100 | 100 | $EVT_ID = implode(',', array_unique($EVT_ID)); |
101 | - return md5($messenger . $message_type . $EVT_ID); |
|
101 | + return md5($messenger.$message_type.$EVT_ID); |
|
102 | 102 | } |
103 | 103 | |
104 | 104 |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | * can_use_espresso_conditionals |
131 | 131 | * tests whether the Espresso Conditional tags like is_espresso_event_single() can be called |
132 | 132 | * |
133 | - * @param $conditional_tag |
|
133 | + * @param string $conditional_tag |
|
134 | 134 | * @return bool |
135 | 135 | */ |
136 | 136 | function can_use_espresso_conditionals( $conditional_tag ) { |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | if ( ! function_exists( 'espresso_ticket_selector' )) { |
202 | 202 | /** |
203 | 203 | * espresso_ticket_selector |
204 | - * @param null $event |
|
204 | + * @param EE_Event $event |
|
205 | 205 | */ |
206 | 206 | function espresso_ticket_selector( $event = NULL ) { |
207 | 207 | if ( ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) { |
@@ -842,7 +842,7 @@ discard block |
||
842 | 842 | /** |
843 | 843 | * espresso_event_venues |
844 | 844 | * |
845 | - * @return array all venues related to an event |
|
845 | + * @return EE_Venue[] all venues related to an event |
|
846 | 846 | */ |
847 | 847 | function espresso_event_venues() { |
848 | 848 | return EEH_Venue_View::get_event_venues(); |
@@ -875,7 +875,7 @@ discard block |
||
875 | 875 | * |
876 | 876 | * @param int $VNU_ID optional, the venue id to check. |
877 | 877 | * |
878 | - * @return bool | null |
|
878 | + * @return null|boolean | null |
|
879 | 879 | */ |
880 | 880 | function espresso_is_venue_private( $VNU_ID = 0 ) { |
881 | 881 | return EEH_Venue_View::is_venue_private( $VNU_ID ); |
@@ -889,7 +889,7 @@ discard block |
||
889 | 889 | * returns true or false if a venue is password protected or not |
890 | 890 | * |
891 | 891 | * @param int $VNU_ID optional, the venue id to check. |
892 | - * @return string |
|
892 | + * @return boolean |
|
893 | 893 | */ |
894 | 894 | function espresso_venue_is_password_protected( $VNU_ID = 0 ) { |
895 | 895 | EE_Registry::instance()->load_helper( 'Venue_View' ); |
@@ -206,7 +206,7 @@ |
||
206 | 206 | function espresso_ticket_selector( $event = NULL ) { |
207 | 207 | if ( ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) { |
208 | 208 | espresso_load_ticket_selector(); |
209 | - \EED_Ticket_Selector::set_definitions(); |
|
209 | + \EED_Ticket_Selector::set_definitions(); |
|
210 | 210 | echo EED_Ticket_Selector::display_ticket_selector( $event ); |
211 | 211 | } |
212 | 212 | } |
@@ -14,12 +14,12 @@ discard block |
||
14 | 14 | * @param int | \EE_Event $event |
15 | 15 | * @return bool |
16 | 16 | */ |
17 | -function is_espresso_event( $event = NULL ) { |
|
18 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
17 | +function is_espresso_event($event = NULL) { |
|
18 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
19 | 19 | // extract EE_Event object from passed param regardless of what it is (within reason of course) |
20 | - $event = EEH_Event_View::get_event( $event ); |
|
20 | + $event = EEH_Event_View::get_event($event); |
|
21 | 21 | // do we have a valid event ? |
22 | - return $event instanceof EE_Event ? TRUE : FALSE; |
|
22 | + return $event instanceof EE_Event ? TRUE : FALSE; |
|
23 | 23 | } |
24 | 24 | return FALSE; |
25 | 25 | } |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | * @return bool |
32 | 32 | */ |
33 | 33 | function is_espresso_event_single() { |
34 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
34 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
35 | 35 | global $wp_query; |
36 | 36 | // return conditionals set by CPTs |
37 | 37 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_single : FALSE; |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * @return bool |
47 | 47 | */ |
48 | 48 | function is_espresso_event_archive() { |
49 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
49 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
50 | 50 | global $wp_query; |
51 | 51 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_archive : FALSE; |
52 | 52 | } |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | * @return bool |
61 | 61 | */ |
62 | 62 | function is_espresso_event_taxonomy() { |
63 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
63 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
64 | 64 | global $wp_query; |
65 | 65 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_taxonomy : FALSE; |
66 | 66 | } |
@@ -74,10 +74,10 @@ discard block |
||
74 | 74 | * @param int | \EE_Venue $venue |
75 | 75 | * @return bool |
76 | 76 | */ |
77 | -function is_espresso_venue( $venue = NULL ) { |
|
78 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
77 | +function is_espresso_venue($venue = NULL) { |
|
78 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
79 | 79 | // extract EE_Venue object from passed param regardless of what it is (within reason of course) |
80 | - $venue = EEH_Venue_View::get_venue( $venue, FALSE ); |
|
80 | + $venue = EEH_Venue_View::get_venue($venue, FALSE); |
|
81 | 81 | // do we have a valid event ? |
82 | 82 | return $venue instanceof EE_Venue ? TRUE : FALSE; |
83 | 83 | } |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | * @return bool |
92 | 92 | */ |
93 | 93 | function is_espresso_venue_single() { |
94 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
94 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
95 | 95 | global $wp_query; |
96 | 96 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_single : FALSE; |
97 | 97 | } |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | * @return bool |
106 | 106 | */ |
107 | 107 | function is_espresso_venue_archive() { |
108 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
108 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
109 | 109 | global $wp_query; |
110 | 110 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_archive : FALSE; |
111 | 111 | } |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | * @return bool |
120 | 120 | */ |
121 | 121 | function is_espresso_venue_taxonomy() { |
122 | - if ( can_use_espresso_conditionals( __FUNCTION__ )) { |
|
122 | + if (can_use_espresso_conditionals(__FUNCTION__)) { |
|
123 | 123 | global $wp_query; |
124 | 124 | return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_taxonomy : FALSE; |
125 | 125 | } |
@@ -133,12 +133,12 @@ discard block |
||
133 | 133 | * @param $conditional_tag |
134 | 134 | * @return bool |
135 | 135 | */ |
136 | -function can_use_espresso_conditionals( $conditional_tag ) { |
|
137 | - if ( ! did_action( 'AHEE__EE_System__initialize' )) { |
|
136 | +function can_use_espresso_conditionals($conditional_tag) { |
|
137 | + if ( ! did_action('AHEE__EE_System__initialize')) { |
|
138 | 138 | EE_Error::doing_it_wrong( |
139 | 139 | __FUNCTION__, |
140 | 140 | sprintf( |
141 | - __( 'The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.','event_espresso'), |
|
141 | + __('The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.', 'event_espresso'), |
|
142 | 142 | $conditional_tag |
143 | 143 | ), |
144 | 144 | '4.4.0' |
@@ -153,13 +153,13 @@ discard block |
||
153 | 153 | |
154 | 154 | /*************************** Event Queries ***************************/ |
155 | 155 | |
156 | -if ( ! function_exists( 'espresso_get_events' )) { |
|
156 | +if ( ! function_exists('espresso_get_events')) { |
|
157 | 157 | /** |
158 | 158 | * espresso_get_events |
159 | 159 | * @param array $params |
160 | 160 | * @return array |
161 | 161 | */ |
162 | - function espresso_get_events( $params = array() ) { |
|
162 | + function espresso_get_events($params = array()) { |
|
163 | 163 | //set default params |
164 | 164 | $default_espresso_events_params = array( |
165 | 165 | 'limit' => 10, |
@@ -170,18 +170,18 @@ discard block |
||
170 | 170 | 'sort' => 'ASC' |
171 | 171 | ); |
172 | 172 | // allow the defaults to be filtered |
173 | - $default_espresso_events_params = apply_filters( 'espresso_get_events__default_espresso_events_params', $default_espresso_events_params ); |
|
173 | + $default_espresso_events_params = apply_filters('espresso_get_events__default_espresso_events_params', $default_espresso_events_params); |
|
174 | 174 | // grab params and merge with defaults, then extract |
175 | - $params = array_merge( $default_espresso_events_params, $params ); |
|
175 | + $params = array_merge($default_espresso_events_params, $params); |
|
176 | 176 | // run the query |
177 | - $events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery( $params ); |
|
177 | + $events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery($params); |
|
178 | 178 | // assign results to a variable so we can return it |
179 | 179 | $events = $events_query->have_posts() ? $events_query->posts : array(); |
180 | 180 | // but first reset the query and postdata |
181 | 181 | wp_reset_query(); |
182 | 182 | wp_reset_postdata(); |
183 | 183 | EED_Events_Archive::remove_all_events_archive_filters(); |
184 | - unset( $events_query ); |
|
184 | + unset($events_query); |
|
185 | 185 | return $events; |
186 | 186 | } |
187 | 187 | } |
@@ -195,33 +195,33 @@ discard block |
||
195 | 195 | * espresso_load_ticket_selector |
196 | 196 | */ |
197 | 197 | function espresso_load_ticket_selector() { |
198 | - EE_Registry::instance()->load_file( EE_MODULES . 'ticket_selector', 'EED_Ticket_Selector', 'module' ); |
|
198 | + EE_Registry::instance()->load_file(EE_MODULES.'ticket_selector', 'EED_Ticket_Selector', 'module'); |
|
199 | 199 | } |
200 | 200 | |
201 | -if ( ! function_exists( 'espresso_ticket_selector' )) { |
|
201 | +if ( ! function_exists('espresso_ticket_selector')) { |
|
202 | 202 | /** |
203 | 203 | * espresso_ticket_selector |
204 | 204 | * @param null $event |
205 | 205 | */ |
206 | - function espresso_ticket_selector( $event = NULL ) { |
|
207 | - if ( ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) { |
|
206 | + function espresso_ticket_selector($event = NULL) { |
|
207 | + if ( ! apply_filters('FHEE_disable_espresso_ticket_selector', FALSE)) { |
|
208 | 208 | espresso_load_ticket_selector(); |
209 | 209 | \EED_Ticket_Selector::set_definitions(); |
210 | - echo EED_Ticket_Selector::display_ticket_selector( $event ); |
|
210 | + echo EED_Ticket_Selector::display_ticket_selector($event); |
|
211 | 211 | } |
212 | 212 | } |
213 | 213 | } |
214 | 214 | |
215 | 215 | |
216 | - if ( ! function_exists( 'espresso_view_details_btn' )) { |
|
216 | + if ( ! function_exists('espresso_view_details_btn')) { |
|
217 | 217 | /** |
218 | 218 | * espresso_view_details_btn |
219 | 219 | * @param null $event |
220 | 220 | */ |
221 | - function espresso_view_details_btn( $event = NULL ) { |
|
222 | - if ( ! apply_filters( 'FHEE_disable_espresso_view_details_btn', FALSE ) ) { |
|
221 | + function espresso_view_details_btn($event = NULL) { |
|
222 | + if ( ! apply_filters('FHEE_disable_espresso_view_details_btn', FALSE)) { |
|
223 | 223 | espresso_load_ticket_selector(); |
224 | - echo EED_Ticket_Selector::display_ticket_selector( $event, TRUE ); |
|
224 | + echo EED_Ticket_Selector::display_ticket_selector($event, TRUE); |
|
225 | 225 | } |
226 | 226 | } |
227 | 227 | } |
@@ -231,7 +231,7 @@ discard block |
||
231 | 231 | |
232 | 232 | /*************************** EEH_Event_View ***************************/ |
233 | 233 | |
234 | -if ( ! function_exists( 'espresso_load_event_list_assets' )) { |
|
234 | +if ( ! function_exists('espresso_load_event_list_assets')) { |
|
235 | 235 | /** |
236 | 236 | * espresso_load_event_list_assets |
237 | 237 | * ensures that event list styles and scripts are loaded |
@@ -240,13 +240,13 @@ discard block |
||
240 | 240 | */ |
241 | 241 | function espresso_load_event_list_assets() { |
242 | 242 | $event_list = EED_Events_Archive::instance(); |
243 | - add_action( 'AHEE__EE_System__initialize_last', array( $event_list, 'load_event_list_assets' ), 10 ); |
|
244 | - add_filter( 'FHEE_enable_default_espresso_css', '__return_true' ); |
|
243 | + add_action('AHEE__EE_System__initialize_last', array($event_list, 'load_event_list_assets'), 10); |
|
244 | + add_filter('FHEE_enable_default_espresso_css', '__return_true'); |
|
245 | 245 | } |
246 | 246 | } |
247 | 247 | |
248 | 248 | |
249 | -if ( ! function_exists( 'espresso_event_reg_button' )) { |
|
249 | +if ( ! function_exists('espresso_event_reg_button')) { |
|
250 | 250 | /** |
251 | 251 | * espresso_event_reg_button |
252 | 252 | * returns the "Register Now" button if event is active, |
@@ -258,9 +258,9 @@ discard block |
||
258 | 258 | * @param bool $EVT_ID |
259 | 259 | * @return string |
260 | 260 | */ |
261 | - function espresso_event_reg_button( $btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE ) { |
|
262 | - $event_status = EEH_Event_View::event_active_status( $EVT_ID ); |
|
263 | - switch ( $event_status ) { |
|
261 | + function espresso_event_reg_button($btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE) { |
|
262 | + $event_status = EEH_Event_View::event_active_status($EVT_ID); |
|
263 | + switch ($event_status) { |
|
264 | 264 | case EE_Datetime::sold_out : |
265 | 265 | $btn_text = __('Sold Out', 'event_espresso'); |
266 | 266 | $class = 'ee-pink'; |
@@ -276,10 +276,10 @@ discard block |
||
276 | 276 | case EE_Datetime::upcoming : |
277 | 277 | case EE_Datetime::active : |
278 | 278 | default : |
279 | - $btn_text =! empty( $btn_text_if_active ) ? $btn_text_if_active : __( 'Register Now', 'event_espresso' ); |
|
279 | + $btn_text = ! empty($btn_text_if_active) ? $btn_text_if_active : __('Register Now', 'event_espresso'); |
|
280 | 280 | $class = 'ee-green'; |
281 | 281 | } |
282 | - if ( $event_status < 1 && ! empty( $btn_text_if_inactive )) { |
|
282 | + if ($event_status < 1 && ! empty($btn_text_if_inactive)) { |
|
283 | 283 | $btn_text = $btn_text_if_inactive; |
284 | 284 | $class = 'ee-grey'; |
285 | 285 | } |
@@ -293,7 +293,7 @@ discard block |
||
293 | 293 | |
294 | 294 | |
295 | 295 | |
296 | -if ( ! function_exists( 'espresso_display_ticket_selector' )) { |
|
296 | +if ( ! function_exists('espresso_display_ticket_selector')) { |
|
297 | 297 | /** |
298 | 298 | * espresso_display_ticket_selector |
299 | 299 | * whether or not to display the Ticket Selector for an event |
@@ -301,14 +301,14 @@ discard block |
||
301 | 301 | * @param bool $EVT_ID |
302 | 302 | * @return boolean |
303 | 303 | */ |
304 | - function espresso_display_ticket_selector( $EVT_ID = FALSE ) { |
|
305 | - return EEH_Event_View::display_ticket_selector( $EVT_ID ); |
|
304 | + function espresso_display_ticket_selector($EVT_ID = FALSE) { |
|
305 | + return EEH_Event_View::display_ticket_selector($EVT_ID); |
|
306 | 306 | } |
307 | 307 | } |
308 | 308 | |
309 | 309 | |
310 | 310 | |
311 | -if ( ! function_exists( 'espresso_event_status_banner' )) { |
|
311 | +if ( ! function_exists('espresso_event_status_banner')) { |
|
312 | 312 | /** |
313 | 313 | * espresso_event_status |
314 | 314 | * returns a banner showing the event status if it is sold out, expired, or inactive |
@@ -316,13 +316,13 @@ discard block |
||
316 | 316 | * @param bool $EVT_ID |
317 | 317 | * @return string |
318 | 318 | */ |
319 | - function espresso_event_status_banner( $EVT_ID = FALSE ) { |
|
320 | - return EEH_Event_View::event_status( $EVT_ID ); |
|
319 | + function espresso_event_status_banner($EVT_ID = FALSE) { |
|
320 | + return EEH_Event_View::event_status($EVT_ID); |
|
321 | 321 | } |
322 | 322 | } |
323 | 323 | |
324 | 324 | |
325 | -if ( ! function_exists( 'espresso_event_status' )) { |
|
325 | +if ( ! function_exists('espresso_event_status')) { |
|
326 | 326 | /** |
327 | 327 | * espresso_event_status |
328 | 328 | * returns the event status if it is sold out, expired, or inactive |
@@ -331,13 +331,13 @@ discard block |
||
331 | 331 | * @param bool $echo |
332 | 332 | * @return string |
333 | 333 | */ |
334 | - function espresso_event_status( $EVT_ID = 0, $echo = TRUE ) { |
|
335 | - return EEH_Event_View::event_active_status( $EVT_ID, $echo ); |
|
334 | + function espresso_event_status($EVT_ID = 0, $echo = TRUE) { |
|
335 | + return EEH_Event_View::event_active_status($EVT_ID, $echo); |
|
336 | 336 | } |
337 | 337 | } |
338 | 338 | |
339 | 339 | |
340 | -if ( ! function_exists( 'espresso_event_categories' )) { |
|
340 | +if ( ! function_exists('espresso_event_categories')) { |
|
341 | 341 | /** |
342 | 342 | * espresso_event_categories |
343 | 343 | * returns the terms associated with an event |
@@ -347,17 +347,17 @@ discard block |
||
347 | 347 | * @param bool $echo |
348 | 348 | * @return string |
349 | 349 | */ |
350 | - function espresso_event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE ) { |
|
351 | - if ( $echo ) { |
|
352 | - echo EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized ); |
|
350 | + function espresso_event_categories($EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) { |
|
351 | + if ($echo) { |
|
352 | + echo EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized); |
|
353 | 353 | return ''; |
354 | 354 | } |
355 | - return EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized ); |
|
355 | + return EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized); |
|
356 | 356 | } |
357 | 357 | } |
358 | 358 | |
359 | 359 | |
360 | -if ( ! function_exists( 'espresso_event_tickets_available' )) { |
|
360 | +if ( ! function_exists('espresso_event_tickets_available')) { |
|
361 | 361 | /** |
362 | 362 | * espresso_event_tickets_available |
363 | 363 | * returns the ticket types available for purchase for an event |
@@ -367,26 +367,26 @@ discard block |
||
367 | 367 | * @param bool $format |
368 | 368 | * @return string |
369 | 369 | */ |
370 | - function espresso_event_tickets_available( $EVT_ID = 0, $echo = TRUE, $format = TRUE ) { |
|
371 | - $tickets = EEH_Event_View::event_tickets_available( $EVT_ID ); |
|
372 | - if ( is_array( $tickets ) && ! empty( $tickets )) { |
|
370 | + function espresso_event_tickets_available($EVT_ID = 0, $echo = TRUE, $format = TRUE) { |
|
371 | + $tickets = EEH_Event_View::event_tickets_available($EVT_ID); |
|
372 | + if (is_array($tickets) && ! empty($tickets)) { |
|
373 | 373 | // if formatting then $html will be a string, else it will be an array of ticket objects |
374 | - $html = $format ? '<ul id="ee-event-tickets-ul-' . $EVT_ID . '" class="ee-event-tickets-ul">' : array(); |
|
375 | - foreach ( $tickets as $ticket ) { |
|
376 | - if ( $ticket instanceof EE_Ticket ) { |
|
377 | - if ( $format ) { |
|
378 | - $html .= '<li id="ee-event-tickets-li-' . $ticket->ID() . '" class="ee-event-tickets-li">'; |
|
379 | - $html .= $ticket->name() . ' ' . EEH_Template::format_currency( $ticket->get_ticket_total_with_taxes() ); |
|
374 | + $html = $format ? '<ul id="ee-event-tickets-ul-'.$EVT_ID.'" class="ee-event-tickets-ul">' : array(); |
|
375 | + foreach ($tickets as $ticket) { |
|
376 | + if ($ticket instanceof EE_Ticket) { |
|
377 | + if ($format) { |
|
378 | + $html .= '<li id="ee-event-tickets-li-'.$ticket->ID().'" class="ee-event-tickets-li">'; |
|
379 | + $html .= $ticket->name().' '.EEH_Template::format_currency($ticket->get_ticket_total_with_taxes()); |
|
380 | 380 | $html .= '</li>'; |
381 | 381 | } else { |
382 | 382 | $html[] = $ticket; |
383 | 383 | } |
384 | 384 | } |
385 | 385 | } |
386 | - if ( $format ) { |
|
386 | + if ($format) { |
|
387 | 387 | $html .= '</ul>'; |
388 | 388 | } |
389 | - if ( $echo && $format ) { |
|
389 | + if ($echo && $format) { |
|
390 | 390 | echo $html; |
391 | 391 | return ''; |
392 | 392 | } |
@@ -396,7 +396,7 @@ discard block |
||
396 | 396 | } |
397 | 397 | } |
398 | 398 | |
399 | -if ( ! function_exists( 'espresso_event_date_obj' )) { |
|
399 | +if ( ! function_exists('espresso_event_date_obj')) { |
|
400 | 400 | /** |
401 | 401 | * espresso_event_date_obj |
402 | 402 | * returns the primary date object for an event |
@@ -404,13 +404,13 @@ discard block |
||
404 | 404 | * @param bool $EVT_ID |
405 | 405 | * @return object |
406 | 406 | */ |
407 | - function espresso_event_date_obj( $EVT_ID = FALSE ) { |
|
408 | - return EEH_Event_View::get_primary_date_obj( $EVT_ID ); |
|
407 | + function espresso_event_date_obj($EVT_ID = FALSE) { |
|
408 | + return EEH_Event_View::get_primary_date_obj($EVT_ID); |
|
409 | 409 | } |
410 | 410 | } |
411 | 411 | |
412 | 412 | |
413 | -if ( ! function_exists( 'espresso_event_date' )) { |
|
413 | +if ( ! function_exists('espresso_event_date')) { |
|
414 | 414 | /** |
415 | 415 | * espresso_event_date |
416 | 416 | * returns the primary date for an event |
@@ -421,22 +421,22 @@ discard block |
||
421 | 421 | * @param bool $echo |
422 | 422 | * @return string |
423 | 423 | */ |
424 | - function espresso_event_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) { |
|
425 | - $date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' ); |
|
426 | - $time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' ); |
|
427 | - $date_format = apply_filters( 'FHEE__espresso_event_date__date_format', $date_format ); |
|
428 | - $time_format = apply_filters( 'FHEE__espresso_event_date__time_format', $time_format ); |
|
429 | - if($echo){ |
|
430 | - echo EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID ); |
|
424 | + function espresso_event_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) { |
|
425 | + $date_format = ! empty($date_format) ? $date_format : get_option('date_format'); |
|
426 | + $time_format = ! empty($time_format) ? $time_format : get_option('time_format'); |
|
427 | + $date_format = apply_filters('FHEE__espresso_event_date__date_format', $date_format); |
|
428 | + $time_format = apply_filters('FHEE__espresso_event_date__time_format', $time_format); |
|
429 | + if ($echo) { |
|
430 | + echo EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID); |
|
431 | 431 | return ''; |
432 | 432 | } |
433 | - return EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID ); |
|
433 | + return EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID); |
|
434 | 434 | |
435 | 435 | } |
436 | 436 | } |
437 | 437 | |
438 | 438 | |
439 | -if ( ! function_exists( 'espresso_list_of_event_dates' )) { |
|
439 | +if ( ! function_exists('espresso_list_of_event_dates')) { |
|
440 | 440 | /** |
441 | 441 | * espresso_list_of_event_dates |
442 | 442 | * returns a unordered list of dates for an event |
@@ -451,40 +451,40 @@ discard block |
||
451 | 451 | * @param null $limit |
452 | 452 | * @return string |
453 | 453 | */ |
454 | - function espresso_list_of_event_dates( $EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL ) { |
|
455 | - $date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' ); |
|
456 | - $time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' ); |
|
457 | - $date_format = apply_filters( 'FHEE__espresso_list_of_event_dates__date_format', $date_format ); |
|
458 | - $time_format = apply_filters( 'FHEE__espresso_list_of_event_dates__time_format', $time_format ); |
|
459 | - $datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, $show_expired, FALSE, $limit ); |
|
460 | - if ( ! $format ) { |
|
461 | - return apply_filters( 'FHEE__espresso_list_of_event_dates__datetimes', $datetimes ); |
|
454 | + function espresso_list_of_event_dates($EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL) { |
|
455 | + $date_format = ! empty($date_format) ? $date_format : get_option('date_format'); |
|
456 | + $time_format = ! empty($time_format) ? $time_format : get_option('time_format'); |
|
457 | + $date_format = apply_filters('FHEE__espresso_list_of_event_dates__date_format', $date_format); |
|
458 | + $time_format = apply_filters('FHEE__espresso_list_of_event_dates__time_format', $time_format); |
|
459 | + $datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, $show_expired, FALSE, $limit); |
|
460 | + if ( ! $format) { |
|
461 | + return apply_filters('FHEE__espresso_list_of_event_dates__datetimes', $datetimes); |
|
462 | 462 | } |
463 | 463 | //d( $datetimes ); |
464 | - if ( is_array( $datetimes ) && ! empty( $datetimes )) { |
|
464 | + if (is_array($datetimes) && ! empty($datetimes)) { |
|
465 | 465 | global $post; |
466 | - $html = $format ? '<ul id="ee-event-datetimes-ul-' . $post->ID . '" class="ee-event-datetimes-ul ee-clearfix">' : ''; |
|
467 | - foreach ( $datetimes as $datetime ) { |
|
468 | - if ( $datetime instanceof EE_Datetime ) { |
|
469 | - $html .= '<li id="ee-event-datetimes-li-' . $datetime->ID(); |
|
470 | - $html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-' . $datetime->get_active_status() . '">'; |
|
466 | + $html = $format ? '<ul id="ee-event-datetimes-ul-'.$post->ID.'" class="ee-event-datetimes-ul ee-clearfix">' : ''; |
|
467 | + foreach ($datetimes as $datetime) { |
|
468 | + if ($datetime instanceof EE_Datetime) { |
|
469 | + $html .= '<li id="ee-event-datetimes-li-'.$datetime->ID(); |
|
470 | + $html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-'.$datetime->get_active_status().'">'; |
|
471 | 471 | $datetime_name = $datetime->name(); |
472 | - $html .= ! empty( $datetime_name ) ? '<strong>' . $datetime_name . '</strong>' : ''; |
|
473 | - $html .= ! empty( $datetime_name ) && $add_breaks ? '<br />' : ''; |
|
474 | - $html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">' . $datetime->date_range( $date_format ) . '</span><br/>'; |
|
475 | - $html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">' . $datetime->time_range( $time_format ) . '</span>'; |
|
472 | + $html .= ! empty($datetime_name) ? '<strong>'.$datetime_name.'</strong>' : ''; |
|
473 | + $html .= ! empty($datetime_name) && $add_breaks ? '<br />' : ''; |
|
474 | + $html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">'.$datetime->date_range($date_format).'</span><br/>'; |
|
475 | + $html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">'.$datetime->time_range($time_format).'</span>'; |
|
476 | 476 | $datetime_description = $datetime->description(); |
477 | - $html .= ! empty( $datetime_description ) && $add_breaks ? '<br />' : ''; |
|
478 | - $html .= ! empty( $datetime_description ) ? ' - ' . $datetime_description : ''; |
|
479 | - $html = apply_filters( 'FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime ); |
|
477 | + $html .= ! empty($datetime_description) && $add_breaks ? '<br />' : ''; |
|
478 | + $html .= ! empty($datetime_description) ? ' - '.$datetime_description : ''; |
|
479 | + $html = apply_filters('FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime); |
|
480 | 480 | $html .= '</li>'; |
481 | 481 | } |
482 | 482 | } |
483 | 483 | $html .= $format ? '</ul>' : ''; |
484 | 484 | } else { |
485 | - $html = $format ? '<p><span class="dashicons dashicons-marker pink-text"></span>' . __( 'There are no upcoming dates for this event.', 'event_espresso' ) . '</p><br/>' : ''; |
|
485 | + $html = $format ? '<p><span class="dashicons dashicons-marker pink-text"></span>'.__('There are no upcoming dates for this event.', 'event_espresso').'</p><br/>' : ''; |
|
486 | 486 | } |
487 | - if ( $echo ) { |
|
487 | + if ($echo) { |
|
488 | 488 | echo $html; |
489 | 489 | return ''; |
490 | 490 | } |
@@ -493,7 +493,7 @@ discard block |
||
493 | 493 | } |
494 | 494 | |
495 | 495 | |
496 | -if ( ! function_exists( 'espresso_event_end_date' )) { |
|
496 | +if ( ! function_exists('espresso_event_end_date')) { |
|
497 | 497 | /** |
498 | 498 | * espresso_event_end_date |
499 | 499 | * returns the last date for an event |
@@ -504,20 +504,20 @@ discard block |
||
504 | 504 | * @param bool $echo |
505 | 505 | * @return string |
506 | 506 | */ |
507 | - function espresso_event_end_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) { |
|
508 | - $date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' ); |
|
509 | - $time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' ); |
|
510 | - $date_format = apply_filters( 'FHEE__espresso_event_end_date__date_format', $date_format ); |
|
511 | - $time_format = apply_filters( 'FHEE__espresso_event_end_date__time_format', $time_format ); |
|
512 | - if($echo){ |
|
513 | - echo EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID ); |
|
507 | + function espresso_event_end_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) { |
|
508 | + $date_format = ! empty($date_format) ? $date_format : get_option('date_format'); |
|
509 | + $time_format = ! empty($time_format) ? $time_format : get_option('time_format'); |
|
510 | + $date_format = apply_filters('FHEE__espresso_event_end_date__date_format', $date_format); |
|
511 | + $time_format = apply_filters('FHEE__espresso_event_end_date__time_format', $time_format); |
|
512 | + if ($echo) { |
|
513 | + echo EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID); |
|
514 | 514 | return ''; |
515 | 515 | } |
516 | - return EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID ); |
|
516 | + return EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID); |
|
517 | 517 | } |
518 | 518 | } |
519 | 519 | |
520 | -if ( ! function_exists( 'espresso_event_date_range' )) { |
|
520 | +if ( ! function_exists('espresso_event_date_range')) { |
|
521 | 521 | /** |
522 | 522 | * espresso_event_date_range |
523 | 523 | * returns the first and last chronologically ordered dates for an event (if different) |
@@ -530,31 +530,31 @@ discard block |
||
530 | 530 | * @param bool $echo |
531 | 531 | * @return string |
532 | 532 | */ |
533 | - function espresso_event_date_range( $date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE ) { |
|
533 | + function espresso_event_date_range($date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE) { |
|
534 | 534 | // set and filter date and time formats when a range is returned |
535 | - $date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' ); |
|
536 | - $date_format = apply_filters( 'FHEE__espresso_event_date_range__date_format', $date_format ); |
|
535 | + $date_format = ! empty($date_format) ? $date_format : get_option('date_format'); |
|
536 | + $date_format = apply_filters('FHEE__espresso_event_date_range__date_format', $date_format); |
|
537 | 537 | // get the start and end date with NO time portion |
538 | - $the_event_date = EEH_Event_View::the_earliest_event_date( $date_format, '', $EVT_ID ); |
|
539 | - $the_event_end_date = EEH_Event_View::the_latest_event_date( $date_format, '', $EVT_ID ); |
|
538 | + $the_event_date = EEH_Event_View::the_earliest_event_date($date_format, '', $EVT_ID); |
|
539 | + $the_event_end_date = EEH_Event_View::the_latest_event_date($date_format, '', $EVT_ID); |
|
540 | 540 | // now we can determine if date range spans more than one day |
541 | - if ( $the_event_date != $the_event_end_date ) { |
|
542 | - $time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' ); |
|
543 | - $time_format = apply_filters( 'FHEE__espresso_event_date_range__time_format', $time_format ); |
|
541 | + if ($the_event_date != $the_event_end_date) { |
|
542 | + $time_format = ! empty($time_format) ? $time_format : get_option('time_format'); |
|
543 | + $time_format = apply_filters('FHEE__espresso_event_date_range__time_format', $time_format); |
|
544 | 544 | $html = sprintf( |
545 | - __( '%1$s - %2$s', 'event_espresso' ), |
|
546 | - EEH_Event_View::the_earliest_event_date( $date_format, $time_format, $EVT_ID ), |
|
547 | - EEH_Event_View::the_latest_event_date( $date_format, $time_format, $EVT_ID ) |
|
545 | + __('%1$s - %2$s', 'event_espresso'), |
|
546 | + EEH_Event_View::the_earliest_event_date($date_format, $time_format, $EVT_ID), |
|
547 | + EEH_Event_View::the_latest_event_date($date_format, $time_format, $EVT_ID) |
|
548 | 548 | ); |
549 | 549 | } else { |
550 | 550 | // set and filter date and time formats when only a single datetime is returned |
551 | - $single_date_format = ! empty( $single_date_format ) ? $single_date_format : get_option( 'date_format' ); |
|
552 | - $single_time_format = ! empty( $single_time_format ) ? $single_time_format : get_option( 'time_format' ); |
|
553 | - $single_date_format = apply_filters( 'FHEE__espresso_event_date_range__single_date_format', $single_date_format ); |
|
554 | - $single_time_format = apply_filters( 'FHEE__espresso_event_date_range__single_time_format', $single_time_format ); |
|
555 | - $html = EEH_Event_View::the_earliest_event_date( $single_date_format, $single_time_format, $EVT_ID ); |
|
551 | + $single_date_format = ! empty($single_date_format) ? $single_date_format : get_option('date_format'); |
|
552 | + $single_time_format = ! empty($single_time_format) ? $single_time_format : get_option('time_format'); |
|
553 | + $single_date_format = apply_filters('FHEE__espresso_event_date_range__single_date_format', $single_date_format); |
|
554 | + $single_time_format = apply_filters('FHEE__espresso_event_date_range__single_time_format', $single_time_format); |
|
555 | + $html = EEH_Event_View::the_earliest_event_date($single_date_format, $single_time_format, $EVT_ID); |
|
556 | 556 | } |
557 | - if ( $echo ) { |
|
557 | + if ($echo) { |
|
558 | 558 | echo $html; |
559 | 559 | return ''; |
560 | 560 | } |
@@ -562,7 +562,7 @@ discard block |
||
562 | 562 | } |
563 | 563 | } |
564 | 564 | |
565 | -if ( ! function_exists( 'espresso_next_upcoming_datetime_obj' )) { |
|
565 | +if ( ! function_exists('espresso_next_upcoming_datetime_obj')) { |
|
566 | 566 | /** |
567 | 567 | * espresso_next_upcoming_datetime_obj |
568 | 568 | * returns the next upcoming datetime object for an event |
@@ -570,12 +570,12 @@ discard block |
||
570 | 570 | * @param int $EVT_ID |
571 | 571 | * @return EE_Datetime|null |
572 | 572 | */ |
573 | - function espresso_next_upcoming_datetime_obj( $EVT_ID = 0 ) { |
|
574 | - return EEH_Event_View::get_next_upcoming_date_obj( $EVT_ID ); |
|
573 | + function espresso_next_upcoming_datetime_obj($EVT_ID = 0) { |
|
574 | + return EEH_Event_View::get_next_upcoming_date_obj($EVT_ID); |
|
575 | 575 | } |
576 | 576 | } |
577 | 577 | |
578 | -if ( ! function_exists( 'espresso_next_upcoming_datetime' ) ) { |
|
578 | +if ( ! function_exists('espresso_next_upcoming_datetime')) { |
|
579 | 579 | /** |
580 | 580 | * espresso_next_upcoming_datetime |
581 | 581 | * returns the start date and time for the next upcoming event. |
@@ -586,30 +586,30 @@ discard block |
||
586 | 586 | * @param bool $echo |
587 | 587 | * @return string |
588 | 588 | */ |
589 | - function espresso_next_upcoming_datetime( $date_format = '', $time_format = '', $EVT_ID = 0, $echo = true ) { |
|
589 | + function espresso_next_upcoming_datetime($date_format = '', $time_format = '', $EVT_ID = 0, $echo = true) { |
|
590 | 590 | |
591 | - $date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' ); |
|
592 | - $date_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__date_format', $date_format ); |
|
591 | + $date_format = ! empty($date_format) ? $date_format : get_option('date_format'); |
|
592 | + $date_format = apply_filters('FHEE__espresso_next_upcoming_datetime__date_format', $date_format); |
|
593 | 593 | |
594 | - $time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' ); |
|
595 | - $time_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__time_format', $time_format ); |
|
594 | + $time_format = ! empty($time_format) ? $time_format : get_option('time_format'); |
|
595 | + $time_format = apply_filters('FHEE__espresso_next_upcoming_datetime__time_format', $time_format); |
|
596 | 596 | |
597 | - $datetime_format = trim( $date_format . ' ' . $time_format); |
|
597 | + $datetime_format = trim($date_format.' '.$time_format); |
|
598 | 598 | |
599 | - $datetime = espresso_next_upcoming_datetime_obj( $EVT_ID ); |
|
599 | + $datetime = espresso_next_upcoming_datetime_obj($EVT_ID); |
|
600 | 600 | |
601 | - if( ! $datetime instanceof EE_Datetime ) { |
|
601 | + if ( ! $datetime instanceof EE_Datetime) { |
|
602 | 602 | return ''; |
603 | 603 | } |
604 | - if ( $echo ){ |
|
605 | - echo $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format ); |
|
604 | + if ($echo) { |
|
605 | + echo $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format); |
|
606 | 606 | return ''; |
607 | 607 | } |
608 | - return $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format ); |
|
608 | + return $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format); |
|
609 | 609 | } |
610 | 610 | } |
611 | 611 | |
612 | -if ( ! function_exists( 'espresso_event_date_as_calendar_page' )) { |
|
612 | +if ( ! function_exists('espresso_event_date_as_calendar_page')) { |
|
613 | 613 | /** |
614 | 614 | * espresso_event_date_as_calendar_page |
615 | 615 | * returns the primary date for an event, stylized to appear as the page of a calendar |
@@ -617,15 +617,15 @@ discard block |
||
617 | 617 | * @param bool $EVT_ID |
618 | 618 | * @return string |
619 | 619 | */ |
620 | - function espresso_event_date_as_calendar_page( $EVT_ID = FALSE ) { |
|
621 | - EEH_Event_View::event_date_as_calendar_page( $EVT_ID ); |
|
620 | + function espresso_event_date_as_calendar_page($EVT_ID = FALSE) { |
|
621 | + EEH_Event_View::event_date_as_calendar_page($EVT_ID); |
|
622 | 622 | } |
623 | 623 | } |
624 | 624 | |
625 | 625 | |
626 | 626 | |
627 | 627 | |
628 | -if ( ! function_exists( 'espresso_event_link_url' )) { |
|
628 | +if ( ! function_exists('espresso_event_link_url')) { |
|
629 | 629 | /** |
630 | 630 | * espresso_event_link_url |
631 | 631 | * |
@@ -633,18 +633,18 @@ discard block |
||
633 | 633 | * @param bool $echo |
634 | 634 | * @return string |
635 | 635 | */ |
636 | - function espresso_event_link_url( $EVT_ID = 0, $echo = TRUE ) { |
|
637 | - if ( $echo ) { |
|
638 | - echo EEH_Event_View::event_link_url( $EVT_ID ); |
|
636 | + function espresso_event_link_url($EVT_ID = 0, $echo = TRUE) { |
|
637 | + if ($echo) { |
|
638 | + echo EEH_Event_View::event_link_url($EVT_ID); |
|
639 | 639 | return ''; |
640 | 640 | } |
641 | - return EEH_Event_View::event_link_url( $EVT_ID ); |
|
641 | + return EEH_Event_View::event_link_url($EVT_ID); |
|
642 | 642 | } |
643 | 643 | } |
644 | 644 | |
645 | 645 | |
646 | 646 | |
647 | -if ( ! function_exists( 'espresso_event_has_content_or_excerpt' )) { |
|
647 | +if ( ! function_exists('espresso_event_has_content_or_excerpt')) { |
|
648 | 648 | /** |
649 | 649 | * espresso_event_has_content_or_excerpt |
650 | 650 | * |
@@ -652,15 +652,15 @@ discard block |
||
652 | 652 | * @param bool $EVT_ID |
653 | 653 | * @return boolean |
654 | 654 | */ |
655 | - function espresso_event_has_content_or_excerpt( $EVT_ID = FALSE ) { |
|
656 | - return EEH_Event_View::event_has_content_or_excerpt( $EVT_ID ); |
|
655 | + function espresso_event_has_content_or_excerpt($EVT_ID = FALSE) { |
|
656 | + return EEH_Event_View::event_has_content_or_excerpt($EVT_ID); |
|
657 | 657 | } |
658 | 658 | } |
659 | 659 | |
660 | 660 | |
661 | 661 | |
662 | 662 | |
663 | -if ( ! function_exists( 'espresso_event_content_or_excerpt' )) { |
|
663 | +if ( ! function_exists('espresso_event_content_or_excerpt')) { |
|
664 | 664 | /** |
665 | 665 | * espresso_event_content_or_excerpt |
666 | 666 | * |
@@ -669,18 +669,18 @@ discard block |
||
669 | 669 | * @param bool $echo |
670 | 670 | * @return string |
671 | 671 | */ |
672 | - function espresso_event_content_or_excerpt( $num_words = 55, $more = NULL, $echo = TRUE ) { |
|
673 | - if ( $echo ) { |
|
674 | - echo EEH_Event_View::event_content_or_excerpt( $num_words, $more ); |
|
672 | + function espresso_event_content_or_excerpt($num_words = 55, $more = NULL, $echo = TRUE) { |
|
673 | + if ($echo) { |
|
674 | + echo EEH_Event_View::event_content_or_excerpt($num_words, $more); |
|
675 | 675 | return ''; |
676 | 676 | } |
677 | - return EEH_Event_View::event_content_or_excerpt( $num_words, $more ); |
|
677 | + return EEH_Event_View::event_content_or_excerpt($num_words, $more); |
|
678 | 678 | } |
679 | 679 | } |
680 | 680 | |
681 | 681 | |
682 | 682 | |
683 | -if ( ! function_exists( 'espresso_event_phone' )) { |
|
683 | +if ( ! function_exists('espresso_event_phone')) { |
|
684 | 684 | /** |
685 | 685 | * espresso_event_phone |
686 | 686 | * |
@@ -688,18 +688,18 @@ discard block |
||
688 | 688 | * @param bool $echo |
689 | 689 | * @return string |
690 | 690 | */ |
691 | - function espresso_event_phone( $EVT_ID = 0, $echo = TRUE ) { |
|
692 | - if ( $echo ) { |
|
693 | - echo EEH_Event_View::event_phone( $EVT_ID ); |
|
691 | + function espresso_event_phone($EVT_ID = 0, $echo = TRUE) { |
|
692 | + if ($echo) { |
|
693 | + echo EEH_Event_View::event_phone($EVT_ID); |
|
694 | 694 | return ''; |
695 | 695 | } |
696 | - return EEH_Event_View::event_phone( $EVT_ID ); |
|
696 | + return EEH_Event_View::event_phone($EVT_ID); |
|
697 | 697 | } |
698 | 698 | } |
699 | 699 | |
700 | 700 | |
701 | 701 | |
702 | -if ( ! function_exists( 'espresso_edit_event_link' )) { |
|
702 | +if ( ! function_exists('espresso_edit_event_link')) { |
|
703 | 703 | /** |
704 | 704 | * espresso_edit_event_link |
705 | 705 | * returns a link to edit an event |
@@ -708,39 +708,39 @@ discard block |
||
708 | 708 | * @param bool $echo |
709 | 709 | * @return string |
710 | 710 | */ |
711 | - function espresso_edit_event_link( $EVT_ID = 0, $echo = TRUE ) { |
|
712 | - if ( $echo ) { |
|
713 | - echo EEH_Event_View::edit_event_link( $EVT_ID ); |
|
711 | + function espresso_edit_event_link($EVT_ID = 0, $echo = TRUE) { |
|
712 | + if ($echo) { |
|
713 | + echo EEH_Event_View::edit_event_link($EVT_ID); |
|
714 | 714 | return ''; |
715 | 715 | } |
716 | - return EEH_Event_View::edit_event_link( $EVT_ID ); |
|
716 | + return EEH_Event_View::edit_event_link($EVT_ID); |
|
717 | 717 | } |
718 | 718 | } |
719 | 719 | |
720 | 720 | |
721 | -if ( ! function_exists( 'espresso_organization_name' )) { |
|
721 | +if ( ! function_exists('espresso_organization_name')) { |
|
722 | 722 | /** |
723 | 723 | * espresso_organization_name |
724 | 724 | * @param bool $echo |
725 | 725 | * @return string |
726 | 726 | */ |
727 | 727 | function espresso_organization_name($echo = TRUE) { |
728 | - if($echo){ |
|
729 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'name' ); |
|
728 | + if ($echo) { |
|
729 | + echo EE_Registry::instance()->CFG->organization->get_pretty('name'); |
|
730 | 730 | return ''; |
731 | 731 | } |
732 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'name' ); |
|
732 | + return EE_Registry::instance()->CFG->organization->get_pretty('name'); |
|
733 | 733 | } |
734 | 734 | } |
735 | 735 | |
736 | -if ( ! function_exists( 'espresso_organization_address' )) { |
|
736 | +if ( ! function_exists('espresso_organization_address')) { |
|
737 | 737 | /** |
738 | 738 | * espresso_organization_address |
739 | 739 | * @param string $type |
740 | 740 | * @return string |
741 | 741 | */ |
742 | - function espresso_organization_address( $type = 'inline' ) { |
|
743 | - if ( EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config ) { |
|
742 | + function espresso_organization_address($type = 'inline') { |
|
743 | + if (EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config) { |
|
744 | 744 | $address = new EventEspresso\core\domain\entities\GenericAddress( |
745 | 745 | EE_Registry::instance()->CFG->organization->address_1, |
746 | 746 | EE_Registry::instance()->CFG->organization->address_2, |
@@ -749,129 +749,129 @@ discard block |
||
749 | 749 | EE_Registry::instance()->CFG->organization->zip, |
750 | 750 | EE_Registry::instance()->CFG->organization->CNT_ISO |
751 | 751 | ); |
752 | - return EEH_Address::format( $address, $type ); |
|
752 | + return EEH_Address::format($address, $type); |
|
753 | 753 | } |
754 | 754 | return ''; |
755 | 755 | } |
756 | 756 | } |
757 | 757 | |
758 | -if ( ! function_exists( 'espresso_organization_email' )) { |
|
758 | +if ( ! function_exists('espresso_organization_email')) { |
|
759 | 759 | /** |
760 | 760 | * espresso_organization_email |
761 | 761 | * @param bool $echo |
762 | 762 | * @return string |
763 | 763 | */ |
764 | - function espresso_organization_email( $echo = TRUE ) { |
|
765 | - if($echo){ |
|
766 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'email' ); |
|
764 | + function espresso_organization_email($echo = TRUE) { |
|
765 | + if ($echo) { |
|
766 | + echo EE_Registry::instance()->CFG->organization->get_pretty('email'); |
|
767 | 767 | return ''; |
768 | 768 | } |
769 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'email' ); |
|
769 | + return EE_Registry::instance()->CFG->organization->get_pretty('email'); |
|
770 | 770 | } |
771 | 771 | } |
772 | 772 | |
773 | -if ( ! function_exists( 'espresso_organization_logo_url' )) { |
|
773 | +if ( ! function_exists('espresso_organization_logo_url')) { |
|
774 | 774 | /** |
775 | 775 | * espresso_organization_logo_url |
776 | 776 | * @param bool $echo |
777 | 777 | * @return string |
778 | 778 | */ |
779 | - function espresso_organization_logo_url( $echo = TRUE ) { |
|
780 | - if($echo){ |
|
781 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' ); |
|
779 | + function espresso_organization_logo_url($echo = TRUE) { |
|
780 | + if ($echo) { |
|
781 | + echo EE_Registry::instance()->CFG->organization->get_pretty('logo_url'); |
|
782 | 782 | return ''; |
783 | 783 | } |
784 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' ); |
|
784 | + return EE_Registry::instance()->CFG->organization->get_pretty('logo_url'); |
|
785 | 785 | } |
786 | 786 | } |
787 | 787 | |
788 | -if ( ! function_exists( 'espresso_organization_facebook' )) { |
|
788 | +if ( ! function_exists('espresso_organization_facebook')) { |
|
789 | 789 | /** |
790 | 790 | * espresso_organization_facebook |
791 | 791 | * @param bool $echo |
792 | 792 | * @return string |
793 | 793 | */ |
794 | - function espresso_organization_facebook( $echo = TRUE ) { |
|
795 | - if($echo){ |
|
796 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' ); |
|
794 | + function espresso_organization_facebook($echo = TRUE) { |
|
795 | + if ($echo) { |
|
796 | + echo EE_Registry::instance()->CFG->organization->get_pretty('facebook'); |
|
797 | 797 | return ''; |
798 | 798 | } |
799 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' ); |
|
799 | + return EE_Registry::instance()->CFG->organization->get_pretty('facebook'); |
|
800 | 800 | } |
801 | 801 | } |
802 | 802 | |
803 | -if ( ! function_exists( 'espresso_organization_twitter' )) { |
|
803 | +if ( ! function_exists('espresso_organization_twitter')) { |
|
804 | 804 | /** |
805 | 805 | * espresso_organization_twitter |
806 | 806 | * @param bool $echo |
807 | 807 | * @return string |
808 | 808 | */ |
809 | - function espresso_organization_twitter( $echo = TRUE ) { |
|
810 | - if($echo){ |
|
811 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' ); |
|
809 | + function espresso_organization_twitter($echo = TRUE) { |
|
810 | + if ($echo) { |
|
811 | + echo EE_Registry::instance()->CFG->organization->get_pretty('twitter'); |
|
812 | 812 | return ''; |
813 | 813 | } |
814 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' ); |
|
814 | + return EE_Registry::instance()->CFG->organization->get_pretty('twitter'); |
|
815 | 815 | } |
816 | 816 | } |
817 | 817 | |
818 | -if ( ! function_exists( 'espresso_organization_linkedin' )) { |
|
818 | +if ( ! function_exists('espresso_organization_linkedin')) { |
|
819 | 819 | /** |
820 | 820 | * espresso_organization_linkedin |
821 | 821 | * @param bool $echo |
822 | 822 | * @return string |
823 | 823 | */ |
824 | - function espresso_organization_linkedin( $echo = TRUE ) { |
|
825 | - if($echo){ |
|
826 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' ); |
|
824 | + function espresso_organization_linkedin($echo = TRUE) { |
|
825 | + if ($echo) { |
|
826 | + echo EE_Registry::instance()->CFG->organization->get_pretty('linkedin'); |
|
827 | 827 | return ''; |
828 | 828 | } |
829 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' ); |
|
829 | + return EE_Registry::instance()->CFG->organization->get_pretty('linkedin'); |
|
830 | 830 | } |
831 | 831 | } |
832 | 832 | |
833 | -if ( ! function_exists( 'espresso_organization_pinterest' )) { |
|
833 | +if ( ! function_exists('espresso_organization_pinterest')) { |
|
834 | 834 | /** |
835 | 835 | * espresso_organization_pinterest |
836 | 836 | * @param bool $echo |
837 | 837 | * @return string |
838 | 838 | */ |
839 | - function espresso_organization_pinterest( $echo = TRUE ) { |
|
840 | - if($echo){ |
|
841 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' ); |
|
839 | + function espresso_organization_pinterest($echo = TRUE) { |
|
840 | + if ($echo) { |
|
841 | + echo EE_Registry::instance()->CFG->organization->get_pretty('pinterest'); |
|
842 | 842 | return ''; |
843 | 843 | } |
844 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' ); |
|
844 | + return EE_Registry::instance()->CFG->organization->get_pretty('pinterest'); |
|
845 | 845 | } |
846 | 846 | } |
847 | 847 | |
848 | -if ( ! function_exists( 'espresso_organization_google' )) { |
|
848 | +if ( ! function_exists('espresso_organization_google')) { |
|
849 | 849 | /** |
850 | 850 | * espresso_organization_google |
851 | 851 | * @param bool $echo |
852 | 852 | * @return string |
853 | 853 | */ |
854 | - function espresso_organization_google( $echo = TRUE ) { |
|
855 | - if($echo){ |
|
856 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'google' ); |
|
854 | + function espresso_organization_google($echo = TRUE) { |
|
855 | + if ($echo) { |
|
856 | + echo EE_Registry::instance()->CFG->organization->get_pretty('google'); |
|
857 | 857 | return ''; |
858 | 858 | } |
859 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'google' ); |
|
859 | + return EE_Registry::instance()->CFG->organization->get_pretty('google'); |
|
860 | 860 | } |
861 | 861 | } |
862 | 862 | |
863 | -if ( ! function_exists( 'espresso_organization_instagram' )) { |
|
863 | +if ( ! function_exists('espresso_organization_instagram')) { |
|
864 | 864 | /** |
865 | 865 | * espresso_organization_instagram |
866 | 866 | * @param bool $echo |
867 | 867 | * @return string |
868 | 868 | */ |
869 | - function espresso_organization_instagram( $echo = TRUE ) { |
|
870 | - if($echo){ |
|
871 | - echo EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' ); |
|
869 | + function espresso_organization_instagram($echo = TRUE) { |
|
870 | + if ($echo) { |
|
871 | + echo EE_Registry::instance()->CFG->organization->get_pretty('instagram'); |
|
872 | 872 | return ''; |
873 | 873 | } |
874 | - return EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' ); |
|
874 | + return EE_Registry::instance()->CFG->organization->get_pretty('instagram'); |
|
875 | 875 | } |
876 | 876 | } |
877 | 877 | |
@@ -881,7 +881,7 @@ discard block |
||
881 | 881 | |
882 | 882 | |
883 | 883 | |
884 | -if ( ! function_exists( 'espresso_event_venues' )) { |
|
884 | +if ( ! function_exists('espresso_event_venues')) { |
|
885 | 885 | /** |
886 | 886 | * espresso_event_venues |
887 | 887 | * |
@@ -895,7 +895,7 @@ discard block |
||
895 | 895 | |
896 | 896 | |
897 | 897 | |
898 | -if ( ! function_exists( 'espresso_venue_id' )) { |
|
898 | +if ( ! function_exists('espresso_venue_id')) { |
|
899 | 899 | /** |
900 | 900 | * espresso_venue_name |
901 | 901 | * |
@@ -903,15 +903,15 @@ discard block |
||
903 | 903 | * @param int $EVT_ID |
904 | 904 | * @return string |
905 | 905 | */ |
906 | - function espresso_venue_id( $EVT_ID = 0 ) { |
|
907 | - $venue = EEH_Venue_View::get_venue( $EVT_ID ); |
|
906 | + function espresso_venue_id($EVT_ID = 0) { |
|
907 | + $venue = EEH_Venue_View::get_venue($EVT_ID); |
|
908 | 908 | return $venue instanceof EE_Venue ? $venue->ID() : 0; |
909 | 909 | } |
910 | 910 | } |
911 | 911 | |
912 | 912 | |
913 | 913 | |
914 | -if ( ! function_exists( 'espresso_is_venue_private' ) ) { |
|
914 | +if ( ! function_exists('espresso_is_venue_private')) { |
|
915 | 915 | /** |
916 | 916 | * Return whether a venue is private or not. |
917 | 917 | * @see EEH_Venue_View::get_venue() for more info on expected return results. |
@@ -920,45 +920,45 @@ discard block |
||
920 | 920 | * |
921 | 921 | * @return bool | null |
922 | 922 | */ |
923 | - function espresso_is_venue_private( $VNU_ID = 0 ) { |
|
924 | - return EEH_Venue_View::is_venue_private( $VNU_ID ); |
|
923 | + function espresso_is_venue_private($VNU_ID = 0) { |
|
924 | + return EEH_Venue_View::is_venue_private($VNU_ID); |
|
925 | 925 | } |
926 | 926 | } |
927 | 927 | |
928 | 928 | |
929 | 929 | |
930 | -if ( ! function_exists( 'espresso_venue_is_password_protected' ) ) { |
|
930 | +if ( ! function_exists('espresso_venue_is_password_protected')) { |
|
931 | 931 | /** |
932 | 932 | * returns true or false if a venue is password protected or not |
933 | 933 | * |
934 | 934 | * @param int $VNU_ID optional, the venue id to check. |
935 | 935 | * @return string |
936 | 936 | */ |
937 | - function espresso_venue_is_password_protected( $VNU_ID = 0 ) { |
|
938 | - EE_Registry::instance()->load_helper( 'Venue_View' ); |
|
939 | - return EEH_Venue_View::is_venue_password_protected( $VNU_ID ); |
|
937 | + function espresso_venue_is_password_protected($VNU_ID = 0) { |
|
938 | + EE_Registry::instance()->load_helper('Venue_View'); |
|
939 | + return EEH_Venue_View::is_venue_password_protected($VNU_ID); |
|
940 | 940 | } |
941 | 941 | } |
942 | 942 | |
943 | 943 | |
944 | 944 | |
945 | -if ( ! function_exists( 'espresso_password_protected_venue_form' ) ) { |
|
945 | +if ( ! function_exists('espresso_password_protected_venue_form')) { |
|
946 | 946 | /** |
947 | 947 | * Returns a password form if venue is password protected. |
948 | 948 | * |
949 | 949 | * @param int $VNU_ID optional, the venue id to check. |
950 | 950 | * @return string |
951 | 951 | */ |
952 | - function espresso_password_protected_venue_form( $VNU_ID = 0 ) { |
|
953 | - EE_Registry::instance()->load_helper( 'Venue_View' ); |
|
954 | - return EEH_Venue_View::password_protected_venue_form( $VNU_ID ); |
|
952 | + function espresso_password_protected_venue_form($VNU_ID = 0) { |
|
953 | + EE_Registry::instance()->load_helper('Venue_View'); |
|
954 | + return EEH_Venue_View::password_protected_venue_form($VNU_ID); |
|
955 | 955 | } |
956 | 956 | } |
957 | 957 | |
958 | 958 | |
959 | 959 | |
960 | 960 | |
961 | -if ( ! function_exists( 'espresso_venue_name' )) { |
|
961 | +if ( ! function_exists('espresso_venue_name')) { |
|
962 | 962 | /** |
963 | 963 | * espresso_venue_name |
964 | 964 | * |
@@ -968,19 +968,19 @@ discard block |
||
968 | 968 | * @param bool $echo |
969 | 969 | * @return string |
970 | 970 | */ |
971 | - function espresso_venue_name( $VNU_ID = 0, $link_to = 'details', $echo = TRUE ) { |
|
972 | - if($echo){ |
|
973 | - echo EEH_Venue_View::venue_name( $link_to, $VNU_ID ); |
|
971 | + function espresso_venue_name($VNU_ID = 0, $link_to = 'details', $echo = TRUE) { |
|
972 | + if ($echo) { |
|
973 | + echo EEH_Venue_View::venue_name($link_to, $VNU_ID); |
|
974 | 974 | return ''; |
975 | 975 | } |
976 | - return EEH_Venue_View::venue_name( $link_to, $VNU_ID ); |
|
976 | + return EEH_Venue_View::venue_name($link_to, $VNU_ID); |
|
977 | 977 | } |
978 | 978 | } |
979 | 979 | |
980 | 980 | |
981 | 981 | |
982 | 982 | |
983 | -if ( ! function_exists( 'espresso_venue_link' )) { |
|
983 | +if ( ! function_exists('espresso_venue_link')) { |
|
984 | 984 | /** |
985 | 985 | * espresso_venue_link |
986 | 986 | * |
@@ -989,14 +989,14 @@ discard block |
||
989 | 989 | * @param string $text |
990 | 990 | * @return string |
991 | 991 | */ |
992 | - function espresso_venue_link( $VNU_ID = 0, $text = '' ) { |
|
993 | - return EEH_Venue_View::venue_details_link( $VNU_ID, $text ); |
|
992 | + function espresso_venue_link($VNU_ID = 0, $text = '') { |
|
993 | + return EEH_Venue_View::venue_details_link($VNU_ID, $text); |
|
994 | 994 | } |
995 | 995 | } |
996 | 996 | |
997 | 997 | |
998 | 998 | |
999 | -if ( ! function_exists( 'espresso_venue_description' )) { |
|
999 | +if ( ! function_exists('espresso_venue_description')) { |
|
1000 | 1000 | /** |
1001 | 1001 | * espresso_venue_description |
1002 | 1002 | * |
@@ -1005,17 +1005,17 @@ discard block |
||
1005 | 1005 | * @param bool $echo |
1006 | 1006 | * @return string |
1007 | 1007 | */ |
1008 | - function espresso_venue_description( $VNU_ID = FALSE, $echo = TRUE ) { |
|
1009 | - if($echo){ |
|
1010 | - echo EEH_Venue_View::venue_description( $VNU_ID ); |
|
1008 | + function espresso_venue_description($VNU_ID = FALSE, $echo = TRUE) { |
|
1009 | + if ($echo) { |
|
1010 | + echo EEH_Venue_View::venue_description($VNU_ID); |
|
1011 | 1011 | return ''; |
1012 | 1012 | } |
1013 | - return EEH_Venue_View::venue_description( $VNU_ID ); |
|
1013 | + return EEH_Venue_View::venue_description($VNU_ID); |
|
1014 | 1014 | } |
1015 | 1015 | } |
1016 | 1016 | |
1017 | 1017 | |
1018 | -if ( ! function_exists( 'espresso_venue_excerpt' )) { |
|
1018 | +if ( ! function_exists('espresso_venue_excerpt')) { |
|
1019 | 1019 | /** |
1020 | 1020 | * espresso_venue_excerpt |
1021 | 1021 | * |
@@ -1024,18 +1024,18 @@ discard block |
||
1024 | 1024 | * @param bool $echo |
1025 | 1025 | * @return string |
1026 | 1026 | */ |
1027 | - function espresso_venue_excerpt( $VNU_ID = 0, $echo = TRUE ) { |
|
1028 | - if ( $echo ) { |
|
1029 | - echo EEH_Venue_View::venue_excerpt( $VNU_ID ); |
|
1027 | + function espresso_venue_excerpt($VNU_ID = 0, $echo = TRUE) { |
|
1028 | + if ($echo) { |
|
1029 | + echo EEH_Venue_View::venue_excerpt($VNU_ID); |
|
1030 | 1030 | return ''; |
1031 | 1031 | } |
1032 | - return EEH_Venue_View::venue_excerpt( $VNU_ID ); |
|
1032 | + return EEH_Venue_View::venue_excerpt($VNU_ID); |
|
1033 | 1033 | } |
1034 | 1034 | } |
1035 | 1035 | |
1036 | 1036 | |
1037 | 1037 | |
1038 | -if ( ! function_exists( 'espresso_venue_categories' )) { |
|
1038 | +if ( ! function_exists('espresso_venue_categories')) { |
|
1039 | 1039 | /** |
1040 | 1040 | * espresso_venue_categories |
1041 | 1041 | * returns the terms associated with a venue |
@@ -1045,17 +1045,17 @@ discard block |
||
1045 | 1045 | * @param bool $echo |
1046 | 1046 | * @return string |
1047 | 1047 | */ |
1048 | - function espresso_venue_categories( $VNU_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE ) { |
|
1049 | - if ( $echo ) { |
|
1050 | - echo EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized ); |
|
1048 | + function espresso_venue_categories($VNU_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) { |
|
1049 | + if ($echo) { |
|
1050 | + echo EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized); |
|
1051 | 1051 | return ''; |
1052 | 1052 | } |
1053 | - return EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized ); |
|
1053 | + return EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized); |
|
1054 | 1054 | } |
1055 | 1055 | } |
1056 | 1056 | |
1057 | 1057 | |
1058 | -if ( ! function_exists( 'espresso_venue_address' )) { |
|
1058 | +if ( ! function_exists('espresso_venue_address')) { |
|
1059 | 1059 | /** |
1060 | 1060 | * espresso_venue_address |
1061 | 1061 | * returns a formatted block of html for displaying a venue's address |
@@ -1065,17 +1065,17 @@ discard block |
||
1065 | 1065 | * @param bool $echo |
1066 | 1066 | * @return string |
1067 | 1067 | */ |
1068 | - function espresso_venue_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) { |
|
1069 | - if ( $echo ) { |
|
1070 | - echo EEH_Venue_View::venue_address( $type, $VNU_ID ); |
|
1068 | + function espresso_venue_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) { |
|
1069 | + if ($echo) { |
|
1070 | + echo EEH_Venue_View::venue_address($type, $VNU_ID); |
|
1071 | 1071 | return ''; |
1072 | 1072 | } |
1073 | - return EEH_Venue_View::venue_address( $type, $VNU_ID ); |
|
1073 | + return EEH_Venue_View::venue_address($type, $VNU_ID); |
|
1074 | 1074 | } |
1075 | 1075 | } |
1076 | 1076 | |
1077 | 1077 | |
1078 | -if ( ! function_exists( 'espresso_venue_raw_address' )) { |
|
1078 | +if ( ! function_exists('espresso_venue_raw_address')) { |
|
1079 | 1079 | /** |
1080 | 1080 | * espresso_venue_address |
1081 | 1081 | * returns an UN-formatted string containing a venue's address |
@@ -1085,17 +1085,17 @@ discard block |
||
1085 | 1085 | * @param bool $echo |
1086 | 1086 | * @return string |
1087 | 1087 | */ |
1088 | - function espresso_venue_raw_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) { |
|
1089 | - if ( $echo ) { |
|
1090 | - echo EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE ); |
|
1088 | + function espresso_venue_raw_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) { |
|
1089 | + if ($echo) { |
|
1090 | + echo EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE); |
|
1091 | 1091 | return ''; |
1092 | 1092 | } |
1093 | - return EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE ); |
|
1093 | + return EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE); |
|
1094 | 1094 | } |
1095 | 1095 | } |
1096 | 1096 | |
1097 | 1097 | |
1098 | -if ( ! function_exists( 'espresso_venue_has_address' )) { |
|
1098 | +if ( ! function_exists('espresso_venue_has_address')) { |
|
1099 | 1099 | /** |
1100 | 1100 | * espresso_venue_has_address |
1101 | 1101 | * returns TRUE or FALSE if a Venue has address information |
@@ -1103,13 +1103,13 @@ discard block |
||
1103 | 1103 | * @param int $VNU_ID |
1104 | 1104 | * @return bool |
1105 | 1105 | */ |
1106 | - function espresso_venue_has_address( $VNU_ID = 0 ) { |
|
1107 | - return EEH_Venue_View::venue_has_address( $VNU_ID ); |
|
1106 | + function espresso_venue_has_address($VNU_ID = 0) { |
|
1107 | + return EEH_Venue_View::venue_has_address($VNU_ID); |
|
1108 | 1108 | } |
1109 | 1109 | } |
1110 | 1110 | |
1111 | 1111 | |
1112 | -if ( ! function_exists( 'espresso_venue_gmap' )) { |
|
1112 | +if ( ! function_exists('espresso_venue_gmap')) { |
|
1113 | 1113 | /** |
1114 | 1114 | * espresso_venue_gmap |
1115 | 1115 | * returns a google map for the venue address |
@@ -1120,17 +1120,17 @@ discard block |
||
1120 | 1120 | * @param bool $echo |
1121 | 1121 | * @return string |
1122 | 1122 | */ |
1123 | - function espresso_venue_gmap( $VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE ) { |
|
1124 | - if ( $echo ) { |
|
1125 | - echo EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap ); |
|
1123 | + function espresso_venue_gmap($VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE) { |
|
1124 | + if ($echo) { |
|
1125 | + echo EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap); |
|
1126 | 1126 | return ''; |
1127 | 1127 | } |
1128 | - return EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap ); |
|
1128 | + return EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap); |
|
1129 | 1129 | } |
1130 | 1130 | } |
1131 | 1131 | |
1132 | 1132 | |
1133 | -if ( ! function_exists( 'espresso_venue_phone' )) { |
|
1133 | +if ( ! function_exists('espresso_venue_phone')) { |
|
1134 | 1134 | /** |
1135 | 1135 | * espresso_venue_phone |
1136 | 1136 | * |
@@ -1138,18 +1138,18 @@ discard block |
||
1138 | 1138 | * @param bool $echo |
1139 | 1139 | * @return string |
1140 | 1140 | */ |
1141 | - function espresso_venue_phone( $VNU_ID = 0, $echo = TRUE ) { |
|
1142 | - if ( $echo ) { |
|
1143 | - echo EEH_Venue_View::venue_phone( $VNU_ID ); |
|
1141 | + function espresso_venue_phone($VNU_ID = 0, $echo = TRUE) { |
|
1142 | + if ($echo) { |
|
1143 | + echo EEH_Venue_View::venue_phone($VNU_ID); |
|
1144 | 1144 | return ''; |
1145 | 1145 | } |
1146 | - return EEH_Venue_View::venue_phone( $VNU_ID ); |
|
1146 | + return EEH_Venue_View::venue_phone($VNU_ID); |
|
1147 | 1147 | } |
1148 | 1148 | } |
1149 | 1149 | |
1150 | 1150 | |
1151 | 1151 | |
1152 | -if ( ! function_exists( 'espresso_venue_website' )) { |
|
1152 | +if ( ! function_exists('espresso_venue_website')) { |
|
1153 | 1153 | /** |
1154 | 1154 | * espresso_venue_website |
1155 | 1155 | * |
@@ -1157,18 +1157,18 @@ discard block |
||
1157 | 1157 | * @param bool $echo |
1158 | 1158 | * @return string |
1159 | 1159 | */ |
1160 | - function espresso_venue_website( $VNU_ID = 0, $echo = TRUE ) { |
|
1161 | - if ( $echo ) { |
|
1162 | - echo EEH_Venue_View::venue_website_link( $VNU_ID ); |
|
1160 | + function espresso_venue_website($VNU_ID = 0, $echo = TRUE) { |
|
1161 | + if ($echo) { |
|
1162 | + echo EEH_Venue_View::venue_website_link($VNU_ID); |
|
1163 | 1163 | return ''; |
1164 | 1164 | } |
1165 | - return EEH_Venue_View::venue_website_link( $VNU_ID ); |
|
1165 | + return EEH_Venue_View::venue_website_link($VNU_ID); |
|
1166 | 1166 | } |
1167 | 1167 | } |
1168 | 1168 | |
1169 | 1169 | |
1170 | 1170 | |
1171 | -if ( ! function_exists( 'espresso_edit_venue_link' )) { |
|
1171 | +if ( ! function_exists('espresso_edit_venue_link')) { |
|
1172 | 1172 | /** |
1173 | 1173 | * espresso_edit_venue_link |
1174 | 1174 | * |
@@ -1176,12 +1176,12 @@ discard block |
||
1176 | 1176 | * @param bool $echo |
1177 | 1177 | * @return string |
1178 | 1178 | */ |
1179 | - function espresso_edit_venue_link( $VNU_ID = 0, $echo = TRUE ) { |
|
1180 | - if($echo){ |
|
1181 | - echo EEH_Venue_View::edit_venue_link( $VNU_ID ); |
|
1179 | + function espresso_edit_venue_link($VNU_ID = 0, $echo = TRUE) { |
|
1180 | + if ($echo) { |
|
1181 | + echo EEH_Venue_View::edit_venue_link($VNU_ID); |
|
1182 | 1182 | return ''; |
1183 | 1183 | } |
1184 | - return EEH_Venue_View::edit_venue_link( $VNU_ID ); |
|
1184 | + return EEH_Venue_View::edit_venue_link($VNU_ID); |
|
1185 | 1185 | } |
1186 | 1186 | } |
1187 | 1187 |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | // with these parameters |
141 | 141 | $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL); |
142 | 142 | // then md5 the above to control it's length, add all of our prefixes, and truncate |
143 | - return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182); |
|
143 | + return substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182); |
|
144 | 144 | } |
145 | 145 | |
146 | 146 | |
@@ -170,9 +170,9 @@ discard block |
||
170 | 170 | return ' |
171 | 171 | <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;"> |
172 | 172 | <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px"> |
173 | - <b>' . $type . '</b><span style="color:#999"> : </span> |
|
174 | - <span>' . $cache_id . '</span> |
|
175 | - <span style="margin-left:2em;">' . __FILE__ . '</span> |
|
173 | + <b>' . $type.'</b><span style="color:#999"> : </span> |
|
174 | + <span>' . $cache_id.'</span> |
|
175 | + <span style="margin-left:2em;">' . __FILE__.'</span> |
|
176 | 176 | </p> |
177 | 177 | </div>'; |
178 | 178 | } |
@@ -16,135 +16,135 @@ discard block |
||
16 | 16 | class BasicCacheManager implements CacheManagerInterface |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @type string |
|
21 | - */ |
|
22 | - const CACHE_PREFIX = 'ee_cache_'; |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * @var CacheStorageInterface $cache_storage |
|
27 | - */ |
|
28 | - private $cache_storage; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * BasicCacheManager constructor. |
|
33 | - * |
|
34 | - * @param CacheStorageInterface $cache_storage [required] |
|
35 | - */ |
|
36 | - public function __construct(CacheStorageInterface $cache_storage) |
|
37 | - { |
|
38 | - $this->cache_storage = $cache_storage; |
|
39 | - } |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * returns a string that will be prepended to all cache identifiers |
|
44 | - * |
|
45 | - * @return string |
|
46 | - */ |
|
47 | - public function cachePrefix() |
|
48 | - { |
|
49 | - return BasicCacheManager::CACHE_PREFIX; |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * @param string $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types. |
|
55 | - * May also be helpful to include an additional specific identifier, |
|
56 | - * such as a post ID as part of the $id_prefix so that individual caches |
|
57 | - * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
58 | - * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
59 | - * @param string $cache_id [required] Additional identifying details that make this cache unique. |
|
60 | - * It is advisable to use some of the actual data |
|
61 | - * that is used to generate the content being cached, |
|
62 | - * in order to guarantee that the cache id is unique for that content. |
|
63 | - * The cache id will be md5'd before usage to make it more db friendly, |
|
64 | - * and the entire cache id string will be truncated to 190 characters. |
|
65 | - * @param Closure $callback [required] since the point of caching is to avoid generating content when not |
|
66 | - * necessary, |
|
67 | - * we wrap our content creation in a Closure so that it is not executed until needed. |
|
68 | - * @param int $expiration |
|
69 | - * @return Closure|mixed |
|
70 | - */ |
|
71 | - public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS) |
|
72 | - { |
|
73 | - $content = ''; |
|
74 | - $expiration = absint( |
|
75 | - apply_filters( |
|
76 | - 'FHEE__CacheManager__get__cache_expiration', |
|
77 | - $expiration, |
|
78 | - $id_prefix, |
|
79 | - $cache_id |
|
80 | - ) |
|
81 | - ); |
|
82 | - $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id); |
|
83 | - // is caching enabled for this content ? |
|
84 | - if ($expiration) { |
|
85 | - $content = $this->cache_storage->get($cache_id); |
|
86 | - } |
|
87 | - // any existing content ? |
|
88 | - if (empty($content)) { |
|
89 | - // nope! let's generate some new stuff |
|
90 | - $content = $callback(); |
|
91 | - // save the new content if caching is enabled |
|
92 | - if ($expiration) { |
|
93 | - $this->cache_storage->add($cache_id, $content, $expiration); |
|
94 | - if (EE_DEBUG) { |
|
95 | - $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE'); |
|
96 | - } |
|
97 | - } |
|
98 | - } else { |
|
99 | - if (EE_DEBUG) { |
|
100 | - $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT'); |
|
101 | - } |
|
102 | - } |
|
103 | - return $content; |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * Generates a unique identifier string for the cache |
|
109 | - * |
|
110 | - * @param string $id_prefix [required] see BasicCacheManager::get() |
|
111 | - * @param string $cache_id [required] see BasicCacheManager::get() |
|
112 | - * @return string |
|
113 | - */ |
|
114 | - private function generateCacheIdentifier($id_prefix, $cache_id) |
|
115 | - { |
|
116 | - // let's make the cached content unique for this "page" |
|
117 | - $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL); |
|
118 | - // with these parameters |
|
119 | - $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL); |
|
120 | - // then md5 the above to control it's length, add all of our prefixes, and truncate |
|
121 | - return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182); |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - /** |
|
126 | - * @param array|string $cache_id [required] Could be an ID prefix affecting many caches |
|
127 | - * or a specific ID targeting a single cache item |
|
128 | - * @return void |
|
129 | - */ |
|
130 | - public function clear($cache_id) |
|
131 | - { |
|
132 | - // ensure incoming arg is in an array |
|
133 | - $cache_id = is_array($cache_id) ? $cache_id : array($cache_id); |
|
134 | - // delete corresponding transients for the supplied id prefix |
|
135 | - $this->cache_storage->deleteMany($cache_id); |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param array|string $cache_id [required] Could be an ID prefix affecting many caches |
|
141 | - * or a specific ID targeting a single cache item |
|
142 | - * @param string $type |
|
143 | - * @return string |
|
144 | - */ |
|
145 | - private function displayCacheNotice($cache_id, $type) |
|
146 | - { |
|
147 | - return ' |
|
19 | + /** |
|
20 | + * @type string |
|
21 | + */ |
|
22 | + const CACHE_PREFIX = 'ee_cache_'; |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * @var CacheStorageInterface $cache_storage |
|
27 | + */ |
|
28 | + private $cache_storage; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * BasicCacheManager constructor. |
|
33 | + * |
|
34 | + * @param CacheStorageInterface $cache_storage [required] |
|
35 | + */ |
|
36 | + public function __construct(CacheStorageInterface $cache_storage) |
|
37 | + { |
|
38 | + $this->cache_storage = $cache_storage; |
|
39 | + } |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * returns a string that will be prepended to all cache identifiers |
|
44 | + * |
|
45 | + * @return string |
|
46 | + */ |
|
47 | + public function cachePrefix() |
|
48 | + { |
|
49 | + return BasicCacheManager::CACHE_PREFIX; |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * @param string $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types. |
|
55 | + * May also be helpful to include an additional specific identifier, |
|
56 | + * such as a post ID as part of the $id_prefix so that individual caches |
|
57 | + * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
58 | + * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
59 | + * @param string $cache_id [required] Additional identifying details that make this cache unique. |
|
60 | + * It is advisable to use some of the actual data |
|
61 | + * that is used to generate the content being cached, |
|
62 | + * in order to guarantee that the cache id is unique for that content. |
|
63 | + * The cache id will be md5'd before usage to make it more db friendly, |
|
64 | + * and the entire cache id string will be truncated to 190 characters. |
|
65 | + * @param Closure $callback [required] since the point of caching is to avoid generating content when not |
|
66 | + * necessary, |
|
67 | + * we wrap our content creation in a Closure so that it is not executed until needed. |
|
68 | + * @param int $expiration |
|
69 | + * @return Closure|mixed |
|
70 | + */ |
|
71 | + public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS) |
|
72 | + { |
|
73 | + $content = ''; |
|
74 | + $expiration = absint( |
|
75 | + apply_filters( |
|
76 | + 'FHEE__CacheManager__get__cache_expiration', |
|
77 | + $expiration, |
|
78 | + $id_prefix, |
|
79 | + $cache_id |
|
80 | + ) |
|
81 | + ); |
|
82 | + $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id); |
|
83 | + // is caching enabled for this content ? |
|
84 | + if ($expiration) { |
|
85 | + $content = $this->cache_storage->get($cache_id); |
|
86 | + } |
|
87 | + // any existing content ? |
|
88 | + if (empty($content)) { |
|
89 | + // nope! let's generate some new stuff |
|
90 | + $content = $callback(); |
|
91 | + // save the new content if caching is enabled |
|
92 | + if ($expiration) { |
|
93 | + $this->cache_storage->add($cache_id, $content, $expiration); |
|
94 | + if (EE_DEBUG) { |
|
95 | + $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE'); |
|
96 | + } |
|
97 | + } |
|
98 | + } else { |
|
99 | + if (EE_DEBUG) { |
|
100 | + $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT'); |
|
101 | + } |
|
102 | + } |
|
103 | + return $content; |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * Generates a unique identifier string for the cache |
|
109 | + * |
|
110 | + * @param string $id_prefix [required] see BasicCacheManager::get() |
|
111 | + * @param string $cache_id [required] see BasicCacheManager::get() |
|
112 | + * @return string |
|
113 | + */ |
|
114 | + private function generateCacheIdentifier($id_prefix, $cache_id) |
|
115 | + { |
|
116 | + // let's make the cached content unique for this "page" |
|
117 | + $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL); |
|
118 | + // with these parameters |
|
119 | + $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL); |
|
120 | + // then md5 the above to control it's length, add all of our prefixes, and truncate |
|
121 | + return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182); |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + /** |
|
126 | + * @param array|string $cache_id [required] Could be an ID prefix affecting many caches |
|
127 | + * or a specific ID targeting a single cache item |
|
128 | + * @return void |
|
129 | + */ |
|
130 | + public function clear($cache_id) |
|
131 | + { |
|
132 | + // ensure incoming arg is in an array |
|
133 | + $cache_id = is_array($cache_id) ? $cache_id : array($cache_id); |
|
134 | + // delete corresponding transients for the supplied id prefix |
|
135 | + $this->cache_storage->deleteMany($cache_id); |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param array|string $cache_id [required] Could be an ID prefix affecting many caches |
|
141 | + * or a specific ID targeting a single cache item |
|
142 | + * @param string $type |
|
143 | + * @return string |
|
144 | + */ |
|
145 | + private function displayCacheNotice($cache_id, $type) |
|
146 | + { |
|
147 | + return ' |
|
148 | 148 | <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;"> |
149 | 149 | <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px"> |
150 | 150 | <b>' . $type . '</b><span style="color:#999"> : </span> |
@@ -152,5 +152,5 @@ discard block |
||
152 | 152 | <span style="margin-left:2em;">' . __FILE__ . '</span> |
153 | 153 | </p> |
154 | 154 | </div>'; |
155 | - } |
|
155 | + } |
|
156 | 156 | } |
@@ -120,7 +120,7 @@ |
||
120 | 120 | |
121 | 121 | /** |
122 | 122 | * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
123 | - * @param $field_name |
|
123 | + * @param string $field_name |
|
124 | 124 | * @param int $row_number |
125 | 125 | * @return string |
126 | 126 | */ |
@@ -14,280 +14,280 @@ |
||
14 | 14 | class EventsAdmin extends CoreAdmin |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * Selector for the Add new Event button in the admin. |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event'; |
|
22 | - |
|
23 | - |
|
24 | - /** |
|
25 | - * Selector for the Event Title field in the event editor |
|
26 | - * @var string |
|
27 | - */ |
|
28 | - const EVENT_EDITOR_TITLE_FIELD_SELECTOR = ['xpath' => "//input[@id='title']"]; |
|
29 | - |
|
30 | - /** |
|
31 | - * Selector for the publish submit button in the event editor. |
|
32 | - * @var string |
|
33 | - */ |
|
34 | - const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = ['xpath'=>"//div[@id='major-publishing-actions']//input[@id='publish']"]; |
|
35 | - |
|
36 | - |
|
37 | - /** |
|
38 | - * Selector for the save button in the event editor |
|
39 | - */ |
|
40 | - const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = ['xpath' => "//div[@id='minor-publishing-actions']//input[@id='save-post']"]; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
46 | - const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status'; |
|
47 | - |
|
48 | - /** |
|
49 | - * Selector for the view link after publishing an event. |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a"; |
|
53 | - |
|
54 | - |
|
55 | - /** |
|
56 | - * Selector for the ID of the event in the event editor |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']"; |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * Selector for the search input on the event list table page. |
|
64 | - * @var string |
|
65 | - */ |
|
66 | - const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input'; |
|
67 | - |
|
68 | - |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @param string $additional_params |
|
73 | - * @return string |
|
74 | - */ |
|
75 | - public static function defaultEventsListTableUrl($additional_params = '') |
|
76 | - { |
|
77 | - return self::adminUrl('espresso_events', 'default', $additional_params); |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * The selector for the DTTname field for the given row in the event editor. |
|
83 | - * @param int $row_number |
|
84 | - * @return string |
|
85 | - */ |
|
86 | - public static function eventEditorDatetimeNameFieldSelector($row_number = 1) |
|
87 | - { |
|
88 | - return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number); |
|
89 | - } |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * The selector for the DTT_EVT_start field for the given row in the event editor.d |
|
94 | - * @param int $row_number |
|
95 | - * @return string |
|
96 | - */ |
|
97 | - public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1) |
|
98 | - { |
|
99 | - return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number); |
|
100 | - } |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * Wrapper for getting the selector for a given field and given row of a datetime in the event editor. |
|
105 | - * |
|
106 | - * @param string $field_name |
|
107 | - * @param int $row_number |
|
108 | - * @return string |
|
109 | - */ |
|
110 | - public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1) |
|
111 | - { |
|
112 | - return "//input[@id='event-datetime-$field_name-$row_number']"; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * The selector for the TKT_name field for the given display row in the event editor. |
|
118 | - * @param int $row_number |
|
119 | - * @return string |
|
120 | - */ |
|
121 | - public static function eventEditorTicketNameFieldSelector($row_number = 1) |
|
122 | - { |
|
123 | - return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number); |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - /** |
|
128 | - * Selector for the TKT_base_price field for the given display row in the event editor. |
|
129 | - * @param int $row_number |
|
130 | - * @return string |
|
131 | - */ |
|
132 | - public static function eventEditorTicketPriceFieldSelector($row_number = 1) |
|
133 | - { |
|
134 | - return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number); |
|
135 | - } |
|
136 | - |
|
137 | - |
|
138 | - /** |
|
139 | - * Selector for the TKT_qty field for the given display row in the event editor. |
|
140 | - * @param int $row_number |
|
141 | - * @return string |
|
142 | - */ |
|
143 | - public static function eventEditorTicketQuantityFieldSelector($row_number = 1) |
|
144 | - { |
|
145 | - return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number); |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - /** |
|
150 | - * Selector for the advanced details toggle for the ticket for the given display row in the event editor. |
|
151 | - * @param int $row_number |
|
152 | - * @return string |
|
153 | - */ |
|
154 | - public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1) |
|
155 | - { |
|
156 | - return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]"; |
|
157 | - } |
|
158 | - |
|
159 | - |
|
160 | - /** |
|
161 | - * Selector for the subtotal amount for the given display row of the ticket in the event editor. |
|
162 | - * @param int $row_number |
|
163 | - * @return string |
|
164 | - */ |
|
165 | - public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1) |
|
166 | - { |
|
167 | - return "//span[@id='price-total-amount-$row_number']"; |
|
168 | - } |
|
169 | - |
|
170 | - |
|
171 | - /** |
|
172 | - * Selector for the Total element for the given display row of the ticket in the event editor. |
|
173 | - * @param int $row_number |
|
174 | - * @return string |
|
175 | - */ |
|
176 | - public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1) |
|
177 | - { |
|
178 | - return "//span[@id='price-total-amount-$row_number']"; |
|
179 | - } |
|
180 | - |
|
181 | - |
|
182 | - /** |
|
183 | - * Selector for the taxable selector for the ticket for the given display row in the event editor. |
|
184 | - * @param int $row_number |
|
185 | - * @return string |
|
186 | - */ |
|
187 | - public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1) |
|
188 | - { |
|
189 | - return "//input[@id='edit-ticket-TKT_taxable-$row_number']"; |
|
190 | - } |
|
191 | - |
|
192 | - |
|
193 | - /** |
|
194 | - * This returns the xpath locater for the Tax amount display container within the advanced settings view for the |
|
195 | - * given ticket (row) and the given tax id (PRC_ID). |
|
196 | - * |
|
197 | - * @param int $tax_id The PRC_ID for the tax you want the locater for. Note, this defaults to the default tax |
|
198 | - * setup on a fresh install. |
|
199 | - * @param int $row_number What row representing the ticket you want the locator for. |
|
200 | - * @return string |
|
201 | - */ |
|
202 | - public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1) |
|
203 | - { |
|
204 | - return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']"; |
|
205 | - } |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
|
210 | - * @param $field_name |
|
211 | - * @param int $row_number |
|
212 | - * @return string |
|
213 | - */ |
|
214 | - public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1) |
|
215 | - { |
|
216 | - return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]"; |
|
217 | - } |
|
218 | - |
|
219 | - |
|
220 | - /** |
|
221 | - * Returns the selector for the event title edit link in the events list table for the given Event Title. |
|
222 | - * @param string $event_title |
|
223 | - * @return string |
|
224 | - */ |
|
225 | - public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title) |
|
226 | - { |
|
227 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"; |
|
228 | - } |
|
229 | - |
|
230 | - |
|
231 | - /** |
|
232 | - * Locator for for the ID column in the event list table for a given event title. |
|
233 | - * @param string $event_title |
|
234 | - * @return string |
|
235 | - */ |
|
236 | - public static function eventListTableEventIdSelectorForTitle($event_title) |
|
237 | - { |
|
238 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
239 | - . "//ancestor::tr/th[contains(@class, 'check-column')]/input"; |
|
240 | - } |
|
241 | - |
|
242 | - |
|
243 | - /** |
|
244 | - * Locator for the view link in the row of an event list table for the given event title. |
|
245 | - * @param string $event_title |
|
246 | - * @return string |
|
247 | - */ |
|
248 | - public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title) |
|
249 | - { |
|
250 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
251 | - . "//ancestor::td//span[@class='view']/a"; |
|
252 | - } |
|
253 | - |
|
254 | - |
|
255 | - /** |
|
256 | - * Locator for the messenger tab in the Notifications metabox in the event editor. |
|
257 | - * @param string $messenger_slug The slug for the messenger (it's reference slug). |
|
258 | - * @return string |
|
259 | - */ |
|
260 | - public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug) |
|
261 | - { |
|
262 | - return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
263 | - . "//a[@rel='ee-tab-$messenger_slug']"; |
|
264 | - } |
|
265 | - |
|
266 | - |
|
267 | - /** |
|
268 | - * Locator for the select input within the notifications metabox. |
|
269 | - * Note, this assumes the tab content for the related messenger is already visible. |
|
270 | - * @param string $message_type_label The message type label (visible string in the table) you want the selector for. |
|
271 | - * @return string |
|
272 | - */ |
|
273 | - public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label) |
|
274 | - { |
|
275 | - return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
276 | - . "//table[@class='messages-custom-template-switcher']" |
|
277 | - . "//tr/td[contains(.,'Registration Approved')]" |
|
278 | - . "//ancestor::tr//select[contains(@class,'message-template-selector')]"; |
|
279 | - } |
|
280 | - |
|
281 | - |
|
282 | - /** |
|
283 | - * Returns the selector for the action link to the registrations list table view filtered by the given event_id. |
|
284 | - * Assumes one is in the context of the Events List Table |
|
285 | - * @param int $event_id |
|
286 | - * @return string |
|
287 | - */ |
|
288 | - public static function listTableActionLinkRegistrationsForEvent($event_id) |
|
289 | - { |
|
290 | - return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-id') and contains(.,$event_id)]" |
|
291 | - . "//ancestor::tr/td//a[div[contains(@class, 'dashicons-groups')]]"; |
|
292 | - } |
|
17 | + /** |
|
18 | + * Selector for the Add new Event button in the admin. |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event'; |
|
22 | + |
|
23 | + |
|
24 | + /** |
|
25 | + * Selector for the Event Title field in the event editor |
|
26 | + * @var string |
|
27 | + */ |
|
28 | + const EVENT_EDITOR_TITLE_FIELD_SELECTOR = ['xpath' => "//input[@id='title']"]; |
|
29 | + |
|
30 | + /** |
|
31 | + * Selector for the publish submit button in the event editor. |
|
32 | + * @var string |
|
33 | + */ |
|
34 | + const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = ['xpath'=>"//div[@id='major-publishing-actions']//input[@id='publish']"]; |
|
35 | + |
|
36 | + |
|
37 | + /** |
|
38 | + * Selector for the save button in the event editor |
|
39 | + */ |
|
40 | + const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = ['xpath' => "//div[@id='minor-publishing-actions']//input[@id='save-post']"]; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | + const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status'; |
|
47 | + |
|
48 | + /** |
|
49 | + * Selector for the view link after publishing an event. |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a"; |
|
53 | + |
|
54 | + |
|
55 | + /** |
|
56 | + * Selector for the ID of the event in the event editor |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']"; |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * Selector for the search input on the event list table page. |
|
64 | + * @var string |
|
65 | + */ |
|
66 | + const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input'; |
|
67 | + |
|
68 | + |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @param string $additional_params |
|
73 | + * @return string |
|
74 | + */ |
|
75 | + public static function defaultEventsListTableUrl($additional_params = '') |
|
76 | + { |
|
77 | + return self::adminUrl('espresso_events', 'default', $additional_params); |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * The selector for the DTTname field for the given row in the event editor. |
|
83 | + * @param int $row_number |
|
84 | + * @return string |
|
85 | + */ |
|
86 | + public static function eventEditorDatetimeNameFieldSelector($row_number = 1) |
|
87 | + { |
|
88 | + return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number); |
|
89 | + } |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * The selector for the DTT_EVT_start field for the given row in the event editor.d |
|
94 | + * @param int $row_number |
|
95 | + * @return string |
|
96 | + */ |
|
97 | + public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1) |
|
98 | + { |
|
99 | + return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number); |
|
100 | + } |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * Wrapper for getting the selector for a given field and given row of a datetime in the event editor. |
|
105 | + * |
|
106 | + * @param string $field_name |
|
107 | + * @param int $row_number |
|
108 | + * @return string |
|
109 | + */ |
|
110 | + public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1) |
|
111 | + { |
|
112 | + return "//input[@id='event-datetime-$field_name-$row_number']"; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * The selector for the TKT_name field for the given display row in the event editor. |
|
118 | + * @param int $row_number |
|
119 | + * @return string |
|
120 | + */ |
|
121 | + public static function eventEditorTicketNameFieldSelector($row_number = 1) |
|
122 | + { |
|
123 | + return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number); |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + /** |
|
128 | + * Selector for the TKT_base_price field for the given display row in the event editor. |
|
129 | + * @param int $row_number |
|
130 | + * @return string |
|
131 | + */ |
|
132 | + public static function eventEditorTicketPriceFieldSelector($row_number = 1) |
|
133 | + { |
|
134 | + return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number); |
|
135 | + } |
|
136 | + |
|
137 | + |
|
138 | + /** |
|
139 | + * Selector for the TKT_qty field for the given display row in the event editor. |
|
140 | + * @param int $row_number |
|
141 | + * @return string |
|
142 | + */ |
|
143 | + public static function eventEditorTicketQuantityFieldSelector($row_number = 1) |
|
144 | + { |
|
145 | + return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number); |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + /** |
|
150 | + * Selector for the advanced details toggle for the ticket for the given display row in the event editor. |
|
151 | + * @param int $row_number |
|
152 | + * @return string |
|
153 | + */ |
|
154 | + public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1) |
|
155 | + { |
|
156 | + return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]"; |
|
157 | + } |
|
158 | + |
|
159 | + |
|
160 | + /** |
|
161 | + * Selector for the subtotal amount for the given display row of the ticket in the event editor. |
|
162 | + * @param int $row_number |
|
163 | + * @return string |
|
164 | + */ |
|
165 | + public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1) |
|
166 | + { |
|
167 | + return "//span[@id='price-total-amount-$row_number']"; |
|
168 | + } |
|
169 | + |
|
170 | + |
|
171 | + /** |
|
172 | + * Selector for the Total element for the given display row of the ticket in the event editor. |
|
173 | + * @param int $row_number |
|
174 | + * @return string |
|
175 | + */ |
|
176 | + public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1) |
|
177 | + { |
|
178 | + return "//span[@id='price-total-amount-$row_number']"; |
|
179 | + } |
|
180 | + |
|
181 | + |
|
182 | + /** |
|
183 | + * Selector for the taxable selector for the ticket for the given display row in the event editor. |
|
184 | + * @param int $row_number |
|
185 | + * @return string |
|
186 | + */ |
|
187 | + public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1) |
|
188 | + { |
|
189 | + return "//input[@id='edit-ticket-TKT_taxable-$row_number']"; |
|
190 | + } |
|
191 | + |
|
192 | + |
|
193 | + /** |
|
194 | + * This returns the xpath locater for the Tax amount display container within the advanced settings view for the |
|
195 | + * given ticket (row) and the given tax id (PRC_ID). |
|
196 | + * |
|
197 | + * @param int $tax_id The PRC_ID for the tax you want the locater for. Note, this defaults to the default tax |
|
198 | + * setup on a fresh install. |
|
199 | + * @param int $row_number What row representing the ticket you want the locator for. |
|
200 | + * @return string |
|
201 | + */ |
|
202 | + public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1) |
|
203 | + { |
|
204 | + return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']"; |
|
205 | + } |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
|
210 | + * @param $field_name |
|
211 | + * @param int $row_number |
|
212 | + * @return string |
|
213 | + */ |
|
214 | + public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1) |
|
215 | + { |
|
216 | + return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]"; |
|
217 | + } |
|
218 | + |
|
219 | + |
|
220 | + /** |
|
221 | + * Returns the selector for the event title edit link in the events list table for the given Event Title. |
|
222 | + * @param string $event_title |
|
223 | + * @return string |
|
224 | + */ |
|
225 | + public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title) |
|
226 | + { |
|
227 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"; |
|
228 | + } |
|
229 | + |
|
230 | + |
|
231 | + /** |
|
232 | + * Locator for for the ID column in the event list table for a given event title. |
|
233 | + * @param string $event_title |
|
234 | + * @return string |
|
235 | + */ |
|
236 | + public static function eventListTableEventIdSelectorForTitle($event_title) |
|
237 | + { |
|
238 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
239 | + . "//ancestor::tr/th[contains(@class, 'check-column')]/input"; |
|
240 | + } |
|
241 | + |
|
242 | + |
|
243 | + /** |
|
244 | + * Locator for the view link in the row of an event list table for the given event title. |
|
245 | + * @param string $event_title |
|
246 | + * @return string |
|
247 | + */ |
|
248 | + public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title) |
|
249 | + { |
|
250 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
251 | + . "//ancestor::td//span[@class='view']/a"; |
|
252 | + } |
|
253 | + |
|
254 | + |
|
255 | + /** |
|
256 | + * Locator for the messenger tab in the Notifications metabox in the event editor. |
|
257 | + * @param string $messenger_slug The slug for the messenger (it's reference slug). |
|
258 | + * @return string |
|
259 | + */ |
|
260 | + public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug) |
|
261 | + { |
|
262 | + return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
263 | + . "//a[@rel='ee-tab-$messenger_slug']"; |
|
264 | + } |
|
265 | + |
|
266 | + |
|
267 | + /** |
|
268 | + * Locator for the select input within the notifications metabox. |
|
269 | + * Note, this assumes the tab content for the related messenger is already visible. |
|
270 | + * @param string $message_type_label The message type label (visible string in the table) you want the selector for. |
|
271 | + * @return string |
|
272 | + */ |
|
273 | + public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label) |
|
274 | + { |
|
275 | + return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
276 | + . "//table[@class='messages-custom-template-switcher']" |
|
277 | + . "//tr/td[contains(.,'Registration Approved')]" |
|
278 | + . "//ancestor::tr//select[contains(@class,'message-template-selector')]"; |
|
279 | + } |
|
280 | + |
|
281 | + |
|
282 | + /** |
|
283 | + * Returns the selector for the action link to the registrations list table view filtered by the given event_id. |
|
284 | + * Assumes one is in the context of the Events List Table |
|
285 | + * @param int $event_id |
|
286 | + * @return string |
|
287 | + */ |
|
288 | + public static function listTableActionLinkRegistrationsForEvent($event_id) |
|
289 | + { |
|
290 | + return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-id') and contains(.,$event_id)]" |
|
291 | + . "//ancestor::tr/td//a[div[contains(@class, 'dashicons-groups')]]"; |
|
292 | + } |
|
293 | 293 | } |
@@ -66,9 +66,9 @@ discard block |
||
66 | 66 | */ |
67 | 67 | public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
68 | 68 | { |
69 | - $url = self::URL_PREFIX . $page; |
|
70 | - $url .= $action ? '&action=' . $action : ''; |
|
71 | - $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
69 | + $url = self::URL_PREFIX.$page; |
|
70 | + $url .= $action ? '&action='.$action : ''; |
|
71 | + $url .= $additional_params ? '&'.ltrim('&', ltrim('?', $additional_params)) : ''; |
|
72 | 72 | return $url; |
73 | 73 | } |
74 | 74 | |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | */ |
81 | 81 | public static function wpEditorTextTabSelector($field_reference) |
82 | 82 | { |
83 | - return '#content-' . $field_reference . '-content-html'; |
|
83 | + return '#content-'.$field_reference.'-content-html'; |
|
84 | 84 | } |
85 | 85 | |
86 | 86 | |
@@ -91,6 +91,6 @@ discard block |
||
91 | 91 | */ |
92 | 92 | public static function wpEditorTextAreaSelector($field_reference) |
93 | 93 | { |
94 | - return '#content-' . $field_reference . '-content'; |
|
94 | + return '#content-'.$field_reference.'-content'; |
|
95 | 95 | } |
96 | 96 | } |
@@ -13,96 +13,96 @@ |
||
13 | 13 | class CoreAdmin |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @var string |
|
18 | - */ |
|
19 | - const URL_PREFIX = 'admin.php?page='; |
|
20 | - |
|
21 | - |
|
22 | - /** |
|
23 | - * This is the selector for the next page button on list tables. |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page'; |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * The selector for the search input submit button on list table pages |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit'; |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * Selector for the screen options dropdown. |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link'; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * Selector for the per page field setting selector (found within screen options dropdown) |
|
45 | - * @var string |
|
46 | - */ |
|
47 | - const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page'; |
|
48 | - |
|
49 | - |
|
50 | - /** |
|
51 | - * Selector for apply screen options settings. |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply'; |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * Selector for bulk action select field on list tables. |
|
59 | - */ |
|
60 | - const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-'; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * Selector for applying a bulk action. |
|
65 | - */ |
|
66 | - const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction'; |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * Get the EE admin url for the given properties. |
|
71 | - * Note, this is JUST the endpoint for the admin route. It is expected that the actor/test would be calling this |
|
72 | - * with `amOnAdminPage` action. |
|
73 | - * |
|
74 | - * @param string $page |
|
75 | - * @param string $action |
|
76 | - * @param string $additional_params |
|
77 | - * @return string |
|
78 | - */ |
|
79 | - public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
|
80 | - { |
|
81 | - $url = self::URL_PREFIX . $page; |
|
82 | - $url .= $action ? '&action=' . $action : ''; |
|
83 | - $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
84 | - return $url; |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns the selector for the text tab switcher for a wp-editor instance. |
|
90 | - * @param $field_reference |
|
91 | - * @return string |
|
92 | - */ |
|
93 | - public static function wpEditorTextTabSelector($field_reference) |
|
94 | - { |
|
95 | - return '#content-' . $field_reference . '-content-html'; |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance. |
|
101 | - * @param $field_reference |
|
102 | - * @return string |
|
103 | - */ |
|
104 | - public static function wpEditorTextAreaSelector($field_reference) |
|
105 | - { |
|
106 | - return '#content-' . $field_reference . '-content'; |
|
107 | - } |
|
16 | + /** |
|
17 | + * @var string |
|
18 | + */ |
|
19 | + const URL_PREFIX = 'admin.php?page='; |
|
20 | + |
|
21 | + |
|
22 | + /** |
|
23 | + * This is the selector for the next page button on list tables. |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page'; |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * The selector for the search input submit button on list table pages |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit'; |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * Selector for the screen options dropdown. |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link'; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * Selector for the per page field setting selector (found within screen options dropdown) |
|
45 | + * @var string |
|
46 | + */ |
|
47 | + const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page'; |
|
48 | + |
|
49 | + |
|
50 | + /** |
|
51 | + * Selector for apply screen options settings. |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply'; |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * Selector for bulk action select field on list tables. |
|
59 | + */ |
|
60 | + const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-'; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * Selector for applying a bulk action. |
|
65 | + */ |
|
66 | + const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction'; |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * Get the EE admin url for the given properties. |
|
71 | + * Note, this is JUST the endpoint for the admin route. It is expected that the actor/test would be calling this |
|
72 | + * with `amOnAdminPage` action. |
|
73 | + * |
|
74 | + * @param string $page |
|
75 | + * @param string $action |
|
76 | + * @param string $additional_params |
|
77 | + * @return string |
|
78 | + */ |
|
79 | + public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
|
80 | + { |
|
81 | + $url = self::URL_PREFIX . $page; |
|
82 | + $url .= $action ? '&action=' . $action : ''; |
|
83 | + $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
84 | + return $url; |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns the selector for the text tab switcher for a wp-editor instance. |
|
90 | + * @param $field_reference |
|
91 | + * @return string |
|
92 | + */ |
|
93 | + public static function wpEditorTextTabSelector($field_reference) |
|
94 | + { |
|
95 | + return '#content-' . $field_reference . '-content-html'; |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance. |
|
101 | + * @param $field_reference |
|
102 | + * @return string |
|
103 | + */ |
|
104 | + public static function wpEditorTextAreaSelector($field_reference) |
|
105 | + { |
|
106 | + return '#content-' . $field_reference . '-content'; |
|
107 | + } |
|
108 | 108 | } |
@@ -18,7 +18,7 @@ discard block |
||
18 | 18 | $this->_form_section->html_id(), |
19 | 19 | $this->_form_section->html_class(), |
20 | 20 | $this->_form_section->html_style() |
21 | - ) . EEH_HTML::tbody(); |
|
21 | + ).EEH_HTML::tbody(); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | */ |
32 | 32 | public function layout_form_end($additional_args = array()) |
33 | 33 | { |
34 | - return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id()); |
|
34 | + return EEH_HTML::tbodyx().EEH_HTML::tablex($this->_form_section->html_id()); |
|
35 | 35 | } |
36 | 36 | |
37 | 37 | |
@@ -50,11 +50,11 @@ discard block |
||
50 | 50 | } else { |
51 | 51 | $html_for_input = $input->get_html_for_input(); |
52 | 52 | $html_for_input .= $input->get_html_for_errors() != '' |
53 | - ? EEH_HTML::nl() . $input->get_html_for_errors() |
|
53 | + ? EEH_HTML::nl().$input->get_html_for_errors() |
|
54 | 54 | : ''; |
55 | - $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
55 | + $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl().$input->get_html_for_help() : ''; |
|
56 | 56 | $html .= EEH_HTML::tr( |
57 | - EEH_HTML::th($input->get_html_for_label()) . |
|
57 | + EEH_HTML::th($input->get_html_for_label()). |
|
58 | 58 | EEH_HTML::td($html_for_input) |
59 | 59 | ); |
60 | 60 | } |
@@ -5,81 +5,81 @@ |
||
5 | 5 | class EE_Two_Column_Layout extends EE_Form_Section_Layout_Base |
6 | 6 | { |
7 | 7 | |
8 | - /** |
|
9 | - * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
10 | - * |
|
11 | - * @param array $additional_args |
|
12 | - * @return string |
|
13 | - */ |
|
14 | - public function layout_form_begin($additional_args = array()) |
|
15 | - { |
|
16 | - return $this->display_form_wide_errors() |
|
17 | - . EEH_HTML::table( |
|
18 | - '', |
|
19 | - $this->_form_section->html_id(), |
|
20 | - $this->_form_section->html_class(), |
|
21 | - $this->_form_section->html_style() |
|
22 | - ) . EEH_HTML::tbody(); |
|
23 | - } |
|
8 | + /** |
|
9 | + * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
10 | + * |
|
11 | + * @param array $additional_args |
|
12 | + * @return string |
|
13 | + */ |
|
14 | + public function layout_form_begin($additional_args = array()) |
|
15 | + { |
|
16 | + return $this->display_form_wide_errors() |
|
17 | + . EEH_HTML::table( |
|
18 | + '', |
|
19 | + $this->_form_section->html_id(), |
|
20 | + $this->_form_section->html_class(), |
|
21 | + $this->_form_section->html_style() |
|
22 | + ) . EEH_HTML::tbody(); |
|
23 | + } |
|
24 | 24 | |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * Should be used to end the form section (eg a /table tag, or a /div tag, etc) |
|
29 | - * |
|
30 | - * @param array $additional_args |
|
31 | - * @return string |
|
32 | - */ |
|
33 | - public function layout_form_end($additional_args = array()) |
|
34 | - { |
|
35 | - return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id()); |
|
36 | - } |
|
27 | + /** |
|
28 | + * Should be used to end the form section (eg a /table tag, or a /div tag, etc) |
|
29 | + * |
|
30 | + * @param array $additional_args |
|
31 | + * @return string |
|
32 | + */ |
|
33 | + public function layout_form_end($additional_args = array()) |
|
34 | + { |
|
35 | + return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id()); |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * Lays out the row for the input, including label and errors |
|
42 | - * |
|
43 | - * @param EE_Form_Input_Base $input |
|
44 | - * @return string |
|
45 | - */ |
|
46 | - public function layout_input($input) |
|
47 | - { |
|
48 | - $html = ''; |
|
49 | - if ($input instanceof EE_Hidden_Input) { |
|
50 | - $html .= $input->get_html_for_input(); |
|
51 | - } else { |
|
52 | - $html_for_input = $input->get_html_for_input(); |
|
53 | - $html_for_input .= $input->get_html_for_errors() != '' |
|
54 | - ? EEH_HTML::nl() . $input->get_html_for_errors() |
|
55 | - : ''; |
|
56 | - $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
57 | - $html .= EEH_HTML::tr( |
|
58 | - EEH_HTML::th($input->get_html_for_label()) . |
|
59 | - EEH_HTML::td($html_for_input) |
|
60 | - ); |
|
61 | - } |
|
62 | - return $html; |
|
63 | - } |
|
40 | + /** |
|
41 | + * Lays out the row for the input, including label and errors |
|
42 | + * |
|
43 | + * @param EE_Form_Input_Base $input |
|
44 | + * @return string |
|
45 | + */ |
|
46 | + public function layout_input($input) |
|
47 | + { |
|
48 | + $html = ''; |
|
49 | + if ($input instanceof EE_Hidden_Input) { |
|
50 | + $html .= $input->get_html_for_input(); |
|
51 | + } else { |
|
52 | + $html_for_input = $input->get_html_for_input(); |
|
53 | + $html_for_input .= $input->get_html_for_errors() != '' |
|
54 | + ? EEH_HTML::nl() . $input->get_html_for_errors() |
|
55 | + : ''; |
|
56 | + $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
57 | + $html .= EEH_HTML::tr( |
|
58 | + EEH_HTML::th($input->get_html_for_label()) . |
|
59 | + EEH_HTML::td($html_for_input) |
|
60 | + ); |
|
61 | + } |
|
62 | + return $html; |
|
63 | + } |
|
64 | 64 | |
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * Lays out a row for the subsection. Please note that if you have a subsection which you don't want wrapped in |
|
69 | - * a tr and td with a colspan=2, you should use a different layout strategy, like EE_No_Layout, EE_Template_Layout, |
|
70 | - * or EE_Div_Per_Section_Layout, and create subsections using EE_Two_Column_Layout for everywhere you want the |
|
71 | - * two-column layout, and then other sub-sections can be outside the EE_Two_Column_Layout table. |
|
72 | - * |
|
73 | - * @param EE_Form_Section_Proper $form_section |
|
74 | - * @return string |
|
75 | - */ |
|
76 | - public function layout_subsection($form_section) |
|
77 | - { |
|
78 | - if ($form_section instanceof EE_Form_Section_Proper |
|
79 | - || $form_section instanceof EE_Form_Section_HTML |
|
80 | - ) { |
|
81 | - return EEH_HTML::no_row($form_section->get_html()); |
|
82 | - } |
|
83 | - return ''; |
|
84 | - } |
|
67 | + /** |
|
68 | + * Lays out a row for the subsection. Please note that if you have a subsection which you don't want wrapped in |
|
69 | + * a tr and td with a colspan=2, you should use a different layout strategy, like EE_No_Layout, EE_Template_Layout, |
|
70 | + * or EE_Div_Per_Section_Layout, and create subsections using EE_Two_Column_Layout for everywhere you want the |
|
71 | + * two-column layout, and then other sub-sections can be outside the EE_Two_Column_Layout table. |
|
72 | + * |
|
73 | + * @param EE_Form_Section_Proper $form_section |
|
74 | + * @return string |
|
75 | + */ |
|
76 | + public function layout_subsection($form_section) |
|
77 | + { |
|
78 | + if ($form_section instanceof EE_Form_Section_Proper |
|
79 | + || $form_section instanceof EE_Form_Section_HTML |
|
80 | + ) { |
|
81 | + return EEH_HTML::no_row($form_section->get_html()); |
|
82 | + } |
|
83 | + return ''; |
|
84 | + } |
|
85 | 85 | } |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | * |
103 | 103 | * @abstract |
104 | 104 | * @access protected |
105 | - * @return array |
|
105 | + * @return string[] |
|
106 | 106 | */ |
107 | 107 | protected function _get_table_filters() |
108 | 108 | { |
@@ -265,7 +265,7 @@ discard block |
||
265 | 265 | * column_TXN_paid |
266 | 266 | * |
267 | 267 | * @param \EE_Transaction $transaction |
268 | - * @return mixed|string |
|
268 | + * @return string |
|
269 | 269 | * @throws \EE_Error |
270 | 270 | */ |
271 | 271 | public function column_TXN_paid(EE_Transaction $transaction) |
@@ -15,121 +15,121 @@ discard block |
||
15 | 15 | class EE_Admin_Transactions_List_Table extends EE_Admin_List_Table |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @var SessionLifespan $session_lifespan |
|
20 | - */ |
|
21 | - private $session_lifespan; |
|
22 | - |
|
23 | - private $_status; |
|
24 | - |
|
25 | - |
|
26 | - /** |
|
27 | - * @param \Transactions_Admin_Page $admin_page |
|
28 | - * @param SessionLifespan $lifespan |
|
29 | - */ |
|
30 | - public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan) |
|
31 | - { |
|
32 | - parent::__construct($admin_page); |
|
33 | - $this->session_lifespan = $lifespan; |
|
34 | - $this->_status = $this->_admin_page->get_transaction_status_array(); |
|
35 | - } |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - *_setup_data |
|
40 | - */ |
|
41 | - protected function _setup_data() |
|
42 | - { |
|
43 | - $this->_data = $this->_admin_page->get_transactions($this->_per_page); |
|
44 | - $status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all'; |
|
45 | - $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status); |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - *_set_properties |
|
51 | - */ |
|
52 | - protected function _set_properties() |
|
53 | - { |
|
54 | - $this->_wp_list_args = array( |
|
55 | - 'singular' => __('transaction', 'event_espresso'), |
|
56 | - 'plural' => __('transactions', 'event_espresso'), |
|
57 | - 'ajax' => true, |
|
58 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
59 | - ); |
|
60 | - $ID_column_name = __('ID', 'event_espresso'); |
|
61 | - $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">'; |
|
62 | - $ID_column_name .= __('Transaction Date', 'event_espresso'); |
|
63 | - $ID_column_name .= '</span> '; |
|
64 | - $this->_columns = array( |
|
65 | - 'TXN_ID' => $ID_column_name, |
|
66 | - 'TXN_timestamp' => __('Transaction Date', 'event_espresso'), |
|
67 | - 'TXN_total' => __('Total', 'event_espresso'), |
|
68 | - 'TXN_paid' => __('Paid', 'event_espresso'), |
|
69 | - 'ATT_fname' => __('Primary Registrant', 'event_espresso'), |
|
70 | - 'event_name' => __('Event', 'event_espresso'), |
|
71 | - 'actions' => __('Actions', 'event_espresso'), |
|
72 | - ); |
|
73 | - |
|
74 | - $this->_sortable_columns = array( |
|
75 | - 'TXN_ID' => array('TXN_ID' => false), |
|
76 | - 'event_name' => array('event_name' => false), |
|
77 | - 'ATT_fname' => array('ATT_fname' => false), |
|
78 | - 'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted |
|
79 | - ); |
|
80 | - |
|
81 | - $this->_primary_column = 'TXN_ID'; |
|
82 | - |
|
83 | - $this->_hidden_columns = array(); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * This simply sets up the row class for the table rows. |
|
89 | - * Allows for easier overriding of child methods for setting up sorting. |
|
90 | - * |
|
91 | - * @param EE_Transaction $transaction the current item |
|
92 | - * @return string |
|
93 | - * @throws \EE_Error |
|
94 | - */ |
|
95 | - protected function _get_row_class($transaction) |
|
96 | - { |
|
97 | - $class = parent::_get_row_class($transaction); |
|
98 | - // add status class |
|
99 | - $class .= ' ee-status-strip txn-status-' . $transaction->status_ID(); |
|
100 | - if ($this->_has_checkbox_column) { |
|
101 | - $class .= ' has-checkbox-column'; |
|
102 | - } |
|
103 | - return $class; |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * _get_table_filters |
|
109 | - * We use this to assemble and return any filters that are associated with this table that help further refine what |
|
110 | - * get's shown in the table. |
|
111 | - * |
|
112 | - * @abstract |
|
113 | - * @access protected |
|
114 | - * @return array |
|
115 | - */ |
|
116 | - protected function _get_table_filters() |
|
117 | - { |
|
118 | - $filters = array(); |
|
119 | - $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
120 | - ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
121 | - : date( |
|
122 | - 'm/d/Y', |
|
123 | - strtotime('-10 year') |
|
124 | - ); |
|
125 | - $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
126 | - ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
127 | - : date( |
|
128 | - 'm/d/Y', |
|
129 | - current_time('timestamp') |
|
130 | - ); |
|
131 | - ob_start(); |
|
132 | - ?> |
|
18 | + /** |
|
19 | + * @var SessionLifespan $session_lifespan |
|
20 | + */ |
|
21 | + private $session_lifespan; |
|
22 | + |
|
23 | + private $_status; |
|
24 | + |
|
25 | + |
|
26 | + /** |
|
27 | + * @param \Transactions_Admin_Page $admin_page |
|
28 | + * @param SessionLifespan $lifespan |
|
29 | + */ |
|
30 | + public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan) |
|
31 | + { |
|
32 | + parent::__construct($admin_page); |
|
33 | + $this->session_lifespan = $lifespan; |
|
34 | + $this->_status = $this->_admin_page->get_transaction_status_array(); |
|
35 | + } |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + *_setup_data |
|
40 | + */ |
|
41 | + protected function _setup_data() |
|
42 | + { |
|
43 | + $this->_data = $this->_admin_page->get_transactions($this->_per_page); |
|
44 | + $status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all'; |
|
45 | + $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status); |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + *_set_properties |
|
51 | + */ |
|
52 | + protected function _set_properties() |
|
53 | + { |
|
54 | + $this->_wp_list_args = array( |
|
55 | + 'singular' => __('transaction', 'event_espresso'), |
|
56 | + 'plural' => __('transactions', 'event_espresso'), |
|
57 | + 'ajax' => true, |
|
58 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
59 | + ); |
|
60 | + $ID_column_name = __('ID', 'event_espresso'); |
|
61 | + $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">'; |
|
62 | + $ID_column_name .= __('Transaction Date', 'event_espresso'); |
|
63 | + $ID_column_name .= '</span> '; |
|
64 | + $this->_columns = array( |
|
65 | + 'TXN_ID' => $ID_column_name, |
|
66 | + 'TXN_timestamp' => __('Transaction Date', 'event_espresso'), |
|
67 | + 'TXN_total' => __('Total', 'event_espresso'), |
|
68 | + 'TXN_paid' => __('Paid', 'event_espresso'), |
|
69 | + 'ATT_fname' => __('Primary Registrant', 'event_espresso'), |
|
70 | + 'event_name' => __('Event', 'event_espresso'), |
|
71 | + 'actions' => __('Actions', 'event_espresso'), |
|
72 | + ); |
|
73 | + |
|
74 | + $this->_sortable_columns = array( |
|
75 | + 'TXN_ID' => array('TXN_ID' => false), |
|
76 | + 'event_name' => array('event_name' => false), |
|
77 | + 'ATT_fname' => array('ATT_fname' => false), |
|
78 | + 'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted |
|
79 | + ); |
|
80 | + |
|
81 | + $this->_primary_column = 'TXN_ID'; |
|
82 | + |
|
83 | + $this->_hidden_columns = array(); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * This simply sets up the row class for the table rows. |
|
89 | + * Allows for easier overriding of child methods for setting up sorting. |
|
90 | + * |
|
91 | + * @param EE_Transaction $transaction the current item |
|
92 | + * @return string |
|
93 | + * @throws \EE_Error |
|
94 | + */ |
|
95 | + protected function _get_row_class($transaction) |
|
96 | + { |
|
97 | + $class = parent::_get_row_class($transaction); |
|
98 | + // add status class |
|
99 | + $class .= ' ee-status-strip txn-status-' . $transaction->status_ID(); |
|
100 | + if ($this->_has_checkbox_column) { |
|
101 | + $class .= ' has-checkbox-column'; |
|
102 | + } |
|
103 | + return $class; |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * _get_table_filters |
|
109 | + * We use this to assemble and return any filters that are associated with this table that help further refine what |
|
110 | + * get's shown in the table. |
|
111 | + * |
|
112 | + * @abstract |
|
113 | + * @access protected |
|
114 | + * @return array |
|
115 | + */ |
|
116 | + protected function _get_table_filters() |
|
117 | + { |
|
118 | + $filters = array(); |
|
119 | + $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
120 | + ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
121 | + : date( |
|
122 | + 'm/d/Y', |
|
123 | + strtotime('-10 year') |
|
124 | + ); |
|
125 | + $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
126 | + ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
127 | + : date( |
|
128 | + 'm/d/Y', |
|
129 | + current_time('timestamp') |
|
130 | + ); |
|
131 | + ob_start(); |
|
132 | + ?> |
|
133 | 133 | <label for="txn-filter-start-date">Display Transactions from </label> |
134 | 134 | <input id="txn-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>" |
135 | 135 | name="txn-filter-start-date" size="15"/> |
@@ -137,578 +137,578 @@ discard block |
||
137 | 137 | <input id="txn-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>" |
138 | 138 | name="txn-filter-end-date" size="15"/> |
139 | 139 | <?php |
140 | - $filters[] = ob_get_contents(); |
|
141 | - ob_end_clean(); |
|
142 | - return $filters; |
|
143 | - } |
|
144 | - |
|
145 | - |
|
146 | - /** |
|
147 | - *_add_view_counts |
|
148 | - */ |
|
149 | - protected function _add_view_counts() |
|
150 | - { |
|
151 | - foreach ($this->_views as $view) { |
|
152 | - $this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']); |
|
153 | - } |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * column TXN_ID |
|
159 | - * |
|
160 | - * @param \EE_Transaction $transaction |
|
161 | - * @return string |
|
162 | - * @throws \EE_Error |
|
163 | - */ |
|
164 | - public function column_TXN_ID(EE_Transaction $transaction) |
|
165 | - { |
|
166 | - $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
167 | - array( |
|
168 | - 'action' => 'view_transaction', |
|
169 | - 'TXN_ID' => $transaction->ID(), |
|
170 | - ), |
|
171 | - TXN_ADMIN_URL |
|
172 | - ); |
|
173 | - $content = '<a href="' . $view_lnk_url . '"' |
|
174 | - . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">' |
|
175 | - . $transaction->ID() |
|
176 | - . '</a>'; |
|
177 | - |
|
178 | - // txn timestamp |
|
179 | - $content .= ' <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>'; |
|
180 | - return $content; |
|
181 | - } |
|
182 | - |
|
183 | - |
|
184 | - /** |
|
185 | - * @param \EE_Transaction $transaction |
|
186 | - * @return string |
|
187 | - * @throws EE_Error |
|
188 | - * @throws InvalidArgumentException |
|
189 | - * @throws InvalidDataTypeException |
|
190 | - * @throws InvalidInterfaceException |
|
191 | - */ |
|
192 | - protected function _get_txn_timestamp(EE_Transaction $transaction) |
|
193 | - { |
|
194 | - // is TXN less than 2 hours old ? |
|
195 | - if (($transaction->failed() || $transaction->is_abandoned()) |
|
196 | - && $this->session_lifespan->expiration() < $transaction->datetime(false, true) |
|
197 | - ) { |
|
198 | - $timestamp = esc_html__('TXN in progress...', 'event_espresso'); |
|
199 | - } else { |
|
200 | - $timestamp = $transaction->get_i18n_datetime('TXN_timestamp'); |
|
201 | - } |
|
202 | - return $timestamp; |
|
203 | - } |
|
204 | - |
|
205 | - |
|
206 | - /** |
|
207 | - * column_cb |
|
208 | - * |
|
209 | - * @param \EE_Transaction $transaction |
|
210 | - * @return string |
|
211 | - * @throws \EE_Error |
|
212 | - */ |
|
213 | - public function column_cb($transaction) |
|
214 | - { |
|
215 | - return sprintf( |
|
216 | - '<input type="checkbox" name="%1$s[]" value="%2$s" />', |
|
217 | - $this->_wp_list_args['singular'], |
|
218 | - $transaction->ID() |
|
219 | - ); |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - /** |
|
224 | - * column_TXN_timestamp |
|
225 | - * |
|
226 | - * @param \EE_Transaction $transaction |
|
227 | - * @return string |
|
228 | - * @throws \EE_Error |
|
229 | - */ |
|
230 | - public function column_TXN_timestamp(EE_Transaction $transaction) |
|
231 | - { |
|
232 | - $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
233 | - array( |
|
234 | - 'action' => 'view_transaction', |
|
235 | - 'TXN_ID' => $transaction->ID(), |
|
236 | - ), |
|
237 | - TXN_ADMIN_URL |
|
238 | - ); |
|
239 | - $txn_date = '<a href="' . $view_lnk_url . '"' |
|
240 | - . ' title="' |
|
241 | - . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">' |
|
242 | - . $this->_get_txn_timestamp($transaction) |
|
243 | - . '</a>'; |
|
244 | - // status |
|
245 | - $txn_date .= '<br><span class="ee-status-text-small">' |
|
246 | - . EEH_Template::pretty_status( |
|
247 | - $transaction->status_ID(), |
|
248 | - false, |
|
249 | - 'sentence' |
|
250 | - ) |
|
251 | - . '</span>'; |
|
252 | - return $txn_date; |
|
253 | - } |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * column_TXN_total |
|
258 | - * |
|
259 | - * @param \EE_Transaction $transaction |
|
260 | - * @return string |
|
261 | - * @throws \EE_Error |
|
262 | - */ |
|
263 | - public function column_TXN_total(EE_Transaction $transaction) |
|
264 | - { |
|
265 | - if ($transaction->get('TXN_total') > 0) { |
|
266 | - return '<span class="txn-pad-rght">' |
|
267 | - . apply_filters( |
|
268 | - 'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total', |
|
269 | - $transaction->get_pretty('TXN_total'), |
|
270 | - $transaction |
|
271 | - ) |
|
272 | - . '</span>'; |
|
273 | - } else { |
|
274 | - return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>'; |
|
275 | - } |
|
276 | - } |
|
277 | - |
|
278 | - |
|
279 | - /** |
|
280 | - * column_TXN_paid |
|
281 | - * |
|
282 | - * @param \EE_Transaction $transaction |
|
283 | - * @return mixed|string |
|
284 | - * @throws \EE_Error |
|
285 | - */ |
|
286 | - public function column_TXN_paid(EE_Transaction $transaction) |
|
287 | - { |
|
288 | - $transaction_total = $transaction->get('TXN_total'); |
|
289 | - $transaction_paid = $transaction->get('TXN_paid'); |
|
290 | - |
|
291 | - if (\EEH_Money::compare_floats($transaction_total, 0, '>')) { |
|
292 | - // monies owing |
|
293 | - $span_class = 'txn-overview-part-payment-spn'; |
|
294 | - if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) { |
|
295 | - // paid in full |
|
296 | - $span_class = 'txn-overview-full-payment-spn'; |
|
297 | - } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) { |
|
298 | - // no payments made |
|
299 | - $span_class = 'txn-overview-no-payment-spn'; |
|
300 | - } |
|
301 | - } else { |
|
302 | - // transaction_total == 0 so this is a free event |
|
303 | - $span_class = 'txn-overview-free-event-spn'; |
|
304 | - } |
|
305 | - |
|
306 | - $payment_method = $transaction->payment_method(); |
|
307 | - $payment_method_name = $payment_method instanceof EE_Payment_Method |
|
308 | - ? $payment_method->admin_name() |
|
309 | - : esc_html__('Unknown', 'event_espresso'); |
|
310 | - |
|
311 | - $content = '<span class="' . $span_class . ' txn-pad-rght">' |
|
312 | - . $transaction->get_pretty('TXN_paid') |
|
313 | - . '</span>'; |
|
314 | - if ($transaction_paid > 0) { |
|
315 | - $content .= '<br><span class="ee-status-text-small">' |
|
316 | - . sprintf( |
|
317 | - esc_html__('...via %s', 'event_espresso'), |
|
318 | - $payment_method_name |
|
319 | - ) |
|
320 | - . '</span>'; |
|
321 | - } |
|
322 | - return $content; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - /** |
|
327 | - * column_ATT_fname |
|
328 | - * |
|
329 | - * @param \EE_Transaction $transaction |
|
330 | - * @return string |
|
331 | - * @throws EE_Error |
|
332 | - * @throws InvalidArgumentException |
|
333 | - * @throws InvalidDataTypeException |
|
334 | - * @throws InvalidInterfaceException |
|
335 | - */ |
|
336 | - public function column_ATT_fname(EE_Transaction $transaction) |
|
337 | - { |
|
338 | - $primary_reg = $transaction->primary_registration(); |
|
339 | - $attendee = $primary_reg->get_first_related('Attendee'); |
|
340 | - if ($attendee instanceof EE_Attendee) { |
|
341 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
342 | - array( |
|
343 | - 'action' => 'view_registration', |
|
344 | - '_REG_ID' => $primary_reg->ID(), |
|
345 | - ), |
|
346 | - REG_ADMIN_URL |
|
347 | - ); |
|
348 | - $content = EE_Registry::instance()->CAP->current_user_can( |
|
349 | - 'ee_read_registration', |
|
350 | - 'espresso_registrations_view_registration', |
|
351 | - $primary_reg->ID() |
|
352 | - ) |
|
353 | - ? '<a href="' . $edit_lnk_url . '"' |
|
354 | - . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">' |
|
355 | - . $attendee->full_name() |
|
356 | - . '</a>' |
|
357 | - : $attendee->full_name(); |
|
358 | - $content .= '<br>' . $attendee->email(); |
|
359 | - return $content; |
|
360 | - } |
|
361 | - return $transaction->failed() || $transaction->is_abandoned() |
|
362 | - ? esc_html__('no contact record.', 'event_espresso') |
|
363 | - : esc_html__( |
|
364 | - 'No contact record, because the transaction was abandoned or the registration process failed.', |
|
365 | - 'event_espresso' |
|
366 | - ); |
|
367 | - } |
|
368 | - |
|
369 | - |
|
370 | - /** |
|
371 | - * column_ATT_email |
|
372 | - * |
|
373 | - * @param \EE_Transaction $transaction |
|
374 | - * @return string |
|
375 | - * @throws \EE_Error |
|
376 | - */ |
|
377 | - public function column_ATT_email(EE_Transaction $transaction) |
|
378 | - { |
|
379 | - $attendee = $transaction->primary_registration()->get_first_related('Attendee'); |
|
380 | - if (! empty($attendee)) { |
|
381 | - return '<a href="mailto:' . $attendee->get('ATT_email') . '">' |
|
382 | - . $attendee->get('ATT_email') |
|
383 | - . '</a>'; |
|
384 | - } else { |
|
385 | - return $transaction->failed() || $transaction->is_abandoned() |
|
386 | - ? esc_html__('no contact record.', 'event_espresso') |
|
387 | - : esc_html__( |
|
388 | - 'No contact record, because the transaction was abandoned or the registration process failed.', |
|
389 | - 'event_espresso' |
|
390 | - ); |
|
391 | - } |
|
392 | - } |
|
393 | - |
|
394 | - |
|
395 | - /** |
|
396 | - * column_event_name |
|
397 | - * |
|
398 | - * @param \EE_Transaction $transaction |
|
399 | - * @return string |
|
400 | - * @throws EE_Error |
|
401 | - * @throws InvalidArgumentException |
|
402 | - * @throws InvalidDataTypeException |
|
403 | - * @throws InvalidInterfaceException |
|
404 | - */ |
|
405 | - public function column_event_name(EE_Transaction $transaction) |
|
406 | - { |
|
407 | - $actions = array(); |
|
408 | - $event = $transaction->primary_registration()->get_first_related('Event'); |
|
409 | - if (! empty($event)) { |
|
410 | - $edit_event_url = EE_Admin_Page::add_query_args_and_nonce( |
|
411 | - array('action' => 'edit', 'post' => $event->ID()), |
|
412 | - EVENTS_ADMIN_URL |
|
413 | - ); |
|
414 | - $event_name = $event->get('EVT_name'); |
|
415 | - |
|
416 | - // filter this view by transactions for this event |
|
417 | - $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce( |
|
418 | - array( |
|
419 | - 'action' => 'default', |
|
420 | - 'EVT_ID' => $event->ID(), |
|
421 | - ) |
|
422 | - ); |
|
423 | - if (empty($this->_req_data['EVT_ID']) |
|
424 | - && EE_Registry::instance()->CAP->current_user_can( |
|
425 | - 'ee_edit_event', |
|
426 | - 'espresso_events_edit', |
|
427 | - $event->ID() |
|
428 | - ) |
|
429 | - ) { |
|
430 | - $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"' |
|
431 | - . ' title="' . esc_attr__( |
|
432 | - 'Filter transactions by this event', |
|
433 | - 'event_espresso' |
|
434 | - ) . '">' |
|
435 | - . esc_html__('View Transactions for this event', 'event_espresso') |
|
436 | - . '</a>'; |
|
437 | - } |
|
438 | - |
|
439 | - return sprintf( |
|
440 | - '%1$s %2$s', |
|
441 | - EE_Registry::instance()->CAP->current_user_can( |
|
442 | - 'ee_edit_event', |
|
443 | - 'espresso_events_edit', |
|
444 | - $event->ID() |
|
445 | - ) |
|
446 | - ? '<a href="' . $edit_event_url . '"' |
|
447 | - . ' title="' |
|
448 | - . sprintf( |
|
449 | - esc_attr__('Edit Event: %s', 'event_espresso'), |
|
450 | - $event->get('EVT_name') |
|
451 | - ) |
|
452 | - . '">' |
|
453 | - . wp_trim_words( |
|
454 | - $event_name, |
|
455 | - 30, |
|
456 | - '...' |
|
457 | - ) |
|
458 | - . '</a>' |
|
459 | - : wp_trim_words($event_name, 30, '...'), |
|
460 | - $this->row_actions($actions) |
|
461 | - ); |
|
462 | - } else { |
|
463 | - return esc_html__( |
|
464 | - 'The event associated with this transaction via the primary registration cannot be retrieved.', |
|
465 | - 'event_espresso' |
|
466 | - ); |
|
467 | - } |
|
468 | - } |
|
469 | - |
|
470 | - |
|
471 | - /** |
|
472 | - * column_actions |
|
473 | - * |
|
474 | - * @param \EE_Transaction $transaction |
|
475 | - * @return string |
|
476 | - * @throws \EE_Error |
|
477 | - */ |
|
478 | - public function column_actions(EE_Transaction $transaction) |
|
479 | - { |
|
480 | - return $this->_action_string( |
|
481 | - $this->get_transaction_details_link($transaction) |
|
482 | - . $this->get_invoice_link($transaction) |
|
483 | - . $this->get_receipt_link($transaction) |
|
484 | - . $this->get_primary_registration_details_link($transaction) |
|
485 | - . $this->get_send_payment_reminder_trigger_link($transaction) |
|
486 | - . $this->get_payment_overview_link($transaction) |
|
487 | - . $this->get_related_messages_link($transaction), |
|
488 | - $transaction, |
|
489 | - 'ul', |
|
490 | - 'txn-overview-actions-ul' |
|
491 | - ); |
|
492 | - } |
|
493 | - |
|
494 | - |
|
495 | - /** |
|
496 | - * Get the transaction details link. |
|
497 | - * |
|
498 | - * @param EE_Transaction $transaction |
|
499 | - * @return string |
|
500 | - * @throws EE_Error |
|
501 | - */ |
|
502 | - protected function get_transaction_details_link(EE_Transaction $transaction) |
|
503 | - { |
|
504 | - $url = EE_Admin_Page::add_query_args_and_nonce( |
|
505 | - array( |
|
506 | - 'action' => 'view_transaction', |
|
507 | - 'TXN_ID' => $transaction->ID(), |
|
508 | - ), |
|
509 | - TXN_ADMIN_URL |
|
510 | - ); |
|
511 | - return ' |
|
140 | + $filters[] = ob_get_contents(); |
|
141 | + ob_end_clean(); |
|
142 | + return $filters; |
|
143 | + } |
|
144 | + |
|
145 | + |
|
146 | + /** |
|
147 | + *_add_view_counts |
|
148 | + */ |
|
149 | + protected function _add_view_counts() |
|
150 | + { |
|
151 | + foreach ($this->_views as $view) { |
|
152 | + $this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']); |
|
153 | + } |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * column TXN_ID |
|
159 | + * |
|
160 | + * @param \EE_Transaction $transaction |
|
161 | + * @return string |
|
162 | + * @throws \EE_Error |
|
163 | + */ |
|
164 | + public function column_TXN_ID(EE_Transaction $transaction) |
|
165 | + { |
|
166 | + $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
167 | + array( |
|
168 | + 'action' => 'view_transaction', |
|
169 | + 'TXN_ID' => $transaction->ID(), |
|
170 | + ), |
|
171 | + TXN_ADMIN_URL |
|
172 | + ); |
|
173 | + $content = '<a href="' . $view_lnk_url . '"' |
|
174 | + . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">' |
|
175 | + . $transaction->ID() |
|
176 | + . '</a>'; |
|
177 | + |
|
178 | + // txn timestamp |
|
179 | + $content .= ' <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>'; |
|
180 | + return $content; |
|
181 | + } |
|
182 | + |
|
183 | + |
|
184 | + /** |
|
185 | + * @param \EE_Transaction $transaction |
|
186 | + * @return string |
|
187 | + * @throws EE_Error |
|
188 | + * @throws InvalidArgumentException |
|
189 | + * @throws InvalidDataTypeException |
|
190 | + * @throws InvalidInterfaceException |
|
191 | + */ |
|
192 | + protected function _get_txn_timestamp(EE_Transaction $transaction) |
|
193 | + { |
|
194 | + // is TXN less than 2 hours old ? |
|
195 | + if (($transaction->failed() || $transaction->is_abandoned()) |
|
196 | + && $this->session_lifespan->expiration() < $transaction->datetime(false, true) |
|
197 | + ) { |
|
198 | + $timestamp = esc_html__('TXN in progress...', 'event_espresso'); |
|
199 | + } else { |
|
200 | + $timestamp = $transaction->get_i18n_datetime('TXN_timestamp'); |
|
201 | + } |
|
202 | + return $timestamp; |
|
203 | + } |
|
204 | + |
|
205 | + |
|
206 | + /** |
|
207 | + * column_cb |
|
208 | + * |
|
209 | + * @param \EE_Transaction $transaction |
|
210 | + * @return string |
|
211 | + * @throws \EE_Error |
|
212 | + */ |
|
213 | + public function column_cb($transaction) |
|
214 | + { |
|
215 | + return sprintf( |
|
216 | + '<input type="checkbox" name="%1$s[]" value="%2$s" />', |
|
217 | + $this->_wp_list_args['singular'], |
|
218 | + $transaction->ID() |
|
219 | + ); |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + /** |
|
224 | + * column_TXN_timestamp |
|
225 | + * |
|
226 | + * @param \EE_Transaction $transaction |
|
227 | + * @return string |
|
228 | + * @throws \EE_Error |
|
229 | + */ |
|
230 | + public function column_TXN_timestamp(EE_Transaction $transaction) |
|
231 | + { |
|
232 | + $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
233 | + array( |
|
234 | + 'action' => 'view_transaction', |
|
235 | + 'TXN_ID' => $transaction->ID(), |
|
236 | + ), |
|
237 | + TXN_ADMIN_URL |
|
238 | + ); |
|
239 | + $txn_date = '<a href="' . $view_lnk_url . '"' |
|
240 | + . ' title="' |
|
241 | + . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">' |
|
242 | + . $this->_get_txn_timestamp($transaction) |
|
243 | + . '</a>'; |
|
244 | + // status |
|
245 | + $txn_date .= '<br><span class="ee-status-text-small">' |
|
246 | + . EEH_Template::pretty_status( |
|
247 | + $transaction->status_ID(), |
|
248 | + false, |
|
249 | + 'sentence' |
|
250 | + ) |
|
251 | + . '</span>'; |
|
252 | + return $txn_date; |
|
253 | + } |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * column_TXN_total |
|
258 | + * |
|
259 | + * @param \EE_Transaction $transaction |
|
260 | + * @return string |
|
261 | + * @throws \EE_Error |
|
262 | + */ |
|
263 | + public function column_TXN_total(EE_Transaction $transaction) |
|
264 | + { |
|
265 | + if ($transaction->get('TXN_total') > 0) { |
|
266 | + return '<span class="txn-pad-rght">' |
|
267 | + . apply_filters( |
|
268 | + 'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total', |
|
269 | + $transaction->get_pretty('TXN_total'), |
|
270 | + $transaction |
|
271 | + ) |
|
272 | + . '</span>'; |
|
273 | + } else { |
|
274 | + return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>'; |
|
275 | + } |
|
276 | + } |
|
277 | + |
|
278 | + |
|
279 | + /** |
|
280 | + * column_TXN_paid |
|
281 | + * |
|
282 | + * @param \EE_Transaction $transaction |
|
283 | + * @return mixed|string |
|
284 | + * @throws \EE_Error |
|
285 | + */ |
|
286 | + public function column_TXN_paid(EE_Transaction $transaction) |
|
287 | + { |
|
288 | + $transaction_total = $transaction->get('TXN_total'); |
|
289 | + $transaction_paid = $transaction->get('TXN_paid'); |
|
290 | + |
|
291 | + if (\EEH_Money::compare_floats($transaction_total, 0, '>')) { |
|
292 | + // monies owing |
|
293 | + $span_class = 'txn-overview-part-payment-spn'; |
|
294 | + if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) { |
|
295 | + // paid in full |
|
296 | + $span_class = 'txn-overview-full-payment-spn'; |
|
297 | + } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) { |
|
298 | + // no payments made |
|
299 | + $span_class = 'txn-overview-no-payment-spn'; |
|
300 | + } |
|
301 | + } else { |
|
302 | + // transaction_total == 0 so this is a free event |
|
303 | + $span_class = 'txn-overview-free-event-spn'; |
|
304 | + } |
|
305 | + |
|
306 | + $payment_method = $transaction->payment_method(); |
|
307 | + $payment_method_name = $payment_method instanceof EE_Payment_Method |
|
308 | + ? $payment_method->admin_name() |
|
309 | + : esc_html__('Unknown', 'event_espresso'); |
|
310 | + |
|
311 | + $content = '<span class="' . $span_class . ' txn-pad-rght">' |
|
312 | + . $transaction->get_pretty('TXN_paid') |
|
313 | + . '</span>'; |
|
314 | + if ($transaction_paid > 0) { |
|
315 | + $content .= '<br><span class="ee-status-text-small">' |
|
316 | + . sprintf( |
|
317 | + esc_html__('...via %s', 'event_espresso'), |
|
318 | + $payment_method_name |
|
319 | + ) |
|
320 | + . '</span>'; |
|
321 | + } |
|
322 | + return $content; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + /** |
|
327 | + * column_ATT_fname |
|
328 | + * |
|
329 | + * @param \EE_Transaction $transaction |
|
330 | + * @return string |
|
331 | + * @throws EE_Error |
|
332 | + * @throws InvalidArgumentException |
|
333 | + * @throws InvalidDataTypeException |
|
334 | + * @throws InvalidInterfaceException |
|
335 | + */ |
|
336 | + public function column_ATT_fname(EE_Transaction $transaction) |
|
337 | + { |
|
338 | + $primary_reg = $transaction->primary_registration(); |
|
339 | + $attendee = $primary_reg->get_first_related('Attendee'); |
|
340 | + if ($attendee instanceof EE_Attendee) { |
|
341 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
342 | + array( |
|
343 | + 'action' => 'view_registration', |
|
344 | + '_REG_ID' => $primary_reg->ID(), |
|
345 | + ), |
|
346 | + REG_ADMIN_URL |
|
347 | + ); |
|
348 | + $content = EE_Registry::instance()->CAP->current_user_can( |
|
349 | + 'ee_read_registration', |
|
350 | + 'espresso_registrations_view_registration', |
|
351 | + $primary_reg->ID() |
|
352 | + ) |
|
353 | + ? '<a href="' . $edit_lnk_url . '"' |
|
354 | + . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">' |
|
355 | + . $attendee->full_name() |
|
356 | + . '</a>' |
|
357 | + : $attendee->full_name(); |
|
358 | + $content .= '<br>' . $attendee->email(); |
|
359 | + return $content; |
|
360 | + } |
|
361 | + return $transaction->failed() || $transaction->is_abandoned() |
|
362 | + ? esc_html__('no contact record.', 'event_espresso') |
|
363 | + : esc_html__( |
|
364 | + 'No contact record, because the transaction was abandoned or the registration process failed.', |
|
365 | + 'event_espresso' |
|
366 | + ); |
|
367 | + } |
|
368 | + |
|
369 | + |
|
370 | + /** |
|
371 | + * column_ATT_email |
|
372 | + * |
|
373 | + * @param \EE_Transaction $transaction |
|
374 | + * @return string |
|
375 | + * @throws \EE_Error |
|
376 | + */ |
|
377 | + public function column_ATT_email(EE_Transaction $transaction) |
|
378 | + { |
|
379 | + $attendee = $transaction->primary_registration()->get_first_related('Attendee'); |
|
380 | + if (! empty($attendee)) { |
|
381 | + return '<a href="mailto:' . $attendee->get('ATT_email') . '">' |
|
382 | + . $attendee->get('ATT_email') |
|
383 | + . '</a>'; |
|
384 | + } else { |
|
385 | + return $transaction->failed() || $transaction->is_abandoned() |
|
386 | + ? esc_html__('no contact record.', 'event_espresso') |
|
387 | + : esc_html__( |
|
388 | + 'No contact record, because the transaction was abandoned or the registration process failed.', |
|
389 | + 'event_espresso' |
|
390 | + ); |
|
391 | + } |
|
392 | + } |
|
393 | + |
|
394 | + |
|
395 | + /** |
|
396 | + * column_event_name |
|
397 | + * |
|
398 | + * @param \EE_Transaction $transaction |
|
399 | + * @return string |
|
400 | + * @throws EE_Error |
|
401 | + * @throws InvalidArgumentException |
|
402 | + * @throws InvalidDataTypeException |
|
403 | + * @throws InvalidInterfaceException |
|
404 | + */ |
|
405 | + public function column_event_name(EE_Transaction $transaction) |
|
406 | + { |
|
407 | + $actions = array(); |
|
408 | + $event = $transaction->primary_registration()->get_first_related('Event'); |
|
409 | + if (! empty($event)) { |
|
410 | + $edit_event_url = EE_Admin_Page::add_query_args_and_nonce( |
|
411 | + array('action' => 'edit', 'post' => $event->ID()), |
|
412 | + EVENTS_ADMIN_URL |
|
413 | + ); |
|
414 | + $event_name = $event->get('EVT_name'); |
|
415 | + |
|
416 | + // filter this view by transactions for this event |
|
417 | + $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce( |
|
418 | + array( |
|
419 | + 'action' => 'default', |
|
420 | + 'EVT_ID' => $event->ID(), |
|
421 | + ) |
|
422 | + ); |
|
423 | + if (empty($this->_req_data['EVT_ID']) |
|
424 | + && EE_Registry::instance()->CAP->current_user_can( |
|
425 | + 'ee_edit_event', |
|
426 | + 'espresso_events_edit', |
|
427 | + $event->ID() |
|
428 | + ) |
|
429 | + ) { |
|
430 | + $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"' |
|
431 | + . ' title="' . esc_attr__( |
|
432 | + 'Filter transactions by this event', |
|
433 | + 'event_espresso' |
|
434 | + ) . '">' |
|
435 | + . esc_html__('View Transactions for this event', 'event_espresso') |
|
436 | + . '</a>'; |
|
437 | + } |
|
438 | + |
|
439 | + return sprintf( |
|
440 | + '%1$s %2$s', |
|
441 | + EE_Registry::instance()->CAP->current_user_can( |
|
442 | + 'ee_edit_event', |
|
443 | + 'espresso_events_edit', |
|
444 | + $event->ID() |
|
445 | + ) |
|
446 | + ? '<a href="' . $edit_event_url . '"' |
|
447 | + . ' title="' |
|
448 | + . sprintf( |
|
449 | + esc_attr__('Edit Event: %s', 'event_espresso'), |
|
450 | + $event->get('EVT_name') |
|
451 | + ) |
|
452 | + . '">' |
|
453 | + . wp_trim_words( |
|
454 | + $event_name, |
|
455 | + 30, |
|
456 | + '...' |
|
457 | + ) |
|
458 | + . '</a>' |
|
459 | + : wp_trim_words($event_name, 30, '...'), |
|
460 | + $this->row_actions($actions) |
|
461 | + ); |
|
462 | + } else { |
|
463 | + return esc_html__( |
|
464 | + 'The event associated with this transaction via the primary registration cannot be retrieved.', |
|
465 | + 'event_espresso' |
|
466 | + ); |
|
467 | + } |
|
468 | + } |
|
469 | + |
|
470 | + |
|
471 | + /** |
|
472 | + * column_actions |
|
473 | + * |
|
474 | + * @param \EE_Transaction $transaction |
|
475 | + * @return string |
|
476 | + * @throws \EE_Error |
|
477 | + */ |
|
478 | + public function column_actions(EE_Transaction $transaction) |
|
479 | + { |
|
480 | + return $this->_action_string( |
|
481 | + $this->get_transaction_details_link($transaction) |
|
482 | + . $this->get_invoice_link($transaction) |
|
483 | + . $this->get_receipt_link($transaction) |
|
484 | + . $this->get_primary_registration_details_link($transaction) |
|
485 | + . $this->get_send_payment_reminder_trigger_link($transaction) |
|
486 | + . $this->get_payment_overview_link($transaction) |
|
487 | + . $this->get_related_messages_link($transaction), |
|
488 | + $transaction, |
|
489 | + 'ul', |
|
490 | + 'txn-overview-actions-ul' |
|
491 | + ); |
|
492 | + } |
|
493 | + |
|
494 | + |
|
495 | + /** |
|
496 | + * Get the transaction details link. |
|
497 | + * |
|
498 | + * @param EE_Transaction $transaction |
|
499 | + * @return string |
|
500 | + * @throws EE_Error |
|
501 | + */ |
|
502 | + protected function get_transaction_details_link(EE_Transaction $transaction) |
|
503 | + { |
|
504 | + $url = EE_Admin_Page::add_query_args_and_nonce( |
|
505 | + array( |
|
506 | + 'action' => 'view_transaction', |
|
507 | + 'TXN_ID' => $transaction->ID(), |
|
508 | + ), |
|
509 | + TXN_ADMIN_URL |
|
510 | + ); |
|
511 | + return ' |
|
512 | 512 | <li> |
513 | 513 | <a href="' . $url . '"' |
514 | - . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text"> |
|
514 | + . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text"> |
|
515 | 515 | <span class="dashicons dashicons-cart"></span> |
516 | 516 | </a> |
517 | 517 | </li>'; |
518 | - } |
|
519 | - |
|
520 | - |
|
521 | - /** |
|
522 | - * Get the invoice link for the given registration. |
|
523 | - * |
|
524 | - * @param EE_Transaction $transaction |
|
525 | - * @return string |
|
526 | - * @throws EE_Error |
|
527 | - */ |
|
528 | - protected function get_invoice_link(EE_Transaction $transaction) |
|
529 | - { |
|
530 | - $registration = $transaction->primary_registration(); |
|
531 | - if ($registration instanceof EE_Registration) { |
|
532 | - $url = $registration->invoice_url(); |
|
533 | - // only show invoice link if message type is active. |
|
534 | - if ($registration->attendee() instanceof EE_Attendee |
|
535 | - && EEH_MSG_Template::is_mt_active('invoice') |
|
536 | - ) { |
|
537 | - return ' |
|
518 | + } |
|
519 | + |
|
520 | + |
|
521 | + /** |
|
522 | + * Get the invoice link for the given registration. |
|
523 | + * |
|
524 | + * @param EE_Transaction $transaction |
|
525 | + * @return string |
|
526 | + * @throws EE_Error |
|
527 | + */ |
|
528 | + protected function get_invoice_link(EE_Transaction $transaction) |
|
529 | + { |
|
530 | + $registration = $transaction->primary_registration(); |
|
531 | + if ($registration instanceof EE_Registration) { |
|
532 | + $url = $registration->invoice_url(); |
|
533 | + // only show invoice link if message type is active. |
|
534 | + if ($registration->attendee() instanceof EE_Attendee |
|
535 | + && EEH_MSG_Template::is_mt_active('invoice') |
|
536 | + ) { |
|
537 | + return ' |
|
538 | 538 | <li> |
539 | 539 | <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"' |
540 | - . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
540 | + . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
541 | 541 | <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span> |
542 | 542 | </a> |
543 | 543 | </li>'; |
544 | - } |
|
545 | - } |
|
546 | - return ''; |
|
547 | - } |
|
548 | - |
|
549 | - |
|
550 | - /** |
|
551 | - * Get the receipt link for the transaction. |
|
552 | - * |
|
553 | - * @param EE_Transaction $transaction |
|
554 | - * @return string |
|
555 | - * @throws EE_Error |
|
556 | - */ |
|
557 | - protected function get_receipt_link(EE_Transaction $transaction) |
|
558 | - { |
|
559 | - $registration = $transaction->primary_registration(); |
|
560 | - if ($registration instanceof EE_Registration) { |
|
561 | - $url = $registration->receipt_url(); |
|
562 | - // only show receipt link if message type is active. |
|
563 | - if ($registration->attendee() instanceof EE_Attendee |
|
564 | - && EEH_MSG_Template::is_mt_active('receipt')) { |
|
565 | - return ' |
|
544 | + } |
|
545 | + } |
|
546 | + return ''; |
|
547 | + } |
|
548 | + |
|
549 | + |
|
550 | + /** |
|
551 | + * Get the receipt link for the transaction. |
|
552 | + * |
|
553 | + * @param EE_Transaction $transaction |
|
554 | + * @return string |
|
555 | + * @throws EE_Error |
|
556 | + */ |
|
557 | + protected function get_receipt_link(EE_Transaction $transaction) |
|
558 | + { |
|
559 | + $registration = $transaction->primary_registration(); |
|
560 | + if ($registration instanceof EE_Registration) { |
|
561 | + $url = $registration->receipt_url(); |
|
562 | + // only show receipt link if message type is active. |
|
563 | + if ($registration->attendee() instanceof EE_Attendee |
|
564 | + && EEH_MSG_Template::is_mt_active('receipt')) { |
|
565 | + return ' |
|
566 | 566 | <li> |
567 | 567 | <a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"' |
568 | - . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
568 | + . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
569 | 569 | <span class="dashicons dashicons-media-default ee-icon-size-18"></span> |
570 | 570 | </a> |
571 | 571 | </li>'; |
572 | - } |
|
573 | - } |
|
574 | - return ''; |
|
575 | - } |
|
576 | - |
|
577 | - |
|
578 | - /** |
|
579 | - * Get the link to view the details for the primary registration. |
|
580 | - * |
|
581 | - * @param EE_Transaction $transaction |
|
582 | - * @return string |
|
583 | - * @throws EE_Error |
|
584 | - * @throws InvalidArgumentException |
|
585 | - * @throws InvalidDataTypeException |
|
586 | - * @throws InvalidInterfaceException |
|
587 | - */ |
|
588 | - protected function get_primary_registration_details_link(EE_Transaction $transaction) |
|
589 | - { |
|
590 | - $registration = $transaction->primary_registration(); |
|
591 | - if ($registration instanceof EE_Registration) { |
|
592 | - $url = EE_Admin_Page::add_query_args_and_nonce( |
|
593 | - array( |
|
594 | - 'action' => 'view_registration', |
|
595 | - '_REG_ID' => $registration->ID(), |
|
596 | - ), |
|
597 | - REG_ADMIN_URL |
|
598 | - ); |
|
599 | - return EE_Registry::instance()->CAP->current_user_can( |
|
600 | - 'ee_read_registration', |
|
601 | - 'espresso_registrations_view_registration', |
|
602 | - $registration->ID() |
|
603 | - ) |
|
604 | - ? ' |
|
572 | + } |
|
573 | + } |
|
574 | + return ''; |
|
575 | + } |
|
576 | + |
|
577 | + |
|
578 | + /** |
|
579 | + * Get the link to view the details for the primary registration. |
|
580 | + * |
|
581 | + * @param EE_Transaction $transaction |
|
582 | + * @return string |
|
583 | + * @throws EE_Error |
|
584 | + * @throws InvalidArgumentException |
|
585 | + * @throws InvalidDataTypeException |
|
586 | + * @throws InvalidInterfaceException |
|
587 | + */ |
|
588 | + protected function get_primary_registration_details_link(EE_Transaction $transaction) |
|
589 | + { |
|
590 | + $registration = $transaction->primary_registration(); |
|
591 | + if ($registration instanceof EE_Registration) { |
|
592 | + $url = EE_Admin_Page::add_query_args_and_nonce( |
|
593 | + array( |
|
594 | + 'action' => 'view_registration', |
|
595 | + '_REG_ID' => $registration->ID(), |
|
596 | + ), |
|
597 | + REG_ADMIN_URL |
|
598 | + ); |
|
599 | + return EE_Registry::instance()->CAP->current_user_can( |
|
600 | + 'ee_read_registration', |
|
601 | + 'espresso_registrations_view_registration', |
|
602 | + $registration->ID() |
|
603 | + ) |
|
604 | + ? ' |
|
605 | 605 | <li> |
606 | 606 | <a href="' . $url . '"' |
607 | - . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text"> |
|
607 | + . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text"> |
|
608 | 608 | <span class="dashicons dashicons-clipboard"></span> |
609 | 609 | </a> |
610 | 610 | </li>' |
611 | - : ''; |
|
612 | - } |
|
613 | - return ''; |
|
614 | - } |
|
615 | - |
|
616 | - |
|
617 | - /** |
|
618 | - * Get send payment reminder trigger link |
|
619 | - * |
|
620 | - * @param EE_Transaction $transaction |
|
621 | - * @return string |
|
622 | - * @throws EE_Error |
|
623 | - * @throws InvalidArgumentException |
|
624 | - * @throws InvalidDataTypeException |
|
625 | - * @throws InvalidInterfaceException |
|
626 | - */ |
|
627 | - protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction) |
|
628 | - { |
|
629 | - $registration = $transaction->primary_registration(); |
|
630 | - if ($registration instanceof EE_Registration |
|
631 | - && $registration->attendee() instanceof EE_Attendee |
|
632 | - && EEH_MSG_Template::is_mt_active('payment_reminder') |
|
633 | - && ! in_array( |
|
634 | - $transaction->status_ID(), |
|
635 | - array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code), |
|
636 | - true |
|
637 | - ) |
|
638 | - && EE_Registry::instance()->CAP->current_user_can( |
|
639 | - 'ee_send_message', |
|
640 | - 'espresso_transactions_send_payment_reminder' |
|
641 | - ) |
|
642 | - ) { |
|
643 | - $url = EE_Admin_Page::add_query_args_and_nonce( |
|
644 | - array( |
|
645 | - 'action' => 'send_payment_reminder', |
|
646 | - 'TXN_ID' => $transaction->ID(), |
|
647 | - ), |
|
648 | - TXN_ADMIN_URL |
|
649 | - ); |
|
650 | - return ' |
|
611 | + : ''; |
|
612 | + } |
|
613 | + return ''; |
|
614 | + } |
|
615 | + |
|
616 | + |
|
617 | + /** |
|
618 | + * Get send payment reminder trigger link |
|
619 | + * |
|
620 | + * @param EE_Transaction $transaction |
|
621 | + * @return string |
|
622 | + * @throws EE_Error |
|
623 | + * @throws InvalidArgumentException |
|
624 | + * @throws InvalidDataTypeException |
|
625 | + * @throws InvalidInterfaceException |
|
626 | + */ |
|
627 | + protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction) |
|
628 | + { |
|
629 | + $registration = $transaction->primary_registration(); |
|
630 | + if ($registration instanceof EE_Registration |
|
631 | + && $registration->attendee() instanceof EE_Attendee |
|
632 | + && EEH_MSG_Template::is_mt_active('payment_reminder') |
|
633 | + && ! in_array( |
|
634 | + $transaction->status_ID(), |
|
635 | + array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code), |
|
636 | + true |
|
637 | + ) |
|
638 | + && EE_Registry::instance()->CAP->current_user_can( |
|
639 | + 'ee_send_message', |
|
640 | + 'espresso_transactions_send_payment_reminder' |
|
641 | + ) |
|
642 | + ) { |
|
643 | + $url = EE_Admin_Page::add_query_args_and_nonce( |
|
644 | + array( |
|
645 | + 'action' => 'send_payment_reminder', |
|
646 | + 'TXN_ID' => $transaction->ID(), |
|
647 | + ), |
|
648 | + TXN_ADMIN_URL |
|
649 | + ); |
|
650 | + return ' |
|
651 | 651 | <li> |
652 | 652 | <a href="' . $url . '"' |
653 | - . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text"> |
|
653 | + . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text"> |
|
654 | 654 | <span class="dashicons dashicons-email-alt"></span> |
655 | 655 | </a> |
656 | 656 | </li>'; |
657 | - } |
|
658 | - return ''; |
|
659 | - } |
|
660 | - |
|
661 | - |
|
662 | - /** |
|
663 | - * Get link to filtered view in the message activity list table of messages for this transaction. |
|
664 | - * |
|
665 | - * @param EE_Transaction $transaction |
|
666 | - * @return string |
|
667 | - * @throws EE_Error |
|
668 | - * @throws InvalidArgumentException |
|
669 | - * @throws InvalidDataTypeException |
|
670 | - * @throws InvalidInterfaceException |
|
671 | - */ |
|
672 | - protected function get_related_messages_link(EE_Transaction $transaction) |
|
673 | - { |
|
674 | - $url = EEH_MSG_Template::get_message_action_link( |
|
675 | - 'see_notifications_for', |
|
676 | - null, |
|
677 | - array('TXN_ID' => $transaction->ID()) |
|
678 | - ); |
|
679 | - return EE_Registry::instance()->CAP->current_user_can( |
|
680 | - 'ee_read_global_messages', |
|
681 | - 'view_filtered_messages' |
|
682 | - ) |
|
683 | - ? '<li>' . $url . '</li>' |
|
684 | - : ''; |
|
685 | - } |
|
686 | - |
|
687 | - |
|
688 | - /** |
|
689 | - * Return the link to make a payment on the frontend |
|
690 | - * |
|
691 | - * @param EE_Transaction $transaction |
|
692 | - * @return string |
|
693 | - * @throws EE_Error |
|
694 | - */ |
|
695 | - protected function get_payment_overview_link(EE_Transaction $transaction) |
|
696 | - { |
|
697 | - $registration = $transaction->primary_registration(); |
|
698 | - if ($registration instanceof EE_Registration |
|
699 | - && $transaction->status_ID() !== EEM_Transaction::complete_status_code |
|
700 | - && $registration->owes_monies_and_can_pay() |
|
701 | - ) { |
|
702 | - return ' |
|
657 | + } |
|
658 | + return ''; |
|
659 | + } |
|
660 | + |
|
661 | + |
|
662 | + /** |
|
663 | + * Get link to filtered view in the message activity list table of messages for this transaction. |
|
664 | + * |
|
665 | + * @param EE_Transaction $transaction |
|
666 | + * @return string |
|
667 | + * @throws EE_Error |
|
668 | + * @throws InvalidArgumentException |
|
669 | + * @throws InvalidDataTypeException |
|
670 | + * @throws InvalidInterfaceException |
|
671 | + */ |
|
672 | + protected function get_related_messages_link(EE_Transaction $transaction) |
|
673 | + { |
|
674 | + $url = EEH_MSG_Template::get_message_action_link( |
|
675 | + 'see_notifications_for', |
|
676 | + null, |
|
677 | + array('TXN_ID' => $transaction->ID()) |
|
678 | + ); |
|
679 | + return EE_Registry::instance()->CAP->current_user_can( |
|
680 | + 'ee_read_global_messages', |
|
681 | + 'view_filtered_messages' |
|
682 | + ) |
|
683 | + ? '<li>' . $url . '</li>' |
|
684 | + : ''; |
|
685 | + } |
|
686 | + |
|
687 | + |
|
688 | + /** |
|
689 | + * Return the link to make a payment on the frontend |
|
690 | + * |
|
691 | + * @param EE_Transaction $transaction |
|
692 | + * @return string |
|
693 | + * @throws EE_Error |
|
694 | + */ |
|
695 | + protected function get_payment_overview_link(EE_Transaction $transaction) |
|
696 | + { |
|
697 | + $registration = $transaction->primary_registration(); |
|
698 | + if ($registration instanceof EE_Registration |
|
699 | + && $transaction->status_ID() !== EEM_Transaction::complete_status_code |
|
700 | + && $registration->owes_monies_and_can_pay() |
|
701 | + ) { |
|
702 | + return ' |
|
703 | 703 | <li> |
704 | 704 | <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"' |
705 | - . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"' |
|
706 | - . ' class="tiny-text"> |
|
705 | + . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"' |
|
706 | + . ' class="tiny-text"> |
|
707 | 707 | <span class="dashicons dashicons-money ee-icon-size-18"></span> |
708 | 708 | </a> |
709 | 709 | </li> |
710 | 710 | '; |
711 | - } |
|
712 | - return ''; |
|
713 | - } |
|
711 | + } |
|
712 | + return ''; |
|
713 | + } |
|
714 | 714 | } |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | { |
97 | 97 | $class = parent::_get_row_class($transaction); |
98 | 98 | // add status class |
99 | - $class .= ' ee-status-strip txn-status-' . $transaction->status_ID(); |
|
99 | + $class .= ' ee-status-strip txn-status-'.$transaction->status_ID(); |
|
100 | 100 | if ($this->_has_checkbox_column) { |
101 | 101 | $class .= ' has-checkbox-column'; |
102 | 102 | } |
@@ -149,7 +149,7 @@ discard block |
||
149 | 149 | protected function _add_view_counts() |
150 | 150 | { |
151 | 151 | foreach ($this->_views as $view) { |
152 | - $this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']); |
|
152 | + $this->_views[$view['slug']]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']); |
|
153 | 153 | } |
154 | 154 | } |
155 | 155 | |
@@ -170,13 +170,13 @@ discard block |
||
170 | 170 | ), |
171 | 171 | TXN_ADMIN_URL |
172 | 172 | ); |
173 | - $content = '<a href="' . $view_lnk_url . '"' |
|
174 | - . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">' |
|
173 | + $content = '<a href="'.$view_lnk_url.'"' |
|
174 | + . ' title="'.esc_attr__('Go to Transaction Details', 'event_espresso').'">' |
|
175 | 175 | . $transaction->ID() |
176 | 176 | . '</a>'; |
177 | 177 | |
178 | 178 | // txn timestamp |
179 | - $content .= ' <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>'; |
|
179 | + $content .= ' <span class="show-on-mobile-view-only">'.$this->_get_txn_timestamp($transaction).'</span>'; |
|
180 | 180 | return $content; |
181 | 181 | } |
182 | 182 | |
@@ -236,9 +236,9 @@ discard block |
||
236 | 236 | ), |
237 | 237 | TXN_ADMIN_URL |
238 | 238 | ); |
239 | - $txn_date = '<a href="' . $view_lnk_url . '"' |
|
239 | + $txn_date = '<a href="'.$view_lnk_url.'"' |
|
240 | 240 | . ' title="' |
241 | - . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">' |
|
241 | + . esc_attr__('View Transaction Details for TXN #', 'event_espresso').$transaction->ID().'">' |
|
242 | 242 | . $this->_get_txn_timestamp($transaction) |
243 | 243 | . '</a>'; |
244 | 244 | // status |
@@ -271,7 +271,7 @@ discard block |
||
271 | 271 | ) |
272 | 272 | . '</span>'; |
273 | 273 | } else { |
274 | - return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>'; |
|
274 | + return '<span class="txn-overview-free-event-spn">'.esc_html__('free', 'event_espresso').'</span>'; |
|
275 | 275 | } |
276 | 276 | } |
277 | 277 | |
@@ -308,7 +308,7 @@ discard block |
||
308 | 308 | ? $payment_method->admin_name() |
309 | 309 | : esc_html__('Unknown', 'event_espresso'); |
310 | 310 | |
311 | - $content = '<span class="' . $span_class . ' txn-pad-rght">' |
|
311 | + $content = '<span class="'.$span_class.' txn-pad-rght">' |
|
312 | 312 | . $transaction->get_pretty('TXN_paid') |
313 | 313 | . '</span>'; |
314 | 314 | if ($transaction_paid > 0) { |
@@ -350,12 +350,12 @@ discard block |
||
350 | 350 | 'espresso_registrations_view_registration', |
351 | 351 | $primary_reg->ID() |
352 | 352 | ) |
353 | - ? '<a href="' . $edit_lnk_url . '"' |
|
354 | - . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">' |
|
353 | + ? '<a href="'.$edit_lnk_url.'"' |
|
354 | + . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'">' |
|
355 | 355 | . $attendee->full_name() |
356 | 356 | . '</a>' |
357 | 357 | : $attendee->full_name(); |
358 | - $content .= '<br>' . $attendee->email(); |
|
358 | + $content .= '<br>'.$attendee->email(); |
|
359 | 359 | return $content; |
360 | 360 | } |
361 | 361 | return $transaction->failed() || $transaction->is_abandoned() |
@@ -377,8 +377,8 @@ discard block |
||
377 | 377 | public function column_ATT_email(EE_Transaction $transaction) |
378 | 378 | { |
379 | 379 | $attendee = $transaction->primary_registration()->get_first_related('Attendee'); |
380 | - if (! empty($attendee)) { |
|
381 | - return '<a href="mailto:' . $attendee->get('ATT_email') . '">' |
|
380 | + if ( ! empty($attendee)) { |
|
381 | + return '<a href="mailto:'.$attendee->get('ATT_email').'">' |
|
382 | 382 | . $attendee->get('ATT_email') |
383 | 383 | . '</a>'; |
384 | 384 | } else { |
@@ -406,7 +406,7 @@ discard block |
||
406 | 406 | { |
407 | 407 | $actions = array(); |
408 | 408 | $event = $transaction->primary_registration()->get_first_related('Event'); |
409 | - if (! empty($event)) { |
|
409 | + if ( ! empty($event)) { |
|
410 | 410 | $edit_event_url = EE_Admin_Page::add_query_args_and_nonce( |
411 | 411 | array('action' => 'edit', 'post' => $event->ID()), |
412 | 412 | EVENTS_ADMIN_URL |
@@ -427,11 +427,11 @@ discard block |
||
427 | 427 | $event->ID() |
428 | 428 | ) |
429 | 429 | ) { |
430 | - $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"' |
|
431 | - . ' title="' . esc_attr__( |
|
430 | + $actions['filter_by_event'] = '<a href="'.$txn_by_event_lnk.'"' |
|
431 | + . ' title="'.esc_attr__( |
|
432 | 432 | 'Filter transactions by this event', |
433 | 433 | 'event_espresso' |
434 | - ) . '">' |
|
434 | + ).'">' |
|
435 | 435 | . esc_html__('View Transactions for this event', 'event_espresso') |
436 | 436 | . '</a>'; |
437 | 437 | } |
@@ -443,7 +443,7 @@ discard block |
||
443 | 443 | 'espresso_events_edit', |
444 | 444 | $event->ID() |
445 | 445 | ) |
446 | - ? '<a href="' . $edit_event_url . '"' |
|
446 | + ? '<a href="'.$edit_event_url.'"' |
|
447 | 447 | . ' title="' |
448 | 448 | . sprintf( |
449 | 449 | esc_attr__('Edit Event: %s', 'event_espresso'), |
@@ -510,8 +510,8 @@ discard block |
||
510 | 510 | ); |
511 | 511 | return ' |
512 | 512 | <li> |
513 | - <a href="' . $url . '"' |
|
514 | - . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text"> |
|
513 | + <a href="' . $url.'"' |
|
514 | + . ' title="'.esc_attr__('View Transaction Details', 'event_espresso').'" class="tiny-text"> |
|
515 | 515 | <span class="dashicons dashicons-cart"></span> |
516 | 516 | </a> |
517 | 517 | </li>'; |
@@ -536,8 +536,8 @@ discard block |
||
536 | 536 | ) { |
537 | 537 | return ' |
538 | 538 | <li> |
539 | - <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"' |
|
540 | - . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
539 | + <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso').'"' |
|
540 | + . ' target="_blank" href="'.$url.'" class="tiny-text"> |
|
541 | 541 | <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span> |
542 | 542 | </a> |
543 | 543 | </li>'; |
@@ -564,8 +564,8 @@ discard block |
||
564 | 564 | && EEH_MSG_Template::is_mt_active('receipt')) { |
565 | 565 | return ' |
566 | 566 | <li> |
567 | - <a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"' |
|
568 | - . ' target="_blank" href="' . $url . '" class="tiny-text"> |
|
567 | + <a title="' . esc_attr__('View Transaction Receipt', 'event_espresso').'"' |
|
568 | + . ' target="_blank" href="'.$url.'" class="tiny-text"> |
|
569 | 569 | <span class="dashicons dashicons-media-default ee-icon-size-18"></span> |
570 | 570 | </a> |
571 | 571 | </li>'; |
@@ -603,8 +603,8 @@ discard block |
||
603 | 603 | ) |
604 | 604 | ? ' |
605 | 605 | <li> |
606 | - <a href="' . $url . '"' |
|
607 | - . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text"> |
|
606 | + <a href="' . $url.'"' |
|
607 | + . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'" class="tiny-text"> |
|
608 | 608 | <span class="dashicons dashicons-clipboard"></span> |
609 | 609 | </a> |
610 | 610 | </li>' |
@@ -649,8 +649,8 @@ discard block |
||
649 | 649 | ); |
650 | 650 | return ' |
651 | 651 | <li> |
652 | - <a href="' . $url . '"' |
|
653 | - . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text"> |
|
652 | + <a href="' . $url.'"' |
|
653 | + . ' title="'.esc_attr__('Send Payment Reminder', 'event_espresso').'" class="tiny-text"> |
|
654 | 654 | <span class="dashicons dashicons-email-alt"></span> |
655 | 655 | </a> |
656 | 656 | </li>'; |
@@ -680,7 +680,7 @@ discard block |
||
680 | 680 | 'ee_read_global_messages', |
681 | 681 | 'view_filtered_messages' |
682 | 682 | ) |
683 | - ? '<li>' . $url . '</li>' |
|
683 | + ? '<li>'.$url.'</li>' |
|
684 | 684 | : ''; |
685 | 685 | } |
686 | 686 | |
@@ -701,8 +701,8 @@ discard block |
||
701 | 701 | ) { |
702 | 702 | return ' |
703 | 703 | <li> |
704 | - <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"' |
|
705 | - . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"' |
|
704 | + <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso').'"' |
|
705 | + . ' target="_blank" href="'.$registration->payment_overview_url(true).'"' |
|
706 | 706 | . ' class="tiny-text"> |
707 | 707 | <span class="dashicons dashicons-money ee-icon-size-18"></span> |
708 | 708 | </a> |
@@ -1,7 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | namespace EventEspresso\Codeception\helpers; |
3 | 3 | |
4 | -use Page\CoreAdmin; |
|
5 | 4 | use Page\CountrySettingsAdmin as CountrySettings; |
6 | 5 | |
7 | 6 | trait CountrySettingsAdmin |
@@ -6,59 +6,59 @@ |
||
6 | 6 | |
7 | 7 | trait CountrySettingsAdmin |
8 | 8 | { |
9 | - /** |
|
10 | - * Instructs the actor to browse to the country settings page. |
|
11 | - * Assumes the actor is already logged in. |
|
12 | - * @param string $additional_params |
|
13 | - */ |
|
14 | - public function amOnCountrySettingsAdminPage($additional_params = '') |
|
15 | - { |
|
16 | - $this->actor()->amOnAdminPage(CountrySettings::url($additional_params)); |
|
17 | - } |
|
9 | + /** |
|
10 | + * Instructs the actor to browse to the country settings page. |
|
11 | + * Assumes the actor is already logged in. |
|
12 | + * @param string $additional_params |
|
13 | + */ |
|
14 | + public function amOnCountrySettingsAdminPage($additional_params = '') |
|
15 | + { |
|
16 | + $this->actor()->amOnAdminPage(CountrySettings::url($additional_params)); |
|
17 | + } |
|
18 | 18 | |
19 | 19 | |
20 | - /** |
|
21 | - * Instructs the actor to select the given decimal places radio option. |
|
22 | - * Assumes the actor is already on the country settings page. |
|
23 | - * @param string $decimal_places |
|
24 | - * @param string $country_code |
|
25 | - */ |
|
26 | - public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US') |
|
27 | - { |
|
28 | - $this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code)); |
|
29 | - } |
|
20 | + /** |
|
21 | + * Instructs the actor to select the given decimal places radio option. |
|
22 | + * Assumes the actor is already on the country settings page. |
|
23 | + * @param string $decimal_places |
|
24 | + * @param string $country_code |
|
25 | + */ |
|
26 | + public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US') |
|
27 | + { |
|
28 | + $this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code)); |
|
29 | + } |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * Instructs the actor to select the given decimal mark radio option. |
|
34 | - * Assumes the actor is already on the country settings page. |
|
35 | - * @param string $decimal_mark |
|
36 | - */ |
|
37 | - public function setCurrencyDecimalMarkTo($decimal_mark = '.') |
|
38 | - { |
|
39 | - $this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark)); |
|
40 | - } |
|
32 | + /** |
|
33 | + * Instructs the actor to select the given decimal mark radio option. |
|
34 | + * Assumes the actor is already on the country settings page. |
|
35 | + * @param string $decimal_mark |
|
36 | + */ |
|
37 | + public function setCurrencyDecimalMarkTo($decimal_mark = '.') |
|
38 | + { |
|
39 | + $this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark)); |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * Instructs the actor to select the given thousands separator radio option. |
|
45 | - * Assumes the actor is already on the country settings page. |
|
46 | - * @param string $thousands_seperator |
|
47 | - */ |
|
48 | - public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',') |
|
49 | - { |
|
50 | - $this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator)); |
|
51 | - } |
|
43 | + /** |
|
44 | + * Instructs the actor to select the given thousands separator radio option. |
|
45 | + * Assumes the actor is already on the country settings page. |
|
46 | + * @param string $thousands_seperator |
|
47 | + */ |
|
48 | + public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',') |
|
49 | + { |
|
50 | + $this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator)); |
|
51 | + } |
|
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * Clicks the country settings submit button. |
|
56 | - * Assumes the actor is on the country settings admin page. |
|
57 | - */ |
|
58 | - public function saveCountrySettings() |
|
59 | - { |
|
60 | - $this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON); |
|
61 | - //no indicator on the page when stuff has been updated so just give a bit of time for it to finish. |
|
62 | - $this->actor()->wait(10); |
|
63 | - } |
|
54 | + /** |
|
55 | + * Clicks the country settings submit button. |
|
56 | + * Assumes the actor is on the country settings admin page. |
|
57 | + */ |
|
58 | + public function saveCountrySettings() |
|
59 | + { |
|
60 | + $this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON); |
|
61 | + //no indicator on the page when stuff has been updated so just give a bit of time for it to finish. |
|
62 | + $this->actor()->wait(10); |
|
63 | + } |
|
64 | 64 | } |
65 | 65 | \ No newline at end of file |
@@ -14,51 +14,51 @@ |
||
14 | 14 | { |
15 | 15 | |
16 | 16 | |
17 | - const COUNTRY_SETTINGS_SAVE_BUTTON = '#country_settings_save_2'; |
|
17 | + const COUNTRY_SETTINGS_SAVE_BUTTON = '#country_settings_save_2'; |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * Return the url for the country settings admin page. |
|
23 | - * @param string $additional_params |
|
24 | - * @return string |
|
25 | - */ |
|
26 | - public static function url($additional_params = '') |
|
27 | - { |
|
28 | - return self::adminUrl('espresso_general_settings', 'country_settings', $additional_params); |
|
29 | - } |
|
21 | + /** |
|
22 | + * Return the url for the country settings admin page. |
|
23 | + * @param string $additional_params |
|
24 | + * @return string |
|
25 | + */ |
|
26 | + public static function url($additional_params = '') |
|
27 | + { |
|
28 | + return self::adminUrl('espresso_general_settings', 'country_settings', $additional_params); |
|
29 | + } |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * Return the decimal places (precision) radio field locator for selection. |
|
34 | - * @param int $decimal_place_value |
|
35 | - * @param string $country_code |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public static function currencyDecimalPlacesRadioField($decimal_place_value = 2, $country_code = 'US') |
|
39 | - { |
|
40 | - return "//input[@id='CNT_cur_dec_plc-$country_code-$decimal_place_value']"; |
|
41 | - } |
|
32 | + /** |
|
33 | + * Return the decimal places (precision) radio field locator for selection. |
|
34 | + * @param int $decimal_place_value |
|
35 | + * @param string $country_code |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public static function currencyDecimalPlacesRadioField($decimal_place_value = 2, $country_code = 'US') |
|
39 | + { |
|
40 | + return "//input[@id='CNT_cur_dec_plc-$country_code-$decimal_place_value']"; |
|
41 | + } |
|
42 | 42 | |
43 | 43 | |
44 | - /** |
|
45 | - * Return the currency decimal mark field locator for selection. |
|
46 | - * @param string $decimal_mark |
|
47 | - * @return string |
|
48 | - */ |
|
49 | - public static function currencyDecimalMarkRadioField($decimal_mark = '.') |
|
50 | - { |
|
51 | - return "//input[@class='CNT_cur_dec_mrk' and @value='$decimal_mark']"; |
|
52 | - } |
|
44 | + /** |
|
45 | + * Return the currency decimal mark field locator for selection. |
|
46 | + * @param string $decimal_mark |
|
47 | + * @return string |
|
48 | + */ |
|
49 | + public static function currencyDecimalMarkRadioField($decimal_mark = '.') |
|
50 | + { |
|
51 | + return "//input[@class='CNT_cur_dec_mrk' and @value='$decimal_mark']"; |
|
52 | + } |
|
53 | 53 | |
54 | 54 | |
55 | - /** |
|
56 | - * Return the currency thousands separator field locator for selection. |
|
57 | - * @param string $thousands_separator |
|
58 | - * @return string |
|
59 | - */ |
|
60 | - public static function currencyThousandsSeparatorField($thousands_separator = ',') |
|
61 | - { |
|
62 | - return "//input[@class='CNT_cur_thsnds' and @value='$thousands_separator']"; |
|
63 | - } |
|
55 | + /** |
|
56 | + * Return the currency thousands separator field locator for selection. |
|
57 | + * @param string $thousands_separator |
|
58 | + * @return string |
|
59 | + */ |
|
60 | + public static function currencyThousandsSeparatorField($thousands_separator = ',') |
|
61 | + { |
|
62 | + return "//input[@class='CNT_cur_thsnds' and @value='$thousands_separator']"; |
|
63 | + } |
|
64 | 64 | } |
65 | 65 | \ No newline at end of file |